babylon.module.d.ts 5.7 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398
  1. declare module "babylonjs/types" {
  2. /** Alias type for value that can be null */
  3. export type Nullable<T> = T | null;
  4. /**
  5. * Alias type for number that are floats
  6. * @ignorenaming
  7. */
  8. export type float = number;
  9. /**
  10. * Alias type for number that are doubles.
  11. * @ignorenaming
  12. */
  13. export type double = number;
  14. /**
  15. * Alias type for number that are integer
  16. * @ignorenaming
  17. */
  18. export type int = number;
  19. /** Alias type for number array or Float32Array */
  20. export type FloatArray = number[] | Float32Array;
  21. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  22. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  23. /**
  24. * Alias for types that can be used by a Buffer or VertexBuffer.
  25. */
  26. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  27. /**
  28. * Alias type for primitive types
  29. * @ignorenaming
  30. */
  31. type Primitive = undefined | null | boolean | string | number | Function;
  32. /**
  33. * Type modifier to make all the properties of an object Readonly
  34. */
  35. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  36. /**
  37. * Type modifier to make all the properties of an object Readonly recursively
  38. */
  39. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  40. /**
  41. * Type modifier to make object properties readonly.
  42. */
  43. export type DeepImmutableObject<T> = {
  44. readonly [K in keyof T]: DeepImmutable<T[K]>;
  45. };
  46. /** @hidden */
  47. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  48. }
  49. }
  50. declare module "babylonjs/Misc/observable" {
  51. import { Nullable } from "babylonjs/types";
  52. /**
  53. * A class serves as a medium between the observable and its observers
  54. */
  55. export class EventState {
  56. /**
  57. * Create a new EventState
  58. * @param mask defines the mask associated with this state
  59. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  60. * @param target defines the original target of the state
  61. * @param currentTarget defines the current target of the state
  62. */
  63. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  64. /**
  65. * Initialize the current event state
  66. * @param mask defines the mask associated with this state
  67. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68. * @param target defines the original target of the state
  69. * @param currentTarget defines the current target of the state
  70. * @returns the current event state
  71. */
  72. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  73. /**
  74. * An Observer can set this property to true to prevent subsequent observers of being notified
  75. */
  76. skipNextObservers: boolean;
  77. /**
  78. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79. */
  80. mask: number;
  81. /**
  82. * The object that originally notified the event
  83. */
  84. target?: any;
  85. /**
  86. * The current object in the bubbling phase
  87. */
  88. currentTarget?: any;
  89. /**
  90. * This will be populated with the return value of the last function that was executed.
  91. * If it is the first function in the callback chain it will be the event data.
  92. */
  93. lastReturnValue?: any;
  94. }
  95. /**
  96. * Represent an Observer registered to a given Observable object.
  97. */
  98. export class Observer<T> {
  99. /**
  100. * Defines the callback to call when the observer is notified
  101. */
  102. callback: (eventData: T, eventState: EventState) => void;
  103. /**
  104. * Defines the mask of the observer (used to filter notifications)
  105. */
  106. mask: number;
  107. /**
  108. * Defines the current scope used to restore the JS context
  109. */
  110. scope: any;
  111. /** @hidden */
  112. _willBeUnregistered: boolean;
  113. /**
  114. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  115. */
  116. unregisterOnNextCall: boolean;
  117. /**
  118. * Creates a new observer
  119. * @param callback defines the callback to call when the observer is notified
  120. * @param mask defines the mask of the observer (used to filter notifications)
  121. * @param scope defines the current scope used to restore the JS context
  122. */
  123. constructor(
  124. /**
  125. * Defines the callback to call when the observer is notified
  126. */
  127. callback: (eventData: T, eventState: EventState) => void,
  128. /**
  129. * Defines the mask of the observer (used to filter notifications)
  130. */
  131. mask: number,
  132. /**
  133. * Defines the current scope used to restore the JS context
  134. */
  135. scope?: any);
  136. }
  137. /**
  138. * Represent a list of observers registered to multiple Observables object.
  139. */
  140. export class MultiObserver<T> {
  141. private _observers;
  142. private _observables;
  143. /**
  144. * Release associated resources
  145. */
  146. dispose(): void;
  147. /**
  148. * Raise a callback when one of the observable will notify
  149. * @param observables defines a list of observables to watch
  150. * @param callback defines the callback to call on notification
  151. * @param mask defines the mask used to filter notifications
  152. * @param scope defines the current scope used to restore the JS context
  153. * @returns the new MultiObserver
  154. */
  155. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  156. }
  157. /**
  158. * The Observable class is a simple implementation of the Observable pattern.
  159. *
  160. * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
  161. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  162. * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
  163. * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
  164. */
  165. export class Observable<T> {
  166. private _observers;
  167. private _eventState;
  168. private _onObserverAdded;
  169. /**
  170. * Gets the list of observers
  171. */
  172. readonly observers: Array<Observer<T>>;
  173. /**
  174. * Creates a new observable
  175. * @param onObserverAdded defines a callback to call when a new observer is added
  176. */
  177. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  178. /**
  179. * Create a new Observer with the specified callback
  180. * @param callback the callback that will be executed for that Observer
  181. * @param mask the mask used to filter observers
  182. * @param insertFirst if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
  183. * @param scope optional scope for the callback to be called from
  184. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  185. * @returns the new observer created for the callback
  186. */
  187. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  188. /**
  189. * Create a new Observer with the specified callback and unregisters after the next notification
  190. * @param callback the callback that will be executed for that Observer
  191. * @returns the new observer created for the callback
  192. */
  193. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  194. /**
  195. * Remove an Observer from the Observable object
  196. * @param observer the instance of the Observer to remove
  197. * @returns false if it doesn't belong to this Observable
  198. */
  199. remove(observer: Nullable<Observer<T>>): boolean;
  200. /**
  201. * Remove a callback from the Observable object
  202. * @param callback the callback to remove
  203. * @param scope optional scope. If used only the callbacks with this scope will be removed
  204. * @returns false if it doesn't belong to this Observable
  205. */
  206. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  207. private _deferUnregister;
  208. private _remove;
  209. /**
  210. * Moves the observable to the top of the observer list making it get called first when notified
  211. * @param observer the observer to move
  212. */
  213. makeObserverTopPriority(observer: Observer<T>): void;
  214. /**
  215. * Moves the observable to the bottom of the observer list making it get called last when notified
  216. * @param observer the observer to move
  217. */
  218. makeObserverBottomPriority(observer: Observer<T>): void;
  219. /**
  220. * Notify all Observers by calling their respective callback with the given data
  221. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  222. * @param eventData defines the data to send to all observers
  223. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  224. * @param target defines the original target of the state
  225. * @param currentTarget defines the current target of the state
  226. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  227. */
  228. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  229. /**
  230. * Calling this will execute each callback, expecting it to be a promise or return a value.
  231. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  232. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  233. * and it is crucial that all callbacks will be executed.
  234. * The order of the callbacks is kept, callbacks are not executed parallel.
  235. *
  236. * @param eventData The data to be sent to each callback
  237. * @param mask is used to filter observers defaults to -1
  238. * @param target defines the callback target (see EventState)
  239. * @param currentTarget defines he current object in the bubbling phase
  240. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  241. */
  242. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  243. /**
  244. * Notify a specific observer
  245. * @param observer defines the observer to notify
  246. * @param eventData defines the data to be sent to each callback
  247. * @param mask is used to filter observers defaults to -1
  248. */
  249. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  250. /**
  251. * Gets a boolean indicating if the observable has at least one observer
  252. * @returns true is the Observable has at least one Observer registered
  253. */
  254. hasObservers(): boolean;
  255. /**
  256. * Clear the list of observers
  257. */
  258. clear(): void;
  259. /**
  260. * Clone the current observable
  261. * @returns a new observable
  262. */
  263. clone(): Observable<T>;
  264. /**
  265. * Does this observable handles observer registered with a given mask
  266. * @param mask defines the mask to be tested
  267. * @return whether or not one observer registered with the given mask is handeled
  268. **/
  269. hasSpecificMask(mask?: number): boolean;
  270. }
  271. }
  272. declare module "babylonjs/Misc/domManagement" {
  273. /**
  274. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  275. * Babylon.js
  276. */
  277. export class DomManagement {
  278. /**
  279. * Checks if the window object exists
  280. * @returns true if the window object exists
  281. */
  282. static IsWindowObjectExist(): boolean;
  283. /**
  284. * Checks if the navigator object exists
  285. * @returns true if the navigator object exists
  286. */
  287. static IsNavigatorAvailable(): boolean;
  288. /**
  289. * Extracts text content from a DOM element hierarchy
  290. * @param element defines the root element
  291. * @returns a string
  292. */
  293. static GetDOMTextContent(element: HTMLElement): string;
  294. }
  295. }
  296. declare module "babylonjs/Misc/logger" {
  297. /**
  298. * Logger used througouht the application to allow configuration of
  299. * the log level required for the messages.
  300. */
  301. export class Logger {
  302. /**
  303. * No log
  304. */
  305. static readonly NoneLogLevel: number;
  306. /**
  307. * Only message logs
  308. */
  309. static readonly MessageLogLevel: number;
  310. /**
  311. * Only warning logs
  312. */
  313. static readonly WarningLogLevel: number;
  314. /**
  315. * Only error logs
  316. */
  317. static readonly ErrorLogLevel: number;
  318. /**
  319. * All logs
  320. */
  321. static readonly AllLogLevel: number;
  322. private static _LogCache;
  323. /**
  324. * Gets a value indicating the number of loading errors
  325. * @ignorenaming
  326. */
  327. static errorsCount: number;
  328. /**
  329. * Callback called when a new log is added
  330. */
  331. static OnNewCacheEntry: (entry: string) => void;
  332. private static _AddLogEntry;
  333. private static _FormatMessage;
  334. private static _LogDisabled;
  335. private static _LogEnabled;
  336. private static _WarnDisabled;
  337. private static _WarnEnabled;
  338. private static _ErrorDisabled;
  339. private static _ErrorEnabled;
  340. /**
  341. * Log a message to the console
  342. */
  343. static Log: (message: string) => void;
  344. /**
  345. * Write a warning message to the console
  346. */
  347. static Warn: (message: string) => void;
  348. /**
  349. * Write an error message to the console
  350. */
  351. static Error: (message: string) => void;
  352. /**
  353. * Gets current log cache (list of logs)
  354. */
  355. static readonly LogCache: string;
  356. /**
  357. * Clears the log cache
  358. */
  359. static ClearLogCache(): void;
  360. /**
  361. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  362. */
  363. static LogLevels: number;
  364. }
  365. }
  366. declare module "babylonjs/Misc/typeStore" {
  367. /** @hidden */
  368. export class _TypeStore {
  369. /** @hidden */
  370. static RegisteredTypes: {
  371. [key: string]: Object;
  372. };
  373. /** @hidden */
  374. static GetClass(fqdn: string): any;
  375. }
  376. }
  377. declare module "babylonjs/Misc/stringTools" {
  378. /**
  379. * Helper to manipulate strings
  380. */
  381. export class StringTools {
  382. /**
  383. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  384. * @param str Source string
  385. * @param suffix Suffix to search for in the source string
  386. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  387. */
  388. static EndsWith(str: string, suffix: string): boolean;
  389. /**
  390. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  391. * @param str Source string
  392. * @param suffix Suffix to search for in the source string
  393. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  394. */
  395. static StartsWith(str: string, suffix: string): boolean;
  396. /**
  397. * Decodes a buffer into a string
  398. * @param buffer The buffer to decode
  399. * @returns The decoded string
  400. */
  401. static Decode(buffer: Uint8Array | Uint16Array): string;
  402. /**
  403. * Encode a buffer to a base64 string
  404. * @param buffer defines the buffer to encode
  405. * @returns the encoded string
  406. */
  407. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  408. }
  409. }
  410. declare module "babylonjs/Misc/deepCopier" {
  411. /**
  412. * Class containing a set of static utilities functions for deep copy.
  413. */
  414. export class DeepCopier {
  415. /**
  416. * Tries to copy an object by duplicating every property
  417. * @param source defines the source object
  418. * @param destination defines the target object
  419. * @param doNotCopyList defines a list of properties to avoid
  420. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  421. */
  422. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  423. }
  424. }
  425. declare module "babylonjs/Misc/precisionDate" {
  426. /**
  427. * Class containing a set of static utilities functions for precision date
  428. */
  429. export class PrecisionDate {
  430. /**
  431. * Gets either window.performance.now() if supported or Date.now() else
  432. */
  433. static readonly Now: number;
  434. }
  435. }
  436. declare module "babylonjs/Misc/devTools" {
  437. /** @hidden */
  438. export class _DevTools {
  439. static WarnImport(name: string): string;
  440. }
  441. }
  442. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  443. /**
  444. * Interface used to define the mechanism to get data from the network
  445. */
  446. export interface IWebRequest {
  447. /**
  448. * Returns client's response url
  449. */
  450. responseURL: string;
  451. /**
  452. * Returns client's status
  453. */
  454. status: number;
  455. /**
  456. * Returns client's status as a text
  457. */
  458. statusText: string;
  459. }
  460. }
  461. declare module "babylonjs/Misc/webRequest" {
  462. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  463. import { Nullable } from "babylonjs/types";
  464. /**
  465. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  466. */
  467. export class WebRequest implements IWebRequest {
  468. private _xhr;
  469. /**
  470. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  471. * i.e. when loading files, where the server/service expects an Authorization header
  472. */
  473. static CustomRequestHeaders: {
  474. [key: string]: string;
  475. };
  476. /**
  477. * Add callback functions in this array to update all the requests before they get sent to the network
  478. */
  479. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  480. private _injectCustomRequestHeaders;
  481. /**
  482. * Gets or sets a function to be called when loading progress changes
  483. */
  484. onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  485. /**
  486. * Returns client's state
  487. */
  488. readonly readyState: number;
  489. /**
  490. * Returns client's status
  491. */
  492. readonly status: number;
  493. /**
  494. * Returns client's status as a text
  495. */
  496. readonly statusText: string;
  497. /**
  498. * Returns client's response
  499. */
  500. readonly response: any;
  501. /**
  502. * Returns client's response url
  503. */
  504. readonly responseURL: string;
  505. /**
  506. * Returns client's response as text
  507. */
  508. readonly responseText: string;
  509. /**
  510. * Gets or sets the expected response type
  511. */
  512. responseType: XMLHttpRequestResponseType;
  513. /** @hidden */
  514. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  515. /** @hidden */
  516. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  517. /**
  518. * Cancels any network activity
  519. */
  520. abort(): void;
  521. /**
  522. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  523. * @param body defines an optional request body
  524. */
  525. send(body?: Document | BodyInit | null): void;
  526. /**
  527. * Sets the request method, request URL
  528. * @param method defines the method to use (GET, POST, etc..)
  529. * @param url defines the url to connect with
  530. */
  531. open(method: string, url: string): void;
  532. /**
  533. * Sets the value of a request header.
  534. * @param name The name of the header whose value is to be set
  535. * @param value The value to set as the body of the header
  536. */
  537. setRequestHeader(name: string, value: string): void;
  538. /**
  539. * Get the string containing the text of a particular header's value.
  540. * @param name The name of the header
  541. * @returns The string containing the text of the given header name
  542. */
  543. getResponseHeader(name: string): Nullable<string>;
  544. }
  545. }
  546. declare module "babylonjs/Misc/fileRequest" {
  547. import { Observable } from "babylonjs/Misc/observable";
  548. /**
  549. * File request interface
  550. */
  551. export interface IFileRequest {
  552. /**
  553. * Raised when the request is complete (success or error).
  554. */
  555. onCompleteObservable: Observable<IFileRequest>;
  556. /**
  557. * Aborts the request for a file.
  558. */
  559. abort: () => void;
  560. }
  561. }
  562. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  563. /**
  564. * Define options used to create a render target texture
  565. */
  566. export class RenderTargetCreationOptions {
  567. /**
  568. * Specifies is mipmaps must be generated
  569. */
  570. generateMipMaps?: boolean;
  571. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  572. generateDepthBuffer?: boolean;
  573. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  574. generateStencilBuffer?: boolean;
  575. /** Defines texture type (int by default) */
  576. type?: number;
  577. /** Defines sampling mode (trilinear by default) */
  578. samplingMode?: number;
  579. /** Defines format (RGBA by default) */
  580. format?: number;
  581. }
  582. }
  583. declare module "babylonjs/Instrumentation/timeToken" {
  584. import { Nullable } from "babylonjs/types";
  585. /**
  586. * @hidden
  587. **/
  588. export class _TimeToken {
  589. _startTimeQuery: Nullable<WebGLQuery>;
  590. _endTimeQuery: Nullable<WebGLQuery>;
  591. _timeElapsedQuery: Nullable<WebGLQuery>;
  592. _timeElapsedQueryEnded: boolean;
  593. }
  594. }
  595. declare module "babylonjs/Engines/constants" {
  596. /** Defines the cross module used constants to avoid circular dependncies */
  597. export class Constants {
  598. /** Defines that alpha blending is disabled */
  599. static readonly ALPHA_DISABLE: number;
  600. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  601. static readonly ALPHA_ADD: number;
  602. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  603. static readonly ALPHA_COMBINE: number;
  604. /** Defines that alpha blending to DEST - SRC * DEST */
  605. static readonly ALPHA_SUBTRACT: number;
  606. /** Defines that alpha blending to SRC * DEST */
  607. static readonly ALPHA_MULTIPLY: number;
  608. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  609. static readonly ALPHA_MAXIMIZED: number;
  610. /** Defines that alpha blending to SRC + DEST */
  611. static readonly ALPHA_ONEONE: number;
  612. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  613. static readonly ALPHA_PREMULTIPLIED: number;
  614. /**
  615. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  616. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  617. */
  618. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  619. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  620. static readonly ALPHA_INTERPOLATE: number;
  621. /**
  622. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  623. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  624. */
  625. static readonly ALPHA_SCREENMODE: number;
  626. /**
  627. * Defines that alpha blending to SRC + DST
  628. * Alpha will be set to SRC ALPHA + DST ALPHA
  629. */
  630. static readonly ALPHA_ONEONE_ONEONE: number;
  631. /**
  632. * Defines that alpha blending to SRC * DST ALPHA + DST
  633. * Alpha will be set to 0
  634. */
  635. static readonly ALPHA_ALPHATOCOLOR: number;
  636. /**
  637. * Defines that alpha blending to SRC * (1 - DST) + DST * (1 - SRC)
  638. */
  639. static readonly ALPHA_REVERSEONEMINUS: number;
  640. /**
  641. * Defines that alpha blending to SRC + DST * (1 - SRC ALPHA)
  642. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  643. */
  644. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  645. /**
  646. * Defines that alpha blending to SRC + DST
  647. * Alpha will be set to SRC ALPHA
  648. */
  649. static readonly ALPHA_ONEONE_ONEZERO: number;
  650. /** Defines that alpha blending equation a SUM */
  651. static readonly ALPHA_EQUATION_ADD: number;
  652. /** Defines that alpha blending equation a SUBSTRACTION */
  653. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  654. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  655. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  656. /** Defines that alpha blending equation a MAX operation */
  657. static readonly ALPHA_EQUATION_MAX: number;
  658. /** Defines that alpha blending equation a MIN operation */
  659. static readonly ALPHA_EQUATION_MIN: number;
  660. /**
  661. * Defines that alpha blending equation a DARKEN operation:
  662. * It takes the min of the src and sums the alpha channels.
  663. */
  664. static readonly ALPHA_EQUATION_DARKEN: number;
  665. /** Defines that the ressource is not delayed*/
  666. static readonly DELAYLOADSTATE_NONE: number;
  667. /** Defines that the ressource was successfully delay loaded */
  668. static readonly DELAYLOADSTATE_LOADED: number;
  669. /** Defines that the ressource is currently delay loading */
  670. static readonly DELAYLOADSTATE_LOADING: number;
  671. /** Defines that the ressource is delayed and has not started loading */
  672. static readonly DELAYLOADSTATE_NOTLOADED: number;
  673. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  674. static readonly NEVER: number;
  675. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  676. static readonly ALWAYS: number;
  677. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  678. static readonly LESS: number;
  679. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  680. static readonly EQUAL: number;
  681. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  682. static readonly LEQUAL: number;
  683. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  684. static readonly GREATER: number;
  685. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  686. static readonly GEQUAL: number;
  687. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  688. static readonly NOTEQUAL: number;
  689. /** Passed to stencilOperation to specify that stencil value must be kept */
  690. static readonly KEEP: number;
  691. /** Passed to stencilOperation to specify that stencil value must be replaced */
  692. static readonly REPLACE: number;
  693. /** Passed to stencilOperation to specify that stencil value must be incremented */
  694. static readonly INCR: number;
  695. /** Passed to stencilOperation to specify that stencil value must be decremented */
  696. static readonly DECR: number;
  697. /** Passed to stencilOperation to specify that stencil value must be inverted */
  698. static readonly INVERT: number;
  699. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  700. static readonly INCR_WRAP: number;
  701. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  702. static readonly DECR_WRAP: number;
  703. /** Texture is not repeating outside of 0..1 UVs */
  704. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  705. /** Texture is repeating outside of 0..1 UVs */
  706. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  707. /** Texture is repeating and mirrored */
  708. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  709. /** ALPHA */
  710. static readonly TEXTUREFORMAT_ALPHA: number;
  711. /** LUMINANCE */
  712. static readonly TEXTUREFORMAT_LUMINANCE: number;
  713. /** LUMINANCE_ALPHA */
  714. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  715. /** RGB */
  716. static readonly TEXTUREFORMAT_RGB: number;
  717. /** RGBA */
  718. static readonly TEXTUREFORMAT_RGBA: number;
  719. /** RED */
  720. static readonly TEXTUREFORMAT_RED: number;
  721. /** RED (2nd reference) */
  722. static readonly TEXTUREFORMAT_R: number;
  723. /** RG */
  724. static readonly TEXTUREFORMAT_RG: number;
  725. /** RED_INTEGER */
  726. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  727. /** RED_INTEGER (2nd reference) */
  728. static readonly TEXTUREFORMAT_R_INTEGER: number;
  729. /** RG_INTEGER */
  730. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  731. /** RGB_INTEGER */
  732. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  733. /** RGBA_INTEGER */
  734. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  735. /** UNSIGNED_BYTE */
  736. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  737. /** UNSIGNED_BYTE (2nd reference) */
  738. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  739. /** FLOAT */
  740. static readonly TEXTURETYPE_FLOAT: number;
  741. /** HALF_FLOAT */
  742. static readonly TEXTURETYPE_HALF_FLOAT: number;
  743. /** BYTE */
  744. static readonly TEXTURETYPE_BYTE: number;
  745. /** SHORT */
  746. static readonly TEXTURETYPE_SHORT: number;
  747. /** UNSIGNED_SHORT */
  748. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  749. /** INT */
  750. static readonly TEXTURETYPE_INT: number;
  751. /** UNSIGNED_INT */
  752. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  753. /** UNSIGNED_SHORT_4_4_4_4 */
  754. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  755. /** UNSIGNED_SHORT_5_5_5_1 */
  756. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  757. /** UNSIGNED_SHORT_5_6_5 */
  758. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  759. /** UNSIGNED_INT_2_10_10_10_REV */
  760. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  761. /** UNSIGNED_INT_24_8 */
  762. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  763. /** UNSIGNED_INT_10F_11F_11F_REV */
  764. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  765. /** UNSIGNED_INT_5_9_9_9_REV */
  766. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  767. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  768. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  769. /** nearest is mag = nearest and min = nearest and mip = linear */
  770. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  771. /** Bilinear is mag = linear and min = linear and mip = nearest */
  772. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  773. /** Trilinear is mag = linear and min = linear and mip = linear */
  774. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  775. /** nearest is mag = nearest and min = nearest and mip = linear */
  776. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  777. /** Bilinear is mag = linear and min = linear and mip = nearest */
  778. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  779. /** Trilinear is mag = linear and min = linear and mip = linear */
  780. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  781. /** mag = nearest and min = nearest and mip = nearest */
  782. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  783. /** mag = nearest and min = linear and mip = nearest */
  784. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  785. /** mag = nearest and min = linear and mip = linear */
  786. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  787. /** mag = nearest and min = linear and mip = none */
  788. static readonly TEXTURE_NEAREST_LINEAR: number;
  789. /** mag = nearest and min = nearest and mip = none */
  790. static readonly TEXTURE_NEAREST_NEAREST: number;
  791. /** mag = linear and min = nearest and mip = nearest */
  792. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  793. /** mag = linear and min = nearest and mip = linear */
  794. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  795. /** mag = linear and min = linear and mip = none */
  796. static readonly TEXTURE_LINEAR_LINEAR: number;
  797. /** mag = linear and min = nearest and mip = none */
  798. static readonly TEXTURE_LINEAR_NEAREST: number;
  799. /** Explicit coordinates mode */
  800. static readonly TEXTURE_EXPLICIT_MODE: number;
  801. /** Spherical coordinates mode */
  802. static readonly TEXTURE_SPHERICAL_MODE: number;
  803. /** Planar coordinates mode */
  804. static readonly TEXTURE_PLANAR_MODE: number;
  805. /** Cubic coordinates mode */
  806. static readonly TEXTURE_CUBIC_MODE: number;
  807. /** Projection coordinates mode */
  808. static readonly TEXTURE_PROJECTION_MODE: number;
  809. /** Skybox coordinates mode */
  810. static readonly TEXTURE_SKYBOX_MODE: number;
  811. /** Inverse Cubic coordinates mode */
  812. static readonly TEXTURE_INVCUBIC_MODE: number;
  813. /** Equirectangular coordinates mode */
  814. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  815. /** Equirectangular Fixed coordinates mode */
  816. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  817. /** Equirectangular Fixed Mirrored coordinates mode */
  818. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  819. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  820. static readonly SCALEMODE_FLOOR: number;
  821. /** Defines that texture rescaling will look for the nearest power of 2 size */
  822. static readonly SCALEMODE_NEAREST: number;
  823. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  824. static readonly SCALEMODE_CEILING: number;
  825. /**
  826. * The dirty texture flag value
  827. */
  828. static readonly MATERIAL_TextureDirtyFlag: number;
  829. /**
  830. * The dirty light flag value
  831. */
  832. static readonly MATERIAL_LightDirtyFlag: number;
  833. /**
  834. * The dirty fresnel flag value
  835. */
  836. static readonly MATERIAL_FresnelDirtyFlag: number;
  837. /**
  838. * The dirty attribute flag value
  839. */
  840. static readonly MATERIAL_AttributesDirtyFlag: number;
  841. /**
  842. * The dirty misc flag value
  843. */
  844. static readonly MATERIAL_MiscDirtyFlag: number;
  845. /**
  846. * The all dirty flag value
  847. */
  848. static readonly MATERIAL_AllDirtyFlag: number;
  849. /**
  850. * Returns the triangle fill mode
  851. */
  852. static readonly MATERIAL_TriangleFillMode: number;
  853. /**
  854. * Returns the wireframe mode
  855. */
  856. static readonly MATERIAL_WireFrameFillMode: number;
  857. /**
  858. * Returns the point fill mode
  859. */
  860. static readonly MATERIAL_PointFillMode: number;
  861. /**
  862. * Returns the point list draw mode
  863. */
  864. static readonly MATERIAL_PointListDrawMode: number;
  865. /**
  866. * Returns the line list draw mode
  867. */
  868. static readonly MATERIAL_LineListDrawMode: number;
  869. /**
  870. * Returns the line loop draw mode
  871. */
  872. static readonly MATERIAL_LineLoopDrawMode: number;
  873. /**
  874. * Returns the line strip draw mode
  875. */
  876. static readonly MATERIAL_LineStripDrawMode: number;
  877. /**
  878. * Returns the triangle strip draw mode
  879. */
  880. static readonly MATERIAL_TriangleStripDrawMode: number;
  881. /**
  882. * Returns the triangle fan draw mode
  883. */
  884. static readonly MATERIAL_TriangleFanDrawMode: number;
  885. /**
  886. * Stores the clock-wise side orientation
  887. */
  888. static readonly MATERIAL_ClockWiseSideOrientation: number;
  889. /**
  890. * Stores the counter clock-wise side orientation
  891. */
  892. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  893. /**
  894. * Nothing
  895. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  896. */
  897. static readonly ACTION_NothingTrigger: number;
  898. /**
  899. * On pick
  900. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  901. */
  902. static readonly ACTION_OnPickTrigger: number;
  903. /**
  904. * On left pick
  905. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  906. */
  907. static readonly ACTION_OnLeftPickTrigger: number;
  908. /**
  909. * On right pick
  910. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  911. */
  912. static readonly ACTION_OnRightPickTrigger: number;
  913. /**
  914. * On center pick
  915. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  916. */
  917. static readonly ACTION_OnCenterPickTrigger: number;
  918. /**
  919. * On pick down
  920. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_OnPickDownTrigger: number;
  923. /**
  924. * On double pick
  925. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnDoublePickTrigger: number;
  928. /**
  929. * On pick up
  930. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnPickUpTrigger: number;
  933. /**
  934. * On pick out.
  935. * This trigger will only be raised if you also declared a OnPickDown
  936. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  937. */
  938. static readonly ACTION_OnPickOutTrigger: number;
  939. /**
  940. * On long press
  941. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  942. */
  943. static readonly ACTION_OnLongPressTrigger: number;
  944. /**
  945. * On pointer over
  946. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  947. */
  948. static readonly ACTION_OnPointerOverTrigger: number;
  949. /**
  950. * On pointer out
  951. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPointerOutTrigger: number;
  954. /**
  955. * On every frame
  956. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  957. */
  958. static readonly ACTION_OnEveryFrameTrigger: number;
  959. /**
  960. * On intersection enter
  961. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnIntersectionEnterTrigger: number;
  964. /**
  965. * On intersection exit
  966. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnIntersectionExitTrigger: number;
  969. /**
  970. * On key down
  971. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnKeyDownTrigger: number;
  974. /**
  975. * On key up
  976. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnKeyUpTrigger: number;
  979. /**
  980. * Billboard mode will only apply to Y axis
  981. */
  982. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  983. /**
  984. * Billboard mode will apply to all axes
  985. */
  986. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  987. /**
  988. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  989. */
  990. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  991. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  992. * Test order :
  993. * Is the bounding sphere outside the frustum ?
  994. * If not, are the bounding box vertices outside the frustum ?
  995. * It not, then the cullable object is in the frustum.
  996. */
  997. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  998. /** Culling strategy : Bounding Sphere Only.
  999. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1000. * It's also less accurate than the standard because some not visible objects can still be selected.
  1001. * Test : is the bounding sphere outside the frustum ?
  1002. * If not, then the cullable object is in the frustum.
  1003. */
  1004. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1005. /** Culling strategy : Optimistic Inclusion.
  1006. * This in an inclusion test first, then the standard exclusion test.
  1007. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1008. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  1009. * Anyway, it's as accurate as the standard strategy.
  1010. * Test :
  1011. * Is the cullable object bounding sphere center in the frustum ?
  1012. * If not, apply the default culling strategy.
  1013. */
  1014. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1015. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1016. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1017. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1018. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  1019. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1020. * Test :
  1021. * Is the cullable object bounding sphere center in the frustum ?
  1022. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1023. */
  1024. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1025. /**
  1026. * No logging while loading
  1027. */
  1028. static readonly SCENELOADER_NO_LOGGING: number;
  1029. /**
  1030. * Minimal logging while loading
  1031. */
  1032. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1033. /**
  1034. * Summary logging while loading
  1035. */
  1036. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1037. /**
  1038. * Detailled logging while loading
  1039. */
  1040. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1041. }
  1042. }
  1043. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1044. import { Nullable } from "babylonjs/types";
  1045. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1046. /**
  1047. * This represents the required contract to create a new type of texture loader.
  1048. */
  1049. export interface IInternalTextureLoader {
  1050. /**
  1051. * Defines wether the loader supports cascade loading the different faces.
  1052. */
  1053. supportCascades: boolean;
  1054. /**
  1055. * This returns if the loader support the current file information.
  1056. * @param extension defines the file extension of the file being loaded
  1057. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1058. * @param fallback defines the fallback internal texture if any
  1059. * @param isBase64 defines whether the texture is encoded as a base64
  1060. * @param isBuffer defines whether the texture data are stored as a buffer
  1061. * @returns true if the loader can load the specified file
  1062. */
  1063. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  1064. /**
  1065. * Transform the url before loading if required.
  1066. * @param rootUrl the url of the texture
  1067. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1068. * @returns the transformed texture
  1069. */
  1070. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  1071. /**
  1072. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  1073. * @param rootUrl the url of the texture
  1074. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1075. * @returns the fallback texture
  1076. */
  1077. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  1078. /**
  1079. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  1080. * @param data contains the texture data
  1081. * @param texture defines the BabylonJS internal texture
  1082. * @param createPolynomials will be true if polynomials have been requested
  1083. * @param onLoad defines the callback to trigger once the texture is ready
  1084. * @param onError defines the callback to trigger in case of error
  1085. */
  1086. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1087. /**
  1088. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  1089. * @param data contains the texture data
  1090. * @param texture defines the BabylonJS internal texture
  1091. * @param callback defines the method to call once ready to upload
  1092. */
  1093. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1094. }
  1095. }
  1096. declare module "babylonjs/Engines/IPipelineContext" {
  1097. /**
  1098. * Class used to store and describe the pipeline context associated with an effect
  1099. */
  1100. export interface IPipelineContext {
  1101. /**
  1102. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1103. */
  1104. isAsync: boolean;
  1105. /**
  1106. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1107. */
  1108. isReady: boolean;
  1109. /** @hidden */
  1110. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1111. }
  1112. }
  1113. declare module "babylonjs/Meshes/dataBuffer" {
  1114. /**
  1115. * Class used to store gfx data (like WebGLBuffer)
  1116. */
  1117. export class DataBuffer {
  1118. /**
  1119. * Gets or sets the number of objects referencing this buffer
  1120. */
  1121. references: number;
  1122. /** Gets or sets the size of the underlying buffer */
  1123. capacity: number;
  1124. /**
  1125. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1126. */
  1127. is32Bits: boolean;
  1128. /**
  1129. * Gets the underlying buffer
  1130. */
  1131. readonly underlyingResource: any;
  1132. }
  1133. }
  1134. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1135. /** @hidden */
  1136. export interface IShaderProcessor {
  1137. attributeProcessor?: (attribute: string) => string;
  1138. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1139. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1140. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1141. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1142. lineProcessor?: (line: string, isFragment: boolean) => string;
  1143. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1144. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1145. }
  1146. }
  1147. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1148. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1149. /** @hidden */
  1150. export interface ProcessingOptions {
  1151. defines: string[];
  1152. indexParameters: any;
  1153. isFragment: boolean;
  1154. shouldUseHighPrecisionShader: boolean;
  1155. supportsUniformBuffers: boolean;
  1156. shadersRepository: string;
  1157. includesShadersStore: {
  1158. [key: string]: string;
  1159. };
  1160. processor?: IShaderProcessor;
  1161. version: string;
  1162. platformName: string;
  1163. lookForClosingBracketForUniformBuffer?: boolean;
  1164. }
  1165. }
  1166. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1167. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1168. /** @hidden */
  1169. export class ShaderCodeNode {
  1170. line: string;
  1171. children: ShaderCodeNode[];
  1172. additionalDefineKey?: string;
  1173. additionalDefineValue?: string;
  1174. isValid(preprocessors: {
  1175. [key: string]: string;
  1176. }): boolean;
  1177. process(preprocessors: {
  1178. [key: string]: string;
  1179. }, options: ProcessingOptions): string;
  1180. }
  1181. }
  1182. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1183. /** @hidden */
  1184. export class ShaderCodeCursor {
  1185. private _lines;
  1186. lineIndex: number;
  1187. readonly currentLine: string;
  1188. readonly canRead: boolean;
  1189. lines: string[];
  1190. }
  1191. }
  1192. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1193. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1194. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1195. /** @hidden */
  1196. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1197. process(preprocessors: {
  1198. [key: string]: string;
  1199. }, options: ProcessingOptions): string;
  1200. }
  1201. }
  1202. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1203. /** @hidden */
  1204. export class ShaderDefineExpression {
  1205. isTrue(preprocessors: {
  1206. [key: string]: string;
  1207. }): boolean;
  1208. }
  1209. }
  1210. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1211. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1212. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1213. /** @hidden */
  1214. export class ShaderCodeTestNode extends ShaderCodeNode {
  1215. testExpression: ShaderDefineExpression;
  1216. isValid(preprocessors: {
  1217. [key: string]: string;
  1218. }): boolean;
  1219. }
  1220. }
  1221. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1222. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1223. /** @hidden */
  1224. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1225. define: string;
  1226. not: boolean;
  1227. constructor(define: string, not?: boolean);
  1228. isTrue(preprocessors: {
  1229. [key: string]: string;
  1230. }): boolean;
  1231. }
  1232. }
  1233. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1234. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1235. /** @hidden */
  1236. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1237. leftOperand: ShaderDefineExpression;
  1238. rightOperand: ShaderDefineExpression;
  1239. isTrue(preprocessors: {
  1240. [key: string]: string;
  1241. }): boolean;
  1242. }
  1243. }
  1244. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1245. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1246. /** @hidden */
  1247. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1248. leftOperand: ShaderDefineExpression;
  1249. rightOperand: ShaderDefineExpression;
  1250. isTrue(preprocessors: {
  1251. [key: string]: string;
  1252. }): boolean;
  1253. }
  1254. }
  1255. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1256. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1257. /** @hidden */
  1258. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1259. define: string;
  1260. operand: string;
  1261. testValue: string;
  1262. constructor(define: string, operand: string, testValue: string);
  1263. isTrue(preprocessors: {
  1264. [key: string]: string;
  1265. }): boolean;
  1266. }
  1267. }
  1268. declare module "babylonjs/Offline/IOfflineProvider" {
  1269. /**
  1270. * Class used to enable access to offline support
  1271. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1272. */
  1273. export interface IOfflineProvider {
  1274. /**
  1275. * Gets a boolean indicating if scene must be saved in the database
  1276. */
  1277. enableSceneOffline: boolean;
  1278. /**
  1279. * Gets a boolean indicating if textures must be saved in the database
  1280. */
  1281. enableTexturesOffline: boolean;
  1282. /**
  1283. * Open the offline support and make it available
  1284. * @param successCallback defines the callback to call on success
  1285. * @param errorCallback defines the callback to call on error
  1286. */
  1287. open(successCallback: () => void, errorCallback: () => void): void;
  1288. /**
  1289. * Loads an image from the offline support
  1290. * @param url defines the url to load from
  1291. * @param image defines the target DOM image
  1292. */
  1293. loadImage(url: string, image: HTMLImageElement): void;
  1294. /**
  1295. * Loads a file from offline support
  1296. * @param url defines the URL to load from
  1297. * @param sceneLoaded defines a callback to call on success
  1298. * @param progressCallBack defines a callback to call when progress changed
  1299. * @param errorCallback defines a callback to call on error
  1300. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1301. */
  1302. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1303. }
  1304. }
  1305. declare module "babylonjs/Misc/filesInputStore" {
  1306. /**
  1307. * Class used to help managing file picking and drag'n'drop
  1308. * File Storage
  1309. */
  1310. export class FilesInputStore {
  1311. /**
  1312. * List of files ready to be loaded
  1313. */
  1314. static FilesToLoad: {
  1315. [key: string]: File;
  1316. };
  1317. }
  1318. }
  1319. declare module "babylonjs/Misc/retryStrategy" {
  1320. import { WebRequest } from "babylonjs/Misc/webRequest";
  1321. /**
  1322. * Class used to define a retry strategy when error happens while loading assets
  1323. */
  1324. export class RetryStrategy {
  1325. /**
  1326. * Function used to defines an exponential back off strategy
  1327. * @param maxRetries defines the maximum number of retries (3 by default)
  1328. * @param baseInterval defines the interval between retries
  1329. * @returns the strategy function to use
  1330. */
  1331. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1332. }
  1333. }
  1334. declare module "babylonjs/Misc/baseError" {
  1335. /**
  1336. * @ignore
  1337. * Application error to support additional information when loading a file
  1338. */
  1339. export abstract class BaseError extends Error {
  1340. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1341. }
  1342. }
  1343. declare module "babylonjs/Misc/fileTools" {
  1344. import { WebRequest } from "babylonjs/Misc/webRequest";
  1345. import { Nullable } from "babylonjs/types";
  1346. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1347. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1348. import { BaseError } from "babylonjs/Misc/baseError";
  1349. /** @ignore */
  1350. export class LoadFileError extends BaseError {
  1351. request?: WebRequest;
  1352. file?: File;
  1353. /**
  1354. * Creates a new LoadFileError
  1355. * @param message defines the message of the error
  1356. * @param request defines the optional web request
  1357. * @param file defines the optional file
  1358. */
  1359. constructor(message: string, object?: WebRequest | File);
  1360. }
  1361. /** @ignore */
  1362. export class RequestFileError extends BaseError {
  1363. request: WebRequest;
  1364. /**
  1365. * Creates a new LoadFileError
  1366. * @param message defines the message of the error
  1367. * @param request defines the optional web request
  1368. */
  1369. constructor(message: string, request: WebRequest);
  1370. }
  1371. /** @ignore */
  1372. export class ReadFileError extends BaseError {
  1373. file: File;
  1374. /**
  1375. * Creates a new ReadFileError
  1376. * @param message defines the message of the error
  1377. * @param file defines the optional file
  1378. */
  1379. constructor(message: string, file: File);
  1380. }
  1381. /**
  1382. * @hidden
  1383. */
  1384. export class FileTools {
  1385. /**
  1386. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1387. */
  1388. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1389. /**
  1390. * Gets or sets the base URL to use to load assets
  1391. */
  1392. static BaseUrl: string;
  1393. /**
  1394. * Default behaviour for cors in the application.
  1395. * It can be a string if the expected behavior is identical in the entire app.
  1396. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1397. */
  1398. static CorsBehavior: string | ((url: string | string[]) => string);
  1399. /**
  1400. * Gets or sets a function used to pre-process url before using them to load assets
  1401. */
  1402. static PreprocessUrl: (url: string) => string;
  1403. /**
  1404. * Removes unwanted characters from an url
  1405. * @param url defines the url to clean
  1406. * @returns the cleaned url
  1407. */
  1408. private static _CleanUrl;
  1409. /**
  1410. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1411. * @param url define the url we are trying
  1412. * @param element define the dom element where to configure the cors policy
  1413. */
  1414. static SetCorsBehavior(url: string | string[], element: {
  1415. crossOrigin: string | null;
  1416. }): void;
  1417. /**
  1418. * Loads an image as an HTMLImageElement.
  1419. * @param input url string, ArrayBuffer, or Blob to load
  1420. * @param onLoad callback called when the image successfully loads
  1421. * @param onError callback called when the image fails to load
  1422. * @param offlineProvider offline provider for caching
  1423. * @param mimeType optional mime type
  1424. * @returns the HTMLImageElement of the loaded image
  1425. */
  1426. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  1427. /**
  1428. * Reads a file from a File object
  1429. * @param file defines the file to load
  1430. * @param onSuccess defines the callback to call when data is loaded
  1431. * @param onProgress defines the callback to call during loading process
  1432. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1433. * @param onError defines the callback to call when an error occurs
  1434. * @returns a file request object
  1435. */
  1436. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1437. /**
  1438. * Loads a file from a url
  1439. * @param url url to load
  1440. * @param onSuccess callback called when the file successfully loads
  1441. * @param onProgress callback called while file is loading (if the server supports this mode)
  1442. * @param offlineProvider defines the offline provider for caching
  1443. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1444. * @param onError callback called when the file fails to load
  1445. * @returns a file request object
  1446. */
  1447. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1448. /**
  1449. * Loads a file
  1450. * @param url url to load
  1451. * @param onSuccess callback called when the file successfully loads
  1452. * @param onProgress callback called while file is loading (if the server supports this mode)
  1453. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1454. * @param onError callback called when the file fails to load
  1455. * @param onOpened callback called when the web request is opened
  1456. * @returns a file request object
  1457. */
  1458. static RequestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (event: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  1459. /**
  1460. * Checks if the loaded document was accessed via `file:`-Protocol.
  1461. * @returns boolean
  1462. */
  1463. static IsFileURL(): boolean;
  1464. }
  1465. }
  1466. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1467. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1468. /** @hidden */
  1469. export class ShaderProcessor {
  1470. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1471. private static _ProcessPrecision;
  1472. private static _ExtractOperation;
  1473. private static _BuildSubExpression;
  1474. private static _BuildExpression;
  1475. private static _MoveCursorWithinIf;
  1476. private static _MoveCursor;
  1477. private static _EvaluatePreProcessors;
  1478. private static _PreparePreProcessors;
  1479. private static _ProcessShaderConversion;
  1480. private static _ProcessIncludes;
  1481. }
  1482. }
  1483. declare module "babylonjs/Maths/math.like" {
  1484. import { float, int, DeepImmutable } from "babylonjs/types";
  1485. /**
  1486. * @hidden
  1487. */
  1488. export interface IColor4Like {
  1489. r: float;
  1490. g: float;
  1491. b: float;
  1492. a: float;
  1493. }
  1494. /**
  1495. * @hidden
  1496. */
  1497. export interface IColor3Like {
  1498. r: float;
  1499. g: float;
  1500. b: float;
  1501. }
  1502. /**
  1503. * @hidden
  1504. */
  1505. export interface IVector4Like {
  1506. x: float;
  1507. y: float;
  1508. z: float;
  1509. w: float;
  1510. }
  1511. /**
  1512. * @hidden
  1513. */
  1514. export interface IVector3Like {
  1515. x: float;
  1516. y: float;
  1517. z: float;
  1518. }
  1519. /**
  1520. * @hidden
  1521. */
  1522. export interface IVector2Like {
  1523. x: float;
  1524. y: float;
  1525. }
  1526. /**
  1527. * @hidden
  1528. */
  1529. export interface IMatrixLike {
  1530. toArray(): DeepImmutable<Float32Array>;
  1531. updateFlag: int;
  1532. }
  1533. /**
  1534. * @hidden
  1535. */
  1536. export interface IViewportLike {
  1537. x: float;
  1538. y: float;
  1539. width: float;
  1540. height: float;
  1541. }
  1542. /**
  1543. * @hidden
  1544. */
  1545. export interface IPlaneLike {
  1546. normal: IVector3Like;
  1547. d: float;
  1548. normalize(): void;
  1549. }
  1550. }
  1551. declare module "babylonjs/Materials/iEffectFallbacks" {
  1552. import { Effect } from "babylonjs/Materials/effect";
  1553. /**
  1554. * Interface used to define common properties for effect fallbacks
  1555. */
  1556. export interface IEffectFallbacks {
  1557. /**
  1558. * Removes the defines that should be removed when falling back.
  1559. * @param currentDefines defines the current define statements for the shader.
  1560. * @param effect defines the current effect we try to compile
  1561. * @returns The resulting defines with defines of the current rank removed.
  1562. */
  1563. reduce(currentDefines: string, effect: Effect): string;
  1564. /**
  1565. * Removes the fallback from the bound mesh.
  1566. */
  1567. unBindMesh(): void;
  1568. /**
  1569. * Checks to see if more fallbacks are still availible.
  1570. */
  1571. hasMoreFallbacks: boolean;
  1572. }
  1573. }
  1574. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1575. /**
  1576. * Class used to evalaute queries containing `and` and `or` operators
  1577. */
  1578. export class AndOrNotEvaluator {
  1579. /**
  1580. * Evaluate a query
  1581. * @param query defines the query to evaluate
  1582. * @param evaluateCallback defines the callback used to filter result
  1583. * @returns true if the query matches
  1584. */
  1585. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1586. private static _HandleParenthesisContent;
  1587. private static _SimplifyNegation;
  1588. }
  1589. }
  1590. declare module "babylonjs/Misc/tags" {
  1591. /**
  1592. * Class used to store custom tags
  1593. */
  1594. export class Tags {
  1595. /**
  1596. * Adds support for tags on the given object
  1597. * @param obj defines the object to use
  1598. */
  1599. static EnableFor(obj: any): void;
  1600. /**
  1601. * Removes tags support
  1602. * @param obj defines the object to use
  1603. */
  1604. static DisableFor(obj: any): void;
  1605. /**
  1606. * Gets a boolean indicating if the given object has tags
  1607. * @param obj defines the object to use
  1608. * @returns a boolean
  1609. */
  1610. static HasTags(obj: any): boolean;
  1611. /**
  1612. * Gets the tags available on a given object
  1613. * @param obj defines the object to use
  1614. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1615. * @returns the tags
  1616. */
  1617. static GetTags(obj: any, asString?: boolean): any;
  1618. /**
  1619. * Adds tags to an object
  1620. * @param obj defines the object to use
  1621. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1622. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1623. */
  1624. static AddTagsTo(obj: any, tagsString: string): void;
  1625. /**
  1626. * @hidden
  1627. */
  1628. static _AddTagTo(obj: any, tag: string): void;
  1629. /**
  1630. * Removes specific tags from a specific object
  1631. * @param obj defines the object to use
  1632. * @param tagsString defines the tags to remove
  1633. */
  1634. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1635. /**
  1636. * @hidden
  1637. */
  1638. static _RemoveTagFrom(obj: any, tag: string): void;
  1639. /**
  1640. * Defines if tags hosted on an object match a given query
  1641. * @param obj defines the object to use
  1642. * @param tagsQuery defines the tag query
  1643. * @returns a boolean
  1644. */
  1645. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1646. }
  1647. }
  1648. declare module "babylonjs/Maths/math.scalar" {
  1649. /**
  1650. * Scalar computation library
  1651. */
  1652. export class Scalar {
  1653. /**
  1654. * Two pi constants convenient for computation.
  1655. */
  1656. static TwoPi: number;
  1657. /**
  1658. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1659. * @param a number
  1660. * @param b number
  1661. * @param epsilon (default = 1.401298E-45)
  1662. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1663. */
  1664. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1665. /**
  1666. * Returns a string : the upper case translation of the number i to hexadecimal.
  1667. * @param i number
  1668. * @returns the upper case translation of the number i to hexadecimal.
  1669. */
  1670. static ToHex(i: number): string;
  1671. /**
  1672. * Returns -1 if value is negative and +1 is value is positive.
  1673. * @param value the value
  1674. * @returns the value itself if it's equal to zero.
  1675. */
  1676. static Sign(value: number): number;
  1677. /**
  1678. * Returns the value itself if it's between min and max.
  1679. * Returns min if the value is lower than min.
  1680. * Returns max if the value is greater than max.
  1681. * @param value the value to clmap
  1682. * @param min the min value to clamp to (default: 0)
  1683. * @param max the max value to clamp to (default: 1)
  1684. * @returns the clamped value
  1685. */
  1686. static Clamp(value: number, min?: number, max?: number): number;
  1687. /**
  1688. * the log2 of value.
  1689. * @param value the value to compute log2 of
  1690. * @returns the log2 of value.
  1691. */
  1692. static Log2(value: number): number;
  1693. /**
  1694. * Loops the value, so that it is never larger than length and never smaller than 0.
  1695. *
  1696. * This is similar to the modulo operator but it works with floating point numbers.
  1697. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1698. * With t = 5 and length = 2.5, the result would be 0.0.
  1699. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1700. * @param value the value
  1701. * @param length the length
  1702. * @returns the looped value
  1703. */
  1704. static Repeat(value: number, length: number): number;
  1705. /**
  1706. * Normalize the value between 0.0 and 1.0 using min and max values
  1707. * @param value value to normalize
  1708. * @param min max to normalize between
  1709. * @param max min to normalize between
  1710. * @returns the normalized value
  1711. */
  1712. static Normalize(value: number, min: number, max: number): number;
  1713. /**
  1714. * Denormalize the value from 0.0 and 1.0 using min and max values
  1715. * @param normalized value to denormalize
  1716. * @param min max to denormalize between
  1717. * @param max min to denormalize between
  1718. * @returns the denormalized value
  1719. */
  1720. static Denormalize(normalized: number, min: number, max: number): number;
  1721. /**
  1722. * Calculates the shortest difference between two given angles given in degrees.
  1723. * @param current current angle in degrees
  1724. * @param target target angle in degrees
  1725. * @returns the delta
  1726. */
  1727. static DeltaAngle(current: number, target: number): number;
  1728. /**
  1729. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1730. * @param tx value
  1731. * @param length length
  1732. * @returns The returned value will move back and forth between 0 and length
  1733. */
  1734. static PingPong(tx: number, length: number): number;
  1735. /**
  1736. * Interpolates between min and max with smoothing at the limits.
  1737. *
  1738. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1739. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1740. * @param from from
  1741. * @param to to
  1742. * @param tx value
  1743. * @returns the smooth stepped value
  1744. */
  1745. static SmoothStep(from: number, to: number, tx: number): number;
  1746. /**
  1747. * Moves a value current towards target.
  1748. *
  1749. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1750. * Negative values of maxDelta pushes the value away from target.
  1751. * @param current current value
  1752. * @param target target value
  1753. * @param maxDelta max distance to move
  1754. * @returns resulting value
  1755. */
  1756. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1757. /**
  1758. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1759. *
  1760. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1761. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1762. * @param current current value
  1763. * @param target target value
  1764. * @param maxDelta max distance to move
  1765. * @returns resulting angle
  1766. */
  1767. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1768. /**
  1769. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1770. * @param start start value
  1771. * @param end target value
  1772. * @param amount amount to lerp between
  1773. * @returns the lerped value
  1774. */
  1775. static Lerp(start: number, end: number, amount: number): number;
  1776. /**
  1777. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1778. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1779. * @param start start value
  1780. * @param end target value
  1781. * @param amount amount to lerp between
  1782. * @returns the lerped value
  1783. */
  1784. static LerpAngle(start: number, end: number, amount: number): number;
  1785. /**
  1786. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1787. * @param a start value
  1788. * @param b target value
  1789. * @param value value between a and b
  1790. * @returns the inverseLerp value
  1791. */
  1792. static InverseLerp(a: number, b: number, value: number): number;
  1793. /**
  1794. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1795. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1796. * @param value1 spline value
  1797. * @param tangent1 spline value
  1798. * @param value2 spline value
  1799. * @param tangent2 spline value
  1800. * @param amount input value
  1801. * @returns hermite result
  1802. */
  1803. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1804. /**
  1805. * Returns a random float number between and min and max values
  1806. * @param min min value of random
  1807. * @param max max value of random
  1808. * @returns random value
  1809. */
  1810. static RandomRange(min: number, max: number): number;
  1811. /**
  1812. * This function returns percentage of a number in a given range.
  1813. *
  1814. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1815. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1816. * @param number to convert to percentage
  1817. * @param min min range
  1818. * @param max max range
  1819. * @returns the percentage
  1820. */
  1821. static RangeToPercent(number: number, min: number, max: number): number;
  1822. /**
  1823. * This function returns number that corresponds to the percentage in a given range.
  1824. *
  1825. * PercentToRange(0.34,0,100) will return 34.
  1826. * @param percent to convert to number
  1827. * @param min min range
  1828. * @param max max range
  1829. * @returns the number
  1830. */
  1831. static PercentToRange(percent: number, min: number, max: number): number;
  1832. /**
  1833. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1834. * @param angle The angle to normalize in radian.
  1835. * @return The converted angle.
  1836. */
  1837. static NormalizeRadians(angle: number): number;
  1838. }
  1839. }
  1840. declare module "babylonjs/Maths/math.constants" {
  1841. /**
  1842. * Constant used to convert a value to gamma space
  1843. * @ignorenaming
  1844. */
  1845. export const ToGammaSpace: number;
  1846. /**
  1847. * Constant used to convert a value to linear space
  1848. * @ignorenaming
  1849. */
  1850. export const ToLinearSpace = 2.2;
  1851. /**
  1852. * Constant used to define the minimal number value in Babylon.js
  1853. * @ignorenaming
  1854. */
  1855. let Epsilon: number;
  1856. export { Epsilon };
  1857. }
  1858. declare module "babylonjs/Maths/math.viewport" {
  1859. /**
  1860. * Class used to represent a viewport on screen
  1861. */
  1862. export class Viewport {
  1863. /** viewport left coordinate */
  1864. x: number;
  1865. /** viewport top coordinate */
  1866. y: number;
  1867. /**viewport width */
  1868. width: number;
  1869. /** viewport height */
  1870. height: number;
  1871. /**
  1872. * Creates a Viewport object located at (x, y) and sized (width, height)
  1873. * @param x defines viewport left coordinate
  1874. * @param y defines viewport top coordinate
  1875. * @param width defines the viewport width
  1876. * @param height defines the viewport height
  1877. */
  1878. constructor(
  1879. /** viewport left coordinate */
  1880. x: number,
  1881. /** viewport top coordinate */
  1882. y: number,
  1883. /**viewport width */
  1884. width: number,
  1885. /** viewport height */
  1886. height: number);
  1887. /**
  1888. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1889. * @param renderWidth defines the rendering width
  1890. * @param renderHeight defines the rendering height
  1891. * @returns a new Viewport
  1892. */
  1893. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1894. /**
  1895. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1896. * @param renderWidth defines the rendering width
  1897. * @param renderHeight defines the rendering height
  1898. * @param ref defines the target viewport
  1899. * @returns the current viewport
  1900. */
  1901. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1902. /**
  1903. * Returns a new Viewport copied from the current one
  1904. * @returns a new Viewport
  1905. */
  1906. clone(): Viewport;
  1907. }
  1908. }
  1909. declare module "babylonjs/Misc/arrayTools" {
  1910. /**
  1911. * Class containing a set of static utilities functions for arrays.
  1912. */
  1913. export class ArrayTools {
  1914. /**
  1915. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1916. * @param size the number of element to construct and put in the array
  1917. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1918. * @returns a new array filled with new objects
  1919. */
  1920. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1921. }
  1922. }
  1923. declare module "babylonjs/Maths/math.vector" {
  1924. import { Viewport } from "babylonjs/Maths/math.viewport";
  1925. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  1926. import { IPlaneLike } from "babylonjs/Maths/math.like";
  1927. /**
  1928. * Class representing a vector containing 2 coordinates
  1929. */
  1930. export class Vector2 {
  1931. /** defines the first coordinate */
  1932. x: number;
  1933. /** defines the second coordinate */
  1934. y: number;
  1935. /**
  1936. * Creates a new Vector2 from the given x and y coordinates
  1937. * @param x defines the first coordinate
  1938. * @param y defines the second coordinate
  1939. */
  1940. constructor(
  1941. /** defines the first coordinate */
  1942. x?: number,
  1943. /** defines the second coordinate */
  1944. y?: number);
  1945. /**
  1946. * Gets a string with the Vector2 coordinates
  1947. * @returns a string with the Vector2 coordinates
  1948. */
  1949. toString(): string;
  1950. /**
  1951. * Gets class name
  1952. * @returns the string "Vector2"
  1953. */
  1954. getClassName(): string;
  1955. /**
  1956. * Gets current vector hash code
  1957. * @returns the Vector2 hash code as a number
  1958. */
  1959. getHashCode(): number;
  1960. /**
  1961. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  1962. * @param array defines the source array
  1963. * @param index defines the offset in source array
  1964. * @returns the current Vector2
  1965. */
  1966. toArray(array: FloatArray, index?: number): Vector2;
  1967. /**
  1968. * Copy the current vector to an array
  1969. * @returns a new array with 2 elements: the Vector2 coordinates.
  1970. */
  1971. asArray(): number[];
  1972. /**
  1973. * Sets the Vector2 coordinates with the given Vector2 coordinates
  1974. * @param source defines the source Vector2
  1975. * @returns the current updated Vector2
  1976. */
  1977. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  1978. /**
  1979. * Sets the Vector2 coordinates with the given floats
  1980. * @param x defines the first coordinate
  1981. * @param y defines the second coordinate
  1982. * @returns the current updated Vector2
  1983. */
  1984. copyFromFloats(x: number, y: number): Vector2;
  1985. /**
  1986. * Sets the Vector2 coordinates with the given floats
  1987. * @param x defines the first coordinate
  1988. * @param y defines the second coordinate
  1989. * @returns the current updated Vector2
  1990. */
  1991. set(x: number, y: number): Vector2;
  1992. /**
  1993. * Add another vector with the current one
  1994. * @param otherVector defines the other vector
  1995. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  1996. */
  1997. add(otherVector: DeepImmutable<Vector2>): Vector2;
  1998. /**
  1999. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2000. * @param otherVector defines the other vector
  2001. * @param result defines the target vector
  2002. * @returns the unmodified current Vector2
  2003. */
  2004. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2005. /**
  2006. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2007. * @param otherVector defines the other vector
  2008. * @returns the current updated Vector2
  2009. */
  2010. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2011. /**
  2012. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2013. * @param otherVector defines the other vector
  2014. * @returns a new Vector2
  2015. */
  2016. addVector3(otherVector: Vector3): Vector2;
  2017. /**
  2018. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2019. * @param otherVector defines the other vector
  2020. * @returns a new Vector2
  2021. */
  2022. subtract(otherVector: Vector2): Vector2;
  2023. /**
  2024. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2025. * @param otherVector defines the other vector
  2026. * @param result defines the target vector
  2027. * @returns the unmodified current Vector2
  2028. */
  2029. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2030. /**
  2031. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2032. * @param otherVector defines the other vector
  2033. * @returns the current updated Vector2
  2034. */
  2035. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2036. /**
  2037. * Multiplies in place the current Vector2 coordinates by the given ones
  2038. * @param otherVector defines the other vector
  2039. * @returns the current updated Vector2
  2040. */
  2041. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2042. /**
  2043. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2044. * @param otherVector defines the other vector
  2045. * @returns a new Vector2
  2046. */
  2047. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2048. /**
  2049. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2050. * @param otherVector defines the other vector
  2051. * @param result defines the target vector
  2052. * @returns the unmodified current Vector2
  2053. */
  2054. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2055. /**
  2056. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2057. * @param x defines the first coordinate
  2058. * @param y defines the second coordinate
  2059. * @returns a new Vector2
  2060. */
  2061. multiplyByFloats(x: number, y: number): Vector2;
  2062. /**
  2063. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2064. * @param otherVector defines the other vector
  2065. * @returns a new Vector2
  2066. */
  2067. divide(otherVector: Vector2): Vector2;
  2068. /**
  2069. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2070. * @param otherVector defines the other vector
  2071. * @param result defines the target vector
  2072. * @returns the unmodified current Vector2
  2073. */
  2074. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2075. /**
  2076. * Divides the current Vector2 coordinates by the given ones
  2077. * @param otherVector defines the other vector
  2078. * @returns the current updated Vector2
  2079. */
  2080. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2081. /**
  2082. * Gets a new Vector2 with current Vector2 negated coordinates
  2083. * @returns a new Vector2
  2084. */
  2085. negate(): Vector2;
  2086. /**
  2087. * Multiply the Vector2 coordinates by scale
  2088. * @param scale defines the scaling factor
  2089. * @returns the current updated Vector2
  2090. */
  2091. scaleInPlace(scale: number): Vector2;
  2092. /**
  2093. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2094. * @param scale defines the scaling factor
  2095. * @returns a new Vector2
  2096. */
  2097. scale(scale: number): Vector2;
  2098. /**
  2099. * Scale the current Vector2 values by a factor to a given Vector2
  2100. * @param scale defines the scale factor
  2101. * @param result defines the Vector2 object where to store the result
  2102. * @returns the unmodified current Vector2
  2103. */
  2104. scaleToRef(scale: number, result: Vector2): Vector2;
  2105. /**
  2106. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2107. * @param scale defines the scale factor
  2108. * @param result defines the Vector2 object where to store the result
  2109. * @returns the unmodified current Vector2
  2110. */
  2111. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2112. /**
  2113. * Gets a boolean if two vectors are equals
  2114. * @param otherVector defines the other vector
  2115. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2116. */
  2117. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2118. /**
  2119. * Gets a boolean if two vectors are equals (using an epsilon value)
  2120. * @param otherVector defines the other vector
  2121. * @param epsilon defines the minimal distance to consider equality
  2122. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2123. */
  2124. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2125. /**
  2126. * Gets a new Vector2 from current Vector2 floored values
  2127. * @returns a new Vector2
  2128. */
  2129. floor(): Vector2;
  2130. /**
  2131. * Gets a new Vector2 from current Vector2 floored values
  2132. * @returns a new Vector2
  2133. */
  2134. fract(): Vector2;
  2135. /**
  2136. * Gets the length of the vector
  2137. * @returns the vector length (float)
  2138. */
  2139. length(): number;
  2140. /**
  2141. * Gets the vector squared length
  2142. * @returns the vector squared length (float)
  2143. */
  2144. lengthSquared(): number;
  2145. /**
  2146. * Normalize the vector
  2147. * @returns the current updated Vector2
  2148. */
  2149. normalize(): Vector2;
  2150. /**
  2151. * Gets a new Vector2 copied from the Vector2
  2152. * @returns a new Vector2
  2153. */
  2154. clone(): Vector2;
  2155. /**
  2156. * Gets a new Vector2(0, 0)
  2157. * @returns a new Vector2
  2158. */
  2159. static Zero(): Vector2;
  2160. /**
  2161. * Gets a new Vector2(1, 1)
  2162. * @returns a new Vector2
  2163. */
  2164. static One(): Vector2;
  2165. /**
  2166. * Gets a new Vector2 set from the given index element of the given array
  2167. * @param array defines the data source
  2168. * @param offset defines the offset in the data source
  2169. * @returns a new Vector2
  2170. */
  2171. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2172. /**
  2173. * Sets "result" from the given index element of the given array
  2174. * @param array defines the data source
  2175. * @param offset defines the offset in the data source
  2176. * @param result defines the target vector
  2177. */
  2178. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2179. /**
  2180. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2181. * @param value1 defines 1st point of control
  2182. * @param value2 defines 2nd point of control
  2183. * @param value3 defines 3rd point of control
  2184. * @param value4 defines 4th point of control
  2185. * @param amount defines the interpolation factor
  2186. * @returns a new Vector2
  2187. */
  2188. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2189. /**
  2190. * Returns a new Vector2 set with same the coordinates than "value" ones if the vector "value" is in the square defined by "min" and "max".
  2191. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2192. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2193. * @param value defines the value to clamp
  2194. * @param min defines the lower limit
  2195. * @param max defines the upper limit
  2196. * @returns a new Vector2
  2197. */
  2198. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2199. /**
  2200. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2201. * @param value1 defines the 1st control point
  2202. * @param tangent1 defines the outgoing tangent
  2203. * @param value2 defines the 2nd control point
  2204. * @param tangent2 defines the incoming tangent
  2205. * @param amount defines the interpolation factor
  2206. * @returns a new Vector2
  2207. */
  2208. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2209. /**
  2210. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2211. * @param start defines the start vector
  2212. * @param end defines the end vector
  2213. * @param amount defines the interpolation factor
  2214. * @returns a new Vector2
  2215. */
  2216. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2217. /**
  2218. * Gets the dot product of the vector "left" and the vector "right"
  2219. * @param left defines first vector
  2220. * @param right defines second vector
  2221. * @returns the dot product (float)
  2222. */
  2223. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2224. /**
  2225. * Returns a new Vector2 equal to the normalized given vector
  2226. * @param vector defines the vector to normalize
  2227. * @returns a new Vector2
  2228. */
  2229. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2230. /**
  2231. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2232. * @param left defines 1st vector
  2233. * @param right defines 2nd vector
  2234. * @returns a new Vector2
  2235. */
  2236. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2237. /**
  2238. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2239. * @param left defines 1st vector
  2240. * @param right defines 2nd vector
  2241. * @returns a new Vector2
  2242. */
  2243. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2244. /**
  2245. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2246. * @param vector defines the vector to transform
  2247. * @param transformation defines the matrix to apply
  2248. * @returns a new Vector2
  2249. */
  2250. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2251. /**
  2252. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2253. * @param vector defines the vector to transform
  2254. * @param transformation defines the matrix to apply
  2255. * @param result defines the target vector
  2256. */
  2257. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2258. /**
  2259. * Determines if a given vector is included in a triangle
  2260. * @param p defines the vector to test
  2261. * @param p0 defines 1st triangle point
  2262. * @param p1 defines 2nd triangle point
  2263. * @param p2 defines 3rd triangle point
  2264. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2265. */
  2266. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2267. /**
  2268. * Gets the distance between the vectors "value1" and "value2"
  2269. * @param value1 defines first vector
  2270. * @param value2 defines second vector
  2271. * @returns the distance between vectors
  2272. */
  2273. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2274. /**
  2275. * Returns the squared distance between the vectors "value1" and "value2"
  2276. * @param value1 defines first vector
  2277. * @param value2 defines second vector
  2278. * @returns the squared distance between vectors
  2279. */
  2280. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2281. /**
  2282. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2283. * @param value1 defines first vector
  2284. * @param value2 defines second vector
  2285. * @returns a new Vector2
  2286. */
  2287. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2288. /**
  2289. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2290. * @param p defines the middle point
  2291. * @param segA defines one point of the segment
  2292. * @param segB defines the other point of the segment
  2293. * @returns the shortest distance
  2294. */
  2295. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2296. }
  2297. /**
  2298. * Classed used to store (x,y,z) vector representation
  2299. * A Vector3 is the main object used in 3D geometry
  2300. * It can represent etiher the coordinates of a point the space, either a direction
  2301. * Reminder: js uses a left handed forward facing system
  2302. */
  2303. export class Vector3 {
  2304. /**
  2305. * Defines the first coordinates (on X axis)
  2306. */
  2307. x: number;
  2308. /**
  2309. * Defines the second coordinates (on Y axis)
  2310. */
  2311. y: number;
  2312. /**
  2313. * Defines the third coordinates (on Z axis)
  2314. */
  2315. z: number;
  2316. private static _UpReadOnly;
  2317. private static _ZeroReadOnly;
  2318. /**
  2319. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2320. * @param x defines the first coordinates (on X axis)
  2321. * @param y defines the second coordinates (on Y axis)
  2322. * @param z defines the third coordinates (on Z axis)
  2323. */
  2324. constructor(
  2325. /**
  2326. * Defines the first coordinates (on X axis)
  2327. */
  2328. x?: number,
  2329. /**
  2330. * Defines the second coordinates (on Y axis)
  2331. */
  2332. y?: number,
  2333. /**
  2334. * Defines the third coordinates (on Z axis)
  2335. */
  2336. z?: number);
  2337. /**
  2338. * Creates a string representation of the Vector3
  2339. * @returns a string with the Vector3 coordinates.
  2340. */
  2341. toString(): string;
  2342. /**
  2343. * Gets the class name
  2344. * @returns the string "Vector3"
  2345. */
  2346. getClassName(): string;
  2347. /**
  2348. * Creates the Vector3 hash code
  2349. * @returns a number which tends to be unique between Vector3 instances
  2350. */
  2351. getHashCode(): number;
  2352. /**
  2353. * Creates an array containing three elements : the coordinates of the Vector3
  2354. * @returns a new array of numbers
  2355. */
  2356. asArray(): number[];
  2357. /**
  2358. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2359. * @param array defines the destination array
  2360. * @param index defines the offset in the destination array
  2361. * @returns the current Vector3
  2362. */
  2363. toArray(array: FloatArray, index?: number): Vector3;
  2364. /**
  2365. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2366. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2367. */
  2368. toQuaternion(): Quaternion;
  2369. /**
  2370. * Adds the given vector to the current Vector3
  2371. * @param otherVector defines the second operand
  2372. * @returns the current updated Vector3
  2373. */
  2374. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2375. /**
  2376. * Adds the given coordinates to the current Vector3
  2377. * @param x defines the x coordinate of the operand
  2378. * @param y defines the y coordinate of the operand
  2379. * @param z defines the z coordinate of the operand
  2380. * @returns the current updated Vector3
  2381. */
  2382. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2383. /**
  2384. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2385. * @param otherVector defines the second operand
  2386. * @returns the resulting Vector3
  2387. */
  2388. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2389. /**
  2390. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2391. * @param otherVector defines the second operand
  2392. * @param result defines the Vector3 object where to store the result
  2393. * @returns the current Vector3
  2394. */
  2395. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2396. /**
  2397. * Subtract the given vector from the current Vector3
  2398. * @param otherVector defines the second operand
  2399. * @returns the current updated Vector3
  2400. */
  2401. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2402. /**
  2403. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2404. * @param otherVector defines the second operand
  2405. * @returns the resulting Vector3
  2406. */
  2407. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2408. /**
  2409. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2410. * @param otherVector defines the second operand
  2411. * @param result defines the Vector3 object where to store the result
  2412. * @returns the current Vector3
  2413. */
  2414. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2415. /**
  2416. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2417. * @param x defines the x coordinate of the operand
  2418. * @param y defines the y coordinate of the operand
  2419. * @param z defines the z coordinate of the operand
  2420. * @returns the resulting Vector3
  2421. */
  2422. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2423. /**
  2424. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2425. * @param x defines the x coordinate of the operand
  2426. * @param y defines the y coordinate of the operand
  2427. * @param z defines the z coordinate of the operand
  2428. * @param result defines the Vector3 object where to store the result
  2429. * @returns the current Vector3
  2430. */
  2431. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2432. /**
  2433. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2434. * @returns a new Vector3
  2435. */
  2436. negate(): Vector3;
  2437. /**
  2438. * Multiplies the Vector3 coordinates by the float "scale"
  2439. * @param scale defines the multiplier factor
  2440. * @returns the current updated Vector3
  2441. */
  2442. scaleInPlace(scale: number): Vector3;
  2443. /**
  2444. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2445. * @param scale defines the multiplier factor
  2446. * @returns a new Vector3
  2447. */
  2448. scale(scale: number): Vector3;
  2449. /**
  2450. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2451. * @param scale defines the multiplier factor
  2452. * @param result defines the Vector3 object where to store the result
  2453. * @returns the current Vector3
  2454. */
  2455. scaleToRef(scale: number, result: Vector3): Vector3;
  2456. /**
  2457. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2458. * @param scale defines the scale factor
  2459. * @param result defines the Vector3 object where to store the result
  2460. * @returns the unmodified current Vector3
  2461. */
  2462. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2463. /**
  2464. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2465. * @param otherVector defines the second operand
  2466. * @returns true if both vectors are equals
  2467. */
  2468. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2469. /**
  2470. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2471. * @param otherVector defines the second operand
  2472. * @param epsilon defines the minimal distance to define values as equals
  2473. * @returns true if both vectors are distant less than epsilon
  2474. */
  2475. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2476. /**
  2477. * Returns true if the current Vector3 coordinates equals the given floats
  2478. * @param x defines the x coordinate of the operand
  2479. * @param y defines the y coordinate of the operand
  2480. * @param z defines the z coordinate of the operand
  2481. * @returns true if both vectors are equals
  2482. */
  2483. equalsToFloats(x: number, y: number, z: number): boolean;
  2484. /**
  2485. * Multiplies the current Vector3 coordinates by the given ones
  2486. * @param otherVector defines the second operand
  2487. * @returns the current updated Vector3
  2488. */
  2489. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2490. /**
  2491. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2492. * @param otherVector defines the second operand
  2493. * @returns the new Vector3
  2494. */
  2495. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2496. /**
  2497. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2498. * @param otherVector defines the second operand
  2499. * @param result defines the Vector3 object where to store the result
  2500. * @returns the current Vector3
  2501. */
  2502. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2503. /**
  2504. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2505. * @param x defines the x coordinate of the operand
  2506. * @param y defines the y coordinate of the operand
  2507. * @param z defines the z coordinate of the operand
  2508. * @returns the new Vector3
  2509. */
  2510. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2511. /**
  2512. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2513. * @param otherVector defines the second operand
  2514. * @returns the new Vector3
  2515. */
  2516. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2517. /**
  2518. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2519. * @param otherVector defines the second operand
  2520. * @param result defines the Vector3 object where to store the result
  2521. * @returns the current Vector3
  2522. */
  2523. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2524. /**
  2525. * Divides the current Vector3 coordinates by the given ones.
  2526. * @param otherVector defines the second operand
  2527. * @returns the current updated Vector3
  2528. */
  2529. divideInPlace(otherVector: Vector3): Vector3;
  2530. /**
  2531. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2532. * @param other defines the second operand
  2533. * @returns the current updated Vector3
  2534. */
  2535. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2536. /**
  2537. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2538. * @param other defines the second operand
  2539. * @returns the current updated Vector3
  2540. */
  2541. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2542. /**
  2543. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2544. * @param x defines the x coordinate of the operand
  2545. * @param y defines the y coordinate of the operand
  2546. * @param z defines the z coordinate of the operand
  2547. * @returns the current updated Vector3
  2548. */
  2549. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2550. /**
  2551. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2552. * @param x defines the x coordinate of the operand
  2553. * @param y defines the y coordinate of the operand
  2554. * @param z defines the z coordinate of the operand
  2555. * @returns the current updated Vector3
  2556. */
  2557. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2558. /**
  2559. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2560. * Check if is non uniform within a certain amount of decimal places to account for this
  2561. * @param epsilon the amount the values can differ
  2562. * @returns if the the vector is non uniform to a certain number of decimal places
  2563. */
  2564. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2565. /**
  2566. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2567. */
  2568. readonly isNonUniform: boolean;
  2569. /**
  2570. * Gets a new Vector3 from current Vector3 floored values
  2571. * @returns a new Vector3
  2572. */
  2573. floor(): Vector3;
  2574. /**
  2575. * Gets a new Vector3 from current Vector3 floored values
  2576. * @returns a new Vector3
  2577. */
  2578. fract(): Vector3;
  2579. /**
  2580. * Gets the length of the Vector3
  2581. * @returns the length of the Vector3
  2582. */
  2583. length(): number;
  2584. /**
  2585. * Gets the squared length of the Vector3
  2586. * @returns squared length of the Vector3
  2587. */
  2588. lengthSquared(): number;
  2589. /**
  2590. * Normalize the current Vector3.
  2591. * Please note that this is an in place operation.
  2592. * @returns the current updated Vector3
  2593. */
  2594. normalize(): Vector3;
  2595. /**
  2596. * Reorders the x y z properties of the vector in place
  2597. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2598. * @returns the current updated vector
  2599. */
  2600. reorderInPlace(order: string): this;
  2601. /**
  2602. * Rotates the vector around 0,0,0 by a quaternion
  2603. * @param quaternion the rotation quaternion
  2604. * @param result vector to store the result
  2605. * @returns the resulting vector
  2606. */
  2607. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2608. /**
  2609. * Rotates a vector around a given point
  2610. * @param quaternion the rotation quaternion
  2611. * @param point the point to rotate around
  2612. * @param result vector to store the result
  2613. * @returns the resulting vector
  2614. */
  2615. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2616. /**
  2617. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2618. * The cross product is then orthogonal to both current and "other"
  2619. * @param other defines the right operand
  2620. * @returns the cross product
  2621. */
  2622. cross(other: Vector3): Vector3;
  2623. /**
  2624. * Normalize the current Vector3 with the given input length.
  2625. * Please note that this is an in place operation.
  2626. * @param len the length of the vector
  2627. * @returns the current updated Vector3
  2628. */
  2629. normalizeFromLength(len: number): Vector3;
  2630. /**
  2631. * Normalize the current Vector3 to a new vector
  2632. * @returns the new Vector3
  2633. */
  2634. normalizeToNew(): Vector3;
  2635. /**
  2636. * Normalize the current Vector3 to the reference
  2637. * @param reference define the Vector3 to update
  2638. * @returns the updated Vector3
  2639. */
  2640. normalizeToRef(reference: DeepImmutable<Vector3>): Vector3;
  2641. /**
  2642. * Creates a new Vector3 copied from the current Vector3
  2643. * @returns the new Vector3
  2644. */
  2645. clone(): Vector3;
  2646. /**
  2647. * Copies the given vector coordinates to the current Vector3 ones
  2648. * @param source defines the source Vector3
  2649. * @returns the current updated Vector3
  2650. */
  2651. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2652. /**
  2653. * Copies the given floats to the current Vector3 coordinates
  2654. * @param x defines the x coordinate of the operand
  2655. * @param y defines the y coordinate of the operand
  2656. * @param z defines the z coordinate of the operand
  2657. * @returns the current updated Vector3
  2658. */
  2659. copyFromFloats(x: number, y: number, z: number): Vector3;
  2660. /**
  2661. * Copies the given floats to the current Vector3 coordinates
  2662. * @param x defines the x coordinate of the operand
  2663. * @param y defines the y coordinate of the operand
  2664. * @param z defines the z coordinate of the operand
  2665. * @returns the current updated Vector3
  2666. */
  2667. set(x: number, y: number, z: number): Vector3;
  2668. /**
  2669. * Copies the given float to the current Vector3 coordinates
  2670. * @param v defines the x, y and z coordinates of the operand
  2671. * @returns the current updated Vector3
  2672. */
  2673. setAll(v: number): Vector3;
  2674. /**
  2675. * Get the clip factor between two vectors
  2676. * @param vector0 defines the first operand
  2677. * @param vector1 defines the second operand
  2678. * @param axis defines the axis to use
  2679. * @param size defines the size along the axis
  2680. * @returns the clip factor
  2681. */
  2682. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2683. /**
  2684. * Get angle between two vectors
  2685. * @param vector0 angle between vector0 and vector1
  2686. * @param vector1 angle between vector0 and vector1
  2687. * @param normal direction of the normal
  2688. * @return the angle between vector0 and vector1
  2689. */
  2690. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2691. /**
  2692. * Returns a new Vector3 set from the index "offset" of the given array
  2693. * @param array defines the source array
  2694. * @param offset defines the offset in the source array
  2695. * @returns the new Vector3
  2696. */
  2697. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2698. /**
  2699. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2700. * This function is deprecated. Use FromArray instead
  2701. * @param array defines the source array
  2702. * @param offset defines the offset in the source array
  2703. * @returns the new Vector3
  2704. */
  2705. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2706. /**
  2707. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2708. * @param array defines the source array
  2709. * @param offset defines the offset in the source array
  2710. * @param result defines the Vector3 where to store the result
  2711. */
  2712. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2713. /**
  2714. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2715. * This function is deprecated. Use FromArrayToRef instead.
  2716. * @param array defines the source array
  2717. * @param offset defines the offset in the source array
  2718. * @param result defines the Vector3 where to store the result
  2719. */
  2720. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2721. /**
  2722. * Sets the given vector "result" with the given floats.
  2723. * @param x defines the x coordinate of the source
  2724. * @param y defines the y coordinate of the source
  2725. * @param z defines the z coordinate of the source
  2726. * @param result defines the Vector3 where to store the result
  2727. */
  2728. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2729. /**
  2730. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2731. * @returns a new empty Vector3
  2732. */
  2733. static Zero(): Vector3;
  2734. /**
  2735. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2736. * @returns a new unit Vector3
  2737. */
  2738. static One(): Vector3;
  2739. /**
  2740. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2741. * @returns a new up Vector3
  2742. */
  2743. static Up(): Vector3;
  2744. /**
  2745. * Gets a up Vector3 that must not be updated
  2746. */
  2747. static readonly UpReadOnly: DeepImmutable<Vector3>;
  2748. /**
  2749. * Gets a zero Vector3 that must not be updated
  2750. */
  2751. static readonly ZeroReadOnly: DeepImmutable<Vector3>;
  2752. /**
  2753. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2754. * @returns a new down Vector3
  2755. */
  2756. static Down(): Vector3;
  2757. /**
  2758. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2759. * @returns a new forward Vector3
  2760. */
  2761. static Forward(): Vector3;
  2762. /**
  2763. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2764. * @returns a new forward Vector3
  2765. */
  2766. static Backward(): Vector3;
  2767. /**
  2768. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2769. * @returns a new right Vector3
  2770. */
  2771. static Right(): Vector3;
  2772. /**
  2773. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2774. * @returns a new left Vector3
  2775. */
  2776. static Left(): Vector3;
  2777. /**
  2778. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2779. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2780. * @param vector defines the Vector3 to transform
  2781. * @param transformation defines the transformation matrix
  2782. * @returns the transformed Vector3
  2783. */
  2784. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2785. /**
  2786. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2787. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2788. * @param vector defines the Vector3 to transform
  2789. * @param transformation defines the transformation matrix
  2790. * @param result defines the Vector3 where to store the result
  2791. */
  2792. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2793. /**
  2794. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  2795. * This method computes tranformed coordinates only, not transformed direction vectors
  2796. * @param x define the x coordinate of the source vector
  2797. * @param y define the y coordinate of the source vector
  2798. * @param z define the z coordinate of the source vector
  2799. * @param transformation defines the transformation matrix
  2800. * @param result defines the Vector3 where to store the result
  2801. */
  2802. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2803. /**
  2804. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  2805. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2806. * @param vector defines the Vector3 to transform
  2807. * @param transformation defines the transformation matrix
  2808. * @returns the new Vector3
  2809. */
  2810. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2811. /**
  2812. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  2813. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2814. * @param vector defines the Vector3 to transform
  2815. * @param transformation defines the transformation matrix
  2816. * @param result defines the Vector3 where to store the result
  2817. */
  2818. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2819. /**
  2820. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  2821. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2822. * @param x define the x coordinate of the source vector
  2823. * @param y define the y coordinate of the source vector
  2824. * @param z define the z coordinate of the source vector
  2825. * @param transformation defines the transformation matrix
  2826. * @param result defines the Vector3 where to store the result
  2827. */
  2828. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2829. /**
  2830. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  2831. * @param value1 defines the first control point
  2832. * @param value2 defines the second control point
  2833. * @param value3 defines the third control point
  2834. * @param value4 defines the fourth control point
  2835. * @param amount defines the amount on the spline to use
  2836. * @returns the new Vector3
  2837. */
  2838. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  2839. /**
  2840. * Returns a new Vector3 set with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  2841. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  2842. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  2843. * @param value defines the current value
  2844. * @param min defines the lower range value
  2845. * @param max defines the upper range value
  2846. * @returns the new Vector3
  2847. */
  2848. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  2849. /**
  2850. * Sets the given vector "result" with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  2851. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  2852. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  2853. * @param value defines the current value
  2854. * @param min defines the lower range value
  2855. * @param max defines the upper range value
  2856. * @param result defines the Vector3 where to store the result
  2857. */
  2858. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  2859. /**
  2860. * Checks if a given vector is inside a specific range
  2861. * @param v defines the vector to test
  2862. * @param min defines the minimum range
  2863. * @param max defines the maximum range
  2864. */
  2865. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  2866. /**
  2867. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  2868. * @param value1 defines the first control point
  2869. * @param tangent1 defines the first tangent vector
  2870. * @param value2 defines the second control point
  2871. * @param tangent2 defines the second tangent vector
  2872. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  2873. * @returns the new Vector3
  2874. */
  2875. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  2876. /**
  2877. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  2878. * @param start defines the start value
  2879. * @param end defines the end value
  2880. * @param amount max defines amount between both (between 0 and 1)
  2881. * @returns the new Vector3
  2882. */
  2883. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  2884. /**
  2885. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  2886. * @param start defines the start value
  2887. * @param end defines the end value
  2888. * @param amount max defines amount between both (between 0 and 1)
  2889. * @param result defines the Vector3 where to store the result
  2890. */
  2891. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  2892. /**
  2893. * Returns the dot product (float) between the vectors "left" and "right"
  2894. * @param left defines the left operand
  2895. * @param right defines the right operand
  2896. * @returns the dot product
  2897. */
  2898. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  2899. /**
  2900. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  2901. * The cross product is then orthogonal to both "left" and "right"
  2902. * @param left defines the left operand
  2903. * @param right defines the right operand
  2904. * @returns the cross product
  2905. */
  2906. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2907. /**
  2908. * Sets the given vector "result" with the cross product of "left" and "right"
  2909. * The cross product is then orthogonal to both "left" and "right"
  2910. * @param left defines the left operand
  2911. * @param right defines the right operand
  2912. * @param result defines the Vector3 where to store the result
  2913. */
  2914. static CrossToRef(left: Vector3, right: Vector3, result: Vector3): void;
  2915. /**
  2916. * Returns a new Vector3 as the normalization of the given vector
  2917. * @param vector defines the Vector3 to normalize
  2918. * @returns the new Vector3
  2919. */
  2920. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  2921. /**
  2922. * Sets the given vector "result" with the normalization of the given first vector
  2923. * @param vector defines the Vector3 to normalize
  2924. * @param result defines the Vector3 where to store the result
  2925. */
  2926. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  2927. /**
  2928. * Project a Vector3 onto screen space
  2929. * @param vector defines the Vector3 to project
  2930. * @param world defines the world matrix to use
  2931. * @param transform defines the transform (view x projection) matrix to use
  2932. * @param viewport defines the screen viewport to use
  2933. * @returns the new Vector3
  2934. */
  2935. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  2936. /** @hidden */
  2937. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  2938. /**
  2939. * Unproject from screen space to object space
  2940. * @param source defines the screen space Vector3 to use
  2941. * @param viewportWidth defines the current width of the viewport
  2942. * @param viewportHeight defines the current height of the viewport
  2943. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2944. * @param transform defines the transform (view x projection) matrix to use
  2945. * @returns the new Vector3
  2946. */
  2947. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  2948. /**
  2949. * Unproject from screen space to object space
  2950. * @param source defines the screen space Vector3 to use
  2951. * @param viewportWidth defines the current width of the viewport
  2952. * @param viewportHeight defines the current height of the viewport
  2953. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2954. * @param view defines the view matrix to use
  2955. * @param projection defines the projection matrix to use
  2956. * @returns the new Vector3
  2957. */
  2958. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  2959. /**
  2960. * Unproject from screen space to object space
  2961. * @param source defines the screen space Vector3 to use
  2962. * @param viewportWidth defines the current width of the viewport
  2963. * @param viewportHeight defines the current height of the viewport
  2964. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2965. * @param view defines the view matrix to use
  2966. * @param projection defines the projection matrix to use
  2967. * @param result defines the Vector3 where to store the result
  2968. */
  2969. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  2970. /**
  2971. * Unproject from screen space to object space
  2972. * @param sourceX defines the screen space x coordinate to use
  2973. * @param sourceY defines the screen space y coordinate to use
  2974. * @param sourceZ defines the screen space z coordinate to use
  2975. * @param viewportWidth defines the current width of the viewport
  2976. * @param viewportHeight defines the current height of the viewport
  2977. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2978. * @param view defines the view matrix to use
  2979. * @param projection defines the projection matrix to use
  2980. * @param result defines the Vector3 where to store the result
  2981. */
  2982. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  2983. /**
  2984. * Gets the minimal coordinate values between two Vector3
  2985. * @param left defines the first operand
  2986. * @param right defines the second operand
  2987. * @returns the new Vector3
  2988. */
  2989. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2990. /**
  2991. * Gets the maximal coordinate values between two Vector3
  2992. * @param left defines the first operand
  2993. * @param right defines the second operand
  2994. * @returns the new Vector3
  2995. */
  2996. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2997. /**
  2998. * Returns the distance between the vectors "value1" and "value2"
  2999. * @param value1 defines the first operand
  3000. * @param value2 defines the second operand
  3001. * @returns the distance
  3002. */
  3003. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3004. /**
  3005. * Returns the squared distance between the vectors "value1" and "value2"
  3006. * @param value1 defines the first operand
  3007. * @param value2 defines the second operand
  3008. * @returns the squared distance
  3009. */
  3010. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3011. /**
  3012. * Returns a new Vector3 located at the center between "value1" and "value2"
  3013. * @param value1 defines the first operand
  3014. * @param value2 defines the second operand
  3015. * @returns the new Vector3
  3016. */
  3017. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3018. /**
  3019. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3020. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3021. * to something in order to rotate it from its local system to the given target system
  3022. * Note: axis1, axis2 and axis3 are normalized during this operation
  3023. * @param axis1 defines the first axis
  3024. * @param axis2 defines the second axis
  3025. * @param axis3 defines the third axis
  3026. * @returns a new Vector3
  3027. */
  3028. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3029. /**
  3030. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3031. * @param axis1 defines the first axis
  3032. * @param axis2 defines the second axis
  3033. * @param axis3 defines the third axis
  3034. * @param ref defines the Vector3 where to store the result
  3035. */
  3036. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3037. }
  3038. /**
  3039. * Vector4 class created for EulerAngle class conversion to Quaternion
  3040. */
  3041. export class Vector4 {
  3042. /** x value of the vector */
  3043. x: number;
  3044. /** y value of the vector */
  3045. y: number;
  3046. /** z value of the vector */
  3047. z: number;
  3048. /** w value of the vector */
  3049. w: number;
  3050. /**
  3051. * Creates a Vector4 object from the given floats.
  3052. * @param x x value of the vector
  3053. * @param y y value of the vector
  3054. * @param z z value of the vector
  3055. * @param w w value of the vector
  3056. */
  3057. constructor(
  3058. /** x value of the vector */
  3059. x: number,
  3060. /** y value of the vector */
  3061. y: number,
  3062. /** z value of the vector */
  3063. z: number,
  3064. /** w value of the vector */
  3065. w: number);
  3066. /**
  3067. * Returns the string with the Vector4 coordinates.
  3068. * @returns a string containing all the vector values
  3069. */
  3070. toString(): string;
  3071. /**
  3072. * Returns the string "Vector4".
  3073. * @returns "Vector4"
  3074. */
  3075. getClassName(): string;
  3076. /**
  3077. * Returns the Vector4 hash code.
  3078. * @returns a unique hash code
  3079. */
  3080. getHashCode(): number;
  3081. /**
  3082. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3083. * @returns the resulting array
  3084. */
  3085. asArray(): number[];
  3086. /**
  3087. * Populates the given array from the given index with the Vector4 coordinates.
  3088. * @param array array to populate
  3089. * @param index index of the array to start at (default: 0)
  3090. * @returns the Vector4.
  3091. */
  3092. toArray(array: FloatArray, index?: number): Vector4;
  3093. /**
  3094. * Adds the given vector to the current Vector4.
  3095. * @param otherVector the vector to add
  3096. * @returns the updated Vector4.
  3097. */
  3098. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3099. /**
  3100. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3101. * @param otherVector the vector to add
  3102. * @returns the resulting vector
  3103. */
  3104. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3105. /**
  3106. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3107. * @param otherVector the vector to add
  3108. * @param result the vector to store the result
  3109. * @returns the current Vector4.
  3110. */
  3111. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3112. /**
  3113. * Subtract in place the given vector from the current Vector4.
  3114. * @param otherVector the vector to subtract
  3115. * @returns the updated Vector4.
  3116. */
  3117. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3118. /**
  3119. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3120. * @param otherVector the vector to add
  3121. * @returns the new vector with the result
  3122. */
  3123. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3124. /**
  3125. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3126. * @param otherVector the vector to subtract
  3127. * @param result the vector to store the result
  3128. * @returns the current Vector4.
  3129. */
  3130. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3131. /**
  3132. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3133. */
  3134. /**
  3135. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3136. * @param x value to subtract
  3137. * @param y value to subtract
  3138. * @param z value to subtract
  3139. * @param w value to subtract
  3140. * @returns new vector containing the result
  3141. */
  3142. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3143. /**
  3144. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3145. * @param x value to subtract
  3146. * @param y value to subtract
  3147. * @param z value to subtract
  3148. * @param w value to subtract
  3149. * @param result the vector to store the result in
  3150. * @returns the current Vector4.
  3151. */
  3152. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3153. /**
  3154. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3155. * @returns a new vector with the negated values
  3156. */
  3157. negate(): Vector4;
  3158. /**
  3159. * Multiplies the current Vector4 coordinates by scale (float).
  3160. * @param scale the number to scale with
  3161. * @returns the updated Vector4.
  3162. */
  3163. scaleInPlace(scale: number): Vector4;
  3164. /**
  3165. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3166. * @param scale the number to scale with
  3167. * @returns a new vector with the result
  3168. */
  3169. scale(scale: number): Vector4;
  3170. /**
  3171. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3172. * @param scale the number to scale with
  3173. * @param result a vector to store the result in
  3174. * @returns the current Vector4.
  3175. */
  3176. scaleToRef(scale: number, result: Vector4): Vector4;
  3177. /**
  3178. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3179. * @param scale defines the scale factor
  3180. * @param result defines the Vector4 object where to store the result
  3181. * @returns the unmodified current Vector4
  3182. */
  3183. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3184. /**
  3185. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3186. * @param otherVector the vector to compare against
  3187. * @returns true if they are equal
  3188. */
  3189. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3190. /**
  3191. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3192. * @param otherVector vector to compare against
  3193. * @param epsilon (Default: very small number)
  3194. * @returns true if they are equal
  3195. */
  3196. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3197. /**
  3198. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3199. * @param x x value to compare against
  3200. * @param y y value to compare against
  3201. * @param z z value to compare against
  3202. * @param w w value to compare against
  3203. * @returns true if equal
  3204. */
  3205. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3206. /**
  3207. * Multiplies in place the current Vector4 by the given one.
  3208. * @param otherVector vector to multiple with
  3209. * @returns the updated Vector4.
  3210. */
  3211. multiplyInPlace(otherVector: Vector4): Vector4;
  3212. /**
  3213. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3214. * @param otherVector vector to multiple with
  3215. * @returns resulting new vector
  3216. */
  3217. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3218. /**
  3219. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3220. * @param otherVector vector to multiple with
  3221. * @param result vector to store the result
  3222. * @returns the current Vector4.
  3223. */
  3224. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3225. /**
  3226. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3227. * @param x x value multiply with
  3228. * @param y y value multiply with
  3229. * @param z z value multiply with
  3230. * @param w w value multiply with
  3231. * @returns resulting new vector
  3232. */
  3233. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3234. /**
  3235. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3236. * @param otherVector vector to devide with
  3237. * @returns resulting new vector
  3238. */
  3239. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3240. /**
  3241. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3242. * @param otherVector vector to devide with
  3243. * @param result vector to store the result
  3244. * @returns the current Vector4.
  3245. */
  3246. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3247. /**
  3248. * Divides the current Vector3 coordinates by the given ones.
  3249. * @param otherVector vector to devide with
  3250. * @returns the updated Vector3.
  3251. */
  3252. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3253. /**
  3254. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3255. * @param other defines the second operand
  3256. * @returns the current updated Vector4
  3257. */
  3258. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3259. /**
  3260. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3261. * @param other defines the second operand
  3262. * @returns the current updated Vector4
  3263. */
  3264. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3265. /**
  3266. * Gets a new Vector4 from current Vector4 floored values
  3267. * @returns a new Vector4
  3268. */
  3269. floor(): Vector4;
  3270. /**
  3271. * Gets a new Vector4 from current Vector3 floored values
  3272. * @returns a new Vector4
  3273. */
  3274. fract(): Vector4;
  3275. /**
  3276. * Returns the Vector4 length (float).
  3277. * @returns the length
  3278. */
  3279. length(): number;
  3280. /**
  3281. * Returns the Vector4 squared length (float).
  3282. * @returns the length squared
  3283. */
  3284. lengthSquared(): number;
  3285. /**
  3286. * Normalizes in place the Vector4.
  3287. * @returns the updated Vector4.
  3288. */
  3289. normalize(): Vector4;
  3290. /**
  3291. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3292. * @returns this converted to a new vector3
  3293. */
  3294. toVector3(): Vector3;
  3295. /**
  3296. * Returns a new Vector4 copied from the current one.
  3297. * @returns the new cloned vector
  3298. */
  3299. clone(): Vector4;
  3300. /**
  3301. * Updates the current Vector4 with the given one coordinates.
  3302. * @param source the source vector to copy from
  3303. * @returns the updated Vector4.
  3304. */
  3305. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3306. /**
  3307. * Updates the current Vector4 coordinates with the given floats.
  3308. * @param x float to copy from
  3309. * @param y float to copy from
  3310. * @param z float to copy from
  3311. * @param w float to copy from
  3312. * @returns the updated Vector4.
  3313. */
  3314. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3315. /**
  3316. * Updates the current Vector4 coordinates with the given floats.
  3317. * @param x float to set from
  3318. * @param y float to set from
  3319. * @param z float to set from
  3320. * @param w float to set from
  3321. * @returns the updated Vector4.
  3322. */
  3323. set(x: number, y: number, z: number, w: number): Vector4;
  3324. /**
  3325. * Copies the given float to the current Vector3 coordinates
  3326. * @param v defines the x, y, z and w coordinates of the operand
  3327. * @returns the current updated Vector3
  3328. */
  3329. setAll(v: number): Vector4;
  3330. /**
  3331. * Returns a new Vector4 set from the starting index of the given array.
  3332. * @param array the array to pull values from
  3333. * @param offset the offset into the array to start at
  3334. * @returns the new vector
  3335. */
  3336. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3337. /**
  3338. * Updates the given vector "result" from the starting index of the given array.
  3339. * @param array the array to pull values from
  3340. * @param offset the offset into the array to start at
  3341. * @param result the vector to store the result in
  3342. */
  3343. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3344. /**
  3345. * Updates the given vector "result" from the starting index of the given Float32Array.
  3346. * @param array the array to pull values from
  3347. * @param offset the offset into the array to start at
  3348. * @param result the vector to store the result in
  3349. */
  3350. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3351. /**
  3352. * Updates the given vector "result" coordinates from the given floats.
  3353. * @param x float to set from
  3354. * @param y float to set from
  3355. * @param z float to set from
  3356. * @param w float to set from
  3357. * @param result the vector to the floats in
  3358. */
  3359. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3360. /**
  3361. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3362. * @returns the new vector
  3363. */
  3364. static Zero(): Vector4;
  3365. /**
  3366. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3367. * @returns the new vector
  3368. */
  3369. static One(): Vector4;
  3370. /**
  3371. * Returns a new normalized Vector4 from the given one.
  3372. * @param vector the vector to normalize
  3373. * @returns the vector
  3374. */
  3375. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3376. /**
  3377. * Updates the given vector "result" from the normalization of the given one.
  3378. * @param vector the vector to normalize
  3379. * @param result the vector to store the result in
  3380. */
  3381. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3382. /**
  3383. * Returns a vector with the minimum values from the left and right vectors
  3384. * @param left left vector to minimize
  3385. * @param right right vector to minimize
  3386. * @returns a new vector with the minimum of the left and right vector values
  3387. */
  3388. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3389. /**
  3390. * Returns a vector with the maximum values from the left and right vectors
  3391. * @param left left vector to maximize
  3392. * @param right right vector to maximize
  3393. * @returns a new vector with the maximum of the left and right vector values
  3394. */
  3395. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3396. /**
  3397. * Returns the distance (float) between the vectors "value1" and "value2".
  3398. * @param value1 value to calulate the distance between
  3399. * @param value2 value to calulate the distance between
  3400. * @return the distance between the two vectors
  3401. */
  3402. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3403. /**
  3404. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3405. * @param value1 value to calulate the distance between
  3406. * @param value2 value to calulate the distance between
  3407. * @return the distance between the two vectors squared
  3408. */
  3409. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3410. /**
  3411. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3412. * @param value1 value to calulate the center between
  3413. * @param value2 value to calulate the center between
  3414. * @return the center between the two vectors
  3415. */
  3416. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3417. /**
  3418. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3419. * This methods computes transformed normalized direction vectors only.
  3420. * @param vector the vector to transform
  3421. * @param transformation the transformation matrix to apply
  3422. * @returns the new vector
  3423. */
  3424. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3425. /**
  3426. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3427. * This methods computes transformed normalized direction vectors only.
  3428. * @param vector the vector to transform
  3429. * @param transformation the transformation matrix to apply
  3430. * @param result the vector to store the result in
  3431. */
  3432. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3433. /**
  3434. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3435. * This methods computes transformed normalized direction vectors only.
  3436. * @param x value to transform
  3437. * @param y value to transform
  3438. * @param z value to transform
  3439. * @param w value to transform
  3440. * @param transformation the transformation matrix to apply
  3441. * @param result the vector to store the results in
  3442. */
  3443. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3444. /**
  3445. * Creates a new Vector4 from a Vector3
  3446. * @param source defines the source data
  3447. * @param w defines the 4th component (default is 0)
  3448. * @returns a new Vector4
  3449. */
  3450. static FromVector3(source: Vector3, w?: number): Vector4;
  3451. }
  3452. /**
  3453. * Class used to store quaternion data
  3454. * @see https://en.wikipedia.org/wiki/Quaternion
  3455. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  3456. */
  3457. export class Quaternion {
  3458. /** defines the first component (0 by default) */
  3459. x: number;
  3460. /** defines the second component (0 by default) */
  3461. y: number;
  3462. /** defines the third component (0 by default) */
  3463. z: number;
  3464. /** defines the fourth component (1.0 by default) */
  3465. w: number;
  3466. /**
  3467. * Creates a new Quaternion from the given floats
  3468. * @param x defines the first component (0 by default)
  3469. * @param y defines the second component (0 by default)
  3470. * @param z defines the third component (0 by default)
  3471. * @param w defines the fourth component (1.0 by default)
  3472. */
  3473. constructor(
  3474. /** defines the first component (0 by default) */
  3475. x?: number,
  3476. /** defines the second component (0 by default) */
  3477. y?: number,
  3478. /** defines the third component (0 by default) */
  3479. z?: number,
  3480. /** defines the fourth component (1.0 by default) */
  3481. w?: number);
  3482. /**
  3483. * Gets a string representation for the current quaternion
  3484. * @returns a string with the Quaternion coordinates
  3485. */
  3486. toString(): string;
  3487. /**
  3488. * Gets the class name of the quaternion
  3489. * @returns the string "Quaternion"
  3490. */
  3491. getClassName(): string;
  3492. /**
  3493. * Gets a hash code for this quaternion
  3494. * @returns the quaternion hash code
  3495. */
  3496. getHashCode(): number;
  3497. /**
  3498. * Copy the quaternion to an array
  3499. * @returns a new array populated with 4 elements from the quaternion coordinates
  3500. */
  3501. asArray(): number[];
  3502. /**
  3503. * Check if two quaternions are equals
  3504. * @param otherQuaternion defines the second operand
  3505. * @return true if the current quaternion and the given one coordinates are strictly equals
  3506. */
  3507. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3508. /**
  3509. * Clone the current quaternion
  3510. * @returns a new quaternion copied from the current one
  3511. */
  3512. clone(): Quaternion;
  3513. /**
  3514. * Copy a quaternion to the current one
  3515. * @param other defines the other quaternion
  3516. * @returns the updated current quaternion
  3517. */
  3518. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3519. /**
  3520. * Updates the current quaternion with the given float coordinates
  3521. * @param x defines the x coordinate
  3522. * @param y defines the y coordinate
  3523. * @param z defines the z coordinate
  3524. * @param w defines the w coordinate
  3525. * @returns the updated current quaternion
  3526. */
  3527. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3528. /**
  3529. * Updates the current quaternion from the given float coordinates
  3530. * @param x defines the x coordinate
  3531. * @param y defines the y coordinate
  3532. * @param z defines the z coordinate
  3533. * @param w defines the w coordinate
  3534. * @returns the updated current quaternion
  3535. */
  3536. set(x: number, y: number, z: number, w: number): Quaternion;
  3537. /**
  3538. * Adds two quaternions
  3539. * @param other defines the second operand
  3540. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3541. */
  3542. add(other: DeepImmutable<Quaternion>): Quaternion;
  3543. /**
  3544. * Add a quaternion to the current one
  3545. * @param other defines the quaternion to add
  3546. * @returns the current quaternion
  3547. */
  3548. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3549. /**
  3550. * Subtract two quaternions
  3551. * @param other defines the second operand
  3552. * @returns a new quaternion as the subtraction result of the given one from the current one
  3553. */
  3554. subtract(other: Quaternion): Quaternion;
  3555. /**
  3556. * Multiplies the current quaternion by a scale factor
  3557. * @param value defines the scale factor
  3558. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3559. */
  3560. scale(value: number): Quaternion;
  3561. /**
  3562. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3563. * @param scale defines the scale factor
  3564. * @param result defines the Quaternion object where to store the result
  3565. * @returns the unmodified current quaternion
  3566. */
  3567. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3568. /**
  3569. * Multiplies in place the current quaternion by a scale factor
  3570. * @param value defines the scale factor
  3571. * @returns the current modified quaternion
  3572. */
  3573. scaleInPlace(value: number): Quaternion;
  3574. /**
  3575. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3576. * @param scale defines the scale factor
  3577. * @param result defines the Quaternion object where to store the result
  3578. * @returns the unmodified current quaternion
  3579. */
  3580. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3581. /**
  3582. * Multiplies two quaternions
  3583. * @param q1 defines the second operand
  3584. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3585. */
  3586. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3587. /**
  3588. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3589. * @param q1 defines the second operand
  3590. * @param result defines the target quaternion
  3591. * @returns the current quaternion
  3592. */
  3593. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3594. /**
  3595. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3596. * @param q1 defines the second operand
  3597. * @returns the currentupdated quaternion
  3598. */
  3599. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3600. /**
  3601. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3602. * @param ref defines the target quaternion
  3603. * @returns the current quaternion
  3604. */
  3605. conjugateToRef(ref: Quaternion): Quaternion;
  3606. /**
  3607. * Conjugates in place (1-q) the current quaternion
  3608. * @returns the current updated quaternion
  3609. */
  3610. conjugateInPlace(): Quaternion;
  3611. /**
  3612. * Conjugates in place (1-q) the current quaternion
  3613. * @returns a new quaternion
  3614. */
  3615. conjugate(): Quaternion;
  3616. /**
  3617. * Gets length of current quaternion
  3618. * @returns the quaternion length (float)
  3619. */
  3620. length(): number;
  3621. /**
  3622. * Normalize in place the current quaternion
  3623. * @returns the current updated quaternion
  3624. */
  3625. normalize(): Quaternion;
  3626. /**
  3627. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3628. * @param order is a reserved parameter and is ignore for now
  3629. * @returns a new Vector3 containing the Euler angles
  3630. */
  3631. toEulerAngles(order?: string): Vector3;
  3632. /**
  3633. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3634. * @param result defines the vector which will be filled with the Euler angles
  3635. * @param order is a reserved parameter and is ignore for now
  3636. * @returns the current unchanged quaternion
  3637. */
  3638. toEulerAnglesToRef(result: Vector3): Quaternion;
  3639. /**
  3640. * Updates the given rotation matrix with the current quaternion values
  3641. * @param result defines the target matrix
  3642. * @returns the current unchanged quaternion
  3643. */
  3644. toRotationMatrix(result: Matrix): Quaternion;
  3645. /**
  3646. * Updates the current quaternion from the given rotation matrix values
  3647. * @param matrix defines the source matrix
  3648. * @returns the current updated quaternion
  3649. */
  3650. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3651. /**
  3652. * Creates a new quaternion from a rotation matrix
  3653. * @param matrix defines the source matrix
  3654. * @returns a new quaternion created from the given rotation matrix values
  3655. */
  3656. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3657. /**
  3658. * Updates the given quaternion with the given rotation matrix values
  3659. * @param matrix defines the source matrix
  3660. * @param result defines the target quaternion
  3661. */
  3662. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3663. /**
  3664. * Returns the dot product (float) between the quaternions "left" and "right"
  3665. * @param left defines the left operand
  3666. * @param right defines the right operand
  3667. * @returns the dot product
  3668. */
  3669. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3670. /**
  3671. * Checks if the two quaternions are close to each other
  3672. * @param quat0 defines the first quaternion to check
  3673. * @param quat1 defines the second quaternion to check
  3674. * @returns true if the two quaternions are close to each other
  3675. */
  3676. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3677. /**
  3678. * Creates an empty quaternion
  3679. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3680. */
  3681. static Zero(): Quaternion;
  3682. /**
  3683. * Inverse a given quaternion
  3684. * @param q defines the source quaternion
  3685. * @returns a new quaternion as the inverted current quaternion
  3686. */
  3687. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3688. /**
  3689. * Inverse a given quaternion
  3690. * @param q defines the source quaternion
  3691. * @param result the quaternion the result will be stored in
  3692. * @returns the result quaternion
  3693. */
  3694. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3695. /**
  3696. * Creates an identity quaternion
  3697. * @returns the identity quaternion
  3698. */
  3699. static Identity(): Quaternion;
  3700. /**
  3701. * Gets a boolean indicating if the given quaternion is identity
  3702. * @param quaternion defines the quaternion to check
  3703. * @returns true if the quaternion is identity
  3704. */
  3705. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3706. /**
  3707. * Creates a quaternion from a rotation around an axis
  3708. * @param axis defines the axis to use
  3709. * @param angle defines the angle to use
  3710. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3711. */
  3712. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3713. /**
  3714. * Creates a rotation around an axis and stores it into the given quaternion
  3715. * @param axis defines the axis to use
  3716. * @param angle defines the angle to use
  3717. * @param result defines the target quaternion
  3718. * @returns the target quaternion
  3719. */
  3720. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3721. /**
  3722. * Creates a new quaternion from data stored into an array
  3723. * @param array defines the data source
  3724. * @param offset defines the offset in the source array where the data starts
  3725. * @returns a new quaternion
  3726. */
  3727. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3728. /**
  3729. * Create a quaternion from Euler rotation angles
  3730. * @param x Pitch
  3731. * @param y Yaw
  3732. * @param z Roll
  3733. * @returns the new Quaternion
  3734. */
  3735. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3736. /**
  3737. * Updates a quaternion from Euler rotation angles
  3738. * @param x Pitch
  3739. * @param y Yaw
  3740. * @param z Roll
  3741. * @param result the quaternion to store the result
  3742. * @returns the updated quaternion
  3743. */
  3744. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3745. /**
  3746. * Create a quaternion from Euler rotation vector
  3747. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3748. * @returns the new Quaternion
  3749. */
  3750. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3751. /**
  3752. * Updates a quaternion from Euler rotation vector
  3753. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3754. * @param result the quaternion to store the result
  3755. * @returns the updated quaternion
  3756. */
  3757. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  3758. /**
  3759. * Creates a new quaternion from the given Euler float angles (y, x, z)
  3760. * @param yaw defines the rotation around Y axis
  3761. * @param pitch defines the rotation around X axis
  3762. * @param roll defines the rotation around Z axis
  3763. * @returns the new quaternion
  3764. */
  3765. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  3766. /**
  3767. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  3768. * @param yaw defines the rotation around Y axis
  3769. * @param pitch defines the rotation around X axis
  3770. * @param roll defines the rotation around Z axis
  3771. * @param result defines the target quaternion
  3772. */
  3773. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  3774. /**
  3775. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  3776. * @param alpha defines the rotation around first axis
  3777. * @param beta defines the rotation around second axis
  3778. * @param gamma defines the rotation around third axis
  3779. * @returns the new quaternion
  3780. */
  3781. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  3782. /**
  3783. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  3784. * @param alpha defines the rotation around first axis
  3785. * @param beta defines the rotation around second axis
  3786. * @param gamma defines the rotation around third axis
  3787. * @param result defines the target quaternion
  3788. */
  3789. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  3790. /**
  3791. * Creates a new quaternion containing the rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation)
  3792. * @param axis1 defines the first axis
  3793. * @param axis2 defines the second axis
  3794. * @param axis3 defines the third axis
  3795. * @returns the new quaternion
  3796. */
  3797. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  3798. /**
  3799. * Creates a rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation) and stores it in the target quaternion
  3800. * @param axis1 defines the first axis
  3801. * @param axis2 defines the second axis
  3802. * @param axis3 defines the third axis
  3803. * @param ref defines the target quaternion
  3804. */
  3805. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  3806. /**
  3807. * Interpolates between two quaternions
  3808. * @param left defines first quaternion
  3809. * @param right defines second quaternion
  3810. * @param amount defines the gradient to use
  3811. * @returns the new interpolated quaternion
  3812. */
  3813. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  3814. /**
  3815. * Interpolates between two quaternions and stores it into a target quaternion
  3816. * @param left defines first quaternion
  3817. * @param right defines second quaternion
  3818. * @param amount defines the gradient to use
  3819. * @param result defines the target quaternion
  3820. */
  3821. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  3822. /**
  3823. * Interpolate between two quaternions using Hermite interpolation
  3824. * @param value1 defines first quaternion
  3825. * @param tangent1 defines the incoming tangent
  3826. * @param value2 defines second quaternion
  3827. * @param tangent2 defines the outgoing tangent
  3828. * @param amount defines the target quaternion
  3829. * @returns the new interpolated quaternion
  3830. */
  3831. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  3832. }
  3833. /**
  3834. * Class used to store matrix data (4x4)
  3835. */
  3836. export class Matrix {
  3837. private static _updateFlagSeed;
  3838. private static _identityReadOnly;
  3839. private _isIdentity;
  3840. private _isIdentityDirty;
  3841. private _isIdentity3x2;
  3842. private _isIdentity3x2Dirty;
  3843. /**
  3844. * Gets the update flag of the matrix which is an unique number for the matrix.
  3845. * It will be incremented every time the matrix data change.
  3846. * You can use it to speed the comparison between two versions of the same matrix.
  3847. */
  3848. updateFlag: number;
  3849. private readonly _m;
  3850. /**
  3851. * Gets the internal data of the matrix
  3852. */
  3853. readonly m: DeepImmutable<Float32Array>;
  3854. /** @hidden */
  3855. _markAsUpdated(): void;
  3856. /** @hidden */
  3857. private _updateIdentityStatus;
  3858. /**
  3859. * Creates an empty matrix (filled with zeros)
  3860. */
  3861. constructor();
  3862. /**
  3863. * Check if the current matrix is identity
  3864. * @returns true is the matrix is the identity matrix
  3865. */
  3866. isIdentity(): boolean;
  3867. /**
  3868. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  3869. * @returns true is the matrix is the identity matrix
  3870. */
  3871. isIdentityAs3x2(): boolean;
  3872. /**
  3873. * Gets the determinant of the matrix
  3874. * @returns the matrix determinant
  3875. */
  3876. determinant(): number;
  3877. /**
  3878. * Returns the matrix as a Float32Array
  3879. * @returns the matrix underlying array
  3880. */
  3881. toArray(): DeepImmutable<Float32Array>;
  3882. /**
  3883. * Returns the matrix as a Float32Array
  3884. * @returns the matrix underlying array.
  3885. */
  3886. asArray(): DeepImmutable<Float32Array>;
  3887. /**
  3888. * Inverts the current matrix in place
  3889. * @returns the current inverted matrix
  3890. */
  3891. invert(): Matrix;
  3892. /**
  3893. * Sets all the matrix elements to zero
  3894. * @returns the current matrix
  3895. */
  3896. reset(): Matrix;
  3897. /**
  3898. * Adds the current matrix with a second one
  3899. * @param other defines the matrix to add
  3900. * @returns a new matrix as the addition of the current matrix and the given one
  3901. */
  3902. add(other: DeepImmutable<Matrix>): Matrix;
  3903. /**
  3904. * Sets the given matrix "result" to the addition of the current matrix and the given one
  3905. * @param other defines the matrix to add
  3906. * @param result defines the target matrix
  3907. * @returns the current matrix
  3908. */
  3909. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  3910. /**
  3911. * Adds in place the given matrix to the current matrix
  3912. * @param other defines the second operand
  3913. * @returns the current updated matrix
  3914. */
  3915. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  3916. /**
  3917. * Sets the given matrix to the current inverted Matrix
  3918. * @param other defines the target matrix
  3919. * @returns the unmodified current matrix
  3920. */
  3921. invertToRef(other: Matrix): Matrix;
  3922. /**
  3923. * add a value at the specified position in the current Matrix
  3924. * @param index the index of the value within the matrix. between 0 and 15.
  3925. * @param value the value to be added
  3926. * @returns the current updated matrix
  3927. */
  3928. addAtIndex(index: number, value: number): Matrix;
  3929. /**
  3930. * mutiply the specified position in the current Matrix by a value
  3931. * @param index the index of the value within the matrix. between 0 and 15.
  3932. * @param value the value to be added
  3933. * @returns the current updated matrix
  3934. */
  3935. multiplyAtIndex(index: number, value: number): Matrix;
  3936. /**
  3937. * Inserts the translation vector (using 3 floats) in the current matrix
  3938. * @param x defines the 1st component of the translation
  3939. * @param y defines the 2nd component of the translation
  3940. * @param z defines the 3rd component of the translation
  3941. * @returns the current updated matrix
  3942. */
  3943. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  3944. /**
  3945. * Adds the translation vector (using 3 floats) in the current matrix
  3946. * @param x defines the 1st component of the translation
  3947. * @param y defines the 2nd component of the translation
  3948. * @param z defines the 3rd component of the translation
  3949. * @returns the current updated matrix
  3950. */
  3951. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  3952. /**
  3953. * Inserts the translation vector in the current matrix
  3954. * @param vector3 defines the translation to insert
  3955. * @returns the current updated matrix
  3956. */
  3957. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  3958. /**
  3959. * Gets the translation value of the current matrix
  3960. * @returns a new Vector3 as the extracted translation from the matrix
  3961. */
  3962. getTranslation(): Vector3;
  3963. /**
  3964. * Fill a Vector3 with the extracted translation from the matrix
  3965. * @param result defines the Vector3 where to store the translation
  3966. * @returns the current matrix
  3967. */
  3968. getTranslationToRef(result: Vector3): Matrix;
  3969. /**
  3970. * Remove rotation and scaling part from the matrix
  3971. * @returns the updated matrix
  3972. */
  3973. removeRotationAndScaling(): Matrix;
  3974. /**
  3975. * Multiply two matrices
  3976. * @param other defines the second operand
  3977. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  3978. */
  3979. multiply(other: DeepImmutable<Matrix>): Matrix;
  3980. /**
  3981. * Copy the current matrix from the given one
  3982. * @param other defines the source matrix
  3983. * @returns the current updated matrix
  3984. */
  3985. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  3986. /**
  3987. * Populates the given array from the starting index with the current matrix values
  3988. * @param array defines the target array
  3989. * @param offset defines the offset in the target array where to start storing values
  3990. * @returns the current matrix
  3991. */
  3992. copyToArray(array: Float32Array, offset?: number): Matrix;
  3993. /**
  3994. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  3995. * @param other defines the second operand
  3996. * @param result defines the matrix where to store the multiplication
  3997. * @returns the current matrix
  3998. */
  3999. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4000. /**
  4001. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4002. * @param other defines the second operand
  4003. * @param result defines the array where to store the multiplication
  4004. * @param offset defines the offset in the target array where to start storing values
  4005. * @returns the current matrix
  4006. */
  4007. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  4008. /**
  4009. * Check equality between this matrix and a second one
  4010. * @param value defines the second matrix to compare
  4011. * @returns true is the current matrix and the given one values are strictly equal
  4012. */
  4013. equals(value: DeepImmutable<Matrix>): boolean;
  4014. /**
  4015. * Clone the current matrix
  4016. * @returns a new matrix from the current matrix
  4017. */
  4018. clone(): Matrix;
  4019. /**
  4020. * Returns the name of the current matrix class
  4021. * @returns the string "Matrix"
  4022. */
  4023. getClassName(): string;
  4024. /**
  4025. * Gets the hash code of the current matrix
  4026. * @returns the hash code
  4027. */
  4028. getHashCode(): number;
  4029. /**
  4030. * Decomposes the current Matrix into a translation, rotation and scaling components
  4031. * @param scale defines the scale vector3 given as a reference to update
  4032. * @param rotation defines the rotation quaternion given as a reference to update
  4033. * @param translation defines the translation vector3 given as a reference to update
  4034. * @returns true if operation was successful
  4035. */
  4036. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4037. /**
  4038. * Gets specific row of the matrix
  4039. * @param index defines the number of the row to get
  4040. * @returns the index-th row of the current matrix as a new Vector4
  4041. */
  4042. getRow(index: number): Nullable<Vector4>;
  4043. /**
  4044. * Sets the index-th row of the current matrix to the vector4 values
  4045. * @param index defines the number of the row to set
  4046. * @param row defines the target vector4
  4047. * @returns the updated current matrix
  4048. */
  4049. setRow(index: number, row: Vector4): Matrix;
  4050. /**
  4051. * Compute the transpose of the matrix
  4052. * @returns the new transposed matrix
  4053. */
  4054. transpose(): Matrix;
  4055. /**
  4056. * Compute the transpose of the matrix and store it in a given matrix
  4057. * @param result defines the target matrix
  4058. * @returns the current matrix
  4059. */
  4060. transposeToRef(result: Matrix): Matrix;
  4061. /**
  4062. * Sets the index-th row of the current matrix with the given 4 x float values
  4063. * @param index defines the row index
  4064. * @param x defines the x component to set
  4065. * @param y defines the y component to set
  4066. * @param z defines the z component to set
  4067. * @param w defines the w component to set
  4068. * @returns the updated current matrix
  4069. */
  4070. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4071. /**
  4072. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4073. * @param scale defines the scale factor
  4074. * @returns a new matrix
  4075. */
  4076. scale(scale: number): Matrix;
  4077. /**
  4078. * Scale the current matrix values by a factor to a given result matrix
  4079. * @param scale defines the scale factor
  4080. * @param result defines the matrix to store the result
  4081. * @returns the current matrix
  4082. */
  4083. scaleToRef(scale: number, result: Matrix): Matrix;
  4084. /**
  4085. * Scale the current matrix values by a factor and add the result to a given matrix
  4086. * @param scale defines the scale factor
  4087. * @param result defines the Matrix to store the result
  4088. * @returns the current matrix
  4089. */
  4090. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4091. /**
  4092. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4093. * @param ref matrix to store the result
  4094. */
  4095. toNormalMatrix(ref: Matrix): void;
  4096. /**
  4097. * Gets only rotation part of the current matrix
  4098. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4099. */
  4100. getRotationMatrix(): Matrix;
  4101. /**
  4102. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4103. * @param result defines the target matrix to store data to
  4104. * @returns the current matrix
  4105. */
  4106. getRotationMatrixToRef(result: Matrix): Matrix;
  4107. /**
  4108. * Toggles model matrix from being right handed to left handed in place and vice versa
  4109. */
  4110. toggleModelMatrixHandInPlace(): void;
  4111. /**
  4112. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4113. */
  4114. toggleProjectionMatrixHandInPlace(): void;
  4115. /**
  4116. * Creates a matrix from an array
  4117. * @param array defines the source array
  4118. * @param offset defines an offset in the source array
  4119. * @returns a new Matrix set from the starting index of the given array
  4120. */
  4121. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4122. /**
  4123. * Copy the content of an array into a given matrix
  4124. * @param array defines the source array
  4125. * @param offset defines an offset in the source array
  4126. * @param result defines the target matrix
  4127. */
  4128. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4129. /**
  4130. * Stores an array into a matrix after having multiplied each component by a given factor
  4131. * @param array defines the source array
  4132. * @param offset defines the offset in the source array
  4133. * @param scale defines the scaling factor
  4134. * @param result defines the target matrix
  4135. */
  4136. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  4137. /**
  4138. * Gets an identity matrix that must not be updated
  4139. */
  4140. static readonly IdentityReadOnly: DeepImmutable<Matrix>;
  4141. /**
  4142. * Stores a list of values (16) inside a given matrix
  4143. * @param initialM11 defines 1st value of 1st row
  4144. * @param initialM12 defines 2nd value of 1st row
  4145. * @param initialM13 defines 3rd value of 1st row
  4146. * @param initialM14 defines 4th value of 1st row
  4147. * @param initialM21 defines 1st value of 2nd row
  4148. * @param initialM22 defines 2nd value of 2nd row
  4149. * @param initialM23 defines 3rd value of 2nd row
  4150. * @param initialM24 defines 4th value of 2nd row
  4151. * @param initialM31 defines 1st value of 3rd row
  4152. * @param initialM32 defines 2nd value of 3rd row
  4153. * @param initialM33 defines 3rd value of 3rd row
  4154. * @param initialM34 defines 4th value of 3rd row
  4155. * @param initialM41 defines 1st value of 4th row
  4156. * @param initialM42 defines 2nd value of 4th row
  4157. * @param initialM43 defines 3rd value of 4th row
  4158. * @param initialM44 defines 4th value of 4th row
  4159. * @param result defines the target matrix
  4160. */
  4161. static FromValuesToRef(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number, result: Matrix): void;
  4162. /**
  4163. * Creates new matrix from a list of values (16)
  4164. * @param initialM11 defines 1st value of 1st row
  4165. * @param initialM12 defines 2nd value of 1st row
  4166. * @param initialM13 defines 3rd value of 1st row
  4167. * @param initialM14 defines 4th value of 1st row
  4168. * @param initialM21 defines 1st value of 2nd row
  4169. * @param initialM22 defines 2nd value of 2nd row
  4170. * @param initialM23 defines 3rd value of 2nd row
  4171. * @param initialM24 defines 4th value of 2nd row
  4172. * @param initialM31 defines 1st value of 3rd row
  4173. * @param initialM32 defines 2nd value of 3rd row
  4174. * @param initialM33 defines 3rd value of 3rd row
  4175. * @param initialM34 defines 4th value of 3rd row
  4176. * @param initialM41 defines 1st value of 4th row
  4177. * @param initialM42 defines 2nd value of 4th row
  4178. * @param initialM43 defines 3rd value of 4th row
  4179. * @param initialM44 defines 4th value of 4th row
  4180. * @returns the new matrix
  4181. */
  4182. static FromValues(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number): Matrix;
  4183. /**
  4184. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4185. * @param scale defines the scale vector3
  4186. * @param rotation defines the rotation quaternion
  4187. * @param translation defines the translation vector3
  4188. * @returns a new matrix
  4189. */
  4190. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4191. /**
  4192. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4193. * @param scale defines the scale vector3
  4194. * @param rotation defines the rotation quaternion
  4195. * @param translation defines the translation vector3
  4196. * @param result defines the target matrix
  4197. */
  4198. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4199. /**
  4200. * Creates a new identity matrix
  4201. * @returns a new identity matrix
  4202. */
  4203. static Identity(): Matrix;
  4204. /**
  4205. * Creates a new identity matrix and stores the result in a given matrix
  4206. * @param result defines the target matrix
  4207. */
  4208. static IdentityToRef(result: Matrix): void;
  4209. /**
  4210. * Creates a new zero matrix
  4211. * @returns a new zero matrix
  4212. */
  4213. static Zero(): Matrix;
  4214. /**
  4215. * Creates a new rotation matrix for "angle" radians around the X axis
  4216. * @param angle defines the angle (in radians) to use
  4217. * @return the new matrix
  4218. */
  4219. static RotationX(angle: number): Matrix;
  4220. /**
  4221. * Creates a new matrix as the invert of a given matrix
  4222. * @param source defines the source matrix
  4223. * @returns the new matrix
  4224. */
  4225. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4226. /**
  4227. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4228. * @param angle defines the angle (in radians) to use
  4229. * @param result defines the target matrix
  4230. */
  4231. static RotationXToRef(angle: number, result: Matrix): void;
  4232. /**
  4233. * Creates a new rotation matrix for "angle" radians around the Y axis
  4234. * @param angle defines the angle (in radians) to use
  4235. * @return the new matrix
  4236. */
  4237. static RotationY(angle: number): Matrix;
  4238. /**
  4239. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4240. * @param angle defines the angle (in radians) to use
  4241. * @param result defines the target matrix
  4242. */
  4243. static RotationYToRef(angle: number, result: Matrix): void;
  4244. /**
  4245. * Creates a new rotation matrix for "angle" radians around the Z axis
  4246. * @param angle defines the angle (in radians) to use
  4247. * @return the new matrix
  4248. */
  4249. static RotationZ(angle: number): Matrix;
  4250. /**
  4251. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4252. * @param angle defines the angle (in radians) to use
  4253. * @param result defines the target matrix
  4254. */
  4255. static RotationZToRef(angle: number, result: Matrix): void;
  4256. /**
  4257. * Creates a new rotation matrix for "angle" radians around the given axis
  4258. * @param axis defines the axis to use
  4259. * @param angle defines the angle (in radians) to use
  4260. * @return the new matrix
  4261. */
  4262. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4263. /**
  4264. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4265. * @param axis defines the axis to use
  4266. * @param angle defines the angle (in radians) to use
  4267. * @param result defines the target matrix
  4268. */
  4269. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4270. /**
  4271. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4272. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4273. * @param from defines the vector to align
  4274. * @param to defines the vector to align to
  4275. * @param result defines the target matrix
  4276. */
  4277. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4278. /**
  4279. * Creates a rotation matrix
  4280. * @param yaw defines the yaw angle in radians (Y axis)
  4281. * @param pitch defines the pitch angle in radians (X axis)
  4282. * @param roll defines the roll angle in radians (X axis)
  4283. * @returns the new rotation matrix
  4284. */
  4285. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4286. /**
  4287. * Creates a rotation matrix and stores it in a given matrix
  4288. * @param yaw defines the yaw angle in radians (Y axis)
  4289. * @param pitch defines the pitch angle in radians (X axis)
  4290. * @param roll defines the roll angle in radians (X axis)
  4291. * @param result defines the target matrix
  4292. */
  4293. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4294. /**
  4295. * Creates a scaling matrix
  4296. * @param x defines the scale factor on X axis
  4297. * @param y defines the scale factor on Y axis
  4298. * @param z defines the scale factor on Z axis
  4299. * @returns the new matrix
  4300. */
  4301. static Scaling(x: number, y: number, z: number): Matrix;
  4302. /**
  4303. * Creates a scaling matrix and stores it in a given matrix
  4304. * @param x defines the scale factor on X axis
  4305. * @param y defines the scale factor on Y axis
  4306. * @param z defines the scale factor on Z axis
  4307. * @param result defines the target matrix
  4308. */
  4309. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4310. /**
  4311. * Creates a translation matrix
  4312. * @param x defines the translation on X axis
  4313. * @param y defines the translation on Y axis
  4314. * @param z defines the translationon Z axis
  4315. * @returns the new matrix
  4316. */
  4317. static Translation(x: number, y: number, z: number): Matrix;
  4318. /**
  4319. * Creates a translation matrix and stores it in a given matrix
  4320. * @param x defines the translation on X axis
  4321. * @param y defines the translation on Y axis
  4322. * @param z defines the translationon Z axis
  4323. * @param result defines the target matrix
  4324. */
  4325. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4326. /**
  4327. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4328. * @param startValue defines the start value
  4329. * @param endValue defines the end value
  4330. * @param gradient defines the gradient factor
  4331. * @returns the new matrix
  4332. */
  4333. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4334. /**
  4335. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4336. * @param startValue defines the start value
  4337. * @param endValue defines the end value
  4338. * @param gradient defines the gradient factor
  4339. * @param result defines the Matrix object where to store data
  4340. */
  4341. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4342. /**
  4343. * Builds a new matrix whose values are computed by:
  4344. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4345. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4346. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4347. * @param startValue defines the first matrix
  4348. * @param endValue defines the second matrix
  4349. * @param gradient defines the gradient between the two matrices
  4350. * @returns the new matrix
  4351. */
  4352. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4353. /**
  4354. * Update a matrix to values which are computed by:
  4355. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4356. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4357. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4358. * @param startValue defines the first matrix
  4359. * @param endValue defines the second matrix
  4360. * @param gradient defines the gradient between the two matrices
  4361. * @param result defines the target matrix
  4362. */
  4363. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4364. /**
  4365. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4366. * This function works in left handed mode
  4367. * @param eye defines the final position of the entity
  4368. * @param target defines where the entity should look at
  4369. * @param up defines the up vector for the entity
  4370. * @returns the new matrix
  4371. */
  4372. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4373. /**
  4374. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4375. * This function works in left handed mode
  4376. * @param eye defines the final position of the entity
  4377. * @param target defines where the entity should look at
  4378. * @param up defines the up vector for the entity
  4379. * @param result defines the target matrix
  4380. */
  4381. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4382. /**
  4383. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4384. * This function works in right handed mode
  4385. * @param eye defines the final position of the entity
  4386. * @param target defines where the entity should look at
  4387. * @param up defines the up vector for the entity
  4388. * @returns the new matrix
  4389. */
  4390. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4391. /**
  4392. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4393. * This function works in right handed mode
  4394. * @param eye defines the final position of the entity
  4395. * @param target defines where the entity should look at
  4396. * @param up defines the up vector for the entity
  4397. * @param result defines the target matrix
  4398. */
  4399. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4400. /**
  4401. * Create a left-handed orthographic projection matrix
  4402. * @param width defines the viewport width
  4403. * @param height defines the viewport height
  4404. * @param znear defines the near clip plane
  4405. * @param zfar defines the far clip plane
  4406. * @returns a new matrix as a left-handed orthographic projection matrix
  4407. */
  4408. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4409. /**
  4410. * Store a left-handed orthographic projection to a given matrix
  4411. * @param width defines the viewport width
  4412. * @param height defines the viewport height
  4413. * @param znear defines the near clip plane
  4414. * @param zfar defines the far clip plane
  4415. * @param result defines the target matrix
  4416. */
  4417. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4418. /**
  4419. * Create a left-handed orthographic projection matrix
  4420. * @param left defines the viewport left coordinate
  4421. * @param right defines the viewport right coordinate
  4422. * @param bottom defines the viewport bottom coordinate
  4423. * @param top defines the viewport top coordinate
  4424. * @param znear defines the near clip plane
  4425. * @param zfar defines the far clip plane
  4426. * @returns a new matrix as a left-handed orthographic projection matrix
  4427. */
  4428. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4429. /**
  4430. * Stores a left-handed orthographic projection into a given matrix
  4431. * @param left defines the viewport left coordinate
  4432. * @param right defines the viewport right coordinate
  4433. * @param bottom defines the viewport bottom coordinate
  4434. * @param top defines the viewport top coordinate
  4435. * @param znear defines the near clip plane
  4436. * @param zfar defines the far clip plane
  4437. * @param result defines the target matrix
  4438. */
  4439. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4440. /**
  4441. * Creates a right-handed orthographic projection matrix
  4442. * @param left defines the viewport left coordinate
  4443. * @param right defines the viewport right coordinate
  4444. * @param bottom defines the viewport bottom coordinate
  4445. * @param top defines the viewport top coordinate
  4446. * @param znear defines the near clip plane
  4447. * @param zfar defines the far clip plane
  4448. * @returns a new matrix as a right-handed orthographic projection matrix
  4449. */
  4450. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4451. /**
  4452. * Stores a right-handed orthographic projection into a given matrix
  4453. * @param left defines the viewport left coordinate
  4454. * @param right defines the viewport right coordinate
  4455. * @param bottom defines the viewport bottom coordinate
  4456. * @param top defines the viewport top coordinate
  4457. * @param znear defines the near clip plane
  4458. * @param zfar defines the far clip plane
  4459. * @param result defines the target matrix
  4460. */
  4461. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4462. /**
  4463. * Creates a left-handed perspective projection matrix
  4464. * @param width defines the viewport width
  4465. * @param height defines the viewport height
  4466. * @param znear defines the near clip plane
  4467. * @param zfar defines the far clip plane
  4468. * @returns a new matrix as a left-handed perspective projection matrix
  4469. */
  4470. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4471. /**
  4472. * Creates a left-handed perspective projection matrix
  4473. * @param fov defines the horizontal field of view
  4474. * @param aspect defines the aspect ratio
  4475. * @param znear defines the near clip plane
  4476. * @param zfar defines the far clip plane
  4477. * @returns a new matrix as a left-handed perspective projection matrix
  4478. */
  4479. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4480. /**
  4481. * Stores a left-handed perspective projection into a given matrix
  4482. * @param fov defines the horizontal field of view
  4483. * @param aspect defines the aspect ratio
  4484. * @param znear defines the near clip plane
  4485. * @param zfar defines the far clip plane
  4486. * @param result defines the target matrix
  4487. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4488. */
  4489. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4490. /**
  4491. * Creates a right-handed perspective projection matrix
  4492. * @param fov defines the horizontal field of view
  4493. * @param aspect defines the aspect ratio
  4494. * @param znear defines the near clip plane
  4495. * @param zfar defines the far clip plane
  4496. * @returns a new matrix as a right-handed perspective projection matrix
  4497. */
  4498. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4499. /**
  4500. * Stores a right-handed perspective projection into a given matrix
  4501. * @param fov defines the horizontal field of view
  4502. * @param aspect defines the aspect ratio
  4503. * @param znear defines the near clip plane
  4504. * @param zfar defines the far clip plane
  4505. * @param result defines the target matrix
  4506. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4507. */
  4508. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4509. /**
  4510. * Stores a perspective projection for WebVR info a given matrix
  4511. * @param fov defines the field of view
  4512. * @param znear defines the near clip plane
  4513. * @param zfar defines the far clip plane
  4514. * @param result defines the target matrix
  4515. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4516. */
  4517. static PerspectiveFovWebVRToRef(fov: {
  4518. upDegrees: number;
  4519. downDegrees: number;
  4520. leftDegrees: number;
  4521. rightDegrees: number;
  4522. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4523. /**
  4524. * Computes a complete transformation matrix
  4525. * @param viewport defines the viewport to use
  4526. * @param world defines the world matrix
  4527. * @param view defines the view matrix
  4528. * @param projection defines the projection matrix
  4529. * @param zmin defines the near clip plane
  4530. * @param zmax defines the far clip plane
  4531. * @returns the transformation matrix
  4532. */
  4533. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4534. /**
  4535. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4536. * @param matrix defines the matrix to use
  4537. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4538. */
  4539. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  4540. /**
  4541. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4542. * @param matrix defines the matrix to use
  4543. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4544. */
  4545. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  4546. /**
  4547. * Compute the transpose of a given matrix
  4548. * @param matrix defines the matrix to transpose
  4549. * @returns the new matrix
  4550. */
  4551. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4552. /**
  4553. * Compute the transpose of a matrix and store it in a target matrix
  4554. * @param matrix defines the matrix to transpose
  4555. * @param result defines the target matrix
  4556. */
  4557. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4558. /**
  4559. * Computes a reflection matrix from a plane
  4560. * @param plane defines the reflection plane
  4561. * @returns a new matrix
  4562. */
  4563. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4564. /**
  4565. * Computes a reflection matrix from a plane
  4566. * @param plane defines the reflection plane
  4567. * @param result defines the target matrix
  4568. */
  4569. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4570. /**
  4571. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4572. * @param xaxis defines the value of the 1st axis
  4573. * @param yaxis defines the value of the 2nd axis
  4574. * @param zaxis defines the value of the 3rd axis
  4575. * @param result defines the target matrix
  4576. */
  4577. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4578. /**
  4579. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4580. * @param quat defines the quaternion to use
  4581. * @param result defines the target matrix
  4582. */
  4583. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4584. }
  4585. /**
  4586. * @hidden
  4587. */
  4588. export class TmpVectors {
  4589. static Vector2: Vector2[];
  4590. static Vector3: Vector3[];
  4591. static Vector4: Vector4[];
  4592. static Quaternion: Quaternion[];
  4593. static Matrix: Matrix[];
  4594. }
  4595. }
  4596. declare module "babylonjs/Maths/math.path" {
  4597. import { DeepImmutable, Nullable } from "babylonjs/types";
  4598. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4599. /**
  4600. * Defines potential orientation for back face culling
  4601. */
  4602. export enum Orientation {
  4603. /**
  4604. * Clockwise
  4605. */
  4606. CW = 0,
  4607. /** Counter clockwise */
  4608. CCW = 1
  4609. }
  4610. /** Class used to represent a Bezier curve */
  4611. export class BezierCurve {
  4612. /**
  4613. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4614. * @param t defines the time
  4615. * @param x1 defines the left coordinate on X axis
  4616. * @param y1 defines the left coordinate on Y axis
  4617. * @param x2 defines the right coordinate on X axis
  4618. * @param y2 defines the right coordinate on Y axis
  4619. * @returns the interpolated value
  4620. */
  4621. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4622. }
  4623. /**
  4624. * Defines angle representation
  4625. */
  4626. export class Angle {
  4627. private _radians;
  4628. /**
  4629. * Creates an Angle object of "radians" radians (float).
  4630. * @param radians the angle in radians
  4631. */
  4632. constructor(radians: number);
  4633. /**
  4634. * Get value in degrees
  4635. * @returns the Angle value in degrees (float)
  4636. */
  4637. degrees(): number;
  4638. /**
  4639. * Get value in radians
  4640. * @returns the Angle value in radians (float)
  4641. */
  4642. radians(): number;
  4643. /**
  4644. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  4645. * @param a defines first vector
  4646. * @param b defines second vector
  4647. * @returns a new Angle
  4648. */
  4649. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4650. /**
  4651. * Gets a new Angle object from the given float in radians
  4652. * @param radians defines the angle value in radians
  4653. * @returns a new Angle
  4654. */
  4655. static FromRadians(radians: number): Angle;
  4656. /**
  4657. * Gets a new Angle object from the given float in degrees
  4658. * @param degrees defines the angle value in degrees
  4659. * @returns a new Angle
  4660. */
  4661. static FromDegrees(degrees: number): Angle;
  4662. }
  4663. /**
  4664. * This represents an arc in a 2d space.
  4665. */
  4666. export class Arc2 {
  4667. /** Defines the start point of the arc */
  4668. startPoint: Vector2;
  4669. /** Defines the mid point of the arc */
  4670. midPoint: Vector2;
  4671. /** Defines the end point of the arc */
  4672. endPoint: Vector2;
  4673. /**
  4674. * Defines the center point of the arc.
  4675. */
  4676. centerPoint: Vector2;
  4677. /**
  4678. * Defines the radius of the arc.
  4679. */
  4680. radius: number;
  4681. /**
  4682. * Defines the angle of the arc (from mid point to end point).
  4683. */
  4684. angle: Angle;
  4685. /**
  4686. * Defines the start angle of the arc (from start point to middle point).
  4687. */
  4688. startAngle: Angle;
  4689. /**
  4690. * Defines the orientation of the arc (clock wise/counter clock wise).
  4691. */
  4692. orientation: Orientation;
  4693. /**
  4694. * Creates an Arc object from the three given points : start, middle and end.
  4695. * @param startPoint Defines the start point of the arc
  4696. * @param midPoint Defines the midlle point of the arc
  4697. * @param endPoint Defines the end point of the arc
  4698. */
  4699. constructor(
  4700. /** Defines the start point of the arc */
  4701. startPoint: Vector2,
  4702. /** Defines the mid point of the arc */
  4703. midPoint: Vector2,
  4704. /** Defines the end point of the arc */
  4705. endPoint: Vector2);
  4706. }
  4707. /**
  4708. * Represents a 2D path made up of multiple 2D points
  4709. */
  4710. export class Path2 {
  4711. private _points;
  4712. private _length;
  4713. /**
  4714. * If the path start and end point are the same
  4715. */
  4716. closed: boolean;
  4717. /**
  4718. * Creates a Path2 object from the starting 2D coordinates x and y.
  4719. * @param x the starting points x value
  4720. * @param y the starting points y value
  4721. */
  4722. constructor(x: number, y: number);
  4723. /**
  4724. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  4725. * @param x the added points x value
  4726. * @param y the added points y value
  4727. * @returns the updated Path2.
  4728. */
  4729. addLineTo(x: number, y: number): Path2;
  4730. /**
  4731. * Adds _numberOfSegments_ segments according to the arc definition (middle point coordinates, end point coordinates, the arc start point being the current Path2 last point) to the current Path2.
  4732. * @param midX middle point x value
  4733. * @param midY middle point y value
  4734. * @param endX end point x value
  4735. * @param endY end point y value
  4736. * @param numberOfSegments (default: 36)
  4737. * @returns the updated Path2.
  4738. */
  4739. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  4740. /**
  4741. * Closes the Path2.
  4742. * @returns the Path2.
  4743. */
  4744. close(): Path2;
  4745. /**
  4746. * Gets the sum of the distance between each sequential point in the path
  4747. * @returns the Path2 total length (float).
  4748. */
  4749. length(): number;
  4750. /**
  4751. * Gets the points which construct the path
  4752. * @returns the Path2 internal array of points.
  4753. */
  4754. getPoints(): Vector2[];
  4755. /**
  4756. * Retreives the point at the distance aways from the starting point
  4757. * @param normalizedLengthPosition the length along the path to retreive the point from
  4758. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  4759. */
  4760. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  4761. /**
  4762. * Creates a new path starting from an x and y position
  4763. * @param x starting x value
  4764. * @param y starting y value
  4765. * @returns a new Path2 starting at the coordinates (x, y).
  4766. */
  4767. static StartingAt(x: number, y: number): Path2;
  4768. }
  4769. /**
  4770. * Represents a 3D path made up of multiple 3D points
  4771. */
  4772. export class Path3D {
  4773. /**
  4774. * an array of Vector3, the curve axis of the Path3D
  4775. */
  4776. path: Vector3[];
  4777. private _curve;
  4778. private _distances;
  4779. private _tangents;
  4780. private _normals;
  4781. private _binormals;
  4782. private _raw;
  4783. /**
  4784. * new Path3D(path, normal, raw)
  4785. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  4786. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  4787. * @param path an array of Vector3, the curve axis of the Path3D
  4788. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  4789. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  4790. */
  4791. constructor(
  4792. /**
  4793. * an array of Vector3, the curve axis of the Path3D
  4794. */
  4795. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean);
  4796. /**
  4797. * Returns the Path3D array of successive Vector3 designing its curve.
  4798. * @returns the Path3D array of successive Vector3 designing its curve.
  4799. */
  4800. getCurve(): Vector3[];
  4801. /**
  4802. * Returns an array populated with tangent vectors on each Path3D curve point.
  4803. * @returns an array populated with tangent vectors on each Path3D curve point.
  4804. */
  4805. getTangents(): Vector3[];
  4806. /**
  4807. * Returns an array populated with normal vectors on each Path3D curve point.
  4808. * @returns an array populated with normal vectors on each Path3D curve point.
  4809. */
  4810. getNormals(): Vector3[];
  4811. /**
  4812. * Returns an array populated with binormal vectors on each Path3D curve point.
  4813. * @returns an array populated with binormal vectors on each Path3D curve point.
  4814. */
  4815. getBinormals(): Vector3[];
  4816. /**
  4817. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  4818. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  4819. */
  4820. getDistances(): number[];
  4821. /**
  4822. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  4823. * @param path path which all values are copied into the curves points
  4824. * @param firstNormal which should be projected onto the curve
  4825. * @returns the same object updated.
  4826. */
  4827. update(path: Vector3[], firstNormal?: Nullable<Vector3>): Path3D;
  4828. private _compute;
  4829. private _getFirstNonNullVector;
  4830. private _getLastNonNullVector;
  4831. private _normalVector;
  4832. }
  4833. /**
  4834. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  4835. * A Curve3 is designed from a series of successive Vector3.
  4836. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  4837. */
  4838. export class Curve3 {
  4839. private _points;
  4840. private _length;
  4841. /**
  4842. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  4843. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  4844. * @param v1 (Vector3) the control point
  4845. * @param v2 (Vector3) the end point of the Quadratic Bezier
  4846. * @param nbPoints (integer) the wanted number of points in the curve
  4847. * @returns the created Curve3
  4848. */
  4849. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4850. /**
  4851. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  4852. * @param v0 (Vector3) the origin point of the Cubic Bezier
  4853. * @param v1 (Vector3) the first control point
  4854. * @param v2 (Vector3) the second control point
  4855. * @param v3 (Vector3) the end point of the Cubic Bezier
  4856. * @param nbPoints (integer) the wanted number of points in the curve
  4857. * @returns the created Curve3
  4858. */
  4859. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4860. /**
  4861. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  4862. * @param p1 (Vector3) the origin point of the Hermite Spline
  4863. * @param t1 (Vector3) the tangent vector at the origin point
  4864. * @param p2 (Vector3) the end point of the Hermite Spline
  4865. * @param t2 (Vector3) the tangent vector at the end point
  4866. * @param nbPoints (integer) the wanted number of points in the curve
  4867. * @returns the created Curve3
  4868. */
  4869. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4870. /**
  4871. * Returns a Curve3 object along a CatmullRom Spline curve :
  4872. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  4873. * @param nbPoints (integer) the wanted number of points between each curve control points
  4874. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  4875. * @returns the created Curve3
  4876. */
  4877. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  4878. /**
  4879. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  4880. * A Curve3 is designed from a series of successive Vector3.
  4881. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  4882. * @param points points which make up the curve
  4883. */
  4884. constructor(points: Vector3[]);
  4885. /**
  4886. * @returns the Curve3 stored array of successive Vector3
  4887. */
  4888. getPoints(): Vector3[];
  4889. /**
  4890. * @returns the computed length (float) of the curve.
  4891. */
  4892. length(): number;
  4893. /**
  4894. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  4895. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  4896. * curveA and curveB keep unchanged.
  4897. * @param curve the curve to continue from this curve
  4898. * @returns the newly constructed curve
  4899. */
  4900. continue(curve: DeepImmutable<Curve3>): Curve3;
  4901. private _computeLength;
  4902. }
  4903. }
  4904. declare module "babylonjs/Animations/easing" {
  4905. /**
  4906. * This represents the main contract an easing function should follow.
  4907. * Easing functions are used throughout the animation system.
  4908. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4909. */
  4910. export interface IEasingFunction {
  4911. /**
  4912. * Given an input gradient between 0 and 1, this returns the corrseponding value
  4913. * of the easing function.
  4914. * The link below provides some of the most common examples of easing functions.
  4915. * @see https://easings.net/
  4916. * @param gradient Defines the value between 0 and 1 we want the easing value for
  4917. * @returns the corresponding value on the curve defined by the easing function
  4918. */
  4919. ease(gradient: number): number;
  4920. }
  4921. /**
  4922. * Base class used for every default easing function.
  4923. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4924. */
  4925. export class EasingFunction implements IEasingFunction {
  4926. /**
  4927. * Interpolation follows the mathematical formula associated with the easing function.
  4928. */
  4929. static readonly EASINGMODE_EASEIN: number;
  4930. /**
  4931. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  4932. */
  4933. static readonly EASINGMODE_EASEOUT: number;
  4934. /**
  4935. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  4936. */
  4937. static readonly EASINGMODE_EASEINOUT: number;
  4938. private _easingMode;
  4939. /**
  4940. * Sets the easing mode of the current function.
  4941. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  4942. */
  4943. setEasingMode(easingMode: number): void;
  4944. /**
  4945. * Gets the current easing mode.
  4946. * @returns the easing mode
  4947. */
  4948. getEasingMode(): number;
  4949. /**
  4950. * @hidden
  4951. */
  4952. easeInCore(gradient: number): number;
  4953. /**
  4954. * Given an input gradient between 0 and 1, this returns the corresponding value
  4955. * of the easing function.
  4956. * @param gradient Defines the value between 0 and 1 we want the easing value for
  4957. * @returns the corresponding value on the curve defined by the easing function
  4958. */
  4959. ease(gradient: number): number;
  4960. }
  4961. /**
  4962. * Easing function with a circle shape (see link below).
  4963. * @see https://easings.net/#easeInCirc
  4964. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4965. */
  4966. export class CircleEase extends EasingFunction implements IEasingFunction {
  4967. /** @hidden */
  4968. easeInCore(gradient: number): number;
  4969. }
  4970. /**
  4971. * Easing function with a ease back shape (see link below).
  4972. * @see https://easings.net/#easeInBack
  4973. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4974. */
  4975. export class BackEase extends EasingFunction implements IEasingFunction {
  4976. /** Defines the amplitude of the function */
  4977. amplitude: number;
  4978. /**
  4979. * Instantiates a back ease easing
  4980. * @see https://easings.net/#easeInBack
  4981. * @param amplitude Defines the amplitude of the function
  4982. */
  4983. constructor(
  4984. /** Defines the amplitude of the function */
  4985. amplitude?: number);
  4986. /** @hidden */
  4987. easeInCore(gradient: number): number;
  4988. }
  4989. /**
  4990. * Easing function with a bouncing shape (see link below).
  4991. * @see https://easings.net/#easeInBounce
  4992. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4993. */
  4994. export class BounceEase extends EasingFunction implements IEasingFunction {
  4995. /** Defines the number of bounces */
  4996. bounces: number;
  4997. /** Defines the amplitude of the bounce */
  4998. bounciness: number;
  4999. /**
  5000. * Instantiates a bounce easing
  5001. * @see https://easings.net/#easeInBounce
  5002. * @param bounces Defines the number of bounces
  5003. * @param bounciness Defines the amplitude of the bounce
  5004. */
  5005. constructor(
  5006. /** Defines the number of bounces */
  5007. bounces?: number,
  5008. /** Defines the amplitude of the bounce */
  5009. bounciness?: number);
  5010. /** @hidden */
  5011. easeInCore(gradient: number): number;
  5012. }
  5013. /**
  5014. * Easing function with a power of 3 shape (see link below).
  5015. * @see https://easings.net/#easeInCubic
  5016. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5017. */
  5018. export class CubicEase extends EasingFunction implements IEasingFunction {
  5019. /** @hidden */
  5020. easeInCore(gradient: number): number;
  5021. }
  5022. /**
  5023. * Easing function with an elastic shape (see link below).
  5024. * @see https://easings.net/#easeInElastic
  5025. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5026. */
  5027. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5028. /** Defines the number of oscillations*/
  5029. oscillations: number;
  5030. /** Defines the amplitude of the oscillations*/
  5031. springiness: number;
  5032. /**
  5033. * Instantiates an elastic easing function
  5034. * @see https://easings.net/#easeInElastic
  5035. * @param oscillations Defines the number of oscillations
  5036. * @param springiness Defines the amplitude of the oscillations
  5037. */
  5038. constructor(
  5039. /** Defines the number of oscillations*/
  5040. oscillations?: number,
  5041. /** Defines the amplitude of the oscillations*/
  5042. springiness?: number);
  5043. /** @hidden */
  5044. easeInCore(gradient: number): number;
  5045. }
  5046. /**
  5047. * Easing function with an exponential shape (see link below).
  5048. * @see https://easings.net/#easeInExpo
  5049. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5050. */
  5051. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5052. /** Defines the exponent of the function */
  5053. exponent: number;
  5054. /**
  5055. * Instantiates an exponential easing function
  5056. * @see https://easings.net/#easeInExpo
  5057. * @param exponent Defines the exponent of the function
  5058. */
  5059. constructor(
  5060. /** Defines the exponent of the function */
  5061. exponent?: number);
  5062. /** @hidden */
  5063. easeInCore(gradient: number): number;
  5064. }
  5065. /**
  5066. * Easing function with a power shape (see link below).
  5067. * @see https://easings.net/#easeInQuad
  5068. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5069. */
  5070. export class PowerEase extends EasingFunction implements IEasingFunction {
  5071. /** Defines the power of the function */
  5072. power: number;
  5073. /**
  5074. * Instantiates an power base easing function
  5075. * @see https://easings.net/#easeInQuad
  5076. * @param power Defines the power of the function
  5077. */
  5078. constructor(
  5079. /** Defines the power of the function */
  5080. power?: number);
  5081. /** @hidden */
  5082. easeInCore(gradient: number): number;
  5083. }
  5084. /**
  5085. * Easing function with a power of 2 shape (see link below).
  5086. * @see https://easings.net/#easeInQuad
  5087. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5088. */
  5089. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5090. /** @hidden */
  5091. easeInCore(gradient: number): number;
  5092. }
  5093. /**
  5094. * Easing function with a power of 4 shape (see link below).
  5095. * @see https://easings.net/#easeInQuart
  5096. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5097. */
  5098. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5099. /** @hidden */
  5100. easeInCore(gradient: number): number;
  5101. }
  5102. /**
  5103. * Easing function with a power of 5 shape (see link below).
  5104. * @see https://easings.net/#easeInQuint
  5105. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5106. */
  5107. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5108. /** @hidden */
  5109. easeInCore(gradient: number): number;
  5110. }
  5111. /**
  5112. * Easing function with a sin shape (see link below).
  5113. * @see https://easings.net/#easeInSine
  5114. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5115. */
  5116. export class SineEase extends EasingFunction implements IEasingFunction {
  5117. /** @hidden */
  5118. easeInCore(gradient: number): number;
  5119. }
  5120. /**
  5121. * Easing function with a bezier shape (see link below).
  5122. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5123. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5124. */
  5125. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5126. /** Defines the x component of the start tangent in the bezier curve */
  5127. x1: number;
  5128. /** Defines the y component of the start tangent in the bezier curve */
  5129. y1: number;
  5130. /** Defines the x component of the end tangent in the bezier curve */
  5131. x2: number;
  5132. /** Defines the y component of the end tangent in the bezier curve */
  5133. y2: number;
  5134. /**
  5135. * Instantiates a bezier function
  5136. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5137. * @param x1 Defines the x component of the start tangent in the bezier curve
  5138. * @param y1 Defines the y component of the start tangent in the bezier curve
  5139. * @param x2 Defines the x component of the end tangent in the bezier curve
  5140. * @param y2 Defines the y component of the end tangent in the bezier curve
  5141. */
  5142. constructor(
  5143. /** Defines the x component of the start tangent in the bezier curve */
  5144. x1?: number,
  5145. /** Defines the y component of the start tangent in the bezier curve */
  5146. y1?: number,
  5147. /** Defines the x component of the end tangent in the bezier curve */
  5148. x2?: number,
  5149. /** Defines the y component of the end tangent in the bezier curve */
  5150. y2?: number);
  5151. /** @hidden */
  5152. easeInCore(gradient: number): number;
  5153. }
  5154. }
  5155. declare module "babylonjs/Maths/math.color" {
  5156. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5157. /**
  5158. * Class used to hold a RBG color
  5159. */
  5160. export class Color3 {
  5161. /**
  5162. * Defines the red component (between 0 and 1, default is 0)
  5163. */
  5164. r: number;
  5165. /**
  5166. * Defines the green component (between 0 and 1, default is 0)
  5167. */
  5168. g: number;
  5169. /**
  5170. * Defines the blue component (between 0 and 1, default is 0)
  5171. */
  5172. b: number;
  5173. /**
  5174. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5175. * @param r defines the red component (between 0 and 1, default is 0)
  5176. * @param g defines the green component (between 0 and 1, default is 0)
  5177. * @param b defines the blue component (between 0 and 1, default is 0)
  5178. */
  5179. constructor(
  5180. /**
  5181. * Defines the red component (between 0 and 1, default is 0)
  5182. */
  5183. r?: number,
  5184. /**
  5185. * Defines the green component (between 0 and 1, default is 0)
  5186. */
  5187. g?: number,
  5188. /**
  5189. * Defines the blue component (between 0 and 1, default is 0)
  5190. */
  5191. b?: number);
  5192. /**
  5193. * Creates a string with the Color3 current values
  5194. * @returns the string representation of the Color3 object
  5195. */
  5196. toString(): string;
  5197. /**
  5198. * Returns the string "Color3"
  5199. * @returns "Color3"
  5200. */
  5201. getClassName(): string;
  5202. /**
  5203. * Compute the Color3 hash code
  5204. * @returns an unique number that can be used to hash Color3 objects
  5205. */
  5206. getHashCode(): number;
  5207. /**
  5208. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5209. * @param array defines the array where to store the r,g,b components
  5210. * @param index defines an optional index in the target array to define where to start storing values
  5211. * @returns the current Color3 object
  5212. */
  5213. toArray(array: FloatArray, index?: number): Color3;
  5214. /**
  5215. * Returns a new Color4 object from the current Color3 and the given alpha
  5216. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5217. * @returns a new Color4 object
  5218. */
  5219. toColor4(alpha?: number): Color4;
  5220. /**
  5221. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5222. * @returns the new array
  5223. */
  5224. asArray(): number[];
  5225. /**
  5226. * Returns the luminance value
  5227. * @returns a float value
  5228. */
  5229. toLuminance(): number;
  5230. /**
  5231. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5232. * @param otherColor defines the second operand
  5233. * @returns the new Color3 object
  5234. */
  5235. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5236. /**
  5237. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5238. * @param otherColor defines the second operand
  5239. * @param result defines the Color3 object where to store the result
  5240. * @returns the current Color3
  5241. */
  5242. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5243. /**
  5244. * Determines equality between Color3 objects
  5245. * @param otherColor defines the second operand
  5246. * @returns true if the rgb values are equal to the given ones
  5247. */
  5248. equals(otherColor: DeepImmutable<Color3>): boolean;
  5249. /**
  5250. * Determines equality between the current Color3 object and a set of r,b,g values
  5251. * @param r defines the red component to check
  5252. * @param g defines the green component to check
  5253. * @param b defines the blue component to check
  5254. * @returns true if the rgb values are equal to the given ones
  5255. */
  5256. equalsFloats(r: number, g: number, b: number): boolean;
  5257. /**
  5258. * Multiplies in place each rgb value by scale
  5259. * @param scale defines the scaling factor
  5260. * @returns the updated Color3
  5261. */
  5262. scale(scale: number): Color3;
  5263. /**
  5264. * Multiplies the rgb values by scale and stores the result into "result"
  5265. * @param scale defines the scaling factor
  5266. * @param result defines the Color3 object where to store the result
  5267. * @returns the unmodified current Color3
  5268. */
  5269. scaleToRef(scale: number, result: Color3): Color3;
  5270. /**
  5271. * Scale the current Color3 values by a factor and add the result to a given Color3
  5272. * @param scale defines the scale factor
  5273. * @param result defines color to store the result into
  5274. * @returns the unmodified current Color3
  5275. */
  5276. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5277. /**
  5278. * Clamps the rgb values by the min and max values and stores the result into "result"
  5279. * @param min defines minimum clamping value (default is 0)
  5280. * @param max defines maximum clamping value (default is 1)
  5281. * @param result defines color to store the result into
  5282. * @returns the original Color3
  5283. */
  5284. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5285. /**
  5286. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5287. * @param otherColor defines the second operand
  5288. * @returns the new Color3
  5289. */
  5290. add(otherColor: DeepImmutable<Color3>): Color3;
  5291. /**
  5292. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5293. * @param otherColor defines the second operand
  5294. * @param result defines Color3 object to store the result into
  5295. * @returns the unmodified current Color3
  5296. */
  5297. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5298. /**
  5299. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5300. * @param otherColor defines the second operand
  5301. * @returns the new Color3
  5302. */
  5303. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5304. /**
  5305. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5306. * @param otherColor defines the second operand
  5307. * @param result defines Color3 object to store the result into
  5308. * @returns the unmodified current Color3
  5309. */
  5310. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5311. /**
  5312. * Copy the current object
  5313. * @returns a new Color3 copied the current one
  5314. */
  5315. clone(): Color3;
  5316. /**
  5317. * Copies the rgb values from the source in the current Color3
  5318. * @param source defines the source Color3 object
  5319. * @returns the updated Color3 object
  5320. */
  5321. copyFrom(source: DeepImmutable<Color3>): Color3;
  5322. /**
  5323. * Updates the Color3 rgb values from the given floats
  5324. * @param r defines the red component to read from
  5325. * @param g defines the green component to read from
  5326. * @param b defines the blue component to read from
  5327. * @returns the current Color3 object
  5328. */
  5329. copyFromFloats(r: number, g: number, b: number): Color3;
  5330. /**
  5331. * Updates the Color3 rgb values from the given floats
  5332. * @param r defines the red component to read from
  5333. * @param g defines the green component to read from
  5334. * @param b defines the blue component to read from
  5335. * @returns the current Color3 object
  5336. */
  5337. set(r: number, g: number, b: number): Color3;
  5338. /**
  5339. * Compute the Color3 hexadecimal code as a string
  5340. * @returns a string containing the hexadecimal representation of the Color3 object
  5341. */
  5342. toHexString(): string;
  5343. /**
  5344. * Computes a new Color3 converted from the current one to linear space
  5345. * @returns a new Color3 object
  5346. */
  5347. toLinearSpace(): Color3;
  5348. /**
  5349. * Converts current color in rgb space to HSV values
  5350. * @returns a new color3 representing the HSV values
  5351. */
  5352. toHSV(): Color3;
  5353. /**
  5354. * Converts current color in rgb space to HSV values
  5355. * @param result defines the Color3 where to store the HSV values
  5356. */
  5357. toHSVToRef(result: Color3): void;
  5358. /**
  5359. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5360. * @param convertedColor defines the Color3 object where to store the linear space version
  5361. * @returns the unmodified Color3
  5362. */
  5363. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5364. /**
  5365. * Computes a new Color3 converted from the current one to gamma space
  5366. * @returns a new Color3 object
  5367. */
  5368. toGammaSpace(): Color3;
  5369. /**
  5370. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5371. * @param convertedColor defines the Color3 object where to store the gamma space version
  5372. * @returns the unmodified Color3
  5373. */
  5374. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5375. private static _BlackReadOnly;
  5376. /**
  5377. * Convert Hue, saturation and value to a Color3 (RGB)
  5378. * @param hue defines the hue
  5379. * @param saturation defines the saturation
  5380. * @param value defines the value
  5381. * @param result defines the Color3 where to store the RGB values
  5382. */
  5383. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5384. /**
  5385. * Creates a new Color3 from the string containing valid hexadecimal values
  5386. * @param hex defines a string containing valid hexadecimal values
  5387. * @returns a new Color3 object
  5388. */
  5389. static FromHexString(hex: string): Color3;
  5390. /**
  5391. * Creates a new Color3 from the starting index of the given array
  5392. * @param array defines the source array
  5393. * @param offset defines an offset in the source array
  5394. * @returns a new Color3 object
  5395. */
  5396. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5397. /**
  5398. * Creates a new Color3 from integer values (< 256)
  5399. * @param r defines the red component to read from (value between 0 and 255)
  5400. * @param g defines the green component to read from (value between 0 and 255)
  5401. * @param b defines the blue component to read from (value between 0 and 255)
  5402. * @returns a new Color3 object
  5403. */
  5404. static FromInts(r: number, g: number, b: number): Color3;
  5405. /**
  5406. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5407. * @param start defines the start Color3 value
  5408. * @param end defines the end Color3 value
  5409. * @param amount defines the gradient value between start and end
  5410. * @returns a new Color3 object
  5411. */
  5412. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5413. /**
  5414. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5415. * @param left defines the start value
  5416. * @param right defines the end value
  5417. * @param amount defines the gradient factor
  5418. * @param result defines the Color3 object where to store the result
  5419. */
  5420. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5421. /**
  5422. * Returns a Color3 value containing a red color
  5423. * @returns a new Color3 object
  5424. */
  5425. static Red(): Color3;
  5426. /**
  5427. * Returns a Color3 value containing a green color
  5428. * @returns a new Color3 object
  5429. */
  5430. static Green(): Color3;
  5431. /**
  5432. * Returns a Color3 value containing a blue color
  5433. * @returns a new Color3 object
  5434. */
  5435. static Blue(): Color3;
  5436. /**
  5437. * Returns a Color3 value containing a black color
  5438. * @returns a new Color3 object
  5439. */
  5440. static Black(): Color3;
  5441. /**
  5442. * Gets a Color3 value containing a black color that must not be updated
  5443. */
  5444. static readonly BlackReadOnly: DeepImmutable<Color3>;
  5445. /**
  5446. * Returns a Color3 value containing a white color
  5447. * @returns a new Color3 object
  5448. */
  5449. static White(): Color3;
  5450. /**
  5451. * Returns a Color3 value containing a purple color
  5452. * @returns a new Color3 object
  5453. */
  5454. static Purple(): Color3;
  5455. /**
  5456. * Returns a Color3 value containing a magenta color
  5457. * @returns a new Color3 object
  5458. */
  5459. static Magenta(): Color3;
  5460. /**
  5461. * Returns a Color3 value containing a yellow color
  5462. * @returns a new Color3 object
  5463. */
  5464. static Yellow(): Color3;
  5465. /**
  5466. * Returns a Color3 value containing a gray color
  5467. * @returns a new Color3 object
  5468. */
  5469. static Gray(): Color3;
  5470. /**
  5471. * Returns a Color3 value containing a teal color
  5472. * @returns a new Color3 object
  5473. */
  5474. static Teal(): Color3;
  5475. /**
  5476. * Returns a Color3 value containing a random color
  5477. * @returns a new Color3 object
  5478. */
  5479. static Random(): Color3;
  5480. }
  5481. /**
  5482. * Class used to hold a RBGA color
  5483. */
  5484. export class Color4 {
  5485. /**
  5486. * Defines the red component (between 0 and 1, default is 0)
  5487. */
  5488. r: number;
  5489. /**
  5490. * Defines the green component (between 0 and 1, default is 0)
  5491. */
  5492. g: number;
  5493. /**
  5494. * Defines the blue component (between 0 and 1, default is 0)
  5495. */
  5496. b: number;
  5497. /**
  5498. * Defines the alpha component (between 0 and 1, default is 1)
  5499. */
  5500. a: number;
  5501. /**
  5502. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5503. * @param r defines the red component (between 0 and 1, default is 0)
  5504. * @param g defines the green component (between 0 and 1, default is 0)
  5505. * @param b defines the blue component (between 0 and 1, default is 0)
  5506. * @param a defines the alpha component (between 0 and 1, default is 1)
  5507. */
  5508. constructor(
  5509. /**
  5510. * Defines the red component (between 0 and 1, default is 0)
  5511. */
  5512. r?: number,
  5513. /**
  5514. * Defines the green component (between 0 and 1, default is 0)
  5515. */
  5516. g?: number,
  5517. /**
  5518. * Defines the blue component (between 0 and 1, default is 0)
  5519. */
  5520. b?: number,
  5521. /**
  5522. * Defines the alpha component (between 0 and 1, default is 1)
  5523. */
  5524. a?: number);
  5525. /**
  5526. * Adds in place the given Color4 values to the current Color4 object
  5527. * @param right defines the second operand
  5528. * @returns the current updated Color4 object
  5529. */
  5530. addInPlace(right: DeepImmutable<Color4>): Color4;
  5531. /**
  5532. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5533. * @returns the new array
  5534. */
  5535. asArray(): number[];
  5536. /**
  5537. * Stores from the starting index in the given array the Color4 successive values
  5538. * @param array defines the array where to store the r,g,b components
  5539. * @param index defines an optional index in the target array to define where to start storing values
  5540. * @returns the current Color4 object
  5541. */
  5542. toArray(array: number[], index?: number): Color4;
  5543. /**
  5544. * Determines equality between Color4 objects
  5545. * @param otherColor defines the second operand
  5546. * @returns true if the rgba values are equal to the given ones
  5547. */
  5548. equals(otherColor: DeepImmutable<Color4>): boolean;
  5549. /**
  5550. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5551. * @param right defines the second operand
  5552. * @returns a new Color4 object
  5553. */
  5554. add(right: DeepImmutable<Color4>): Color4;
  5555. /**
  5556. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5557. * @param right defines the second operand
  5558. * @returns a new Color4 object
  5559. */
  5560. subtract(right: DeepImmutable<Color4>): Color4;
  5561. /**
  5562. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5563. * @param right defines the second operand
  5564. * @param result defines the Color4 object where to store the result
  5565. * @returns the current Color4 object
  5566. */
  5567. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5568. /**
  5569. * Creates a new Color4 with the current Color4 values multiplied by scale
  5570. * @param scale defines the scaling factor to apply
  5571. * @returns a new Color4 object
  5572. */
  5573. scale(scale: number): Color4;
  5574. /**
  5575. * Multiplies the current Color4 values by scale and stores the result in "result"
  5576. * @param scale defines the scaling factor to apply
  5577. * @param result defines the Color4 object where to store the result
  5578. * @returns the current unmodified Color4
  5579. */
  5580. scaleToRef(scale: number, result: Color4): Color4;
  5581. /**
  5582. * Scale the current Color4 values by a factor and add the result to a given Color4
  5583. * @param scale defines the scale factor
  5584. * @param result defines the Color4 object where to store the result
  5585. * @returns the unmodified current Color4
  5586. */
  5587. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5588. /**
  5589. * Clamps the rgb values by the min and max values and stores the result into "result"
  5590. * @param min defines minimum clamping value (default is 0)
  5591. * @param max defines maximum clamping value (default is 1)
  5592. * @param result defines color to store the result into.
  5593. * @returns the cuurent Color4
  5594. */
  5595. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5596. /**
  5597. * Multipy an Color4 value by another and return a new Color4 object
  5598. * @param color defines the Color4 value to multiply by
  5599. * @returns a new Color4 object
  5600. */
  5601. multiply(color: Color4): Color4;
  5602. /**
  5603. * Multipy a Color4 value by another and push the result in a reference value
  5604. * @param color defines the Color4 value to multiply by
  5605. * @param result defines the Color4 to fill the result in
  5606. * @returns the result Color4
  5607. */
  5608. multiplyToRef(color: Color4, result: Color4): Color4;
  5609. /**
  5610. * Creates a string with the Color4 current values
  5611. * @returns the string representation of the Color4 object
  5612. */
  5613. toString(): string;
  5614. /**
  5615. * Returns the string "Color4"
  5616. * @returns "Color4"
  5617. */
  5618. getClassName(): string;
  5619. /**
  5620. * Compute the Color4 hash code
  5621. * @returns an unique number that can be used to hash Color4 objects
  5622. */
  5623. getHashCode(): number;
  5624. /**
  5625. * Creates a new Color4 copied from the current one
  5626. * @returns a new Color4 object
  5627. */
  5628. clone(): Color4;
  5629. /**
  5630. * Copies the given Color4 values into the current one
  5631. * @param source defines the source Color4 object
  5632. * @returns the current updated Color4 object
  5633. */
  5634. copyFrom(source: Color4): Color4;
  5635. /**
  5636. * Copies the given float values into the current one
  5637. * @param r defines the red component to read from
  5638. * @param g defines the green component to read from
  5639. * @param b defines the blue component to read from
  5640. * @param a defines the alpha component to read from
  5641. * @returns the current updated Color4 object
  5642. */
  5643. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  5644. /**
  5645. * Copies the given float values into the current one
  5646. * @param r defines the red component to read from
  5647. * @param g defines the green component to read from
  5648. * @param b defines the blue component to read from
  5649. * @param a defines the alpha component to read from
  5650. * @returns the current updated Color4 object
  5651. */
  5652. set(r: number, g: number, b: number, a: number): Color4;
  5653. /**
  5654. * Compute the Color4 hexadecimal code as a string
  5655. * @returns a string containing the hexadecimal representation of the Color4 object
  5656. */
  5657. toHexString(): string;
  5658. /**
  5659. * Computes a new Color4 converted from the current one to linear space
  5660. * @returns a new Color4 object
  5661. */
  5662. toLinearSpace(): Color4;
  5663. /**
  5664. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  5665. * @param convertedColor defines the Color4 object where to store the linear space version
  5666. * @returns the unmodified Color4
  5667. */
  5668. toLinearSpaceToRef(convertedColor: Color4): Color4;
  5669. /**
  5670. * Computes a new Color4 converted from the current one to gamma space
  5671. * @returns a new Color4 object
  5672. */
  5673. toGammaSpace(): Color4;
  5674. /**
  5675. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  5676. * @param convertedColor defines the Color4 object where to store the gamma space version
  5677. * @returns the unmodified Color4
  5678. */
  5679. toGammaSpaceToRef(convertedColor: Color4): Color4;
  5680. /**
  5681. * Creates a new Color4 from the string containing valid hexadecimal values
  5682. * @param hex defines a string containing valid hexadecimal values
  5683. * @returns a new Color4 object
  5684. */
  5685. static FromHexString(hex: string): Color4;
  5686. /**
  5687. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5688. * @param left defines the start value
  5689. * @param right defines the end value
  5690. * @param amount defines the gradient factor
  5691. * @returns a new Color4 object
  5692. */
  5693. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  5694. /**
  5695. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5696. * @param left defines the start value
  5697. * @param right defines the end value
  5698. * @param amount defines the gradient factor
  5699. * @param result defines the Color4 object where to store data
  5700. */
  5701. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  5702. /**
  5703. * Creates a new Color4 from a Color3 and an alpha value
  5704. * @param color3 defines the source Color3 to read from
  5705. * @param alpha defines the alpha component (1.0 by default)
  5706. * @returns a new Color4 object
  5707. */
  5708. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  5709. /**
  5710. * Creates a new Color4 from the starting index element of the given array
  5711. * @param array defines the source array to read from
  5712. * @param offset defines the offset in the source array
  5713. * @returns a new Color4 object
  5714. */
  5715. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5716. /**
  5717. * Creates a new Color3 from integer values (< 256)
  5718. * @param r defines the red component to read from (value between 0 and 255)
  5719. * @param g defines the green component to read from (value between 0 and 255)
  5720. * @param b defines the blue component to read from (value between 0 and 255)
  5721. * @param a defines the alpha component to read from (value between 0 and 255)
  5722. * @returns a new Color3 object
  5723. */
  5724. static FromInts(r: number, g: number, b: number, a: number): Color4;
  5725. /**
  5726. * Check the content of a given array and convert it to an array containing RGBA data
  5727. * If the original array was already containing count * 4 values then it is returned directly
  5728. * @param colors defines the array to check
  5729. * @param count defines the number of RGBA data to expect
  5730. * @returns an array containing count * 4 values (RGBA)
  5731. */
  5732. static CheckColors4(colors: number[], count: number): number[];
  5733. }
  5734. /**
  5735. * @hidden
  5736. */
  5737. export class TmpColors {
  5738. static Color3: Color3[];
  5739. static Color4: Color4[];
  5740. }
  5741. }
  5742. declare module "babylonjs/Animations/animationKey" {
  5743. /**
  5744. * Defines an interface which represents an animation key frame
  5745. */
  5746. export interface IAnimationKey {
  5747. /**
  5748. * Frame of the key frame
  5749. */
  5750. frame: number;
  5751. /**
  5752. * Value at the specifies key frame
  5753. */
  5754. value: any;
  5755. /**
  5756. * The input tangent for the cubic hermite spline
  5757. */
  5758. inTangent?: any;
  5759. /**
  5760. * The output tangent for the cubic hermite spline
  5761. */
  5762. outTangent?: any;
  5763. /**
  5764. * The animation interpolation type
  5765. */
  5766. interpolation?: AnimationKeyInterpolation;
  5767. }
  5768. /**
  5769. * Enum for the animation key frame interpolation type
  5770. */
  5771. export enum AnimationKeyInterpolation {
  5772. /**
  5773. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  5774. */
  5775. STEP = 1
  5776. }
  5777. }
  5778. declare module "babylonjs/Animations/animationRange" {
  5779. /**
  5780. * Represents the range of an animation
  5781. */
  5782. export class AnimationRange {
  5783. /**The name of the animation range**/
  5784. name: string;
  5785. /**The starting frame of the animation */
  5786. from: number;
  5787. /**The ending frame of the animation*/
  5788. to: number;
  5789. /**
  5790. * Initializes the range of an animation
  5791. * @param name The name of the animation range
  5792. * @param from The starting frame of the animation
  5793. * @param to The ending frame of the animation
  5794. */
  5795. constructor(
  5796. /**The name of the animation range**/
  5797. name: string,
  5798. /**The starting frame of the animation */
  5799. from: number,
  5800. /**The ending frame of the animation*/
  5801. to: number);
  5802. /**
  5803. * Makes a copy of the animation range
  5804. * @returns A copy of the animation range
  5805. */
  5806. clone(): AnimationRange;
  5807. }
  5808. }
  5809. declare module "babylonjs/Animations/animationEvent" {
  5810. /**
  5811. * Composed of a frame, and an action function
  5812. */
  5813. export class AnimationEvent {
  5814. /** The frame for which the event is triggered **/
  5815. frame: number;
  5816. /** The event to perform when triggered **/
  5817. action: (currentFrame: number) => void;
  5818. /** Specifies if the event should be triggered only once**/
  5819. onlyOnce?: boolean | undefined;
  5820. /**
  5821. * Specifies if the animation event is done
  5822. */
  5823. isDone: boolean;
  5824. /**
  5825. * Initializes the animation event
  5826. * @param frame The frame for which the event is triggered
  5827. * @param action The event to perform when triggered
  5828. * @param onlyOnce Specifies if the event should be triggered only once
  5829. */
  5830. constructor(
  5831. /** The frame for which the event is triggered **/
  5832. frame: number,
  5833. /** The event to perform when triggered **/
  5834. action: (currentFrame: number) => void,
  5835. /** Specifies if the event should be triggered only once**/
  5836. onlyOnce?: boolean | undefined);
  5837. /** @hidden */
  5838. _clone(): AnimationEvent;
  5839. }
  5840. }
  5841. declare module "babylonjs/Behaviors/behavior" {
  5842. import { Nullable } from "babylonjs/types";
  5843. /**
  5844. * Interface used to define a behavior
  5845. */
  5846. export interface Behavior<T> {
  5847. /** gets or sets behavior's name */
  5848. name: string;
  5849. /**
  5850. * Function called when the behavior needs to be initialized (after attaching it to a target)
  5851. */
  5852. init(): void;
  5853. /**
  5854. * Called when the behavior is attached to a target
  5855. * @param target defines the target where the behavior is attached to
  5856. */
  5857. attach(target: T): void;
  5858. /**
  5859. * Called when the behavior is detached from its target
  5860. */
  5861. detach(): void;
  5862. }
  5863. /**
  5864. * Interface implemented by classes supporting behaviors
  5865. */
  5866. export interface IBehaviorAware<T> {
  5867. /**
  5868. * Attach a behavior
  5869. * @param behavior defines the behavior to attach
  5870. * @returns the current host
  5871. */
  5872. addBehavior(behavior: Behavior<T>): T;
  5873. /**
  5874. * Remove a behavior from the current object
  5875. * @param behavior defines the behavior to detach
  5876. * @returns the current host
  5877. */
  5878. removeBehavior(behavior: Behavior<T>): T;
  5879. /**
  5880. * Gets a behavior using its name to search
  5881. * @param name defines the name to search
  5882. * @returns the behavior or null if not found
  5883. */
  5884. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  5885. }
  5886. }
  5887. declare module "babylonjs/Misc/smartArray" {
  5888. /**
  5889. * Defines an array and its length.
  5890. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  5891. */
  5892. export interface ISmartArrayLike<T> {
  5893. /**
  5894. * The data of the array.
  5895. */
  5896. data: Array<T>;
  5897. /**
  5898. * The active length of the array.
  5899. */
  5900. length: number;
  5901. }
  5902. /**
  5903. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  5904. */
  5905. export class SmartArray<T> implements ISmartArrayLike<T> {
  5906. /**
  5907. * The full set of data from the array.
  5908. */
  5909. data: Array<T>;
  5910. /**
  5911. * The active length of the array.
  5912. */
  5913. length: number;
  5914. protected _id: number;
  5915. /**
  5916. * Instantiates a Smart Array.
  5917. * @param capacity defines the default capacity of the array.
  5918. */
  5919. constructor(capacity: number);
  5920. /**
  5921. * Pushes a value at the end of the active data.
  5922. * @param value defines the object to push in the array.
  5923. */
  5924. push(value: T): void;
  5925. /**
  5926. * Iterates over the active data and apply the lambda to them.
  5927. * @param func defines the action to apply on each value.
  5928. */
  5929. forEach(func: (content: T) => void): void;
  5930. /**
  5931. * Sorts the full sets of data.
  5932. * @param compareFn defines the comparison function to apply.
  5933. */
  5934. sort(compareFn: (a: T, b: T) => number): void;
  5935. /**
  5936. * Resets the active data to an empty array.
  5937. */
  5938. reset(): void;
  5939. /**
  5940. * Releases all the data from the array as well as the array.
  5941. */
  5942. dispose(): void;
  5943. /**
  5944. * Concats the active data with a given array.
  5945. * @param array defines the data to concatenate with.
  5946. */
  5947. concat(array: any): void;
  5948. /**
  5949. * Returns the position of a value in the active data.
  5950. * @param value defines the value to find the index for
  5951. * @returns the index if found in the active data otherwise -1
  5952. */
  5953. indexOf(value: T): number;
  5954. /**
  5955. * Returns whether an element is part of the active data.
  5956. * @param value defines the value to look for
  5957. * @returns true if found in the active data otherwise false
  5958. */
  5959. contains(value: T): boolean;
  5960. private static _GlobalId;
  5961. }
  5962. /**
  5963. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  5964. * The data in this array can only be present once
  5965. */
  5966. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  5967. private _duplicateId;
  5968. /**
  5969. * Pushes a value at the end of the active data.
  5970. * THIS DOES NOT PREVENT DUPPLICATE DATA
  5971. * @param value defines the object to push in the array.
  5972. */
  5973. push(value: T): void;
  5974. /**
  5975. * Pushes a value at the end of the active data.
  5976. * If the data is already present, it won t be added again
  5977. * @param value defines the object to push in the array.
  5978. * @returns true if added false if it was already present
  5979. */
  5980. pushNoDuplicate(value: T): boolean;
  5981. /**
  5982. * Resets the active data to an empty array.
  5983. */
  5984. reset(): void;
  5985. /**
  5986. * Concats the active data with a given array.
  5987. * This ensures no dupplicate will be present in the result.
  5988. * @param array defines the data to concatenate with.
  5989. */
  5990. concatWithNoDuplicate(array: any): void;
  5991. }
  5992. }
  5993. declare module "babylonjs/Cameras/cameraInputsManager" {
  5994. import { Nullable } from "babylonjs/types";
  5995. import { Camera } from "babylonjs/Cameras/camera";
  5996. /**
  5997. * @ignore
  5998. * This is a list of all the different input types that are available in the application.
  5999. * Fo instance: ArcRotateCameraGamepadInput...
  6000. */
  6001. export var CameraInputTypes: {};
  6002. /**
  6003. * This is the contract to implement in order to create a new input class.
  6004. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6005. */
  6006. export interface ICameraInput<TCamera extends Camera> {
  6007. /**
  6008. * Defines the camera the input is attached to.
  6009. */
  6010. camera: Nullable<TCamera>;
  6011. /**
  6012. * Gets the class name of the current intput.
  6013. * @returns the class name
  6014. */
  6015. getClassName(): string;
  6016. /**
  6017. * Get the friendly name associated with the input class.
  6018. * @returns the input friendly name
  6019. */
  6020. getSimpleName(): string;
  6021. /**
  6022. * Attach the input controls to a specific dom element to get the input from.
  6023. * @param element Defines the element the controls should be listened from
  6024. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6025. */
  6026. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6027. /**
  6028. * Detach the current controls from the specified dom element.
  6029. * @param element Defines the element to stop listening the inputs from
  6030. */
  6031. detachControl(element: Nullable<HTMLElement>): void;
  6032. /**
  6033. * Update the current camera state depending on the inputs that have been used this frame.
  6034. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6035. */
  6036. checkInputs?: () => void;
  6037. }
  6038. /**
  6039. * Represents a map of input types to input instance or input index to input instance.
  6040. */
  6041. export interface CameraInputsMap<TCamera extends Camera> {
  6042. /**
  6043. * Accessor to the input by input type.
  6044. */
  6045. [name: string]: ICameraInput<TCamera>;
  6046. /**
  6047. * Accessor to the input by input index.
  6048. */
  6049. [idx: number]: ICameraInput<TCamera>;
  6050. }
  6051. /**
  6052. * This represents the input manager used within a camera.
  6053. * It helps dealing with all the different kind of input attached to a camera.
  6054. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6055. */
  6056. export class CameraInputsManager<TCamera extends Camera> {
  6057. /**
  6058. * Defines the list of inputs attahed to the camera.
  6059. */
  6060. attached: CameraInputsMap<TCamera>;
  6061. /**
  6062. * Defines the dom element the camera is collecting inputs from.
  6063. * This is null if the controls have not been attached.
  6064. */
  6065. attachedElement: Nullable<HTMLElement>;
  6066. /**
  6067. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6068. */
  6069. noPreventDefault: boolean;
  6070. /**
  6071. * Defined the camera the input manager belongs to.
  6072. */
  6073. camera: TCamera;
  6074. /**
  6075. * Update the current camera state depending on the inputs that have been used this frame.
  6076. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6077. */
  6078. checkInputs: () => void;
  6079. /**
  6080. * Instantiate a new Camera Input Manager.
  6081. * @param camera Defines the camera the input manager blongs to
  6082. */
  6083. constructor(camera: TCamera);
  6084. /**
  6085. * Add an input method to a camera
  6086. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6087. * @param input camera input method
  6088. */
  6089. add(input: ICameraInput<TCamera>): void;
  6090. /**
  6091. * Remove a specific input method from a camera
  6092. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6093. * @param inputToRemove camera input method
  6094. */
  6095. remove(inputToRemove: ICameraInput<TCamera>): void;
  6096. /**
  6097. * Remove a specific input type from a camera
  6098. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6099. * @param inputType the type of the input to remove
  6100. */
  6101. removeByType(inputType: string): void;
  6102. private _addCheckInputs;
  6103. /**
  6104. * Attach the input controls to the currently attached dom element to listen the events from.
  6105. * @param input Defines the input to attach
  6106. */
  6107. attachInput(input: ICameraInput<TCamera>): void;
  6108. /**
  6109. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6110. * @param element Defines the dom element to collect the events from
  6111. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6112. */
  6113. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6114. /**
  6115. * Detach the current manager inputs controls from a specific dom element.
  6116. * @param element Defines the dom element to collect the events from
  6117. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6118. */
  6119. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6120. /**
  6121. * Rebuild the dynamic inputCheck function from the current list of
  6122. * defined inputs in the manager.
  6123. */
  6124. rebuildInputCheck(): void;
  6125. /**
  6126. * Remove all attached input methods from a camera
  6127. */
  6128. clear(): void;
  6129. /**
  6130. * Serialize the current input manager attached to a camera.
  6131. * This ensures than once parsed,
  6132. * the input associated to the camera will be identical to the current ones
  6133. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6134. */
  6135. serialize(serializedCamera: any): void;
  6136. /**
  6137. * Parses an input manager serialized JSON to restore the previous list of inputs
  6138. * and states associated to a camera.
  6139. * @param parsedCamera Defines the JSON to parse
  6140. */
  6141. parse(parsedCamera: any): void;
  6142. }
  6143. }
  6144. declare module "babylonjs/Meshes/buffer" {
  6145. import { Nullable, DataArray } from "babylonjs/types";
  6146. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6147. /**
  6148. * Class used to store data that will be store in GPU memory
  6149. */
  6150. export class Buffer {
  6151. private _engine;
  6152. private _buffer;
  6153. /** @hidden */
  6154. _data: Nullable<DataArray>;
  6155. private _updatable;
  6156. private _instanced;
  6157. private _divisor;
  6158. /**
  6159. * Gets the byte stride.
  6160. */
  6161. readonly byteStride: number;
  6162. /**
  6163. * Constructor
  6164. * @param engine the engine
  6165. * @param data the data to use for this buffer
  6166. * @param updatable whether the data is updatable
  6167. * @param stride the stride (optional)
  6168. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6169. * @param instanced whether the buffer is instanced (optional)
  6170. * @param useBytes set to true if the stride in in bytes (optional)
  6171. * @param divisor sets an optional divisor for instances (1 by default)
  6172. */
  6173. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6174. /**
  6175. * Create a new VertexBuffer based on the current buffer
  6176. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6177. * @param offset defines offset in the buffer (0 by default)
  6178. * @param size defines the size in floats of attributes (position is 3 for instance)
  6179. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6180. * @param instanced defines if the vertex buffer contains indexed data
  6181. * @param useBytes defines if the offset and stride are in bytes *
  6182. * @param divisor sets an optional divisor for instances (1 by default)
  6183. * @returns the new vertex buffer
  6184. */
  6185. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6186. /**
  6187. * Gets a boolean indicating if the Buffer is updatable?
  6188. * @returns true if the buffer is updatable
  6189. */
  6190. isUpdatable(): boolean;
  6191. /**
  6192. * Gets current buffer's data
  6193. * @returns a DataArray or null
  6194. */
  6195. getData(): Nullable<DataArray>;
  6196. /**
  6197. * Gets underlying native buffer
  6198. * @returns underlying native buffer
  6199. */
  6200. getBuffer(): Nullable<DataBuffer>;
  6201. /**
  6202. * Gets the stride in float32 units (i.e. byte stride / 4).
  6203. * May not be an integer if the byte stride is not divisible by 4.
  6204. * DEPRECATED. Use byteStride instead.
  6205. * @returns the stride in float32 units
  6206. */
  6207. getStrideSize(): number;
  6208. /**
  6209. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6210. * @param data defines the data to store
  6211. */
  6212. create(data?: Nullable<DataArray>): void;
  6213. /** @hidden */
  6214. _rebuild(): void;
  6215. /**
  6216. * Update current buffer data
  6217. * @param data defines the data to store
  6218. */
  6219. update(data: DataArray): void;
  6220. /**
  6221. * Updates the data directly.
  6222. * @param data the new data
  6223. * @param offset the new offset
  6224. * @param vertexCount the vertex count (optional)
  6225. * @param useBytes set to true if the offset is in bytes
  6226. */
  6227. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6228. /**
  6229. * Release all resources
  6230. */
  6231. dispose(): void;
  6232. }
  6233. /**
  6234. * Specialized buffer used to store vertex data
  6235. */
  6236. export class VertexBuffer {
  6237. /** @hidden */
  6238. _buffer: Buffer;
  6239. private _kind;
  6240. private _size;
  6241. private _ownsBuffer;
  6242. private _instanced;
  6243. private _instanceDivisor;
  6244. /**
  6245. * The byte type.
  6246. */
  6247. static readonly BYTE: number;
  6248. /**
  6249. * The unsigned byte type.
  6250. */
  6251. static readonly UNSIGNED_BYTE: number;
  6252. /**
  6253. * The short type.
  6254. */
  6255. static readonly SHORT: number;
  6256. /**
  6257. * The unsigned short type.
  6258. */
  6259. static readonly UNSIGNED_SHORT: number;
  6260. /**
  6261. * The integer type.
  6262. */
  6263. static readonly INT: number;
  6264. /**
  6265. * The unsigned integer type.
  6266. */
  6267. static readonly UNSIGNED_INT: number;
  6268. /**
  6269. * The float type.
  6270. */
  6271. static readonly FLOAT: number;
  6272. /**
  6273. * Gets or sets the instance divisor when in instanced mode
  6274. */
  6275. instanceDivisor: number;
  6276. /**
  6277. * Gets the byte stride.
  6278. */
  6279. readonly byteStride: number;
  6280. /**
  6281. * Gets the byte offset.
  6282. */
  6283. readonly byteOffset: number;
  6284. /**
  6285. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6286. */
  6287. readonly normalized: boolean;
  6288. /**
  6289. * Gets the data type of each component in the array.
  6290. */
  6291. readonly type: number;
  6292. /**
  6293. * Constructor
  6294. * @param engine the engine
  6295. * @param data the data to use for this vertex buffer
  6296. * @param kind the vertex buffer kind
  6297. * @param updatable whether the data is updatable
  6298. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6299. * @param stride the stride (optional)
  6300. * @param instanced whether the buffer is instanced (optional)
  6301. * @param offset the offset of the data (optional)
  6302. * @param size the number of components (optional)
  6303. * @param type the type of the component (optional)
  6304. * @param normalized whether the data contains normalized data (optional)
  6305. * @param useBytes set to true if stride and offset are in bytes (optional)
  6306. * @param divisor defines the instance divisor to use (1 by default)
  6307. */
  6308. constructor(engine: any, data: DataArray | Buffer, kind: string, updatable: boolean, postponeInternalCreation?: boolean, stride?: number, instanced?: boolean, offset?: number, size?: number, type?: number, normalized?: boolean, useBytes?: boolean, divisor?: number);
  6309. /** @hidden */
  6310. _rebuild(): void;
  6311. /**
  6312. * Returns the kind of the VertexBuffer (string)
  6313. * @returns a string
  6314. */
  6315. getKind(): string;
  6316. /**
  6317. * Gets a boolean indicating if the VertexBuffer is updatable?
  6318. * @returns true if the buffer is updatable
  6319. */
  6320. isUpdatable(): boolean;
  6321. /**
  6322. * Gets current buffer's data
  6323. * @returns a DataArray or null
  6324. */
  6325. getData(): Nullable<DataArray>;
  6326. /**
  6327. * Gets underlying native buffer
  6328. * @returns underlying native buffer
  6329. */
  6330. getBuffer(): Nullable<DataBuffer>;
  6331. /**
  6332. * Gets the stride in float32 units (i.e. byte stride / 4).
  6333. * May not be an integer if the byte stride is not divisible by 4.
  6334. * DEPRECATED. Use byteStride instead.
  6335. * @returns the stride in float32 units
  6336. */
  6337. getStrideSize(): number;
  6338. /**
  6339. * Returns the offset as a multiple of the type byte length.
  6340. * DEPRECATED. Use byteOffset instead.
  6341. * @returns the offset in bytes
  6342. */
  6343. getOffset(): number;
  6344. /**
  6345. * Returns the number of components per vertex attribute (integer)
  6346. * @returns the size in float
  6347. */
  6348. getSize(): number;
  6349. /**
  6350. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6351. * @returns true if this buffer is instanced
  6352. */
  6353. getIsInstanced(): boolean;
  6354. /**
  6355. * Returns the instancing divisor, zero for non-instanced (integer).
  6356. * @returns a number
  6357. */
  6358. getInstanceDivisor(): number;
  6359. /**
  6360. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6361. * @param data defines the data to store
  6362. */
  6363. create(data?: DataArray): void;
  6364. /**
  6365. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6366. * This function will create a new buffer if the current one is not updatable
  6367. * @param data defines the data to store
  6368. */
  6369. update(data: DataArray): void;
  6370. /**
  6371. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6372. * Returns the directly updated WebGLBuffer.
  6373. * @param data the new data
  6374. * @param offset the new offset
  6375. * @param useBytes set to true if the offset is in bytes
  6376. */
  6377. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6378. /**
  6379. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6380. */
  6381. dispose(): void;
  6382. /**
  6383. * Enumerates each value of this vertex buffer as numbers.
  6384. * @param count the number of values to enumerate
  6385. * @param callback the callback function called for each value
  6386. */
  6387. forEach(count: number, callback: (value: number, index: number) => void): void;
  6388. /**
  6389. * Positions
  6390. */
  6391. static readonly PositionKind: string;
  6392. /**
  6393. * Normals
  6394. */
  6395. static readonly NormalKind: string;
  6396. /**
  6397. * Tangents
  6398. */
  6399. static readonly TangentKind: string;
  6400. /**
  6401. * Texture coordinates
  6402. */
  6403. static readonly UVKind: string;
  6404. /**
  6405. * Texture coordinates 2
  6406. */
  6407. static readonly UV2Kind: string;
  6408. /**
  6409. * Texture coordinates 3
  6410. */
  6411. static readonly UV3Kind: string;
  6412. /**
  6413. * Texture coordinates 4
  6414. */
  6415. static readonly UV4Kind: string;
  6416. /**
  6417. * Texture coordinates 5
  6418. */
  6419. static readonly UV5Kind: string;
  6420. /**
  6421. * Texture coordinates 6
  6422. */
  6423. static readonly UV6Kind: string;
  6424. /**
  6425. * Colors
  6426. */
  6427. static readonly ColorKind: string;
  6428. /**
  6429. * Matrix indices (for bones)
  6430. */
  6431. static readonly MatricesIndicesKind: string;
  6432. /**
  6433. * Matrix weights (for bones)
  6434. */
  6435. static readonly MatricesWeightsKind: string;
  6436. /**
  6437. * Additional matrix indices (for bones)
  6438. */
  6439. static readonly MatricesIndicesExtraKind: string;
  6440. /**
  6441. * Additional matrix weights (for bones)
  6442. */
  6443. static readonly MatricesWeightsExtraKind: string;
  6444. /**
  6445. * Deduces the stride given a kind.
  6446. * @param kind The kind string to deduce
  6447. * @returns The deduced stride
  6448. */
  6449. static DeduceStride(kind: string): number;
  6450. /**
  6451. * Gets the byte length of the given type.
  6452. * @param type the type
  6453. * @returns the number of bytes
  6454. */
  6455. static GetTypeByteLength(type: number): number;
  6456. /**
  6457. * Enumerates each value of the given parameters as numbers.
  6458. * @param data the data to enumerate
  6459. * @param byteOffset the byte offset of the data
  6460. * @param byteStride the byte stride of the data
  6461. * @param componentCount the number of components per element
  6462. * @param componentType the type of the component
  6463. * @param count the number of values to enumerate
  6464. * @param normalized whether the data is normalized
  6465. * @param callback the callback function called for each value
  6466. */
  6467. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6468. private static _GetFloatValue;
  6469. }
  6470. }
  6471. declare module "babylonjs/Collisions/intersectionInfo" {
  6472. import { Nullable } from "babylonjs/types";
  6473. /**
  6474. * @hidden
  6475. */
  6476. export class IntersectionInfo {
  6477. bu: Nullable<number>;
  6478. bv: Nullable<number>;
  6479. distance: number;
  6480. faceId: number;
  6481. subMeshId: number;
  6482. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6483. }
  6484. }
  6485. declare module "babylonjs/Maths/math.plane" {
  6486. import { DeepImmutable } from "babylonjs/types";
  6487. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  6488. /**
  6489. * Represens a plane by the equation ax + by + cz + d = 0
  6490. */
  6491. export class Plane {
  6492. private static _TmpMatrix;
  6493. /**
  6494. * Normal of the plane (a,b,c)
  6495. */
  6496. normal: Vector3;
  6497. /**
  6498. * d component of the plane
  6499. */
  6500. d: number;
  6501. /**
  6502. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  6503. * @param a a component of the plane
  6504. * @param b b component of the plane
  6505. * @param c c component of the plane
  6506. * @param d d component of the plane
  6507. */
  6508. constructor(a: number, b: number, c: number, d: number);
  6509. /**
  6510. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  6511. */
  6512. asArray(): number[];
  6513. /**
  6514. * @returns a new plane copied from the current Plane.
  6515. */
  6516. clone(): Plane;
  6517. /**
  6518. * @returns the string "Plane".
  6519. */
  6520. getClassName(): string;
  6521. /**
  6522. * @returns the Plane hash code.
  6523. */
  6524. getHashCode(): number;
  6525. /**
  6526. * Normalize the current Plane in place.
  6527. * @returns the updated Plane.
  6528. */
  6529. normalize(): Plane;
  6530. /**
  6531. * Applies a transformation the plane and returns the result
  6532. * @param transformation the transformation matrix to be applied to the plane
  6533. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  6534. */
  6535. transform(transformation: DeepImmutable<Matrix>): Plane;
  6536. /**
  6537. * Calcualtte the dot product between the point and the plane normal
  6538. * @param point point to calculate the dot product with
  6539. * @returns the dot product (float) of the point coordinates and the plane normal.
  6540. */
  6541. dotCoordinate(point: DeepImmutable<Vector3>): number;
  6542. /**
  6543. * Updates the current Plane from the plane defined by the three given points.
  6544. * @param point1 one of the points used to contruct the plane
  6545. * @param point2 one of the points used to contruct the plane
  6546. * @param point3 one of the points used to contruct the plane
  6547. * @returns the updated Plane.
  6548. */
  6549. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  6550. /**
  6551. * Checks if the plane is facing a given direction
  6552. * @param direction the direction to check if the plane is facing
  6553. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  6554. * @returns True is the vector "direction" is the same side than the plane normal.
  6555. */
  6556. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  6557. /**
  6558. * Calculates the distance to a point
  6559. * @param point point to calculate distance to
  6560. * @returns the signed distance (float) from the given point to the Plane.
  6561. */
  6562. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  6563. /**
  6564. * Creates a plane from an array
  6565. * @param array the array to create a plane from
  6566. * @returns a new Plane from the given array.
  6567. */
  6568. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  6569. /**
  6570. * Creates a plane from three points
  6571. * @param point1 point used to create the plane
  6572. * @param point2 point used to create the plane
  6573. * @param point3 point used to create the plane
  6574. * @returns a new Plane defined by the three given points.
  6575. */
  6576. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  6577. /**
  6578. * Creates a plane from an origin point and a normal
  6579. * @param origin origin of the plane to be constructed
  6580. * @param normal normal of the plane to be constructed
  6581. * @returns a new Plane the normal vector to this plane at the given origin point.
  6582. * Note : the vector "normal" is updated because normalized.
  6583. */
  6584. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): Plane;
  6585. /**
  6586. * Calculates the distance from a plane and a point
  6587. * @param origin origin of the plane to be constructed
  6588. * @param normal normal of the plane to be constructed
  6589. * @param point point to calculate distance to
  6590. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  6591. */
  6592. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  6593. }
  6594. }
  6595. declare module "babylonjs/Culling/boundingSphere" {
  6596. import { DeepImmutable } from "babylonjs/types";
  6597. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6598. import { Plane } from "babylonjs/Maths/math.plane";
  6599. /**
  6600. * Class used to store bounding sphere information
  6601. */
  6602. export class BoundingSphere {
  6603. /**
  6604. * Gets the center of the bounding sphere in local space
  6605. */
  6606. readonly center: Vector3;
  6607. /**
  6608. * Radius of the bounding sphere in local space
  6609. */
  6610. radius: number;
  6611. /**
  6612. * Gets the center of the bounding sphere in world space
  6613. */
  6614. readonly centerWorld: Vector3;
  6615. /**
  6616. * Radius of the bounding sphere in world space
  6617. */
  6618. radiusWorld: number;
  6619. /**
  6620. * Gets the minimum vector in local space
  6621. */
  6622. readonly minimum: Vector3;
  6623. /**
  6624. * Gets the maximum vector in local space
  6625. */
  6626. readonly maximum: Vector3;
  6627. private _worldMatrix;
  6628. private static readonly TmpVector3;
  6629. /**
  6630. * Creates a new bounding sphere
  6631. * @param min defines the minimum vector (in local space)
  6632. * @param max defines the maximum vector (in local space)
  6633. * @param worldMatrix defines the new world matrix
  6634. */
  6635. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6636. /**
  6637. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6638. * @param min defines the new minimum vector (in local space)
  6639. * @param max defines the new maximum vector (in local space)
  6640. * @param worldMatrix defines the new world matrix
  6641. */
  6642. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6643. /**
  6644. * Scale the current bounding sphere by applying a scale factor
  6645. * @param factor defines the scale factor to apply
  6646. * @returns the current bounding box
  6647. */
  6648. scale(factor: number): BoundingSphere;
  6649. /**
  6650. * Gets the world matrix of the bounding box
  6651. * @returns a matrix
  6652. */
  6653. getWorldMatrix(): DeepImmutable<Matrix>;
  6654. /** @hidden */
  6655. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6656. /**
  6657. * Tests if the bounding sphere is intersecting the frustum planes
  6658. * @param frustumPlanes defines the frustum planes to test
  6659. * @returns true if there is an intersection
  6660. */
  6661. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6662. /**
  6663. * Tests if the bounding sphere center is in between the frustum planes.
  6664. * Used for optimistic fast inclusion.
  6665. * @param frustumPlanes defines the frustum planes to test
  6666. * @returns true if the sphere center is in between the frustum planes
  6667. */
  6668. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6669. /**
  6670. * Tests if a point is inside the bounding sphere
  6671. * @param point defines the point to test
  6672. * @returns true if the point is inside the bounding sphere
  6673. */
  6674. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6675. /**
  6676. * Checks if two sphere intersct
  6677. * @param sphere0 sphere 0
  6678. * @param sphere1 sphere 1
  6679. * @returns true if the speres intersect
  6680. */
  6681. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6682. }
  6683. }
  6684. declare module "babylonjs/Culling/boundingBox" {
  6685. import { DeepImmutable } from "babylonjs/types";
  6686. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6687. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6688. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6689. import { Plane } from "babylonjs/Maths/math.plane";
  6690. /**
  6691. * Class used to store bounding box information
  6692. */
  6693. export class BoundingBox implements ICullable {
  6694. /**
  6695. * Gets the 8 vectors representing the bounding box in local space
  6696. */
  6697. readonly vectors: Vector3[];
  6698. /**
  6699. * Gets the center of the bounding box in local space
  6700. */
  6701. readonly center: Vector3;
  6702. /**
  6703. * Gets the center of the bounding box in world space
  6704. */
  6705. readonly centerWorld: Vector3;
  6706. /**
  6707. * Gets the extend size in local space
  6708. */
  6709. readonly extendSize: Vector3;
  6710. /**
  6711. * Gets the extend size in world space
  6712. */
  6713. readonly extendSizeWorld: Vector3;
  6714. /**
  6715. * Gets the OBB (object bounding box) directions
  6716. */
  6717. readonly directions: Vector3[];
  6718. /**
  6719. * Gets the 8 vectors representing the bounding box in world space
  6720. */
  6721. readonly vectorsWorld: Vector3[];
  6722. /**
  6723. * Gets the minimum vector in world space
  6724. */
  6725. readonly minimumWorld: Vector3;
  6726. /**
  6727. * Gets the maximum vector in world space
  6728. */
  6729. readonly maximumWorld: Vector3;
  6730. /**
  6731. * Gets the minimum vector in local space
  6732. */
  6733. readonly minimum: Vector3;
  6734. /**
  6735. * Gets the maximum vector in local space
  6736. */
  6737. readonly maximum: Vector3;
  6738. private _worldMatrix;
  6739. private static readonly TmpVector3;
  6740. /**
  6741. * @hidden
  6742. */
  6743. _tag: number;
  6744. /**
  6745. * Creates a new bounding box
  6746. * @param min defines the minimum vector (in local space)
  6747. * @param max defines the maximum vector (in local space)
  6748. * @param worldMatrix defines the new world matrix
  6749. */
  6750. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6751. /**
  6752. * Recreates the entire bounding box from scratch as if we call the constructor in place
  6753. * @param min defines the new minimum vector (in local space)
  6754. * @param max defines the new maximum vector (in local space)
  6755. * @param worldMatrix defines the new world matrix
  6756. */
  6757. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6758. /**
  6759. * Scale the current bounding box by applying a scale factor
  6760. * @param factor defines the scale factor to apply
  6761. * @returns the current bounding box
  6762. */
  6763. scale(factor: number): BoundingBox;
  6764. /**
  6765. * Gets the world matrix of the bounding box
  6766. * @returns a matrix
  6767. */
  6768. getWorldMatrix(): DeepImmutable<Matrix>;
  6769. /** @hidden */
  6770. _update(world: DeepImmutable<Matrix>): void;
  6771. /**
  6772. * Tests if the bounding box is intersecting the frustum planes
  6773. * @param frustumPlanes defines the frustum planes to test
  6774. * @returns true if there is an intersection
  6775. */
  6776. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6777. /**
  6778. * Tests if the bounding box is entirely inside the frustum planes
  6779. * @param frustumPlanes defines the frustum planes to test
  6780. * @returns true if there is an inclusion
  6781. */
  6782. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6783. /**
  6784. * Tests if a point is inside the bounding box
  6785. * @param point defines the point to test
  6786. * @returns true if the point is inside the bounding box
  6787. */
  6788. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6789. /**
  6790. * Tests if the bounding box intersects with a bounding sphere
  6791. * @param sphere defines the sphere to test
  6792. * @returns true if there is an intersection
  6793. */
  6794. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  6795. /**
  6796. * Tests if the bounding box intersects with a box defined by a min and max vectors
  6797. * @param min defines the min vector to use
  6798. * @param max defines the max vector to use
  6799. * @returns true if there is an intersection
  6800. */
  6801. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  6802. /**
  6803. * Tests if two bounding boxes are intersections
  6804. * @param box0 defines the first box to test
  6805. * @param box1 defines the second box to test
  6806. * @returns true if there is an intersection
  6807. */
  6808. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  6809. /**
  6810. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  6811. * @param minPoint defines the minimum vector of the bounding box
  6812. * @param maxPoint defines the maximum vector of the bounding box
  6813. * @param sphereCenter defines the sphere center
  6814. * @param sphereRadius defines the sphere radius
  6815. * @returns true if there is an intersection
  6816. */
  6817. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  6818. /**
  6819. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  6820. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  6821. * @param frustumPlanes defines the frustum planes to test
  6822. * @return true if there is an inclusion
  6823. */
  6824. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6825. /**
  6826. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  6827. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  6828. * @param frustumPlanes defines the frustum planes to test
  6829. * @return true if there is an intersection
  6830. */
  6831. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6832. }
  6833. }
  6834. declare module "babylonjs/Collisions/collider" {
  6835. import { Nullable, IndicesArray } from "babylonjs/types";
  6836. import { Vector3 } from "babylonjs/Maths/math.vector";
  6837. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  6838. import { Plane } from "babylonjs/Maths/math.plane";
  6839. /** @hidden */
  6840. export class Collider {
  6841. /** Define if a collision was found */
  6842. collisionFound: boolean;
  6843. /**
  6844. * Define last intersection point in local space
  6845. */
  6846. intersectionPoint: Vector3;
  6847. /**
  6848. * Define last collided mesh
  6849. */
  6850. collidedMesh: Nullable<AbstractMesh>;
  6851. private _collisionPoint;
  6852. private _planeIntersectionPoint;
  6853. private _tempVector;
  6854. private _tempVector2;
  6855. private _tempVector3;
  6856. private _tempVector4;
  6857. private _edge;
  6858. private _baseToVertex;
  6859. private _destinationPoint;
  6860. private _slidePlaneNormal;
  6861. private _displacementVector;
  6862. /** @hidden */
  6863. _radius: Vector3;
  6864. /** @hidden */
  6865. _retry: number;
  6866. private _velocity;
  6867. private _basePoint;
  6868. private _epsilon;
  6869. /** @hidden */
  6870. _velocityWorldLength: number;
  6871. /** @hidden */
  6872. _basePointWorld: Vector3;
  6873. private _velocityWorld;
  6874. private _normalizedVelocity;
  6875. /** @hidden */
  6876. _initialVelocity: Vector3;
  6877. /** @hidden */
  6878. _initialPosition: Vector3;
  6879. private _nearestDistance;
  6880. private _collisionMask;
  6881. collisionMask: number;
  6882. /**
  6883. * Gets the plane normal used to compute the sliding response (in local space)
  6884. */
  6885. readonly slidePlaneNormal: Vector3;
  6886. /** @hidden */
  6887. _initialize(source: Vector3, dir: Vector3, e: number): void;
  6888. /** @hidden */
  6889. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  6890. /** @hidden */
  6891. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  6892. /** @hidden */
  6893. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  6894. /** @hidden */
  6895. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  6896. /** @hidden */
  6897. _getResponse(pos: Vector3, vel: Vector3): void;
  6898. }
  6899. }
  6900. declare module "babylonjs/Culling/boundingInfo" {
  6901. import { DeepImmutable } from "babylonjs/types";
  6902. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6903. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  6904. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6905. import { Plane } from "babylonjs/Maths/math.plane";
  6906. import { Collider } from "babylonjs/Collisions/collider";
  6907. /**
  6908. * Interface for cullable objects
  6909. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  6910. */
  6911. export interface ICullable {
  6912. /**
  6913. * Checks if the object or part of the object is in the frustum
  6914. * @param frustumPlanes Camera near/planes
  6915. * @returns true if the object is in frustum otherwise false
  6916. */
  6917. isInFrustum(frustumPlanes: Plane[]): boolean;
  6918. /**
  6919. * Checks if a cullable object (mesh...) is in the camera frustum
  6920. * Unlike isInFrustum this cheks the full bounding box
  6921. * @param frustumPlanes Camera near/planes
  6922. * @returns true if the object is in frustum otherwise false
  6923. */
  6924. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  6925. }
  6926. /**
  6927. * Info for a bounding data of a mesh
  6928. */
  6929. export class BoundingInfo implements ICullable {
  6930. /**
  6931. * Bounding box for the mesh
  6932. */
  6933. readonly boundingBox: BoundingBox;
  6934. /**
  6935. * Bounding sphere for the mesh
  6936. */
  6937. readonly boundingSphere: BoundingSphere;
  6938. private _isLocked;
  6939. private static readonly TmpVector3;
  6940. /**
  6941. * Constructs bounding info
  6942. * @param minimum min vector of the bounding box/sphere
  6943. * @param maximum max vector of the bounding box/sphere
  6944. * @param worldMatrix defines the new world matrix
  6945. */
  6946. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6947. /**
  6948. * Recreates the entire bounding info from scratch as if we call the constructor in place
  6949. * @param min defines the new minimum vector (in local space)
  6950. * @param max defines the new maximum vector (in local space)
  6951. * @param worldMatrix defines the new world matrix
  6952. */
  6953. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6954. /**
  6955. * min vector of the bounding box/sphere
  6956. */
  6957. readonly minimum: Vector3;
  6958. /**
  6959. * max vector of the bounding box/sphere
  6960. */
  6961. readonly maximum: Vector3;
  6962. /**
  6963. * If the info is locked and won't be updated to avoid perf overhead
  6964. */
  6965. isLocked: boolean;
  6966. /**
  6967. * Updates the bounding sphere and box
  6968. * @param world world matrix to be used to update
  6969. */
  6970. update(world: DeepImmutable<Matrix>): void;
  6971. /**
  6972. * Recreate the bounding info to be centered around a specific point given a specific extend.
  6973. * @param center New center of the bounding info
  6974. * @param extend New extend of the bounding info
  6975. * @returns the current bounding info
  6976. */
  6977. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  6978. /**
  6979. * Scale the current bounding info by applying a scale factor
  6980. * @param factor defines the scale factor to apply
  6981. * @returns the current bounding info
  6982. */
  6983. scale(factor: number): BoundingInfo;
  6984. /**
  6985. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  6986. * @param frustumPlanes defines the frustum to test
  6987. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  6988. * @returns true if the bounding info is in the frustum planes
  6989. */
  6990. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  6991. /**
  6992. * Gets the world distance between the min and max points of the bounding box
  6993. */
  6994. readonly diagonalLength: number;
  6995. /**
  6996. * Checks if a cullable object (mesh...) is in the camera frustum
  6997. * Unlike isInFrustum this cheks the full bounding box
  6998. * @param frustumPlanes Camera near/planes
  6999. * @returns true if the object is in frustum otherwise false
  7000. */
  7001. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7002. /** @hidden */
  7003. _checkCollision(collider: Collider): boolean;
  7004. /**
  7005. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7006. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7007. * @param point the point to check intersection with
  7008. * @returns if the point intersects
  7009. */
  7010. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7011. /**
  7012. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7013. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7014. * @param boundingInfo the bounding info to check intersection with
  7015. * @param precise if the intersection should be done using OBB
  7016. * @returns if the bounding info intersects
  7017. */
  7018. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7019. }
  7020. }
  7021. declare module "babylonjs/Maths/math.functions" {
  7022. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7023. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7024. /**
  7025. * Extracts minimum and maximum values from a list of indexed positions
  7026. * @param positions defines the positions to use
  7027. * @param indices defines the indices to the positions
  7028. * @param indexStart defines the start index
  7029. * @param indexCount defines the end index
  7030. * @param bias defines bias value to add to the result
  7031. * @return minimum and maximum values
  7032. */
  7033. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7034. minimum: Vector3;
  7035. maximum: Vector3;
  7036. };
  7037. /**
  7038. * Extracts minimum and maximum values from a list of positions
  7039. * @param positions defines the positions to use
  7040. * @param start defines the start index in the positions array
  7041. * @param count defines the number of positions to handle
  7042. * @param bias defines bias value to add to the result
  7043. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7044. * @return minimum and maximum values
  7045. */
  7046. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7047. minimum: Vector3;
  7048. maximum: Vector3;
  7049. };
  7050. }
  7051. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7052. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7053. /** @hidden */
  7054. export class WebGLDataBuffer extends DataBuffer {
  7055. private _buffer;
  7056. constructor(resource: WebGLBuffer);
  7057. readonly underlyingResource: any;
  7058. }
  7059. }
  7060. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7061. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7062. import { Nullable } from "babylonjs/types";
  7063. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7064. /** @hidden */
  7065. export class WebGLPipelineContext implements IPipelineContext {
  7066. engine: ThinEngine;
  7067. program: Nullable<WebGLProgram>;
  7068. context?: WebGLRenderingContext;
  7069. vertexShader?: WebGLShader;
  7070. fragmentShader?: WebGLShader;
  7071. isParallelCompiled: boolean;
  7072. onCompiled?: () => void;
  7073. transformFeedback?: WebGLTransformFeedback | null;
  7074. readonly isAsync: boolean;
  7075. readonly isReady: boolean;
  7076. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7077. }
  7078. }
  7079. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7080. import { FloatArray, Nullable } from "babylonjs/types";
  7081. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7082. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7083. module "babylonjs/Engines/thinEngine" {
  7084. interface ThinEngine {
  7085. /**
  7086. * Create an uniform buffer
  7087. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7088. * @param elements defines the content of the uniform buffer
  7089. * @returns the webGL uniform buffer
  7090. */
  7091. createUniformBuffer(elements: FloatArray): DataBuffer;
  7092. /**
  7093. * Create a dynamic uniform buffer
  7094. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7095. * @param elements defines the content of the uniform buffer
  7096. * @returns the webGL uniform buffer
  7097. */
  7098. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7099. /**
  7100. * Update an existing uniform buffer
  7101. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7102. * @param uniformBuffer defines the target uniform buffer
  7103. * @param elements defines the content to update
  7104. * @param offset defines the offset in the uniform buffer where update should start
  7105. * @param count defines the size of the data to update
  7106. */
  7107. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7108. /**
  7109. * Bind an uniform buffer to the current webGL context
  7110. * @param buffer defines the buffer to bind
  7111. */
  7112. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7113. /**
  7114. * Bind a buffer to the current webGL context at a given location
  7115. * @param buffer defines the buffer to bind
  7116. * @param location defines the index where to bind the buffer
  7117. */
  7118. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7119. /**
  7120. * Bind a specific block at a given index in a specific shader program
  7121. * @param pipelineContext defines the pipeline context to use
  7122. * @param blockName defines the block name
  7123. * @param index defines the index where to bind the block
  7124. */
  7125. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7126. }
  7127. }
  7128. }
  7129. declare module "babylonjs/Materials/uniformBuffer" {
  7130. import { Nullable, FloatArray } from "babylonjs/types";
  7131. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7132. import { Engine } from "babylonjs/Engines/engine";
  7133. import { Effect } from "babylonjs/Materials/effect";
  7134. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7135. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7136. import { Color3 } from "babylonjs/Maths/math.color";
  7137. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7138. /**
  7139. * Uniform buffer objects.
  7140. *
  7141. * Handles blocks of uniform on the GPU.
  7142. *
  7143. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7144. *
  7145. * For more information, please refer to :
  7146. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7147. */
  7148. export class UniformBuffer {
  7149. private _engine;
  7150. private _buffer;
  7151. private _data;
  7152. private _bufferData;
  7153. private _dynamic?;
  7154. private _uniformLocations;
  7155. private _uniformSizes;
  7156. private _uniformLocationPointer;
  7157. private _needSync;
  7158. private _noUBO;
  7159. private _currentEffect;
  7160. /** @hidden */
  7161. _alreadyBound: boolean;
  7162. private static _MAX_UNIFORM_SIZE;
  7163. private static _tempBuffer;
  7164. /**
  7165. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7166. * This is dynamic to allow compat with webgl 1 and 2.
  7167. * You will need to pass the name of the uniform as well as the value.
  7168. */
  7169. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7170. /**
  7171. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7172. * This is dynamic to allow compat with webgl 1 and 2.
  7173. * You will need to pass the name of the uniform as well as the value.
  7174. */
  7175. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7176. /**
  7177. * Lambda to Update a single float in a uniform buffer.
  7178. * This is dynamic to allow compat with webgl 1 and 2.
  7179. * You will need to pass the name of the uniform as well as the value.
  7180. */
  7181. updateFloat: (name: string, x: number) => void;
  7182. /**
  7183. * Lambda to Update a vec2 of float in a uniform buffer.
  7184. * This is dynamic to allow compat with webgl 1 and 2.
  7185. * You will need to pass the name of the uniform as well as the value.
  7186. */
  7187. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7188. /**
  7189. * Lambda to Update a vec3 of float in a uniform buffer.
  7190. * This is dynamic to allow compat with webgl 1 and 2.
  7191. * You will need to pass the name of the uniform as well as the value.
  7192. */
  7193. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7194. /**
  7195. * Lambda to Update a vec4 of float in a uniform buffer.
  7196. * This is dynamic to allow compat with webgl 1 and 2.
  7197. * You will need to pass the name of the uniform as well as the value.
  7198. */
  7199. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7200. /**
  7201. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7202. * This is dynamic to allow compat with webgl 1 and 2.
  7203. * You will need to pass the name of the uniform as well as the value.
  7204. */
  7205. updateMatrix: (name: string, mat: Matrix) => void;
  7206. /**
  7207. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7208. * This is dynamic to allow compat with webgl 1 and 2.
  7209. * You will need to pass the name of the uniform as well as the value.
  7210. */
  7211. updateVector3: (name: string, vector: Vector3) => void;
  7212. /**
  7213. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7214. * This is dynamic to allow compat with webgl 1 and 2.
  7215. * You will need to pass the name of the uniform as well as the value.
  7216. */
  7217. updateVector4: (name: string, vector: Vector4) => void;
  7218. /**
  7219. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7220. * This is dynamic to allow compat with webgl 1 and 2.
  7221. * You will need to pass the name of the uniform as well as the value.
  7222. */
  7223. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7224. /**
  7225. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7226. * This is dynamic to allow compat with webgl 1 and 2.
  7227. * You will need to pass the name of the uniform as well as the value.
  7228. */
  7229. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7230. /**
  7231. * Instantiates a new Uniform buffer objects.
  7232. *
  7233. * Handles blocks of uniform on the GPU.
  7234. *
  7235. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7236. *
  7237. * For more information, please refer to :
  7238. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7239. * @param engine Define the engine the buffer is associated with
  7240. * @param data Define the data contained in the buffer
  7241. * @param dynamic Define if the buffer is updatable
  7242. */
  7243. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7244. /**
  7245. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7246. * or just falling back on setUniformXXX calls.
  7247. */
  7248. readonly useUbo: boolean;
  7249. /**
  7250. * Indicates if the WebGL underlying uniform buffer is in sync
  7251. * with the javascript cache data.
  7252. */
  7253. readonly isSync: boolean;
  7254. /**
  7255. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7256. * Also, a dynamic UniformBuffer will disable cache verification and always
  7257. * update the underlying WebGL uniform buffer to the GPU.
  7258. * @returns if Dynamic, otherwise false
  7259. */
  7260. isDynamic(): boolean;
  7261. /**
  7262. * The data cache on JS side.
  7263. * @returns the underlying data as a float array
  7264. */
  7265. getData(): Float32Array;
  7266. /**
  7267. * The underlying WebGL Uniform buffer.
  7268. * @returns the webgl buffer
  7269. */
  7270. getBuffer(): Nullable<DataBuffer>;
  7271. /**
  7272. * std140 layout specifies how to align data within an UBO structure.
  7273. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7274. * for specs.
  7275. */
  7276. private _fillAlignment;
  7277. /**
  7278. * Adds an uniform in the buffer.
  7279. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7280. * for the layout to be correct !
  7281. * @param name Name of the uniform, as used in the uniform block in the shader.
  7282. * @param size Data size, or data directly.
  7283. */
  7284. addUniform(name: string, size: number | number[]): void;
  7285. /**
  7286. * Adds a Matrix 4x4 to the uniform buffer.
  7287. * @param name Name of the uniform, as used in the uniform block in the shader.
  7288. * @param mat A 4x4 matrix.
  7289. */
  7290. addMatrix(name: string, mat: Matrix): void;
  7291. /**
  7292. * Adds a vec2 to the uniform buffer.
  7293. * @param name Name of the uniform, as used in the uniform block in the shader.
  7294. * @param x Define the x component value of the vec2
  7295. * @param y Define the y component value of the vec2
  7296. */
  7297. addFloat2(name: string, x: number, y: number): void;
  7298. /**
  7299. * Adds a vec3 to the uniform buffer.
  7300. * @param name Name of the uniform, as used in the uniform block in the shader.
  7301. * @param x Define the x component value of the vec3
  7302. * @param y Define the y component value of the vec3
  7303. * @param z Define the z component value of the vec3
  7304. */
  7305. addFloat3(name: string, x: number, y: number, z: number): void;
  7306. /**
  7307. * Adds a vec3 to the uniform buffer.
  7308. * @param name Name of the uniform, as used in the uniform block in the shader.
  7309. * @param color Define the vec3 from a Color
  7310. */
  7311. addColor3(name: string, color: Color3): void;
  7312. /**
  7313. * Adds a vec4 to the uniform buffer.
  7314. * @param name Name of the uniform, as used in the uniform block in the shader.
  7315. * @param color Define the rgb components from a Color
  7316. * @param alpha Define the a component of the vec4
  7317. */
  7318. addColor4(name: string, color: Color3, alpha: number): void;
  7319. /**
  7320. * Adds a vec3 to the uniform buffer.
  7321. * @param name Name of the uniform, as used in the uniform block in the shader.
  7322. * @param vector Define the vec3 components from a Vector
  7323. */
  7324. addVector3(name: string, vector: Vector3): void;
  7325. /**
  7326. * Adds a Matrix 3x3 to the uniform buffer.
  7327. * @param name Name of the uniform, as used in the uniform block in the shader.
  7328. */
  7329. addMatrix3x3(name: string): void;
  7330. /**
  7331. * Adds a Matrix 2x2 to the uniform buffer.
  7332. * @param name Name of the uniform, as used in the uniform block in the shader.
  7333. */
  7334. addMatrix2x2(name: string): void;
  7335. /**
  7336. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7337. */
  7338. create(): void;
  7339. /** @hidden */
  7340. _rebuild(): void;
  7341. /**
  7342. * Updates the WebGL Uniform Buffer on the GPU.
  7343. * If the `dynamic` flag is set to true, no cache comparison is done.
  7344. * Otherwise, the buffer will be updated only if the cache differs.
  7345. */
  7346. update(): void;
  7347. /**
  7348. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7349. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7350. * @param data Define the flattened data
  7351. * @param size Define the size of the data.
  7352. */
  7353. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7354. private _valueCache;
  7355. private _cacheMatrix;
  7356. private _updateMatrix3x3ForUniform;
  7357. private _updateMatrix3x3ForEffect;
  7358. private _updateMatrix2x2ForEffect;
  7359. private _updateMatrix2x2ForUniform;
  7360. private _updateFloatForEffect;
  7361. private _updateFloatForUniform;
  7362. private _updateFloat2ForEffect;
  7363. private _updateFloat2ForUniform;
  7364. private _updateFloat3ForEffect;
  7365. private _updateFloat3ForUniform;
  7366. private _updateFloat4ForEffect;
  7367. private _updateFloat4ForUniform;
  7368. private _updateMatrixForEffect;
  7369. private _updateMatrixForUniform;
  7370. private _updateVector3ForEffect;
  7371. private _updateVector3ForUniform;
  7372. private _updateVector4ForEffect;
  7373. private _updateVector4ForUniform;
  7374. private _updateColor3ForEffect;
  7375. private _updateColor3ForUniform;
  7376. private _updateColor4ForEffect;
  7377. private _updateColor4ForUniform;
  7378. /**
  7379. * Sets a sampler uniform on the effect.
  7380. * @param name Define the name of the sampler.
  7381. * @param texture Define the texture to set in the sampler
  7382. */
  7383. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7384. /**
  7385. * Directly updates the value of the uniform in the cache AND on the GPU.
  7386. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7387. * @param data Define the flattened data
  7388. */
  7389. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7390. /**
  7391. * Binds this uniform buffer to an effect.
  7392. * @param effect Define the effect to bind the buffer to
  7393. * @param name Name of the uniform block in the shader.
  7394. */
  7395. bindToEffect(effect: Effect, name: string): void;
  7396. /**
  7397. * Disposes the uniform buffer.
  7398. */
  7399. dispose(): void;
  7400. }
  7401. }
  7402. declare module "babylonjs/Misc/iInspectable" {
  7403. /**
  7404. * Enum that determines the text-wrapping mode to use.
  7405. */
  7406. export enum InspectableType {
  7407. /**
  7408. * Checkbox for booleans
  7409. */
  7410. Checkbox = 0,
  7411. /**
  7412. * Sliders for numbers
  7413. */
  7414. Slider = 1,
  7415. /**
  7416. * Vector3
  7417. */
  7418. Vector3 = 2,
  7419. /**
  7420. * Quaternions
  7421. */
  7422. Quaternion = 3,
  7423. /**
  7424. * Color3
  7425. */
  7426. Color3 = 4,
  7427. /**
  7428. * String
  7429. */
  7430. String = 5
  7431. }
  7432. /**
  7433. * Interface used to define custom inspectable properties.
  7434. * This interface is used by the inspector to display custom property grids
  7435. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7436. */
  7437. export interface IInspectable {
  7438. /**
  7439. * Gets the label to display
  7440. */
  7441. label: string;
  7442. /**
  7443. * Gets the name of the property to edit
  7444. */
  7445. propertyName: string;
  7446. /**
  7447. * Gets the type of the editor to use
  7448. */
  7449. type: InspectableType;
  7450. /**
  7451. * Gets the minimum value of the property when using in "slider" mode
  7452. */
  7453. min?: number;
  7454. /**
  7455. * Gets the maximum value of the property when using in "slider" mode
  7456. */
  7457. max?: number;
  7458. /**
  7459. * Gets the setp to use when using in "slider" mode
  7460. */
  7461. step?: number;
  7462. }
  7463. }
  7464. declare module "babylonjs/Misc/timingTools" {
  7465. /**
  7466. * Class used to provide helper for timing
  7467. */
  7468. export class TimingTools {
  7469. /**
  7470. * Polyfill for setImmediate
  7471. * @param action defines the action to execute after the current execution block
  7472. */
  7473. static SetImmediate(action: () => void): void;
  7474. }
  7475. }
  7476. declare module "babylonjs/Misc/instantiationTools" {
  7477. /**
  7478. * Class used to enable instatition of objects by class name
  7479. */
  7480. export class InstantiationTools {
  7481. /**
  7482. * Use this object to register external classes like custom textures or material
  7483. * to allow the laoders to instantiate them
  7484. */
  7485. static RegisteredExternalClasses: {
  7486. [key: string]: Object;
  7487. };
  7488. /**
  7489. * Tries to instantiate a new object from a given class name
  7490. * @param className defines the class name to instantiate
  7491. * @returns the new object or null if the system was not able to do the instantiation
  7492. */
  7493. static Instantiate(className: string): any;
  7494. }
  7495. }
  7496. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7497. /**
  7498. * Define options used to create a depth texture
  7499. */
  7500. export class DepthTextureCreationOptions {
  7501. /** Specifies whether or not a stencil should be allocated in the texture */
  7502. generateStencil?: boolean;
  7503. /** Specifies whether or not bilinear filtering is enable on the texture */
  7504. bilinearFiltering?: boolean;
  7505. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7506. comparisonFunction?: number;
  7507. /** Specifies if the created texture is a cube texture */
  7508. isCube?: boolean;
  7509. }
  7510. }
  7511. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7512. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7513. import { Nullable } from "babylonjs/types";
  7514. import { Scene } from "babylonjs/scene";
  7515. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  7516. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7517. module "babylonjs/Engines/thinEngine" {
  7518. interface ThinEngine {
  7519. /**
  7520. * Creates a depth stencil cube texture.
  7521. * This is only available in WebGL 2.
  7522. * @param size The size of face edge in the cube texture.
  7523. * @param options The options defining the cube texture.
  7524. * @returns The cube texture
  7525. */
  7526. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7527. /**
  7528. * Creates a cube texture
  7529. * @param rootUrl defines the url where the files to load is located
  7530. * @param scene defines the current scene
  7531. * @param files defines the list of files to load (1 per face)
  7532. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7533. * @param onLoad defines an optional callback raised when the texture is loaded
  7534. * @param onError defines an optional callback raised if there is an issue to load the texture
  7535. * @param format defines the format of the data
  7536. * @param forcedExtension defines the extension to use to pick the right loader
  7537. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7538. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7539. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7540. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7541. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (defualt: empty array)
  7542. * @returns the cube texture as an InternalTexture
  7543. */
  7544. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean | undefined, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number, fallback: Nullable<InternalTexture>, excludeLoaders: Array<IInternalTextureLoader>): InternalTexture;
  7545. /**
  7546. * Creates a cube texture
  7547. * @param rootUrl defines the url where the files to load is located
  7548. * @param scene defines the current scene
  7549. * @param files defines the list of files to load (1 per face)
  7550. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7551. * @param onLoad defines an optional callback raised when the texture is loaded
  7552. * @param onError defines an optional callback raised if there is an issue to load the texture
  7553. * @param format defines the format of the data
  7554. * @param forcedExtension defines the extension to use to pick the right loader
  7555. * @returns the cube texture as an InternalTexture
  7556. */
  7557. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any): InternalTexture;
  7558. /**
  7559. * Creates a cube texture
  7560. * @param rootUrl defines the url where the files to load is located
  7561. * @param scene defines the current scene
  7562. * @param files defines the list of files to load (1 per face)
  7563. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7564. * @param onLoad defines an optional callback raised when the texture is loaded
  7565. * @param onError defines an optional callback raised if there is an issue to load the texture
  7566. * @param format defines the format of the data
  7567. * @param forcedExtension defines the extension to use to pick the right loader
  7568. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7569. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7570. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7571. * @returns the cube texture as an InternalTexture
  7572. */
  7573. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number): InternalTexture;
  7574. /** @hidden */
  7575. _partialLoadFile(url: string, index: number, loadedFiles: (string | ArrayBuffer)[], onfinish: (files: (string | ArrayBuffer)[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7576. /** @hidden */
  7577. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: (string | ArrayBuffer)[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7578. /** @hidden */
  7579. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7580. /** @hidden */
  7581. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7582. /**
  7583. * @hidden
  7584. */
  7585. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7586. }
  7587. }
  7588. }
  7589. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7590. import { Nullable } from "babylonjs/types";
  7591. import { Scene } from "babylonjs/scene";
  7592. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7593. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7594. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7595. /**
  7596. * Class for creating a cube texture
  7597. */
  7598. export class CubeTexture extends BaseTexture {
  7599. private _delayedOnLoad;
  7600. /**
  7601. * The url of the texture
  7602. */
  7603. url: string;
  7604. /**
  7605. * Gets or sets the center of the bounding box associated with the cube texture.
  7606. * It must define where the camera used to render the texture was set
  7607. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7608. */
  7609. boundingBoxPosition: Vector3;
  7610. private _boundingBoxSize;
  7611. /**
  7612. * Gets or sets the size of the bounding box associated with the cube texture
  7613. * When defined, the cubemap will switch to local mode
  7614. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7615. * @example https://www.babylonjs-playground.com/#RNASML
  7616. */
  7617. /**
  7618. * Returns the bounding box size
  7619. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7620. */
  7621. boundingBoxSize: Vector3;
  7622. protected _rotationY: number;
  7623. /**
  7624. * Sets texture matrix rotation angle around Y axis in radians.
  7625. */
  7626. /**
  7627. * Gets texture matrix rotation angle around Y axis radians.
  7628. */
  7629. rotationY: number;
  7630. /**
  7631. * Are mip maps generated for this texture or not.
  7632. */
  7633. readonly noMipmap: boolean;
  7634. private _noMipmap;
  7635. private _files;
  7636. protected _forcedExtension: Nullable<string>;
  7637. private _extensions;
  7638. private _textureMatrix;
  7639. private _format;
  7640. private _createPolynomials;
  7641. /** @hidden */
  7642. _prefiltered: boolean;
  7643. /**
  7644. * Creates a cube texture from an array of image urls
  7645. * @param files defines an array of image urls
  7646. * @param scene defines the hosting scene
  7647. * @param noMipmap specifies if mip maps are not used
  7648. * @returns a cube texture
  7649. */
  7650. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7651. /**
  7652. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7653. * @param url defines the url of the prefiltered texture
  7654. * @param scene defines the scene the texture is attached to
  7655. * @param forcedExtension defines the extension of the file if different from the url
  7656. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7657. * @return the prefiltered texture
  7658. */
  7659. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7660. /**
  7661. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7662. * as prefiltered data.
  7663. * @param rootUrl defines the url of the texture or the root name of the six images
  7664. * @param scene defines the scene the texture is attached to
  7665. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7666. * @param noMipmap defines if mipmaps should be created or not
  7667. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7668. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7669. * @param onError defines a callback triggered in case of error during load
  7670. * @param format defines the internal format to use for the texture once loaded
  7671. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7672. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7673. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7674. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7675. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7676. * @return the cube texture
  7677. */
  7678. constructor(rootUrl: string, scene: Scene, extensions?: Nullable<string[]>, noMipmap?: boolean, files?: Nullable<string[]>, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, prefiltered?: boolean, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number);
  7679. /**
  7680. * Gets a boolean indicating if the cube texture contains prefiltered mips (used to simulate roughness with PBR)
  7681. */
  7682. readonly isPrefiltered: boolean;
  7683. /**
  7684. * Get the current class name of the texture useful for serialization or dynamic coding.
  7685. * @returns "CubeTexture"
  7686. */
  7687. getClassName(): string;
  7688. /**
  7689. * Update the url (and optional buffer) of this texture if url was null during construction.
  7690. * @param url the url of the texture
  7691. * @param forcedExtension defines the extension to use
  7692. * @param onLoad callback called when the texture is loaded (defaults to null)
  7693. */
  7694. updateURL(url: string, forcedExtension?: string, onLoad?: () => void): void;
  7695. /**
  7696. * Delays loading of the cube texture
  7697. * @param forcedExtension defines the extension to use
  7698. */
  7699. delayLoad(forcedExtension?: string): void;
  7700. /**
  7701. * Returns the reflection texture matrix
  7702. * @returns the reflection texture matrix
  7703. */
  7704. getReflectionTextureMatrix(): Matrix;
  7705. /**
  7706. * Sets the reflection texture matrix
  7707. * @param value Reflection texture matrix
  7708. */
  7709. setReflectionTextureMatrix(value: Matrix): void;
  7710. /**
  7711. * Parses text to create a cube texture
  7712. * @param parsedTexture define the serialized text to read from
  7713. * @param scene defines the hosting scene
  7714. * @param rootUrl defines the root url of the cube texture
  7715. * @returns a cube texture
  7716. */
  7717. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  7718. /**
  7719. * Makes a clone, or deep copy, of the cube texture
  7720. * @returns a new cube texture
  7721. */
  7722. clone(): CubeTexture;
  7723. }
  7724. }
  7725. declare module "babylonjs/Materials/materialDefines" {
  7726. /**
  7727. * Manages the defines for the Material
  7728. */
  7729. export class MaterialDefines {
  7730. /** @hidden */
  7731. protected _keys: string[];
  7732. private _isDirty;
  7733. /** @hidden */
  7734. _renderId: number;
  7735. /** @hidden */
  7736. _areLightsDirty: boolean;
  7737. /** @hidden */
  7738. _areLightsDisposed: boolean;
  7739. /** @hidden */
  7740. _areAttributesDirty: boolean;
  7741. /** @hidden */
  7742. _areTexturesDirty: boolean;
  7743. /** @hidden */
  7744. _areFresnelDirty: boolean;
  7745. /** @hidden */
  7746. _areMiscDirty: boolean;
  7747. /** @hidden */
  7748. _areImageProcessingDirty: boolean;
  7749. /** @hidden */
  7750. _normals: boolean;
  7751. /** @hidden */
  7752. _uvs: boolean;
  7753. /** @hidden */
  7754. _needNormals: boolean;
  7755. /** @hidden */
  7756. _needUVs: boolean;
  7757. [id: string]: any;
  7758. /**
  7759. * Specifies if the material needs to be re-calculated
  7760. */
  7761. readonly isDirty: boolean;
  7762. /**
  7763. * Marks the material to indicate that it has been re-calculated
  7764. */
  7765. markAsProcessed(): void;
  7766. /**
  7767. * Marks the material to indicate that it needs to be re-calculated
  7768. */
  7769. markAsUnprocessed(): void;
  7770. /**
  7771. * Marks the material to indicate all of its defines need to be re-calculated
  7772. */
  7773. markAllAsDirty(): void;
  7774. /**
  7775. * Marks the material to indicate that image processing needs to be re-calculated
  7776. */
  7777. markAsImageProcessingDirty(): void;
  7778. /**
  7779. * Marks the material to indicate the lights need to be re-calculated
  7780. * @param disposed Defines whether the light is dirty due to dispose or not
  7781. */
  7782. markAsLightDirty(disposed?: boolean): void;
  7783. /**
  7784. * Marks the attribute state as changed
  7785. */
  7786. markAsAttributesDirty(): void;
  7787. /**
  7788. * Marks the texture state as changed
  7789. */
  7790. markAsTexturesDirty(): void;
  7791. /**
  7792. * Marks the fresnel state as changed
  7793. */
  7794. markAsFresnelDirty(): void;
  7795. /**
  7796. * Marks the misc state as changed
  7797. */
  7798. markAsMiscDirty(): void;
  7799. /**
  7800. * Rebuilds the material defines
  7801. */
  7802. rebuild(): void;
  7803. /**
  7804. * Specifies if two material defines are equal
  7805. * @param other - A material define instance to compare to
  7806. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  7807. */
  7808. isEqual(other: MaterialDefines): boolean;
  7809. /**
  7810. * Clones this instance's defines to another instance
  7811. * @param other - material defines to clone values to
  7812. */
  7813. cloneTo(other: MaterialDefines): void;
  7814. /**
  7815. * Resets the material define values
  7816. */
  7817. reset(): void;
  7818. /**
  7819. * Converts the material define values to a string
  7820. * @returns - String of material define information
  7821. */
  7822. toString(): string;
  7823. }
  7824. }
  7825. declare module "babylonjs/Materials/colorCurves" {
  7826. import { Effect } from "babylonjs/Materials/effect";
  7827. /**
  7828. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  7829. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  7830. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  7831. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  7832. */
  7833. export class ColorCurves {
  7834. private _dirty;
  7835. private _tempColor;
  7836. private _globalCurve;
  7837. private _highlightsCurve;
  7838. private _midtonesCurve;
  7839. private _shadowsCurve;
  7840. private _positiveCurve;
  7841. private _negativeCurve;
  7842. private _globalHue;
  7843. private _globalDensity;
  7844. private _globalSaturation;
  7845. private _globalExposure;
  7846. /**
  7847. * Gets the global Hue value.
  7848. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7849. */
  7850. /**
  7851. * Sets the global Hue value.
  7852. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7853. */
  7854. globalHue: number;
  7855. /**
  7856. * Gets the global Density value.
  7857. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7858. * Values less than zero provide a filter of opposite hue.
  7859. */
  7860. /**
  7861. * Sets the global Density value.
  7862. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7863. * Values less than zero provide a filter of opposite hue.
  7864. */
  7865. globalDensity: number;
  7866. /**
  7867. * Gets the global Saturation value.
  7868. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7869. */
  7870. /**
  7871. * Sets the global Saturation value.
  7872. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7873. */
  7874. globalSaturation: number;
  7875. /**
  7876. * Gets the global Exposure value.
  7877. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7878. */
  7879. /**
  7880. * Sets the global Exposure value.
  7881. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7882. */
  7883. globalExposure: number;
  7884. private _highlightsHue;
  7885. private _highlightsDensity;
  7886. private _highlightsSaturation;
  7887. private _highlightsExposure;
  7888. /**
  7889. * Gets the highlights Hue value.
  7890. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7891. */
  7892. /**
  7893. * Sets the highlights Hue value.
  7894. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7895. */
  7896. highlightsHue: number;
  7897. /**
  7898. * Gets the highlights Density value.
  7899. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7900. * Values less than zero provide a filter of opposite hue.
  7901. */
  7902. /**
  7903. * Sets the highlights Density value.
  7904. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7905. * Values less than zero provide a filter of opposite hue.
  7906. */
  7907. highlightsDensity: number;
  7908. /**
  7909. * Gets the highlights Saturation value.
  7910. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7911. */
  7912. /**
  7913. * Sets the highlights Saturation value.
  7914. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7915. */
  7916. highlightsSaturation: number;
  7917. /**
  7918. * Gets the highlights Exposure value.
  7919. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7920. */
  7921. /**
  7922. * Sets the highlights Exposure value.
  7923. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7924. */
  7925. highlightsExposure: number;
  7926. private _midtonesHue;
  7927. private _midtonesDensity;
  7928. private _midtonesSaturation;
  7929. private _midtonesExposure;
  7930. /**
  7931. * Gets the midtones Hue value.
  7932. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7933. */
  7934. /**
  7935. * Sets the midtones Hue value.
  7936. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7937. */
  7938. midtonesHue: number;
  7939. /**
  7940. * Gets the midtones Density value.
  7941. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7942. * Values less than zero provide a filter of opposite hue.
  7943. */
  7944. /**
  7945. * Sets the midtones Density value.
  7946. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7947. * Values less than zero provide a filter of opposite hue.
  7948. */
  7949. midtonesDensity: number;
  7950. /**
  7951. * Gets the midtones Saturation value.
  7952. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7953. */
  7954. /**
  7955. * Sets the midtones Saturation value.
  7956. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7957. */
  7958. midtonesSaturation: number;
  7959. /**
  7960. * Gets the midtones Exposure value.
  7961. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7962. */
  7963. /**
  7964. * Sets the midtones Exposure value.
  7965. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7966. */
  7967. midtonesExposure: number;
  7968. private _shadowsHue;
  7969. private _shadowsDensity;
  7970. private _shadowsSaturation;
  7971. private _shadowsExposure;
  7972. /**
  7973. * Gets the shadows Hue value.
  7974. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7975. */
  7976. /**
  7977. * Sets the shadows Hue value.
  7978. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7979. */
  7980. shadowsHue: number;
  7981. /**
  7982. * Gets the shadows Density value.
  7983. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7984. * Values less than zero provide a filter of opposite hue.
  7985. */
  7986. /**
  7987. * Sets the shadows Density value.
  7988. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7989. * Values less than zero provide a filter of opposite hue.
  7990. */
  7991. shadowsDensity: number;
  7992. /**
  7993. * Gets the shadows Saturation value.
  7994. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7995. */
  7996. /**
  7997. * Sets the shadows Saturation value.
  7998. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7999. */
  8000. shadowsSaturation: number;
  8001. /**
  8002. * Gets the shadows Exposure value.
  8003. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8004. */
  8005. /**
  8006. * Sets the shadows Exposure value.
  8007. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8008. */
  8009. shadowsExposure: number;
  8010. /**
  8011. * Returns the class name
  8012. * @returns The class name
  8013. */
  8014. getClassName(): string;
  8015. /**
  8016. * Binds the color curves to the shader.
  8017. * @param colorCurves The color curve to bind
  8018. * @param effect The effect to bind to
  8019. * @param positiveUniform The positive uniform shader parameter
  8020. * @param neutralUniform The neutral uniform shader parameter
  8021. * @param negativeUniform The negative uniform shader parameter
  8022. */
  8023. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8024. /**
  8025. * Prepare the list of uniforms associated with the ColorCurves effects.
  8026. * @param uniformsList The list of uniforms used in the effect
  8027. */
  8028. static PrepareUniforms(uniformsList: string[]): void;
  8029. /**
  8030. * Returns color grading data based on a hue, density, saturation and exposure value.
  8031. * @param filterHue The hue of the color filter.
  8032. * @param filterDensity The density of the color filter.
  8033. * @param saturation The saturation.
  8034. * @param exposure The exposure.
  8035. * @param result The result data container.
  8036. */
  8037. private getColorGradingDataToRef;
  8038. /**
  8039. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8040. * @param value The input slider value in range [-100,100].
  8041. * @returns Adjusted value.
  8042. */
  8043. private static applyColorGradingSliderNonlinear;
  8044. /**
  8045. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8046. * @param hue The hue (H) input.
  8047. * @param saturation The saturation (S) input.
  8048. * @param brightness The brightness (B) input.
  8049. * @result An RGBA color represented as Vector4.
  8050. */
  8051. private static fromHSBToRef;
  8052. /**
  8053. * Returns a value clamped between min and max
  8054. * @param value The value to clamp
  8055. * @param min The minimum of value
  8056. * @param max The maximum of value
  8057. * @returns The clamped value.
  8058. */
  8059. private static clamp;
  8060. /**
  8061. * Clones the current color curve instance.
  8062. * @return The cloned curves
  8063. */
  8064. clone(): ColorCurves;
  8065. /**
  8066. * Serializes the current color curve instance to a json representation.
  8067. * @return a JSON representation
  8068. */
  8069. serialize(): any;
  8070. /**
  8071. * Parses the color curve from a json representation.
  8072. * @param source the JSON source to parse
  8073. * @return The parsed curves
  8074. */
  8075. static Parse(source: any): ColorCurves;
  8076. }
  8077. }
  8078. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8079. import { Observable } from "babylonjs/Misc/observable";
  8080. import { Nullable } from "babylonjs/types";
  8081. import { Color4 } from "babylonjs/Maths/math.color";
  8082. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8083. import { Effect } from "babylonjs/Materials/effect";
  8084. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8085. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8086. /**
  8087. * Interface to follow in your material defines to integrate easily the
  8088. * Image proccessing functions.
  8089. * @hidden
  8090. */
  8091. export interface IImageProcessingConfigurationDefines {
  8092. IMAGEPROCESSING: boolean;
  8093. VIGNETTE: boolean;
  8094. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8095. VIGNETTEBLENDMODEOPAQUE: boolean;
  8096. TONEMAPPING: boolean;
  8097. TONEMAPPING_ACES: boolean;
  8098. CONTRAST: boolean;
  8099. EXPOSURE: boolean;
  8100. COLORCURVES: boolean;
  8101. COLORGRADING: boolean;
  8102. COLORGRADING3D: boolean;
  8103. SAMPLER3DGREENDEPTH: boolean;
  8104. SAMPLER3DBGRMAP: boolean;
  8105. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8106. }
  8107. /**
  8108. * @hidden
  8109. */
  8110. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8111. IMAGEPROCESSING: boolean;
  8112. VIGNETTE: boolean;
  8113. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8114. VIGNETTEBLENDMODEOPAQUE: boolean;
  8115. TONEMAPPING: boolean;
  8116. TONEMAPPING_ACES: boolean;
  8117. CONTRAST: boolean;
  8118. COLORCURVES: boolean;
  8119. COLORGRADING: boolean;
  8120. COLORGRADING3D: boolean;
  8121. SAMPLER3DGREENDEPTH: boolean;
  8122. SAMPLER3DBGRMAP: boolean;
  8123. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8124. EXPOSURE: boolean;
  8125. constructor();
  8126. }
  8127. /**
  8128. * This groups together the common properties used for image processing either in direct forward pass
  8129. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8130. * or not.
  8131. */
  8132. export class ImageProcessingConfiguration {
  8133. /**
  8134. * Default tone mapping applied in BabylonJS.
  8135. */
  8136. static readonly TONEMAPPING_STANDARD: number;
  8137. /**
  8138. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8139. * to other engines rendering to increase portability.
  8140. */
  8141. static readonly TONEMAPPING_ACES: number;
  8142. /**
  8143. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8144. */
  8145. colorCurves: Nullable<ColorCurves>;
  8146. private _colorCurvesEnabled;
  8147. /**
  8148. * Gets wether the color curves effect is enabled.
  8149. */
  8150. /**
  8151. * Sets wether the color curves effect is enabled.
  8152. */
  8153. colorCurvesEnabled: boolean;
  8154. private _colorGradingTexture;
  8155. /**
  8156. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8157. */
  8158. /**
  8159. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8160. */
  8161. colorGradingTexture: Nullable<BaseTexture>;
  8162. private _colorGradingEnabled;
  8163. /**
  8164. * Gets wether the color grading effect is enabled.
  8165. */
  8166. /**
  8167. * Sets wether the color grading effect is enabled.
  8168. */
  8169. colorGradingEnabled: boolean;
  8170. private _colorGradingWithGreenDepth;
  8171. /**
  8172. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8173. */
  8174. /**
  8175. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8176. */
  8177. colorGradingWithGreenDepth: boolean;
  8178. private _colorGradingBGR;
  8179. /**
  8180. * Gets wether the color grading texture contains BGR values.
  8181. */
  8182. /**
  8183. * Sets wether the color grading texture contains BGR values.
  8184. */
  8185. colorGradingBGR: boolean;
  8186. /** @hidden */
  8187. _exposure: number;
  8188. /**
  8189. * Gets the Exposure used in the effect.
  8190. */
  8191. /**
  8192. * Sets the Exposure used in the effect.
  8193. */
  8194. exposure: number;
  8195. private _toneMappingEnabled;
  8196. /**
  8197. * Gets wether the tone mapping effect is enabled.
  8198. */
  8199. /**
  8200. * Sets wether the tone mapping effect is enabled.
  8201. */
  8202. toneMappingEnabled: boolean;
  8203. private _toneMappingType;
  8204. /**
  8205. * Gets the type of tone mapping effect.
  8206. */
  8207. /**
  8208. * Sets the type of tone mapping effect used in BabylonJS.
  8209. */
  8210. toneMappingType: number;
  8211. protected _contrast: number;
  8212. /**
  8213. * Gets the contrast used in the effect.
  8214. */
  8215. /**
  8216. * Sets the contrast used in the effect.
  8217. */
  8218. contrast: number;
  8219. /**
  8220. * Vignette stretch size.
  8221. */
  8222. vignetteStretch: number;
  8223. /**
  8224. * Vignette centre X Offset.
  8225. */
  8226. vignetteCentreX: number;
  8227. /**
  8228. * Vignette centre Y Offset.
  8229. */
  8230. vignetteCentreY: number;
  8231. /**
  8232. * Vignette weight or intensity of the vignette effect.
  8233. */
  8234. vignetteWeight: number;
  8235. /**
  8236. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8237. * if vignetteEnabled is set to true.
  8238. */
  8239. vignetteColor: Color4;
  8240. /**
  8241. * Camera field of view used by the Vignette effect.
  8242. */
  8243. vignetteCameraFov: number;
  8244. private _vignetteBlendMode;
  8245. /**
  8246. * Gets the vignette blend mode allowing different kind of effect.
  8247. */
  8248. /**
  8249. * Sets the vignette blend mode allowing different kind of effect.
  8250. */
  8251. vignetteBlendMode: number;
  8252. private _vignetteEnabled;
  8253. /**
  8254. * Gets wether the vignette effect is enabled.
  8255. */
  8256. /**
  8257. * Sets wether the vignette effect is enabled.
  8258. */
  8259. vignetteEnabled: boolean;
  8260. private _applyByPostProcess;
  8261. /**
  8262. * Gets wether the image processing is applied through a post process or not.
  8263. */
  8264. /**
  8265. * Sets wether the image processing is applied through a post process or not.
  8266. */
  8267. applyByPostProcess: boolean;
  8268. private _isEnabled;
  8269. /**
  8270. * Gets wether the image processing is enabled or not.
  8271. */
  8272. /**
  8273. * Sets wether the image processing is enabled or not.
  8274. */
  8275. isEnabled: boolean;
  8276. /**
  8277. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8278. */
  8279. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8280. /**
  8281. * Method called each time the image processing information changes requires to recompile the effect.
  8282. */
  8283. protected _updateParameters(): void;
  8284. /**
  8285. * Gets the current class name.
  8286. * @return "ImageProcessingConfiguration"
  8287. */
  8288. getClassName(): string;
  8289. /**
  8290. * Prepare the list of uniforms associated with the Image Processing effects.
  8291. * @param uniforms The list of uniforms used in the effect
  8292. * @param defines the list of defines currently in use
  8293. */
  8294. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8295. /**
  8296. * Prepare the list of samplers associated with the Image Processing effects.
  8297. * @param samplersList The list of uniforms used in the effect
  8298. * @param defines the list of defines currently in use
  8299. */
  8300. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8301. /**
  8302. * Prepare the list of defines associated to the shader.
  8303. * @param defines the list of defines to complete
  8304. * @param forPostProcess Define if we are currently in post process mode or not
  8305. */
  8306. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8307. /**
  8308. * Returns true if all the image processing information are ready.
  8309. * @returns True if ready, otherwise, false
  8310. */
  8311. isReady(): boolean;
  8312. /**
  8313. * Binds the image processing to the shader.
  8314. * @param effect The effect to bind to
  8315. * @param overrideAspectRatio Override the aspect ratio of the effect
  8316. */
  8317. bind(effect: Effect, overrideAspectRatio?: number): void;
  8318. /**
  8319. * Clones the current image processing instance.
  8320. * @return The cloned image processing
  8321. */
  8322. clone(): ImageProcessingConfiguration;
  8323. /**
  8324. * Serializes the current image processing instance to a json representation.
  8325. * @return a JSON representation
  8326. */
  8327. serialize(): any;
  8328. /**
  8329. * Parses the image processing from a json representation.
  8330. * @param source the JSON source to parse
  8331. * @return The parsed image processing
  8332. */
  8333. static Parse(source: any): ImageProcessingConfiguration;
  8334. private static _VIGNETTEMODE_MULTIPLY;
  8335. private static _VIGNETTEMODE_OPAQUE;
  8336. /**
  8337. * Used to apply the vignette as a mix with the pixel color.
  8338. */
  8339. static readonly VIGNETTEMODE_MULTIPLY: number;
  8340. /**
  8341. * Used to apply the vignette as a replacement of the pixel color.
  8342. */
  8343. static readonly VIGNETTEMODE_OPAQUE: number;
  8344. }
  8345. }
  8346. declare module "babylonjs/Shaders/postprocess.vertex" {
  8347. /** @hidden */
  8348. export var postprocessVertexShader: {
  8349. name: string;
  8350. shader: string;
  8351. };
  8352. }
  8353. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8354. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8355. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8356. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8357. module "babylonjs/Engines/thinEngine" {
  8358. interface ThinEngine {
  8359. /**
  8360. * Creates a new render target texture
  8361. * @param size defines the size of the texture
  8362. * @param options defines the options used to create the texture
  8363. * @returns a new render target texture stored in an InternalTexture
  8364. */
  8365. createRenderTargetTexture(size: number | {
  8366. width: number;
  8367. height: number;
  8368. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8369. /**
  8370. * Creates a depth stencil texture.
  8371. * This is only available in WebGL 2 or with the depth texture extension available.
  8372. * @param size The size of face edge in the texture.
  8373. * @param options The options defining the texture.
  8374. * @returns The texture
  8375. */
  8376. createDepthStencilTexture(size: number | {
  8377. width: number;
  8378. height: number;
  8379. }, options: DepthTextureCreationOptions): InternalTexture;
  8380. /** @hidden */
  8381. _createDepthStencilTexture(size: number | {
  8382. width: number;
  8383. height: number;
  8384. }, options: DepthTextureCreationOptions): InternalTexture;
  8385. }
  8386. }
  8387. }
  8388. declare module "babylonjs/Maths/math.axis" {
  8389. import { Vector3 } from "babylonjs/Maths/math.vector";
  8390. /** Defines supported spaces */
  8391. export enum Space {
  8392. /** Local (object) space */
  8393. LOCAL = 0,
  8394. /** World space */
  8395. WORLD = 1,
  8396. /** Bone space */
  8397. BONE = 2
  8398. }
  8399. /** Defines the 3 main axes */
  8400. export class Axis {
  8401. /** X axis */
  8402. static X: Vector3;
  8403. /** Y axis */
  8404. static Y: Vector3;
  8405. /** Z axis */
  8406. static Z: Vector3;
  8407. }
  8408. }
  8409. declare module "babylonjs/Cameras/targetCamera" {
  8410. import { Nullable } from "babylonjs/types";
  8411. import { Camera } from "babylonjs/Cameras/camera";
  8412. import { Scene } from "babylonjs/scene";
  8413. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8414. /**
  8415. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  8416. * This is the base of the follow, arc rotate cameras and Free camera
  8417. * @see http://doc.babylonjs.com/features/cameras
  8418. */
  8419. export class TargetCamera extends Camera {
  8420. private static _RigCamTransformMatrix;
  8421. private static _TargetTransformMatrix;
  8422. private static _TargetFocalPoint;
  8423. /**
  8424. * Define the current direction the camera is moving to
  8425. */
  8426. cameraDirection: Vector3;
  8427. /**
  8428. * Define the current rotation the camera is rotating to
  8429. */
  8430. cameraRotation: Vector2;
  8431. /**
  8432. * When set, the up vector of the camera will be updated by the rotation of the camera
  8433. */
  8434. updateUpVectorFromRotation: boolean;
  8435. private _tmpQuaternion;
  8436. /**
  8437. * Define the current rotation of the camera
  8438. */
  8439. rotation: Vector3;
  8440. /**
  8441. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  8442. */
  8443. rotationQuaternion: Quaternion;
  8444. /**
  8445. * Define the current speed of the camera
  8446. */
  8447. speed: number;
  8448. /**
  8449. * Add cconstraint to the camera to prevent it to move freely in all directions and
  8450. * around all axis.
  8451. */
  8452. noRotationConstraint: boolean;
  8453. /**
  8454. * Define the current target of the camera as an object or a position.
  8455. */
  8456. lockedTarget: any;
  8457. /** @hidden */
  8458. _currentTarget: Vector3;
  8459. /** @hidden */
  8460. _initialFocalDistance: number;
  8461. /** @hidden */
  8462. _viewMatrix: Matrix;
  8463. /** @hidden */
  8464. _camMatrix: Matrix;
  8465. /** @hidden */
  8466. _cameraTransformMatrix: Matrix;
  8467. /** @hidden */
  8468. _cameraRotationMatrix: Matrix;
  8469. /** @hidden */
  8470. _referencePoint: Vector3;
  8471. /** @hidden */
  8472. _transformedReferencePoint: Vector3;
  8473. protected _globalCurrentTarget: Vector3;
  8474. protected _globalCurrentUpVector: Vector3;
  8475. /** @hidden */
  8476. _reset: () => void;
  8477. private _defaultUp;
  8478. /**
  8479. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  8480. * This is the base of the follow, arc rotate cameras and Free camera
  8481. * @see http://doc.babylonjs.com/features/cameras
  8482. * @param name Defines the name of the camera in the scene
  8483. * @param position Defines the start position of the camera in the scene
  8484. * @param scene Defines the scene the camera belongs to
  8485. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  8486. */
  8487. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  8488. /**
  8489. * Gets the position in front of the camera at a given distance.
  8490. * @param distance The distance from the camera we want the position to be
  8491. * @returns the position
  8492. */
  8493. getFrontPosition(distance: number): Vector3;
  8494. /** @hidden */
  8495. _getLockedTargetPosition(): Nullable<Vector3>;
  8496. private _storedPosition;
  8497. private _storedRotation;
  8498. private _storedRotationQuaternion;
  8499. /**
  8500. * Store current camera state of the camera (fov, position, rotation, etc..)
  8501. * @returns the camera
  8502. */
  8503. storeState(): Camera;
  8504. /**
  8505. * Restored camera state. You must call storeState() first
  8506. * @returns whether it was successful or not
  8507. * @hidden
  8508. */
  8509. _restoreStateValues(): boolean;
  8510. /** @hidden */
  8511. _initCache(): void;
  8512. /** @hidden */
  8513. _updateCache(ignoreParentClass?: boolean): void;
  8514. /** @hidden */
  8515. _isSynchronizedViewMatrix(): boolean;
  8516. /** @hidden */
  8517. _computeLocalCameraSpeed(): number;
  8518. /**
  8519. * Defines the target the camera should look at.
  8520. * @param target Defines the new target as a Vector or a mesh
  8521. */
  8522. setTarget(target: Vector3): void;
  8523. /**
  8524. * Return the current target position of the camera. This value is expressed in local space.
  8525. * @returns the target position
  8526. */
  8527. getTarget(): Vector3;
  8528. /** @hidden */
  8529. _decideIfNeedsToMove(): boolean;
  8530. /** @hidden */
  8531. _updatePosition(): void;
  8532. /** @hidden */
  8533. _checkInputs(): void;
  8534. protected _updateCameraRotationMatrix(): void;
  8535. /**
  8536. * Update the up vector to apply the rotation of the camera (So if you changed the camera rotation.z this will let you update the up vector as well)
  8537. * @returns the current camera
  8538. */
  8539. private _rotateUpVectorWithCameraRotationMatrix;
  8540. private _cachedRotationZ;
  8541. private _cachedQuaternionRotationZ;
  8542. /** @hidden */
  8543. _getViewMatrix(): Matrix;
  8544. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  8545. /**
  8546. * @hidden
  8547. */
  8548. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  8549. /**
  8550. * @hidden
  8551. */
  8552. _updateRigCameras(): void;
  8553. private _getRigCamPositionAndTarget;
  8554. /**
  8555. * Gets the current object class name.
  8556. * @return the class name
  8557. */
  8558. getClassName(): string;
  8559. }
  8560. }
  8561. declare module "babylonjs/Events/keyboardEvents" {
  8562. /**
  8563. * Gather the list of keyboard event types as constants.
  8564. */
  8565. export class KeyboardEventTypes {
  8566. /**
  8567. * The keydown event is fired when a key becomes active (pressed).
  8568. */
  8569. static readonly KEYDOWN: number;
  8570. /**
  8571. * The keyup event is fired when a key has been released.
  8572. */
  8573. static readonly KEYUP: number;
  8574. }
  8575. /**
  8576. * This class is used to store keyboard related info for the onKeyboardObservable event.
  8577. */
  8578. export class KeyboardInfo {
  8579. /**
  8580. * Defines the type of event (KeyboardEventTypes)
  8581. */
  8582. type: number;
  8583. /**
  8584. * Defines the related dom event
  8585. */
  8586. event: KeyboardEvent;
  8587. /**
  8588. * Instantiates a new keyboard info.
  8589. * This class is used to store keyboard related info for the onKeyboardObservable event.
  8590. * @param type Defines the type of event (KeyboardEventTypes)
  8591. * @param event Defines the related dom event
  8592. */
  8593. constructor(
  8594. /**
  8595. * Defines the type of event (KeyboardEventTypes)
  8596. */
  8597. type: number,
  8598. /**
  8599. * Defines the related dom event
  8600. */
  8601. event: KeyboardEvent);
  8602. }
  8603. /**
  8604. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  8605. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  8606. */
  8607. export class KeyboardInfoPre extends KeyboardInfo {
  8608. /**
  8609. * Defines the type of event (KeyboardEventTypes)
  8610. */
  8611. type: number;
  8612. /**
  8613. * Defines the related dom event
  8614. */
  8615. event: KeyboardEvent;
  8616. /**
  8617. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  8618. */
  8619. skipOnPointerObservable: boolean;
  8620. /**
  8621. * Instantiates a new keyboard pre info.
  8622. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  8623. * @param type Defines the type of event (KeyboardEventTypes)
  8624. * @param event Defines the related dom event
  8625. */
  8626. constructor(
  8627. /**
  8628. * Defines the type of event (KeyboardEventTypes)
  8629. */
  8630. type: number,
  8631. /**
  8632. * Defines the related dom event
  8633. */
  8634. event: KeyboardEvent);
  8635. }
  8636. }
  8637. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  8638. import { Nullable } from "babylonjs/types";
  8639. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  8640. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  8641. /**
  8642. * Manage the keyboard inputs to control the movement of a free camera.
  8643. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  8644. */
  8645. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  8646. /**
  8647. * Defines the camera the input is attached to.
  8648. */
  8649. camera: FreeCamera;
  8650. /**
  8651. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  8652. */
  8653. keysUp: number[];
  8654. /**
  8655. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  8656. */
  8657. keysDown: number[];
  8658. /**
  8659. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  8660. */
  8661. keysLeft: number[];
  8662. /**
  8663. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  8664. */
  8665. keysRight: number[];
  8666. private _keys;
  8667. private _onCanvasBlurObserver;
  8668. private _onKeyboardObserver;
  8669. private _engine;
  8670. private _scene;
  8671. /**
  8672. * Attach the input controls to a specific dom element to get the input from.
  8673. * @param element Defines the element the controls should be listened from
  8674. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  8675. */
  8676. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  8677. /**
  8678. * Detach the current controls from the specified dom element.
  8679. * @param element Defines the element to stop listening the inputs from
  8680. */
  8681. detachControl(element: Nullable<HTMLElement>): void;
  8682. /**
  8683. * Update the current camera state depending on the inputs that have been used this frame.
  8684. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  8685. */
  8686. checkInputs(): void;
  8687. /**
  8688. * Gets the class name of the current intput.
  8689. * @returns the class name
  8690. */
  8691. getClassName(): string;
  8692. /** @hidden */
  8693. _onLostFocus(): void;
  8694. /**
  8695. * Get the friendly name associated with the input class.
  8696. * @returns the input friendly name
  8697. */
  8698. getSimpleName(): string;
  8699. }
  8700. }
  8701. declare module "babylonjs/Lights/shadowLight" {
  8702. import { Camera } from "babylonjs/Cameras/camera";
  8703. import { Scene } from "babylonjs/scene";
  8704. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  8705. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8706. import { Light } from "babylonjs/Lights/light";
  8707. /**
  8708. * Interface describing all the common properties and methods a shadow light needs to implement.
  8709. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  8710. * as well as binding the different shadow properties to the effects.
  8711. */
  8712. export interface IShadowLight extends Light {
  8713. /**
  8714. * The light id in the scene (used in scene.findLighById for instance)
  8715. */
  8716. id: string;
  8717. /**
  8718. * The position the shdow will be casted from.
  8719. */
  8720. position: Vector3;
  8721. /**
  8722. * In 2d mode (needCube being false), the direction used to cast the shadow.
  8723. */
  8724. direction: Vector3;
  8725. /**
  8726. * The transformed position. Position of the light in world space taking parenting in account.
  8727. */
  8728. transformedPosition: Vector3;
  8729. /**
  8730. * The transformed direction. Direction of the light in world space taking parenting in account.
  8731. */
  8732. transformedDirection: Vector3;
  8733. /**
  8734. * The friendly name of the light in the scene.
  8735. */
  8736. name: string;
  8737. /**
  8738. * Defines the shadow projection clipping minimum z value.
  8739. */
  8740. shadowMinZ: number;
  8741. /**
  8742. * Defines the shadow projection clipping maximum z value.
  8743. */
  8744. shadowMaxZ: number;
  8745. /**
  8746. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8747. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8748. */
  8749. computeTransformedInformation(): boolean;
  8750. /**
  8751. * Gets the scene the light belongs to.
  8752. * @returns The scene
  8753. */
  8754. getScene(): Scene;
  8755. /**
  8756. * Callback defining a custom Projection Matrix Builder.
  8757. * This can be used to override the default projection matrix computation.
  8758. */
  8759. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8760. /**
  8761. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  8762. * @param matrix The materix to updated with the projection information
  8763. * @param viewMatrix The transform matrix of the light
  8764. * @param renderList The list of mesh to render in the map
  8765. * @returns The current light
  8766. */
  8767. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  8768. /**
  8769. * Gets the current depth scale used in ESM.
  8770. * @returns The scale
  8771. */
  8772. getDepthScale(): number;
  8773. /**
  8774. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8775. * @returns true if a cube texture needs to be use
  8776. */
  8777. needCube(): boolean;
  8778. /**
  8779. * Detects if the projection matrix requires to be recomputed this frame.
  8780. * @returns true if it requires to be recomputed otherwise, false.
  8781. */
  8782. needProjectionMatrixCompute(): boolean;
  8783. /**
  8784. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8785. */
  8786. forceProjectionMatrixCompute(): void;
  8787. /**
  8788. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8789. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8790. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8791. */
  8792. getShadowDirection(faceIndex?: number): Vector3;
  8793. /**
  8794. * Gets the minZ used for shadow according to both the scene and the light.
  8795. * @param activeCamera The camera we are returning the min for
  8796. * @returns the depth min z
  8797. */
  8798. getDepthMinZ(activeCamera: Camera): number;
  8799. /**
  8800. * Gets the maxZ used for shadow according to both the scene and the light.
  8801. * @param activeCamera The camera we are returning the max for
  8802. * @returns the depth max z
  8803. */
  8804. getDepthMaxZ(activeCamera: Camera): number;
  8805. }
  8806. /**
  8807. * Base implementation IShadowLight
  8808. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  8809. */
  8810. export abstract class ShadowLight extends Light implements IShadowLight {
  8811. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  8812. protected _position: Vector3;
  8813. protected _setPosition(value: Vector3): void;
  8814. /**
  8815. * Sets the position the shadow will be casted from. Also use as the light position for both
  8816. * point and spot lights.
  8817. */
  8818. /**
  8819. * Sets the position the shadow will be casted from. Also use as the light position for both
  8820. * point and spot lights.
  8821. */
  8822. position: Vector3;
  8823. protected _direction: Vector3;
  8824. protected _setDirection(value: Vector3): void;
  8825. /**
  8826. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  8827. * Also use as the light direction on spot and directional lights.
  8828. */
  8829. /**
  8830. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  8831. * Also use as the light direction on spot and directional lights.
  8832. */
  8833. direction: Vector3;
  8834. private _shadowMinZ;
  8835. /**
  8836. * Gets the shadow projection clipping minimum z value.
  8837. */
  8838. /**
  8839. * Sets the shadow projection clipping minimum z value.
  8840. */
  8841. shadowMinZ: number;
  8842. private _shadowMaxZ;
  8843. /**
  8844. * Sets the shadow projection clipping maximum z value.
  8845. */
  8846. /**
  8847. * Gets the shadow projection clipping maximum z value.
  8848. */
  8849. shadowMaxZ: number;
  8850. /**
  8851. * Callback defining a custom Projection Matrix Builder.
  8852. * This can be used to override the default projection matrix computation.
  8853. */
  8854. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8855. /**
  8856. * The transformed position. Position of the light in world space taking parenting in account.
  8857. */
  8858. transformedPosition: Vector3;
  8859. /**
  8860. * The transformed direction. Direction of the light in world space taking parenting in account.
  8861. */
  8862. transformedDirection: Vector3;
  8863. private _needProjectionMatrixCompute;
  8864. /**
  8865. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8866. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8867. */
  8868. computeTransformedInformation(): boolean;
  8869. /**
  8870. * Return the depth scale used for the shadow map.
  8871. * @returns the depth scale.
  8872. */
  8873. getDepthScale(): number;
  8874. /**
  8875. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8876. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8877. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8878. */
  8879. getShadowDirection(faceIndex?: number): Vector3;
  8880. /**
  8881. * Returns the ShadowLight absolute position in the World.
  8882. * @returns the position vector in world space
  8883. */
  8884. getAbsolutePosition(): Vector3;
  8885. /**
  8886. * Sets the ShadowLight direction toward the passed target.
  8887. * @param target The point to target in local space
  8888. * @returns the updated ShadowLight direction
  8889. */
  8890. setDirectionToTarget(target: Vector3): Vector3;
  8891. /**
  8892. * Returns the light rotation in euler definition.
  8893. * @returns the x y z rotation in local space.
  8894. */
  8895. getRotation(): Vector3;
  8896. /**
  8897. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8898. * @returns true if a cube texture needs to be use
  8899. */
  8900. needCube(): boolean;
  8901. /**
  8902. * Detects if the projection matrix requires to be recomputed this frame.
  8903. * @returns true if it requires to be recomputed otherwise, false.
  8904. */
  8905. needProjectionMatrixCompute(): boolean;
  8906. /**
  8907. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8908. */
  8909. forceProjectionMatrixCompute(): void;
  8910. /** @hidden */
  8911. _initCache(): void;
  8912. /** @hidden */
  8913. _isSynchronized(): boolean;
  8914. /**
  8915. * Computes the world matrix of the node
  8916. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  8917. * @returns the world matrix
  8918. */
  8919. computeWorldMatrix(force?: boolean): Matrix;
  8920. /**
  8921. * Gets the minZ used for shadow according to both the scene and the light.
  8922. * @param activeCamera The camera we are returning the min for
  8923. * @returns the depth min z
  8924. */
  8925. getDepthMinZ(activeCamera: Camera): number;
  8926. /**
  8927. * Gets the maxZ used for shadow according to both the scene and the light.
  8928. * @param activeCamera The camera we are returning the max for
  8929. * @returns the depth max z
  8930. */
  8931. getDepthMaxZ(activeCamera: Camera): number;
  8932. /**
  8933. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  8934. * @param matrix The materix to updated with the projection information
  8935. * @param viewMatrix The transform matrix of the light
  8936. * @param renderList The list of mesh to render in the map
  8937. * @returns The current light
  8938. */
  8939. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  8940. }
  8941. }
  8942. declare module "babylonjs/Materials/effectFallbacks" {
  8943. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  8944. import { Effect } from "babylonjs/Materials/effect";
  8945. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8946. /**
  8947. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  8948. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  8949. */
  8950. export class EffectFallbacks implements IEffectFallbacks {
  8951. private _defines;
  8952. private _currentRank;
  8953. private _maxRank;
  8954. private _mesh;
  8955. /**
  8956. * Removes the fallback from the bound mesh.
  8957. */
  8958. unBindMesh(): void;
  8959. /**
  8960. * Adds a fallback on the specified property.
  8961. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  8962. * @param define The name of the define in the shader
  8963. */
  8964. addFallback(rank: number, define: string): void;
  8965. /**
  8966. * Sets the mesh to use CPU skinning when needing to fallback.
  8967. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  8968. * @param mesh The mesh to use the fallbacks.
  8969. */
  8970. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  8971. /**
  8972. * Checks to see if more fallbacks are still availible.
  8973. */
  8974. readonly hasMoreFallbacks: boolean;
  8975. /**
  8976. * Removes the defines that should be removed when falling back.
  8977. * @param currentDefines defines the current define statements for the shader.
  8978. * @param effect defines the current effect we try to compile
  8979. * @returns The resulting defines with defines of the current rank removed.
  8980. */
  8981. reduce(currentDefines: string, effect: Effect): string;
  8982. }
  8983. }
  8984. declare module "babylonjs/Materials/materialHelper" {
  8985. import { Nullable } from "babylonjs/types";
  8986. import { Scene } from "babylonjs/scene";
  8987. import { Engine } from "babylonjs/Engines/engine";
  8988. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8989. import { Light } from "babylonjs/Lights/light";
  8990. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  8991. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  8992. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8993. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8994. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  8995. /**
  8996. * "Static Class" containing the most commonly used helper while dealing with material for
  8997. * rendering purpose.
  8998. *
  8999. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  9000. *
  9001. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  9002. */
  9003. export class MaterialHelper {
  9004. /**
  9005. * Bind the current view position to an effect.
  9006. * @param effect The effect to be bound
  9007. * @param scene The scene the eyes position is used from
  9008. */
  9009. static BindEyePosition(effect: Effect, scene: Scene): void;
  9010. /**
  9011. * Helps preparing the defines values about the UVs in used in the effect.
  9012. * UVs are shared as much as we can accross channels in the shaders.
  9013. * @param texture The texture we are preparing the UVs for
  9014. * @param defines The defines to update
  9015. * @param key The channel key "diffuse", "specular"... used in the shader
  9016. */
  9017. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  9018. /**
  9019. * Binds a texture matrix value to its corrsponding uniform
  9020. * @param texture The texture to bind the matrix for
  9021. * @param uniformBuffer The uniform buffer receivin the data
  9022. * @param key The channel key "diffuse", "specular"... used in the shader
  9023. */
  9024. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  9025. /**
  9026. * Gets the current status of the fog (should it be enabled?)
  9027. * @param mesh defines the mesh to evaluate for fog support
  9028. * @param scene defines the hosting scene
  9029. * @returns true if fog must be enabled
  9030. */
  9031. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  9032. /**
  9033. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  9034. * @param mesh defines the current mesh
  9035. * @param scene defines the current scene
  9036. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  9037. * @param pointsCloud defines if point cloud rendering has to be turned on
  9038. * @param fogEnabled defines if fog has to be turned on
  9039. * @param alphaTest defines if alpha testing has to be turned on
  9040. * @param defines defines the current list of defines
  9041. */
  9042. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  9043. /**
  9044. * Helper used to prepare the list of defines associated with frame values for shader compilation
  9045. * @param scene defines the current scene
  9046. * @param engine defines the current engine
  9047. * @param defines specifies the list of active defines
  9048. * @param useInstances defines if instances have to be turned on
  9049. * @param useClipPlane defines if clip plane have to be turned on
  9050. */
  9051. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>): void;
  9052. /**
  9053. * Prepares the defines for bones
  9054. * @param mesh The mesh containing the geometry data we will draw
  9055. * @param defines The defines to update
  9056. */
  9057. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  9058. /**
  9059. * Prepares the defines for morph targets
  9060. * @param mesh The mesh containing the geometry data we will draw
  9061. * @param defines The defines to update
  9062. */
  9063. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  9064. /**
  9065. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  9066. * @param mesh The mesh containing the geometry data we will draw
  9067. * @param defines The defines to update
  9068. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  9069. * @param useBones Precise whether bones should be used or not (override mesh info)
  9070. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  9071. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  9072. * @returns false if defines are considered not dirty and have not been checked
  9073. */
  9074. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  9075. /**
  9076. * Prepares the defines related to multiview
  9077. * @param scene The scene we are intending to draw
  9078. * @param defines The defines to update
  9079. */
  9080. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  9081. /**
  9082. * Prepares the defines related to the light information passed in parameter
  9083. * @param scene The scene we are intending to draw
  9084. * @param mesh The mesh the effect is compiling for
  9085. * @param light The light the effect is compiling for
  9086. * @param lightIndex The index of the light
  9087. * @param defines The defines to update
  9088. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  9089. * @param state Defines the current state regarding what is needed (normals, etc...)
  9090. */
  9091. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  9092. needNormals: boolean;
  9093. needRebuild: boolean;
  9094. shadowEnabled: boolean;
  9095. specularEnabled: boolean;
  9096. lightmapMode: boolean;
  9097. }): void;
  9098. /**
  9099. * Prepares the defines related to the light information passed in parameter
  9100. * @param scene The scene we are intending to draw
  9101. * @param mesh The mesh the effect is compiling for
  9102. * @param defines The defines to update
  9103. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  9104. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  9105. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  9106. * @returns true if normals will be required for the rest of the effect
  9107. */
  9108. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  9109. /**
  9110. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  9111. * @param lightIndex defines the light index
  9112. * @param uniformsList The uniform list
  9113. * @param samplersList The sampler list
  9114. * @param projectedLightTexture defines if projected texture must be used
  9115. * @param uniformBuffersList defines an optional list of uniform buffers
  9116. */
  9117. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  9118. /**
  9119. * Prepares the uniforms and samplers list to be used in the effect
  9120. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  9121. * @param samplersList The sampler list
  9122. * @param defines The defines helping in the list generation
  9123. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  9124. */
  9125. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  9126. /**
  9127. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  9128. * @param defines The defines to update while falling back
  9129. * @param fallbacks The authorized effect fallbacks
  9130. * @param maxSimultaneousLights The maximum number of lights allowed
  9131. * @param rank the current rank of the Effect
  9132. * @returns The newly affected rank
  9133. */
  9134. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  9135. private static _TmpMorphInfluencers;
  9136. /**
  9137. * Prepares the list of attributes required for morph targets according to the effect defines.
  9138. * @param attribs The current list of supported attribs
  9139. * @param mesh The mesh to prepare the morph targets attributes for
  9140. * @param influencers The number of influencers
  9141. */
  9142. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  9143. /**
  9144. * Prepares the list of attributes required for morph targets according to the effect defines.
  9145. * @param attribs The current list of supported attribs
  9146. * @param mesh The mesh to prepare the morph targets attributes for
  9147. * @param defines The current Defines of the effect
  9148. */
  9149. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  9150. /**
  9151. * Prepares the list of attributes required for bones according to the effect defines.
  9152. * @param attribs The current list of supported attribs
  9153. * @param mesh The mesh to prepare the bones attributes for
  9154. * @param defines The current Defines of the effect
  9155. * @param fallbacks The current efffect fallback strategy
  9156. */
  9157. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  9158. /**
  9159. * Check and prepare the list of attributes required for instances according to the effect defines.
  9160. * @param attribs The current list of supported attribs
  9161. * @param defines The current MaterialDefines of the effect
  9162. */
  9163. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  9164. /**
  9165. * Add the list of attributes required for instances to the attribs array.
  9166. * @param attribs The current list of supported attribs
  9167. */
  9168. static PushAttributesForInstances(attribs: string[]): void;
  9169. /**
  9170. * Binds the light information to the effect.
  9171. * @param light The light containing the generator
  9172. * @param effect The effect we are binding the data to
  9173. * @param lightIndex The light index in the effect used to render
  9174. */
  9175. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  9176. /**
  9177. * Binds the lights information from the scene to the effect for the given mesh.
  9178. * @param light Light to bind
  9179. * @param lightIndex Light index
  9180. * @param scene The scene where the light belongs to
  9181. * @param effect The effect we are binding the data to
  9182. * @param useSpecular Defines if specular is supported
  9183. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  9184. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  9185. */
  9186. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  9187. /**
  9188. * Binds the lights information from the scene to the effect for the given mesh.
  9189. * @param scene The scene the lights belongs to
  9190. * @param mesh The mesh we are binding the information to render
  9191. * @param effect The effect we are binding the data to
  9192. * @param defines The generated defines for the effect
  9193. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  9194. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  9195. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  9196. */
  9197. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  9198. private static _tempFogColor;
  9199. /**
  9200. * Binds the fog information from the scene to the effect for the given mesh.
  9201. * @param scene The scene the lights belongs to
  9202. * @param mesh The mesh we are binding the information to render
  9203. * @param effect The effect we are binding the data to
  9204. * @param linearSpace Defines if the fog effect is applied in linear space
  9205. */
  9206. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  9207. /**
  9208. * Binds the bones information from the mesh to the effect.
  9209. * @param mesh The mesh we are binding the information to render
  9210. * @param effect The effect we are binding the data to
  9211. */
  9212. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  9213. /**
  9214. * Binds the morph targets information from the mesh to the effect.
  9215. * @param abstractMesh The mesh we are binding the information to render
  9216. * @param effect The effect we are binding the data to
  9217. */
  9218. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  9219. /**
  9220. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  9221. * @param defines The generated defines used in the effect
  9222. * @param effect The effect we are binding the data to
  9223. * @param scene The scene we are willing to render with logarithmic scale for
  9224. */
  9225. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  9226. /**
  9227. * Binds the clip plane information from the scene to the effect.
  9228. * @param scene The scene the clip plane information are extracted from
  9229. * @param effect The effect we are binding the data to
  9230. */
  9231. static BindClipPlane(effect: Effect, scene: Scene): void;
  9232. }
  9233. }
  9234. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9235. /** @hidden */
  9236. export var packingFunctions: {
  9237. name: string;
  9238. shader: string;
  9239. };
  9240. }
  9241. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9242. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9243. /** @hidden */
  9244. export var shadowMapPixelShader: {
  9245. name: string;
  9246. shader: string;
  9247. };
  9248. }
  9249. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9250. /** @hidden */
  9251. export var bonesDeclaration: {
  9252. name: string;
  9253. shader: string;
  9254. };
  9255. }
  9256. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9257. /** @hidden */
  9258. export var morphTargetsVertexGlobalDeclaration: {
  9259. name: string;
  9260. shader: string;
  9261. };
  9262. }
  9263. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9264. /** @hidden */
  9265. export var morphTargetsVertexDeclaration: {
  9266. name: string;
  9267. shader: string;
  9268. };
  9269. }
  9270. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9271. /** @hidden */
  9272. export var instancesDeclaration: {
  9273. name: string;
  9274. shader: string;
  9275. };
  9276. }
  9277. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9278. /** @hidden */
  9279. export var helperFunctions: {
  9280. name: string;
  9281. shader: string;
  9282. };
  9283. }
  9284. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9285. /** @hidden */
  9286. export var morphTargetsVertex: {
  9287. name: string;
  9288. shader: string;
  9289. };
  9290. }
  9291. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9292. /** @hidden */
  9293. export var instancesVertex: {
  9294. name: string;
  9295. shader: string;
  9296. };
  9297. }
  9298. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9299. /** @hidden */
  9300. export var bonesVertex: {
  9301. name: string;
  9302. shader: string;
  9303. };
  9304. }
  9305. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9306. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9307. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9308. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9309. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9310. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9311. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9312. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9313. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9314. /** @hidden */
  9315. export var shadowMapVertexShader: {
  9316. name: string;
  9317. shader: string;
  9318. };
  9319. }
  9320. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9321. /** @hidden */
  9322. export var depthBoxBlurPixelShader: {
  9323. name: string;
  9324. shader: string;
  9325. };
  9326. }
  9327. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  9328. import { Nullable } from "babylonjs/types";
  9329. import { Scene } from "babylonjs/scene";
  9330. import { Matrix } from "babylonjs/Maths/math.vector";
  9331. import { SubMesh } from "babylonjs/Meshes/subMesh";
  9332. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9333. import { Mesh } from "babylonjs/Meshes/mesh";
  9334. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  9335. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  9336. import { Effect } from "babylonjs/Materials/effect";
  9337. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  9338. import "babylonjs/Shaders/shadowMap.fragment";
  9339. import "babylonjs/Shaders/shadowMap.vertex";
  9340. import "babylonjs/Shaders/depthBoxBlur.fragment";
  9341. import { Observable } from "babylonjs/Misc/observable";
  9342. /**
  9343. * Defines the options associated with the creation of a custom shader for a shadow generator.
  9344. */
  9345. export interface ICustomShaderOptions {
  9346. /**
  9347. * Gets or sets the custom shader name to use
  9348. */
  9349. shaderName: string;
  9350. /**
  9351. * The list of attribute names used in the shader
  9352. */
  9353. attributes?: string[];
  9354. /**
  9355. * The list of unifrom names used in the shader
  9356. */
  9357. uniforms?: string[];
  9358. /**
  9359. * The list of sampler names used in the shader
  9360. */
  9361. samplers?: string[];
  9362. /**
  9363. * The list of defines used in the shader
  9364. */
  9365. defines?: string[];
  9366. }
  9367. /**
  9368. * Interface to implement to create a shadow generator compatible with BJS.
  9369. */
  9370. export interface IShadowGenerator {
  9371. /**
  9372. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  9373. * @returns The render target texture if present otherwise, null
  9374. */
  9375. getShadowMap(): Nullable<RenderTargetTexture>;
  9376. /**
  9377. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  9378. * @returns The render target texture if the shadow map is present otherwise, null
  9379. */
  9380. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  9381. /**
  9382. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  9383. * @param subMesh The submesh we want to render in the shadow map
  9384. * @param useInstances Defines wether will draw in the map using instances
  9385. * @returns true if ready otherwise, false
  9386. */
  9387. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  9388. /**
  9389. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  9390. * @param defines Defines of the material we want to update
  9391. * @param lightIndex Index of the light in the enabled light list of the material
  9392. */
  9393. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  9394. /**
  9395. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  9396. * defined in the generator but impacting the effect).
  9397. * It implies the unifroms available on the materials are the standard BJS ones.
  9398. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  9399. * @param effect The effect we are binfing the information for
  9400. */
  9401. bindShadowLight(lightIndex: string, effect: Effect): void;
  9402. /**
  9403. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  9404. * (eq to shadow prjection matrix * light transform matrix)
  9405. * @returns The transform matrix used to create the shadow map
  9406. */
  9407. getTransformMatrix(): Matrix;
  9408. /**
  9409. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  9410. * Cube and 2D textures for instance.
  9411. */
  9412. recreateShadowMap(): void;
  9413. /**
  9414. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9415. * @param onCompiled Callback triggered at the and of the effects compilation
  9416. * @param options Sets of optional options forcing the compilation with different modes
  9417. */
  9418. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  9419. useInstances: boolean;
  9420. }>): void;
  9421. /**
  9422. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9423. * @param options Sets of optional options forcing the compilation with different modes
  9424. * @returns A promise that resolves when the compilation completes
  9425. */
  9426. forceCompilationAsync(options?: Partial<{
  9427. useInstances: boolean;
  9428. }>): Promise<void>;
  9429. /**
  9430. * Serializes the shadow generator setup to a json object.
  9431. * @returns The serialized JSON object
  9432. */
  9433. serialize(): any;
  9434. /**
  9435. * Disposes the Shadow map and related Textures and effects.
  9436. */
  9437. dispose(): void;
  9438. }
  9439. /**
  9440. * Default implementation IShadowGenerator.
  9441. * This is the main object responsible of generating shadows in the framework.
  9442. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  9443. */
  9444. export class ShadowGenerator implements IShadowGenerator {
  9445. /**
  9446. * Shadow generator mode None: no filtering applied.
  9447. */
  9448. static readonly FILTER_NONE: number;
  9449. /**
  9450. * Shadow generator mode ESM: Exponential Shadow Mapping.
  9451. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9452. */
  9453. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  9454. /**
  9455. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  9456. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  9457. */
  9458. static readonly FILTER_POISSONSAMPLING: number;
  9459. /**
  9460. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  9461. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9462. */
  9463. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  9464. /**
  9465. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  9466. * edge artifacts on steep falloff.
  9467. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9468. */
  9469. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  9470. /**
  9471. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  9472. * edge artifacts on steep falloff.
  9473. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9474. */
  9475. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  9476. /**
  9477. * Shadow generator mode PCF: Percentage Closer Filtering
  9478. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  9479. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  9480. */
  9481. static readonly FILTER_PCF: number;
  9482. /**
  9483. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  9484. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  9485. * Contact Hardening
  9486. */
  9487. static readonly FILTER_PCSS: number;
  9488. /**
  9489. * Reserved for PCF and PCSS
  9490. * Highest Quality.
  9491. *
  9492. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  9493. *
  9494. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  9495. */
  9496. static readonly QUALITY_HIGH: number;
  9497. /**
  9498. * Reserved for PCF and PCSS
  9499. * Good tradeoff for quality/perf cross devices
  9500. *
  9501. * Execute PCF on a 3*3 kernel.
  9502. *
  9503. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  9504. */
  9505. static readonly QUALITY_MEDIUM: number;
  9506. /**
  9507. * Reserved for PCF and PCSS
  9508. * The lowest quality but the fastest.
  9509. *
  9510. * Execute PCF on a 1*1 kernel.
  9511. *
  9512. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  9513. */
  9514. static readonly QUALITY_LOW: number;
  9515. /** Gets or sets the custom shader name to use */
  9516. customShaderOptions: ICustomShaderOptions;
  9517. /**
  9518. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  9519. */
  9520. onBeforeShadowMapRenderObservable: Observable<Effect>;
  9521. /**
  9522. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  9523. */
  9524. onAfterShadowMapRenderObservable: Observable<Effect>;
  9525. /**
  9526. * Observable triggered before a mesh is rendered in the shadow map.
  9527. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  9528. */
  9529. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  9530. /**
  9531. * Observable triggered after a mesh is rendered in the shadow map.
  9532. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  9533. */
  9534. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  9535. private _bias;
  9536. /**
  9537. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  9538. */
  9539. /**
  9540. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  9541. */
  9542. bias: number;
  9543. private _normalBias;
  9544. /**
  9545. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  9546. */
  9547. /**
  9548. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  9549. */
  9550. normalBias: number;
  9551. private _blurBoxOffset;
  9552. /**
  9553. * Gets the blur box offset: offset applied during the blur pass.
  9554. * Only useful if useKernelBlur = false
  9555. */
  9556. /**
  9557. * Sets the blur box offset: offset applied during the blur pass.
  9558. * Only useful if useKernelBlur = false
  9559. */
  9560. blurBoxOffset: number;
  9561. private _blurScale;
  9562. /**
  9563. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  9564. * 2 means half of the size.
  9565. */
  9566. /**
  9567. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  9568. * 2 means half of the size.
  9569. */
  9570. blurScale: number;
  9571. private _blurKernel;
  9572. /**
  9573. * Gets the blur kernel: kernel size of the blur pass.
  9574. * Only useful if useKernelBlur = true
  9575. */
  9576. /**
  9577. * Sets the blur kernel: kernel size of the blur pass.
  9578. * Only useful if useKernelBlur = true
  9579. */
  9580. blurKernel: number;
  9581. private _useKernelBlur;
  9582. /**
  9583. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  9584. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  9585. */
  9586. /**
  9587. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  9588. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  9589. */
  9590. useKernelBlur: boolean;
  9591. private _depthScale;
  9592. /**
  9593. * Gets the depth scale used in ESM mode.
  9594. */
  9595. /**
  9596. * Sets the depth scale used in ESM mode.
  9597. * This can override the scale stored on the light.
  9598. */
  9599. depthScale: number;
  9600. private _filter;
  9601. /**
  9602. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  9603. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  9604. */
  9605. /**
  9606. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  9607. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  9608. */
  9609. filter: number;
  9610. /**
  9611. * Gets if the current filter is set to Poisson Sampling.
  9612. */
  9613. /**
  9614. * Sets the current filter to Poisson Sampling.
  9615. */
  9616. usePoissonSampling: boolean;
  9617. /**
  9618. * Gets if the current filter is set to ESM.
  9619. */
  9620. /**
  9621. * Sets the current filter is to ESM.
  9622. */
  9623. useExponentialShadowMap: boolean;
  9624. /**
  9625. * Gets if the current filter is set to filtered ESM.
  9626. */
  9627. /**
  9628. * Gets if the current filter is set to filtered ESM.
  9629. */
  9630. useBlurExponentialShadowMap: boolean;
  9631. /**
  9632. * Gets if the current filter is set to "close ESM" (using the inverse of the
  9633. * exponential to prevent steep falloff artifacts).
  9634. */
  9635. /**
  9636. * Sets the current filter to "close ESM" (using the inverse of the
  9637. * exponential to prevent steep falloff artifacts).
  9638. */
  9639. useCloseExponentialShadowMap: boolean;
  9640. /**
  9641. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  9642. * exponential to prevent steep falloff artifacts).
  9643. */
  9644. /**
  9645. * Sets the current filter to filtered "close ESM" (using the inverse of the
  9646. * exponential to prevent steep falloff artifacts).
  9647. */
  9648. useBlurCloseExponentialShadowMap: boolean;
  9649. /**
  9650. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  9651. */
  9652. /**
  9653. * Sets the current filter to "PCF" (percentage closer filtering).
  9654. */
  9655. usePercentageCloserFiltering: boolean;
  9656. private _filteringQuality;
  9657. /**
  9658. * Gets the PCF or PCSS Quality.
  9659. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  9660. */
  9661. /**
  9662. * Sets the PCF or PCSS Quality.
  9663. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  9664. */
  9665. filteringQuality: number;
  9666. /**
  9667. * Gets if the current filter is set to "PCSS" (contact hardening).
  9668. */
  9669. /**
  9670. * Sets the current filter to "PCSS" (contact hardening).
  9671. */
  9672. useContactHardeningShadow: boolean;
  9673. private _contactHardeningLightSizeUVRatio;
  9674. /**
  9675. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  9676. * Using a ratio helps keeping shape stability independently of the map size.
  9677. *
  9678. * It does not account for the light projection as it was having too much
  9679. * instability during the light setup or during light position changes.
  9680. *
  9681. * Only valid if useContactHardeningShadow is true.
  9682. */
  9683. /**
  9684. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  9685. * Using a ratio helps keeping shape stability independently of the map size.
  9686. *
  9687. * It does not account for the light projection as it was having too much
  9688. * instability during the light setup or during light position changes.
  9689. *
  9690. * Only valid if useContactHardeningShadow is true.
  9691. */
  9692. contactHardeningLightSizeUVRatio: number;
  9693. private _darkness;
  9694. /** Gets or sets the actual darkness of a shadow */
  9695. darkness: number;
  9696. /**
  9697. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  9698. * 0 means strongest and 1 would means no shadow.
  9699. * @returns the darkness.
  9700. */
  9701. getDarkness(): number;
  9702. /**
  9703. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  9704. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  9705. * @returns the shadow generator allowing fluent coding.
  9706. */
  9707. setDarkness(darkness: number): ShadowGenerator;
  9708. private _transparencyShadow;
  9709. /** Gets or sets the ability to have transparent shadow */
  9710. transparencyShadow: boolean;
  9711. /**
  9712. * Sets the ability to have transparent shadow (boolean).
  9713. * @param transparent True if transparent else False
  9714. * @returns the shadow generator allowing fluent coding
  9715. */
  9716. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  9717. private _shadowMap;
  9718. private _shadowMap2;
  9719. /**
  9720. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  9721. * @returns The render target texture if present otherwise, null
  9722. */
  9723. getShadowMap(): Nullable<RenderTargetTexture>;
  9724. /**
  9725. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  9726. * @returns The render target texture if the shadow map is present otherwise, null
  9727. */
  9728. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  9729. /**
  9730. * Gets the class name of that object
  9731. * @returns "ShadowGenerator"
  9732. */
  9733. getClassName(): string;
  9734. /**
  9735. * Helper function to add a mesh and its descendants to the list of shadow casters.
  9736. * @param mesh Mesh to add
  9737. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  9738. * @returns the Shadow Generator itself
  9739. */
  9740. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  9741. /**
  9742. * Helper function to remove a mesh and its descendants from the list of shadow casters
  9743. * @param mesh Mesh to remove
  9744. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  9745. * @returns the Shadow Generator itself
  9746. */
  9747. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  9748. /**
  9749. * Controls the extent to which the shadows fade out at the edge of the frustum
  9750. * Used only by directionals and spots
  9751. */
  9752. frustumEdgeFalloff: number;
  9753. private _light;
  9754. /**
  9755. * Returns the associated light object.
  9756. * @returns the light generating the shadow
  9757. */
  9758. getLight(): IShadowLight;
  9759. /**
  9760. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  9761. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  9762. * It might on the other hand introduce peter panning.
  9763. */
  9764. forceBackFacesOnly: boolean;
  9765. private _scene;
  9766. private _lightDirection;
  9767. private _effect;
  9768. private _viewMatrix;
  9769. private _projectionMatrix;
  9770. private _transformMatrix;
  9771. private _cachedPosition;
  9772. private _cachedDirection;
  9773. private _cachedDefines;
  9774. private _currentRenderID;
  9775. private _boxBlurPostprocess;
  9776. private _kernelBlurXPostprocess;
  9777. private _kernelBlurYPostprocess;
  9778. private _blurPostProcesses;
  9779. private _mapSize;
  9780. private _currentFaceIndex;
  9781. private _currentFaceIndexCache;
  9782. private _textureType;
  9783. private _defaultTextureMatrix;
  9784. private _storedUniqueId;
  9785. /** @hidden */
  9786. static _SceneComponentInitialization: (scene: Scene) => void;
  9787. /**
  9788. * Creates a ShadowGenerator object.
  9789. * A ShadowGenerator is the required tool to use the shadows.
  9790. * Each light casting shadows needs to use its own ShadowGenerator.
  9791. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  9792. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  9793. * @param light The light object generating the shadows.
  9794. * @param usefulFloatFirst By default the generator will try to use half float textures but if you need precision (for self shadowing for instance), you can use this option to enforce full float texture.
  9795. */
  9796. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  9797. private _initializeGenerator;
  9798. private _initializeShadowMap;
  9799. private _initializeBlurRTTAndPostProcesses;
  9800. private _renderForShadowMap;
  9801. private _renderSubMeshForShadowMap;
  9802. private _applyFilterValues;
  9803. /**
  9804. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9805. * @param onCompiled Callback triggered at the and of the effects compilation
  9806. * @param options Sets of optional options forcing the compilation with different modes
  9807. */
  9808. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  9809. useInstances: boolean;
  9810. }>): void;
  9811. /**
  9812. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9813. * @param options Sets of optional options forcing the compilation with different modes
  9814. * @returns A promise that resolves when the compilation completes
  9815. */
  9816. forceCompilationAsync(options?: Partial<{
  9817. useInstances: boolean;
  9818. }>): Promise<void>;
  9819. /**
  9820. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  9821. * @param subMesh The submesh we want to render in the shadow map
  9822. * @param useInstances Defines wether will draw in the map using instances
  9823. * @returns true if ready otherwise, false
  9824. */
  9825. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  9826. /**
  9827. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  9828. * @param defines Defines of the material we want to update
  9829. * @param lightIndex Index of the light in the enabled light list of the material
  9830. */
  9831. prepareDefines(defines: any, lightIndex: number): void;
  9832. /**
  9833. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  9834. * defined in the generator but impacting the effect).
  9835. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  9836. * @param effect The effect we are binfing the information for
  9837. */
  9838. bindShadowLight(lightIndex: string, effect: Effect): void;
  9839. /**
  9840. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  9841. * (eq to shadow prjection matrix * light transform matrix)
  9842. * @returns The transform matrix used to create the shadow map
  9843. */
  9844. getTransformMatrix(): Matrix;
  9845. /**
  9846. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  9847. * Cube and 2D textures for instance.
  9848. */
  9849. recreateShadowMap(): void;
  9850. private _disposeBlurPostProcesses;
  9851. private _disposeRTTandPostProcesses;
  9852. /**
  9853. * Disposes the ShadowGenerator.
  9854. * Returns nothing.
  9855. */
  9856. dispose(): void;
  9857. /**
  9858. * Serializes the shadow generator setup to a json object.
  9859. * @returns The serialized JSON object
  9860. */
  9861. serialize(): any;
  9862. /**
  9863. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  9864. * @param parsedShadowGenerator The JSON object to parse
  9865. * @param scene The scene to create the shadow map for
  9866. * @returns The parsed shadow generator
  9867. */
  9868. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  9869. }
  9870. }
  9871. declare module "babylonjs/Lights/light" {
  9872. import { Nullable } from "babylonjs/types";
  9873. import { Scene } from "babylonjs/scene";
  9874. import { Vector3 } from "babylonjs/Maths/math.vector";
  9875. import { Color3 } from "babylonjs/Maths/math.color";
  9876. import { Node } from "babylonjs/node";
  9877. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9878. import { Effect } from "babylonjs/Materials/effect";
  9879. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  9880. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  9881. /**
  9882. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  9883. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  9884. * All meshes allow light to pass through them unless shadow generation is activated. The default number of lights allowed is four but this can be increased.
  9885. */
  9886. export abstract class Light extends Node {
  9887. /**
  9888. * Falloff Default: light is falling off following the material specification:
  9889. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  9890. */
  9891. static readonly FALLOFF_DEFAULT: number;
  9892. /**
  9893. * Falloff Physical: light is falling off following the inverse squared distance law.
  9894. */
  9895. static readonly FALLOFF_PHYSICAL: number;
  9896. /**
  9897. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  9898. * to enhance interoperability with other engines.
  9899. */
  9900. static readonly FALLOFF_GLTF: number;
  9901. /**
  9902. * Falloff Standard: light is falling off like in the standard material
  9903. * to enhance interoperability with other materials.
  9904. */
  9905. static readonly FALLOFF_STANDARD: number;
  9906. /**
  9907. * If every light affecting the material is in this lightmapMode,
  9908. * material.lightmapTexture adds or multiplies
  9909. * (depends on material.useLightmapAsShadowmap)
  9910. * after every other light calculations.
  9911. */
  9912. static readonly LIGHTMAP_DEFAULT: number;
  9913. /**
  9914. * material.lightmapTexture as only diffuse lighting from this light
  9915. * adds only specular lighting from this light
  9916. * adds dynamic shadows
  9917. */
  9918. static readonly LIGHTMAP_SPECULAR: number;
  9919. /**
  9920. * material.lightmapTexture as only lighting
  9921. * no light calculation from this light
  9922. * only adds dynamic shadows from this light
  9923. */
  9924. static readonly LIGHTMAP_SHADOWSONLY: number;
  9925. /**
  9926. * Each light type uses the default quantity according to its type:
  9927. * point/spot lights use luminous intensity
  9928. * directional lights use illuminance
  9929. */
  9930. static readonly INTENSITYMODE_AUTOMATIC: number;
  9931. /**
  9932. * lumen (lm)
  9933. */
  9934. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  9935. /**
  9936. * candela (lm/sr)
  9937. */
  9938. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  9939. /**
  9940. * lux (lm/m^2)
  9941. */
  9942. static readonly INTENSITYMODE_ILLUMINANCE: number;
  9943. /**
  9944. * nit (cd/m^2)
  9945. */
  9946. static readonly INTENSITYMODE_LUMINANCE: number;
  9947. /**
  9948. * Light type const id of the point light.
  9949. */
  9950. static readonly LIGHTTYPEID_POINTLIGHT: number;
  9951. /**
  9952. * Light type const id of the directional light.
  9953. */
  9954. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  9955. /**
  9956. * Light type const id of the spot light.
  9957. */
  9958. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  9959. /**
  9960. * Light type const id of the hemispheric light.
  9961. */
  9962. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  9963. /**
  9964. * Diffuse gives the basic color to an object.
  9965. */
  9966. diffuse: Color3;
  9967. /**
  9968. * Specular produces a highlight color on an object.
  9969. * Note: This is note affecting PBR materials.
  9970. */
  9971. specular: Color3;
  9972. /**
  9973. * Defines the falloff type for this light. This lets overrriding how punctual light are
  9974. * falling off base on range or angle.
  9975. * This can be set to any values in Light.FALLOFF_x.
  9976. *
  9977. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  9978. * other types of materials.
  9979. */
  9980. falloffType: number;
  9981. /**
  9982. * Strength of the light.
  9983. * Note: By default it is define in the framework own unit.
  9984. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  9985. */
  9986. intensity: number;
  9987. private _range;
  9988. protected _inverseSquaredRange: number;
  9989. /**
  9990. * Defines how far from the source the light is impacting in scene units.
  9991. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  9992. */
  9993. /**
  9994. * Defines how far from the source the light is impacting in scene units.
  9995. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  9996. */
  9997. range: number;
  9998. /**
  9999. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  10000. * of light.
  10001. */
  10002. private _photometricScale;
  10003. private _intensityMode;
  10004. /**
  10005. * Gets the photometric scale used to interpret the intensity.
  10006. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  10007. */
  10008. /**
  10009. * Sets the photometric scale used to interpret the intensity.
  10010. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  10011. */
  10012. intensityMode: number;
  10013. private _radius;
  10014. /**
  10015. * Gets the light radius used by PBR Materials to simulate soft area lights.
  10016. */
  10017. /**
  10018. * sets the light radius used by PBR Materials to simulate soft area lights.
  10019. */
  10020. radius: number;
  10021. private _renderPriority;
  10022. /**
  10023. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  10024. * exceeding the number allowed of the materials.
  10025. */
  10026. renderPriority: number;
  10027. private _shadowEnabled;
  10028. /**
  10029. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  10030. * the current shadow generator.
  10031. */
  10032. /**
  10033. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  10034. * the current shadow generator.
  10035. */
  10036. shadowEnabled: boolean;
  10037. private _includedOnlyMeshes;
  10038. /**
  10039. * Gets the only meshes impacted by this light.
  10040. */
  10041. /**
  10042. * Sets the only meshes impacted by this light.
  10043. */
  10044. includedOnlyMeshes: AbstractMesh[];
  10045. private _excludedMeshes;
  10046. /**
  10047. * Gets the meshes not impacted by this light.
  10048. */
  10049. /**
  10050. * Sets the meshes not impacted by this light.
  10051. */
  10052. excludedMeshes: AbstractMesh[];
  10053. private _excludeWithLayerMask;
  10054. /**
  10055. * Gets the layer id use to find what meshes are not impacted by the light.
  10056. * Inactive if 0
  10057. */
  10058. /**
  10059. * Sets the layer id use to find what meshes are not impacted by the light.
  10060. * Inactive if 0
  10061. */
  10062. excludeWithLayerMask: number;
  10063. private _includeOnlyWithLayerMask;
  10064. /**
  10065. * Gets the layer id use to find what meshes are impacted by the light.
  10066. * Inactive if 0
  10067. */
  10068. /**
  10069. * Sets the layer id use to find what meshes are impacted by the light.
  10070. * Inactive if 0
  10071. */
  10072. includeOnlyWithLayerMask: number;
  10073. private _lightmapMode;
  10074. /**
  10075. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  10076. */
  10077. /**
  10078. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  10079. */
  10080. lightmapMode: number;
  10081. /**
  10082. * Shadow generator associted to the light.
  10083. * @hidden Internal use only.
  10084. */
  10085. _shadowGenerator: Nullable<IShadowGenerator>;
  10086. /**
  10087. * @hidden Internal use only.
  10088. */
  10089. _excludedMeshesIds: string[];
  10090. /**
  10091. * @hidden Internal use only.
  10092. */
  10093. _includedOnlyMeshesIds: string[];
  10094. /**
  10095. * The current light unifom buffer.
  10096. * @hidden Internal use only.
  10097. */
  10098. _uniformBuffer: UniformBuffer;
  10099. /** @hidden */
  10100. _renderId: number;
  10101. /**
  10102. * Creates a Light object in the scene.
  10103. * Documentation : https://doc.babylonjs.com/babylon101/lights
  10104. * @param name The firendly name of the light
  10105. * @param scene The scene the light belongs too
  10106. */
  10107. constructor(name: string, scene: Scene);
  10108. protected abstract _buildUniformLayout(): void;
  10109. /**
  10110. * Sets the passed Effect "effect" with the Light information.
  10111. * @param effect The effect to update
  10112. * @param lightIndex The index of the light in the effect to update
  10113. * @returns The light
  10114. */
  10115. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  10116. /**
  10117. * Sets the passed Effect "effect" with the Light information.
  10118. * @param effect The effect to update
  10119. * @param lightDataUniformName The uniform used to store light data (position or direction)
  10120. * @returns The light
  10121. */
  10122. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  10123. /**
  10124. * Returns the string "Light".
  10125. * @returns the class name
  10126. */
  10127. getClassName(): string;
  10128. /** @hidden */
  10129. readonly _isLight: boolean;
  10130. /**
  10131. * Converts the light information to a readable string for debug purpose.
  10132. * @param fullDetails Supports for multiple levels of logging within scene loading
  10133. * @returns the human readable light info
  10134. */
  10135. toString(fullDetails?: boolean): string;
  10136. /** @hidden */
  10137. protected _syncParentEnabledState(): void;
  10138. /**
  10139. * Set the enabled state of this node.
  10140. * @param value - the new enabled state
  10141. */
  10142. setEnabled(value: boolean): void;
  10143. /**
  10144. * Returns the Light associated shadow generator if any.
  10145. * @return the associated shadow generator.
  10146. */
  10147. getShadowGenerator(): Nullable<IShadowGenerator>;
  10148. /**
  10149. * Returns a Vector3, the absolute light position in the World.
  10150. * @returns the world space position of the light
  10151. */
  10152. getAbsolutePosition(): Vector3;
  10153. /**
  10154. * Specifies if the light will affect the passed mesh.
  10155. * @param mesh The mesh to test against the light
  10156. * @return true the mesh is affected otherwise, false.
  10157. */
  10158. canAffectMesh(mesh: AbstractMesh): boolean;
  10159. /**
  10160. * Sort function to order lights for rendering.
  10161. * @param a First Light object to compare to second.
  10162. * @param b Second Light object to compare first.
  10163. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  10164. */
  10165. static CompareLightsPriority(a: Light, b: Light): number;
  10166. /**
  10167. * Releases resources associated with this node.
  10168. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  10169. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  10170. */
  10171. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  10172. /**
  10173. * Returns the light type ID (integer).
  10174. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  10175. */
  10176. getTypeID(): number;
  10177. /**
  10178. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  10179. * @returns the scaled intensity in intensity mode unit
  10180. */
  10181. getScaledIntensity(): number;
  10182. /**
  10183. * Returns a new Light object, named "name", from the current one.
  10184. * @param name The name of the cloned light
  10185. * @returns the new created light
  10186. */
  10187. clone(name: string): Nullable<Light>;
  10188. /**
  10189. * Serializes the current light into a Serialization object.
  10190. * @returns the serialized object.
  10191. */
  10192. serialize(): any;
  10193. /**
  10194. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  10195. * This new light is named "name" and added to the passed scene.
  10196. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  10197. * @param name The friendly name of the light
  10198. * @param scene The scene the new light will belong to
  10199. * @returns the constructor function
  10200. */
  10201. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  10202. /**
  10203. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  10204. * @param parsedLight The JSON representation of the light
  10205. * @param scene The scene to create the parsed light in
  10206. * @returns the created light after parsing
  10207. */
  10208. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  10209. private _hookArrayForExcluded;
  10210. private _hookArrayForIncludedOnly;
  10211. private _resyncMeshes;
  10212. /**
  10213. * Forces the meshes to update their light related information in their rendering used effects
  10214. * @hidden Internal Use Only
  10215. */
  10216. _markMeshesAsLightDirty(): void;
  10217. /**
  10218. * Recomputes the cached photometric scale if needed.
  10219. */
  10220. private _computePhotometricScale;
  10221. /**
  10222. * Returns the Photometric Scale according to the light type and intensity mode.
  10223. */
  10224. private _getPhotometricScale;
  10225. /**
  10226. * Reorder the light in the scene according to their defined priority.
  10227. * @hidden Internal Use Only
  10228. */
  10229. _reorderLightsInScene(): void;
  10230. /**
  10231. * Prepares the list of defines specific to the light type.
  10232. * @param defines the list of defines
  10233. * @param lightIndex defines the index of the light for the effect
  10234. */
  10235. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  10236. }
  10237. }
  10238. declare module "babylonjs/Actions/action" {
  10239. import { Observable } from "babylonjs/Misc/observable";
  10240. import { Condition } from "babylonjs/Actions/condition";
  10241. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10242. import { ActionManager } from "babylonjs/Actions/actionManager";
  10243. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  10244. /**
  10245. * Interface used to define Action
  10246. */
  10247. export interface IAction {
  10248. /**
  10249. * Trigger for the action
  10250. */
  10251. trigger: number;
  10252. /** Options of the trigger */
  10253. triggerOptions: any;
  10254. /**
  10255. * Gets the trigger parameters
  10256. * @returns the trigger parameters
  10257. */
  10258. getTriggerParameter(): any;
  10259. /**
  10260. * Internal only - executes current action event
  10261. * @hidden
  10262. */
  10263. _executeCurrent(evt?: ActionEvent): void;
  10264. /**
  10265. * Serialize placeholder for child classes
  10266. * @param parent of child
  10267. * @returns the serialized object
  10268. */
  10269. serialize(parent: any): any;
  10270. /**
  10271. * Internal only
  10272. * @hidden
  10273. */
  10274. _prepare(): void;
  10275. /**
  10276. * Internal only - manager for action
  10277. * @hidden
  10278. */
  10279. _actionManager: AbstractActionManager;
  10280. /**
  10281. * Adds action to chain of actions, may be a DoNothingAction
  10282. * @param action defines the next action to execute
  10283. * @returns The action passed in
  10284. * @see https://www.babylonjs-playground.com/#1T30HR#0
  10285. */
  10286. then(action: IAction): IAction;
  10287. }
  10288. /**
  10289. * The action to be carried out following a trigger
  10290. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  10291. */
  10292. export class Action implements IAction {
  10293. /** the trigger, with or without parameters, for the action */
  10294. triggerOptions: any;
  10295. /**
  10296. * Trigger for the action
  10297. */
  10298. trigger: number;
  10299. /**
  10300. * Internal only - manager for action
  10301. * @hidden
  10302. */
  10303. _actionManager: ActionManager;
  10304. private _nextActiveAction;
  10305. private _child;
  10306. private _condition?;
  10307. private _triggerParameter;
  10308. /**
  10309. * An event triggered prior to action being executed.
  10310. */
  10311. onBeforeExecuteObservable: Observable<Action>;
  10312. /**
  10313. * Creates a new Action
  10314. * @param triggerOptions the trigger, with or without parameters, for the action
  10315. * @param condition an optional determinant of action
  10316. */
  10317. constructor(
  10318. /** the trigger, with or without parameters, for the action */
  10319. triggerOptions: any, condition?: Condition);
  10320. /**
  10321. * Internal only
  10322. * @hidden
  10323. */
  10324. _prepare(): void;
  10325. /**
  10326. * Gets the trigger parameters
  10327. * @returns the trigger parameters
  10328. */
  10329. getTriggerParameter(): any;
  10330. /**
  10331. * Internal only - executes current action event
  10332. * @hidden
  10333. */
  10334. _executeCurrent(evt?: ActionEvent): void;
  10335. /**
  10336. * Execute placeholder for child classes
  10337. * @param evt optional action event
  10338. */
  10339. execute(evt?: ActionEvent): void;
  10340. /**
  10341. * Skips to next active action
  10342. */
  10343. skipToNextActiveAction(): void;
  10344. /**
  10345. * Adds action to chain of actions, may be a DoNothingAction
  10346. * @param action defines the next action to execute
  10347. * @returns The action passed in
  10348. * @see https://www.babylonjs-playground.com/#1T30HR#0
  10349. */
  10350. then(action: Action): Action;
  10351. /**
  10352. * Internal only
  10353. * @hidden
  10354. */
  10355. _getProperty(propertyPath: string): string;
  10356. /**
  10357. * Internal only
  10358. * @hidden
  10359. */
  10360. _getEffectiveTarget(target: any, propertyPath: string): any;
  10361. /**
  10362. * Serialize placeholder for child classes
  10363. * @param parent of child
  10364. * @returns the serialized object
  10365. */
  10366. serialize(parent: any): any;
  10367. /**
  10368. * Internal only called by serialize
  10369. * @hidden
  10370. */
  10371. protected _serialize(serializedAction: any, parent?: any): any;
  10372. /**
  10373. * Internal only
  10374. * @hidden
  10375. */
  10376. static _SerializeValueAsString: (value: any) => string;
  10377. /**
  10378. * Internal only
  10379. * @hidden
  10380. */
  10381. static _GetTargetProperty: (target: import("babylonjs/node").Node | import("babylonjs/scene").Scene) => {
  10382. name: string;
  10383. targetType: string;
  10384. value: string;
  10385. };
  10386. }
  10387. }
  10388. declare module "babylonjs/Actions/condition" {
  10389. import { ActionManager } from "babylonjs/Actions/actionManager";
  10390. /**
  10391. * A Condition applied to an Action
  10392. */
  10393. export class Condition {
  10394. /**
  10395. * Internal only - manager for action
  10396. * @hidden
  10397. */
  10398. _actionManager: ActionManager;
  10399. /**
  10400. * Internal only
  10401. * @hidden
  10402. */
  10403. _evaluationId: number;
  10404. /**
  10405. * Internal only
  10406. * @hidden
  10407. */
  10408. _currentResult: boolean;
  10409. /**
  10410. * Creates a new Condition
  10411. * @param actionManager the manager of the action the condition is applied to
  10412. */
  10413. constructor(actionManager: ActionManager);
  10414. /**
  10415. * Check if the current condition is valid
  10416. * @returns a boolean
  10417. */
  10418. isValid(): boolean;
  10419. /**
  10420. * Internal only
  10421. * @hidden
  10422. */
  10423. _getProperty(propertyPath: string): string;
  10424. /**
  10425. * Internal only
  10426. * @hidden
  10427. */
  10428. _getEffectiveTarget(target: any, propertyPath: string): any;
  10429. /**
  10430. * Serialize placeholder for child classes
  10431. * @returns the serialized object
  10432. */
  10433. serialize(): any;
  10434. /**
  10435. * Internal only
  10436. * @hidden
  10437. */
  10438. protected _serialize(serializedCondition: any): any;
  10439. }
  10440. /**
  10441. * Defines specific conditional operators as extensions of Condition
  10442. */
  10443. export class ValueCondition extends Condition {
  10444. /** path to specify the property of the target the conditional operator uses */
  10445. propertyPath: string;
  10446. /** the value compared by the conditional operator against the current value of the property */
  10447. value: any;
  10448. /** the conditional operator, default ValueCondition.IsEqual */
  10449. operator: number;
  10450. /**
  10451. * Internal only
  10452. * @hidden
  10453. */
  10454. private static _IsEqual;
  10455. /**
  10456. * Internal only
  10457. * @hidden
  10458. */
  10459. private static _IsDifferent;
  10460. /**
  10461. * Internal only
  10462. * @hidden
  10463. */
  10464. private static _IsGreater;
  10465. /**
  10466. * Internal only
  10467. * @hidden
  10468. */
  10469. private static _IsLesser;
  10470. /**
  10471. * returns the number for IsEqual
  10472. */
  10473. static readonly IsEqual: number;
  10474. /**
  10475. * Returns the number for IsDifferent
  10476. */
  10477. static readonly IsDifferent: number;
  10478. /**
  10479. * Returns the number for IsGreater
  10480. */
  10481. static readonly IsGreater: number;
  10482. /**
  10483. * Returns the number for IsLesser
  10484. */
  10485. static readonly IsLesser: number;
  10486. /**
  10487. * Internal only The action manager for the condition
  10488. * @hidden
  10489. */
  10490. _actionManager: ActionManager;
  10491. /**
  10492. * Internal only
  10493. * @hidden
  10494. */
  10495. private _target;
  10496. /**
  10497. * Internal only
  10498. * @hidden
  10499. */
  10500. private _effectiveTarget;
  10501. /**
  10502. * Internal only
  10503. * @hidden
  10504. */
  10505. private _property;
  10506. /**
  10507. * Creates a new ValueCondition
  10508. * @param actionManager manager for the action the condition applies to
  10509. * @param target for the action
  10510. * @param propertyPath path to specify the property of the target the conditional operator uses
  10511. * @param value the value compared by the conditional operator against the current value of the property
  10512. * @param operator the conditional operator, default ValueCondition.IsEqual
  10513. */
  10514. constructor(actionManager: ActionManager, target: any,
  10515. /** path to specify the property of the target the conditional operator uses */
  10516. propertyPath: string,
  10517. /** the value compared by the conditional operator against the current value of the property */
  10518. value: any,
  10519. /** the conditional operator, default ValueCondition.IsEqual */
  10520. operator?: number);
  10521. /**
  10522. * Compares the given value with the property value for the specified conditional operator
  10523. * @returns the result of the comparison
  10524. */
  10525. isValid(): boolean;
  10526. /**
  10527. * Serialize the ValueCondition into a JSON compatible object
  10528. * @returns serialization object
  10529. */
  10530. serialize(): any;
  10531. /**
  10532. * Gets the name of the conditional operator for the ValueCondition
  10533. * @param operator the conditional operator
  10534. * @returns the name
  10535. */
  10536. static GetOperatorName(operator: number): string;
  10537. }
  10538. /**
  10539. * Defines a predicate condition as an extension of Condition
  10540. */
  10541. export class PredicateCondition extends Condition {
  10542. /** defines the predicate function used to validate the condition */
  10543. predicate: () => boolean;
  10544. /**
  10545. * Internal only - manager for action
  10546. * @hidden
  10547. */
  10548. _actionManager: ActionManager;
  10549. /**
  10550. * Creates a new PredicateCondition
  10551. * @param actionManager manager for the action the condition applies to
  10552. * @param predicate defines the predicate function used to validate the condition
  10553. */
  10554. constructor(actionManager: ActionManager,
  10555. /** defines the predicate function used to validate the condition */
  10556. predicate: () => boolean);
  10557. /**
  10558. * @returns the validity of the predicate condition
  10559. */
  10560. isValid(): boolean;
  10561. }
  10562. /**
  10563. * Defines a state condition as an extension of Condition
  10564. */
  10565. export class StateCondition extends Condition {
  10566. /** Value to compare with target state */
  10567. value: string;
  10568. /**
  10569. * Internal only - manager for action
  10570. * @hidden
  10571. */
  10572. _actionManager: ActionManager;
  10573. /**
  10574. * Internal only
  10575. * @hidden
  10576. */
  10577. private _target;
  10578. /**
  10579. * Creates a new StateCondition
  10580. * @param actionManager manager for the action the condition applies to
  10581. * @param target of the condition
  10582. * @param value to compare with target state
  10583. */
  10584. constructor(actionManager: ActionManager, target: any,
  10585. /** Value to compare with target state */
  10586. value: string);
  10587. /**
  10588. * Gets a boolean indicating if the current condition is met
  10589. * @returns the validity of the state
  10590. */
  10591. isValid(): boolean;
  10592. /**
  10593. * Serialize the StateCondition into a JSON compatible object
  10594. * @returns serialization object
  10595. */
  10596. serialize(): any;
  10597. }
  10598. }
  10599. declare module "babylonjs/Actions/directActions" {
  10600. import { Action } from "babylonjs/Actions/action";
  10601. import { Condition } from "babylonjs/Actions/condition";
  10602. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  10603. /**
  10604. * This defines an action responsible to toggle a boolean once triggered.
  10605. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10606. */
  10607. export class SwitchBooleanAction extends Action {
  10608. /**
  10609. * The path to the boolean property in the target object
  10610. */
  10611. propertyPath: string;
  10612. private _target;
  10613. private _effectiveTarget;
  10614. private _property;
  10615. /**
  10616. * Instantiate the action
  10617. * @param triggerOptions defines the trigger options
  10618. * @param target defines the object containing the boolean
  10619. * @param propertyPath defines the path to the boolean property in the target object
  10620. * @param condition defines the trigger related conditions
  10621. */
  10622. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  10623. /** @hidden */
  10624. _prepare(): void;
  10625. /**
  10626. * Execute the action toggle the boolean value.
  10627. */
  10628. execute(): void;
  10629. /**
  10630. * Serializes the actions and its related information.
  10631. * @param parent defines the object to serialize in
  10632. * @returns the serialized object
  10633. */
  10634. serialize(parent: any): any;
  10635. }
  10636. /**
  10637. * This defines an action responsible to set a the state field of the target
  10638. * to a desired value once triggered.
  10639. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10640. */
  10641. export class SetStateAction extends Action {
  10642. /**
  10643. * The value to store in the state field.
  10644. */
  10645. value: string;
  10646. private _target;
  10647. /**
  10648. * Instantiate the action
  10649. * @param triggerOptions defines the trigger options
  10650. * @param target defines the object containing the state property
  10651. * @param value defines the value to store in the state field
  10652. * @param condition defines the trigger related conditions
  10653. */
  10654. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  10655. /**
  10656. * Execute the action and store the value on the target state property.
  10657. */
  10658. execute(): void;
  10659. /**
  10660. * Serializes the actions and its related information.
  10661. * @param parent defines the object to serialize in
  10662. * @returns the serialized object
  10663. */
  10664. serialize(parent: any): any;
  10665. }
  10666. /**
  10667. * This defines an action responsible to set a property of the target
  10668. * to a desired value once triggered.
  10669. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10670. */
  10671. export class SetValueAction extends Action {
  10672. /**
  10673. * The path of the property to set in the target.
  10674. */
  10675. propertyPath: string;
  10676. /**
  10677. * The value to set in the property
  10678. */
  10679. value: any;
  10680. private _target;
  10681. private _effectiveTarget;
  10682. private _property;
  10683. /**
  10684. * Instantiate the action
  10685. * @param triggerOptions defines the trigger options
  10686. * @param target defines the object containing the property
  10687. * @param propertyPath defines the path of the property to set in the target
  10688. * @param value defines the value to set in the property
  10689. * @param condition defines the trigger related conditions
  10690. */
  10691. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10692. /** @hidden */
  10693. _prepare(): void;
  10694. /**
  10695. * Execute the action and set the targetted property to the desired value.
  10696. */
  10697. execute(): void;
  10698. /**
  10699. * Serializes the actions and its related information.
  10700. * @param parent defines the object to serialize in
  10701. * @returns the serialized object
  10702. */
  10703. serialize(parent: any): any;
  10704. }
  10705. /**
  10706. * This defines an action responsible to increment the target value
  10707. * to a desired value once triggered.
  10708. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10709. */
  10710. export class IncrementValueAction extends Action {
  10711. /**
  10712. * The path of the property to increment in the target.
  10713. */
  10714. propertyPath: string;
  10715. /**
  10716. * The value we should increment the property by.
  10717. */
  10718. value: any;
  10719. private _target;
  10720. private _effectiveTarget;
  10721. private _property;
  10722. /**
  10723. * Instantiate the action
  10724. * @param triggerOptions defines the trigger options
  10725. * @param target defines the object containing the property
  10726. * @param propertyPath defines the path of the property to increment in the target
  10727. * @param value defines the value value we should increment the property by
  10728. * @param condition defines the trigger related conditions
  10729. */
  10730. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10731. /** @hidden */
  10732. _prepare(): void;
  10733. /**
  10734. * Execute the action and increment the target of the value amount.
  10735. */
  10736. execute(): void;
  10737. /**
  10738. * Serializes the actions and its related information.
  10739. * @param parent defines the object to serialize in
  10740. * @returns the serialized object
  10741. */
  10742. serialize(parent: any): any;
  10743. }
  10744. /**
  10745. * This defines an action responsible to start an animation once triggered.
  10746. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10747. */
  10748. export class PlayAnimationAction extends Action {
  10749. /**
  10750. * Where the animation should start (animation frame)
  10751. */
  10752. from: number;
  10753. /**
  10754. * Where the animation should stop (animation frame)
  10755. */
  10756. to: number;
  10757. /**
  10758. * Define if the animation should loop or stop after the first play.
  10759. */
  10760. loop?: boolean;
  10761. private _target;
  10762. /**
  10763. * Instantiate the action
  10764. * @param triggerOptions defines the trigger options
  10765. * @param target defines the target animation or animation name
  10766. * @param from defines from where the animation should start (animation frame)
  10767. * @param end defines where the animation should stop (animation frame)
  10768. * @param loop defines if the animation should loop or stop after the first play
  10769. * @param condition defines the trigger related conditions
  10770. */
  10771. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10772. /** @hidden */
  10773. _prepare(): void;
  10774. /**
  10775. * Execute the action and play the animation.
  10776. */
  10777. execute(): void;
  10778. /**
  10779. * Serializes the actions and its related information.
  10780. * @param parent defines the object to serialize in
  10781. * @returns the serialized object
  10782. */
  10783. serialize(parent: any): any;
  10784. }
  10785. /**
  10786. * This defines an action responsible to stop an animation once triggered.
  10787. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10788. */
  10789. export class StopAnimationAction extends Action {
  10790. private _target;
  10791. /**
  10792. * Instantiate the action
  10793. * @param triggerOptions defines the trigger options
  10794. * @param target defines the target animation or animation name
  10795. * @param condition defines the trigger related conditions
  10796. */
  10797. constructor(triggerOptions: any, target: any, condition?: Condition);
  10798. /** @hidden */
  10799. _prepare(): void;
  10800. /**
  10801. * Execute the action and stop the animation.
  10802. */
  10803. execute(): void;
  10804. /**
  10805. * Serializes the actions and its related information.
  10806. * @param parent defines the object to serialize in
  10807. * @returns the serialized object
  10808. */
  10809. serialize(parent: any): any;
  10810. }
  10811. /**
  10812. * This defines an action responsible that does nothing once triggered.
  10813. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10814. */
  10815. export class DoNothingAction extends Action {
  10816. /**
  10817. * Instantiate the action
  10818. * @param triggerOptions defines the trigger options
  10819. * @param condition defines the trigger related conditions
  10820. */
  10821. constructor(triggerOptions?: any, condition?: Condition);
  10822. /**
  10823. * Execute the action and do nothing.
  10824. */
  10825. execute(): void;
  10826. /**
  10827. * Serializes the actions and its related information.
  10828. * @param parent defines the object to serialize in
  10829. * @returns the serialized object
  10830. */
  10831. serialize(parent: any): any;
  10832. }
  10833. /**
  10834. * This defines an action responsible to trigger several actions once triggered.
  10835. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10836. */
  10837. export class CombineAction extends Action {
  10838. /**
  10839. * The list of aggregated animations to run.
  10840. */
  10841. children: Action[];
  10842. /**
  10843. * Instantiate the action
  10844. * @param triggerOptions defines the trigger options
  10845. * @param children defines the list of aggregated animations to run
  10846. * @param condition defines the trigger related conditions
  10847. */
  10848. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10849. /** @hidden */
  10850. _prepare(): void;
  10851. /**
  10852. * Execute the action and executes all the aggregated actions.
  10853. */
  10854. execute(evt: ActionEvent): void;
  10855. /**
  10856. * Serializes the actions and its related information.
  10857. * @param parent defines the object to serialize in
  10858. * @returns the serialized object
  10859. */
  10860. serialize(parent: any): any;
  10861. }
  10862. /**
  10863. * This defines an action responsible to run code (external event) once triggered.
  10864. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10865. */
  10866. export class ExecuteCodeAction extends Action {
  10867. /**
  10868. * The callback function to run.
  10869. */
  10870. func: (evt: ActionEvent) => void;
  10871. /**
  10872. * Instantiate the action
  10873. * @param triggerOptions defines the trigger options
  10874. * @param func defines the callback function to run
  10875. * @param condition defines the trigger related conditions
  10876. */
  10877. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10878. /**
  10879. * Execute the action and run the attached code.
  10880. */
  10881. execute(evt: ActionEvent): void;
  10882. }
  10883. /**
  10884. * This defines an action responsible to set the parent property of the target once triggered.
  10885. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10886. */
  10887. export class SetParentAction extends Action {
  10888. private _parent;
  10889. private _target;
  10890. /**
  10891. * Instantiate the action
  10892. * @param triggerOptions defines the trigger options
  10893. * @param target defines the target containing the parent property
  10894. * @param parent defines from where the animation should start (animation frame)
  10895. * @param condition defines the trigger related conditions
  10896. */
  10897. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10898. /** @hidden */
  10899. _prepare(): void;
  10900. /**
  10901. * Execute the action and set the parent property.
  10902. */
  10903. execute(): void;
  10904. /**
  10905. * Serializes the actions and its related information.
  10906. * @param parent defines the object to serialize in
  10907. * @returns the serialized object
  10908. */
  10909. serialize(parent: any): any;
  10910. }
  10911. }
  10912. declare module "babylonjs/Actions/actionManager" {
  10913. import { Nullable } from "babylonjs/types";
  10914. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10915. import { Scene } from "babylonjs/scene";
  10916. import { IAction } from "babylonjs/Actions/action";
  10917. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10918. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10919. /**
  10920. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10921. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10922. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10923. */
  10924. export class ActionManager extends AbstractActionManager {
  10925. /**
  10926. * Nothing
  10927. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10928. */
  10929. static readonly NothingTrigger: number;
  10930. /**
  10931. * On pick
  10932. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10933. */
  10934. static readonly OnPickTrigger: number;
  10935. /**
  10936. * On left pick
  10937. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10938. */
  10939. static readonly OnLeftPickTrigger: number;
  10940. /**
  10941. * On right pick
  10942. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10943. */
  10944. static readonly OnRightPickTrigger: number;
  10945. /**
  10946. * On center pick
  10947. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10948. */
  10949. static readonly OnCenterPickTrigger: number;
  10950. /**
  10951. * On pick down
  10952. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10953. */
  10954. static readonly OnPickDownTrigger: number;
  10955. /**
  10956. * On double pick
  10957. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10958. */
  10959. static readonly OnDoublePickTrigger: number;
  10960. /**
  10961. * On pick up
  10962. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10963. */
  10964. static readonly OnPickUpTrigger: number;
  10965. /**
  10966. * On pick out.
  10967. * This trigger will only be raised if you also declared a OnPickDown
  10968. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10969. */
  10970. static readonly OnPickOutTrigger: number;
  10971. /**
  10972. * On long press
  10973. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10974. */
  10975. static readonly OnLongPressTrigger: number;
  10976. /**
  10977. * On pointer over
  10978. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10979. */
  10980. static readonly OnPointerOverTrigger: number;
  10981. /**
  10982. * On pointer out
  10983. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10984. */
  10985. static readonly OnPointerOutTrigger: number;
  10986. /**
  10987. * On every frame
  10988. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10989. */
  10990. static readonly OnEveryFrameTrigger: number;
  10991. /**
  10992. * On intersection enter
  10993. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10994. */
  10995. static readonly OnIntersectionEnterTrigger: number;
  10996. /**
  10997. * On intersection exit
  10998. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10999. */
  11000. static readonly OnIntersectionExitTrigger: number;
  11001. /**
  11002. * On key down
  11003. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11004. */
  11005. static readonly OnKeyDownTrigger: number;
  11006. /**
  11007. * On key up
  11008. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11009. */
  11010. static readonly OnKeyUpTrigger: number;
  11011. private _scene;
  11012. /**
  11013. * Creates a new action manager
  11014. * @param scene defines the hosting scene
  11015. */
  11016. constructor(scene: Scene);
  11017. /**
  11018. * Releases all associated resources
  11019. */
  11020. dispose(): void;
  11021. /**
  11022. * Gets hosting scene
  11023. * @returns the hosting scene
  11024. */
  11025. getScene(): Scene;
  11026. /**
  11027. * Does this action manager handles actions of any of the given triggers
  11028. * @param triggers defines the triggers to be tested
  11029. * @return a boolean indicating whether one (or more) of the triggers is handled
  11030. */
  11031. hasSpecificTriggers(triggers: number[]): boolean;
  11032. /**
  11033. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  11034. * speed.
  11035. * @param triggerA defines the trigger to be tested
  11036. * @param triggerB defines the trigger to be tested
  11037. * @return a boolean indicating whether one (or more) of the triggers is handled
  11038. */
  11039. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  11040. /**
  11041. * Does this action manager handles actions of a given trigger
  11042. * @param trigger defines the trigger to be tested
  11043. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  11044. * @return whether the trigger is handled
  11045. */
  11046. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  11047. /**
  11048. * Does this action manager has pointer triggers
  11049. */
  11050. readonly hasPointerTriggers: boolean;
  11051. /**
  11052. * Does this action manager has pick triggers
  11053. */
  11054. readonly hasPickTriggers: boolean;
  11055. /**
  11056. * Registers an action to this action manager
  11057. * @param action defines the action to be registered
  11058. * @return the action amended (prepared) after registration
  11059. */
  11060. registerAction(action: IAction): Nullable<IAction>;
  11061. /**
  11062. * Unregisters an action to this action manager
  11063. * @param action defines the action to be unregistered
  11064. * @return a boolean indicating whether the action has been unregistered
  11065. */
  11066. unregisterAction(action: IAction): Boolean;
  11067. /**
  11068. * Process a specific trigger
  11069. * @param trigger defines the trigger to process
  11070. * @param evt defines the event details to be processed
  11071. */
  11072. processTrigger(trigger: number, evt?: IActionEvent): void;
  11073. /** @hidden */
  11074. _getEffectiveTarget(target: any, propertyPath: string): any;
  11075. /** @hidden */
  11076. _getProperty(propertyPath: string): string;
  11077. /**
  11078. * Serialize this manager to a JSON object
  11079. * @param name defines the property name to store this manager
  11080. * @returns a JSON representation of this manager
  11081. */
  11082. serialize(name: string): any;
  11083. /**
  11084. * Creates a new ActionManager from a JSON data
  11085. * @param parsedActions defines the JSON data to read from
  11086. * @param object defines the hosting mesh
  11087. * @param scene defines the hosting scene
  11088. */
  11089. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  11090. /**
  11091. * Get a trigger name by index
  11092. * @param trigger defines the trigger index
  11093. * @returns a trigger name
  11094. */
  11095. static GetTriggerName(trigger: number): string;
  11096. }
  11097. }
  11098. declare module "babylonjs/Culling/ray" {
  11099. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  11100. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  11101. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11102. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11103. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  11104. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  11105. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  11106. import { Plane } from "babylonjs/Maths/math.plane";
  11107. /**
  11108. * Class representing a ray with position and direction
  11109. */
  11110. export class Ray {
  11111. /** origin point */
  11112. origin: Vector3;
  11113. /** direction */
  11114. direction: Vector3;
  11115. /** length of the ray */
  11116. length: number;
  11117. private static readonly TmpVector3;
  11118. private _tmpRay;
  11119. /**
  11120. * Creates a new ray
  11121. * @param origin origin point
  11122. * @param direction direction
  11123. * @param length length of the ray
  11124. */
  11125. constructor(
  11126. /** origin point */
  11127. origin: Vector3,
  11128. /** direction */
  11129. direction: Vector3,
  11130. /** length of the ray */
  11131. length?: number);
  11132. /**
  11133. * Checks if the ray intersects a box
  11134. * @param minimum bound of the box
  11135. * @param maximum bound of the box
  11136. * @param intersectionTreshold extra extend to be added to the box in all direction
  11137. * @returns if the box was hit
  11138. */
  11139. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  11140. /**
  11141. * Checks if the ray intersects a box
  11142. * @param box the bounding box to check
  11143. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  11144. * @returns if the box was hit
  11145. */
  11146. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  11147. /**
  11148. * If the ray hits a sphere
  11149. * @param sphere the bounding sphere to check
  11150. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  11151. * @returns true if it hits the sphere
  11152. */
  11153. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  11154. /**
  11155. * If the ray hits a triange
  11156. * @param vertex0 triangle vertex
  11157. * @param vertex1 triangle vertex
  11158. * @param vertex2 triangle vertex
  11159. * @returns intersection information if hit
  11160. */
  11161. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  11162. /**
  11163. * Checks if ray intersects a plane
  11164. * @param plane the plane to check
  11165. * @returns the distance away it was hit
  11166. */
  11167. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  11168. /**
  11169. * Calculate the intercept of a ray on a given axis
  11170. * @param axis to check 'x' | 'y' | 'z'
  11171. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  11172. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  11173. */
  11174. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  11175. /**
  11176. * Checks if ray intersects a mesh
  11177. * @param mesh the mesh to check
  11178. * @param fastCheck if only the bounding box should checked
  11179. * @returns picking info of the intersecton
  11180. */
  11181. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  11182. /**
  11183. * Checks if ray intersects a mesh
  11184. * @param meshes the meshes to check
  11185. * @param fastCheck if only the bounding box should checked
  11186. * @param results array to store result in
  11187. * @returns Array of picking infos
  11188. */
  11189. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  11190. private _comparePickingInfo;
  11191. private static smallnum;
  11192. private static rayl;
  11193. /**
  11194. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  11195. * @param sega the first point of the segment to test the intersection against
  11196. * @param segb the second point of the segment to test the intersection against
  11197. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  11198. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  11199. */
  11200. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  11201. /**
  11202. * Update the ray from viewport position
  11203. * @param x position
  11204. * @param y y position
  11205. * @param viewportWidth viewport width
  11206. * @param viewportHeight viewport height
  11207. * @param world world matrix
  11208. * @param view view matrix
  11209. * @param projection projection matrix
  11210. * @returns this ray updated
  11211. */
  11212. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  11213. /**
  11214. * Creates a ray with origin and direction of 0,0,0
  11215. * @returns the new ray
  11216. */
  11217. static Zero(): Ray;
  11218. /**
  11219. * Creates a new ray from screen space and viewport
  11220. * @param x position
  11221. * @param y y position
  11222. * @param viewportWidth viewport width
  11223. * @param viewportHeight viewport height
  11224. * @param world world matrix
  11225. * @param view view matrix
  11226. * @param projection projection matrix
  11227. * @returns new ray
  11228. */
  11229. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  11230. /**
  11231. * Function will create a new transformed ray starting from origin and ending at the end point. Ray's length will be set, and ray will be
  11232. * transformed to the given world matrix.
  11233. * @param origin The origin point
  11234. * @param end The end point
  11235. * @param world a matrix to transform the ray to. Default is the identity matrix.
  11236. * @returns the new ray
  11237. */
  11238. static CreateNewFromTo(origin: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, world?: DeepImmutable<Matrix>): Ray;
  11239. /**
  11240. * Transforms a ray by a matrix
  11241. * @param ray ray to transform
  11242. * @param matrix matrix to apply
  11243. * @returns the resulting new ray
  11244. */
  11245. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  11246. /**
  11247. * Transforms a ray by a matrix
  11248. * @param ray ray to transform
  11249. * @param matrix matrix to apply
  11250. * @param result ray to store result in
  11251. */
  11252. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  11253. /**
  11254. * Unproject a ray from screen space to object space
  11255. * @param sourceX defines the screen space x coordinate to use
  11256. * @param sourceY defines the screen space y coordinate to use
  11257. * @param viewportWidth defines the current width of the viewport
  11258. * @param viewportHeight defines the current height of the viewport
  11259. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  11260. * @param view defines the view matrix to use
  11261. * @param projection defines the projection matrix to use
  11262. */
  11263. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  11264. }
  11265. /**
  11266. * Type used to define predicate used to select faces when a mesh intersection is detected
  11267. */
  11268. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  11269. module "babylonjs/scene" {
  11270. interface Scene {
  11271. /** @hidden */
  11272. _tempPickingRay: Nullable<Ray>;
  11273. /** @hidden */
  11274. _cachedRayForTransform: Ray;
  11275. /** @hidden */
  11276. _pickWithRayInverseMatrix: Matrix;
  11277. /** @hidden */
  11278. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  11279. /** @hidden */
  11280. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  11281. }
  11282. }
  11283. }
  11284. declare module "babylonjs/sceneComponent" {
  11285. import { Scene } from "babylonjs/scene";
  11286. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11287. import { SubMesh } from "babylonjs/Meshes/subMesh";
  11288. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  11289. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  11290. import { Nullable } from "babylonjs/types";
  11291. import { Camera } from "babylonjs/Cameras/camera";
  11292. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  11293. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11294. import { AbstractScene } from "babylonjs/abstractScene";
  11295. import { Mesh } from "babylonjs/Meshes/mesh";
  11296. /**
  11297. * Groups all the scene component constants in one place to ease maintenance.
  11298. * @hidden
  11299. */
  11300. export class SceneComponentConstants {
  11301. static readonly NAME_EFFECTLAYER: string;
  11302. static readonly NAME_LAYER: string;
  11303. static readonly NAME_LENSFLARESYSTEM: string;
  11304. static readonly NAME_BOUNDINGBOXRENDERER: string;
  11305. static readonly NAME_PARTICLESYSTEM: string;
  11306. static readonly NAME_GAMEPAD: string;
  11307. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  11308. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  11309. static readonly NAME_DEPTHRENDERER: string;
  11310. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  11311. static readonly NAME_SPRITE: string;
  11312. static readonly NAME_OUTLINERENDERER: string;
  11313. static readonly NAME_PROCEDURALTEXTURE: string;
  11314. static readonly NAME_SHADOWGENERATOR: string;
  11315. static readonly NAME_OCTREE: string;
  11316. static readonly NAME_PHYSICSENGINE: string;
  11317. static readonly NAME_AUDIO: string;
  11318. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  11319. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  11320. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  11321. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  11322. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  11323. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  11324. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  11325. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  11326. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  11327. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  11328. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  11329. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  11330. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  11331. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  11332. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  11333. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  11334. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  11335. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  11336. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  11337. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  11338. static readonly STEP_AFTERRENDER_AUDIO: number;
  11339. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  11340. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  11341. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  11342. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  11343. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  11344. static readonly STEP_POINTERMOVE_SPRITE: number;
  11345. static readonly STEP_POINTERDOWN_SPRITE: number;
  11346. static readonly STEP_POINTERUP_SPRITE: number;
  11347. }
  11348. /**
  11349. * This represents a scene component.
  11350. *
  11351. * This is used to decouple the dependency the scene is having on the different workloads like
  11352. * layers, post processes...
  11353. */
  11354. export interface ISceneComponent {
  11355. /**
  11356. * The name of the component. Each component must have a unique name.
  11357. */
  11358. name: string;
  11359. /**
  11360. * The scene the component belongs to.
  11361. */
  11362. scene: Scene;
  11363. /**
  11364. * Register the component to one instance of a scene.
  11365. */
  11366. register(): void;
  11367. /**
  11368. * Rebuilds the elements related to this component in case of
  11369. * context lost for instance.
  11370. */
  11371. rebuild(): void;
  11372. /**
  11373. * Disposes the component and the associated ressources.
  11374. */
  11375. dispose(): void;
  11376. }
  11377. /**
  11378. * This represents a SERIALIZABLE scene component.
  11379. *
  11380. * This extends Scene Component to add Serialization methods on top.
  11381. */
  11382. export interface ISceneSerializableComponent extends ISceneComponent {
  11383. /**
  11384. * Adds all the elements from the container to the scene
  11385. * @param container the container holding the elements
  11386. */
  11387. addFromContainer(container: AbstractScene): void;
  11388. /**
  11389. * Removes all the elements in the container from the scene
  11390. * @param container contains the elements to remove
  11391. * @param dispose if the removed element should be disposed (default: false)
  11392. */
  11393. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  11394. /**
  11395. * Serializes the component data to the specified json object
  11396. * @param serializationObject The object to serialize to
  11397. */
  11398. serialize(serializationObject: any): void;
  11399. }
  11400. /**
  11401. * Strong typing of a Mesh related stage step action
  11402. */
  11403. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  11404. /**
  11405. * Strong typing of a Evaluate Sub Mesh related stage step action
  11406. */
  11407. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  11408. /**
  11409. * Strong typing of a Active Mesh related stage step action
  11410. */
  11411. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  11412. /**
  11413. * Strong typing of a Camera related stage step action
  11414. */
  11415. export type CameraStageAction = (camera: Camera) => void;
  11416. /**
  11417. * Strong typing of a Camera Frame buffer related stage step action
  11418. */
  11419. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  11420. /**
  11421. * Strong typing of a Render Target related stage step action
  11422. */
  11423. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  11424. /**
  11425. * Strong typing of a RenderingGroup related stage step action
  11426. */
  11427. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  11428. /**
  11429. * Strong typing of a Mesh Render related stage step action
  11430. */
  11431. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  11432. /**
  11433. * Strong typing of a simple stage step action
  11434. */
  11435. export type SimpleStageAction = () => void;
  11436. /**
  11437. * Strong typing of a render target action.
  11438. */
  11439. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  11440. /**
  11441. * Strong typing of a pointer move action.
  11442. */
  11443. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, canvas: HTMLCanvasElement) => Nullable<PickingInfo>;
  11444. /**
  11445. * Strong typing of a pointer up/down action.
  11446. */
  11447. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  11448. /**
  11449. * Representation of a stage in the scene (Basically a list of ordered steps)
  11450. * @hidden
  11451. */
  11452. export class Stage<T extends Function> extends Array<{
  11453. index: number;
  11454. component: ISceneComponent;
  11455. action: T;
  11456. }> {
  11457. /**
  11458. * Hide ctor from the rest of the world.
  11459. * @param items The items to add.
  11460. */
  11461. private constructor();
  11462. /**
  11463. * Creates a new Stage.
  11464. * @returns A new instance of a Stage
  11465. */
  11466. static Create<T extends Function>(): Stage<T>;
  11467. /**
  11468. * Registers a step in an ordered way in the targeted stage.
  11469. * @param index Defines the position to register the step in
  11470. * @param component Defines the component attached to the step
  11471. * @param action Defines the action to launch during the step
  11472. */
  11473. registerStep(index: number, component: ISceneComponent, action: T): void;
  11474. /**
  11475. * Clears all the steps from the stage.
  11476. */
  11477. clear(): void;
  11478. }
  11479. }
  11480. declare module "babylonjs/Sprites/spriteSceneComponent" {
  11481. import { Nullable } from "babylonjs/types";
  11482. import { Observable } from "babylonjs/Misc/observable";
  11483. import { Scene } from "babylonjs/scene";
  11484. import { Sprite } from "babylonjs/Sprites/sprite";
  11485. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11486. import { Ray } from "babylonjs/Culling/ray";
  11487. import { Camera } from "babylonjs/Cameras/camera";
  11488. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11489. import { ISceneComponent } from "babylonjs/sceneComponent";
  11490. module "babylonjs/scene" {
  11491. interface Scene {
  11492. /** @hidden */
  11493. _pointerOverSprite: Nullable<Sprite>;
  11494. /** @hidden */
  11495. _pickedDownSprite: Nullable<Sprite>;
  11496. /** @hidden */
  11497. _tempSpritePickingRay: Nullable<Ray>;
  11498. /**
  11499. * All of the sprite managers added to this scene
  11500. * @see http://doc.babylonjs.com/babylon101/sprites
  11501. */
  11502. spriteManagers: Array<ISpriteManager>;
  11503. /**
  11504. * An event triggered when sprites rendering is about to start
  11505. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11506. */
  11507. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11508. /**
  11509. * An event triggered when sprites rendering is done
  11510. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11511. */
  11512. onAfterSpritesRenderingObservable: Observable<Scene>;
  11513. /** @hidden */
  11514. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11515. /** Launch a ray to try to pick a sprite in the scene
  11516. * @param x position on screen
  11517. * @param y position on screen
  11518. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11519. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  11520. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11521. * @returns a PickingInfo
  11522. */
  11523. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11524. /** Use the given ray to pick a sprite in the scene
  11525. * @param ray The ray (in world space) to use to pick meshes
  11526. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11527. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  11528. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11529. * @returns a PickingInfo
  11530. */
  11531. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11532. /** @hidden */
  11533. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11534. /** Launch a ray to try to pick sprites in the scene
  11535. * @param x position on screen
  11536. * @param y position on screen
  11537. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11538. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11539. * @returns a PickingInfo array
  11540. */
  11541. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11542. /** Use the given ray to pick sprites in the scene
  11543. * @param ray The ray (in world space) to use to pick meshes
  11544. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11545. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11546. * @returns a PickingInfo array
  11547. */
  11548. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11549. /**
  11550. * Force the sprite under the pointer
  11551. * @param sprite defines the sprite to use
  11552. */
  11553. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11554. /**
  11555. * Gets the sprite under the pointer
  11556. * @returns a Sprite or null if no sprite is under the pointer
  11557. */
  11558. getPointerOverSprite(): Nullable<Sprite>;
  11559. }
  11560. }
  11561. /**
  11562. * Defines the sprite scene component responsible to manage sprites
  11563. * in a given scene.
  11564. */
  11565. export class SpriteSceneComponent implements ISceneComponent {
  11566. /**
  11567. * The component name helpfull to identify the component in the list of scene components.
  11568. */
  11569. readonly name: string;
  11570. /**
  11571. * The scene the component belongs to.
  11572. */
  11573. scene: Scene;
  11574. /** @hidden */
  11575. private _spritePredicate;
  11576. /**
  11577. * Creates a new instance of the component for the given scene
  11578. * @param scene Defines the scene to register the component in
  11579. */
  11580. constructor(scene: Scene);
  11581. /**
  11582. * Registers the component in a given scene
  11583. */
  11584. register(): void;
  11585. /**
  11586. * Rebuilds the elements related to this component in case of
  11587. * context lost for instance.
  11588. */
  11589. rebuild(): void;
  11590. /**
  11591. * Disposes the component and the associated ressources.
  11592. */
  11593. dispose(): void;
  11594. private _pickSpriteButKeepRay;
  11595. private _pointerMove;
  11596. private _pointerDown;
  11597. private _pointerUp;
  11598. }
  11599. }
  11600. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11601. /** @hidden */
  11602. export var fogFragmentDeclaration: {
  11603. name: string;
  11604. shader: string;
  11605. };
  11606. }
  11607. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11608. /** @hidden */
  11609. export var fogFragment: {
  11610. name: string;
  11611. shader: string;
  11612. };
  11613. }
  11614. declare module "babylonjs/Shaders/sprites.fragment" {
  11615. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11616. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11617. /** @hidden */
  11618. export var spritesPixelShader: {
  11619. name: string;
  11620. shader: string;
  11621. };
  11622. }
  11623. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11624. /** @hidden */
  11625. export var fogVertexDeclaration: {
  11626. name: string;
  11627. shader: string;
  11628. };
  11629. }
  11630. declare module "babylonjs/Shaders/sprites.vertex" {
  11631. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11632. /** @hidden */
  11633. export var spritesVertexShader: {
  11634. name: string;
  11635. shader: string;
  11636. };
  11637. }
  11638. declare module "babylonjs/Sprites/spriteManager" {
  11639. import { IDisposable, Scene } from "babylonjs/scene";
  11640. import { Nullable } from "babylonjs/types";
  11641. import { Observable } from "babylonjs/Misc/observable";
  11642. import { Sprite } from "babylonjs/Sprites/sprite";
  11643. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11644. import { Camera } from "babylonjs/Cameras/camera";
  11645. import { Texture } from "babylonjs/Materials/Textures/texture";
  11646. import "babylonjs/Shaders/sprites.fragment";
  11647. import "babylonjs/Shaders/sprites.vertex";
  11648. import { Ray } from "babylonjs/Culling/ray";
  11649. /**
  11650. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11651. */
  11652. export interface ISpriteManager extends IDisposable {
  11653. /**
  11654. * Restricts the camera to viewing objects with the same layerMask.
  11655. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11656. */
  11657. layerMask: number;
  11658. /**
  11659. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11660. */
  11661. isPickable: boolean;
  11662. /**
  11663. * Specifies the rendering group id for this mesh (0 by default)
  11664. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11665. */
  11666. renderingGroupId: number;
  11667. /**
  11668. * Defines the list of sprites managed by the manager.
  11669. */
  11670. sprites: Array<Sprite>;
  11671. /**
  11672. * Tests the intersection of a sprite with a specific ray.
  11673. * @param ray The ray we are sending to test the collision
  11674. * @param camera The camera space we are sending rays in
  11675. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11676. * @param fastCheck Is the hit test done in a OOBB or AOBB fashion the faster, the less precise
  11677. * @returns picking info or null.
  11678. */
  11679. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11680. /**
  11681. * Intersects the sprites with a ray
  11682. * @param ray defines the ray to intersect with
  11683. * @param camera defines the current active camera
  11684. * @param predicate defines a predicate used to select candidate sprites
  11685. * @returns null if no hit or a PickingInfo array
  11686. */
  11687. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11688. /**
  11689. * Renders the list of sprites on screen.
  11690. */
  11691. render(): void;
  11692. }
  11693. /**
  11694. * Class used to manage multiple sprites on the same spritesheet
  11695. * @see http://doc.babylonjs.com/babylon101/sprites
  11696. */
  11697. export class SpriteManager implements ISpriteManager {
  11698. /** defines the manager's name */
  11699. name: string;
  11700. /** Gets the list of sprites */
  11701. sprites: Sprite[];
  11702. /** Gets or sets the rendering group id (0 by default) */
  11703. renderingGroupId: number;
  11704. /** Gets or sets camera layer mask */
  11705. layerMask: number;
  11706. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11707. fogEnabled: boolean;
  11708. /** Gets or sets a boolean indicating if the sprites are pickable */
  11709. isPickable: boolean;
  11710. /** Defines the default width of a cell in the spritesheet */
  11711. cellWidth: number;
  11712. /** Defines the default height of a cell in the spritesheet */
  11713. cellHeight: number;
  11714. /** Associative array from JSON sprite data file */
  11715. private _cellData;
  11716. /** Array of sprite names from JSON sprite data file */
  11717. private _spriteMap;
  11718. /** True when packed cell data from JSON file is ready*/
  11719. private _packedAndReady;
  11720. /**
  11721. * An event triggered when the manager is disposed.
  11722. */
  11723. onDisposeObservable: Observable<SpriteManager>;
  11724. private _onDisposeObserver;
  11725. /**
  11726. * Callback called when the manager is disposed
  11727. */
  11728. onDispose: () => void;
  11729. private _capacity;
  11730. private _fromPacked;
  11731. private _spriteTexture;
  11732. private _epsilon;
  11733. private _scene;
  11734. private _vertexData;
  11735. private _buffer;
  11736. private _vertexBuffers;
  11737. private _indexBuffer;
  11738. private _effectBase;
  11739. private _effectFog;
  11740. /**
  11741. * Gets or sets the spritesheet texture
  11742. */
  11743. texture: Texture;
  11744. /**
  11745. * Creates a new sprite manager
  11746. * @param name defines the manager's name
  11747. * @param imgUrl defines the sprite sheet url
  11748. * @param capacity defines the maximum allowed number of sprites
  11749. * @param cellSize defines the size of a sprite cell
  11750. * @param scene defines the hosting scene
  11751. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11752. * @param samplingMode defines the smapling mode to use with spritesheet
  11753. * @param fromPacked set to false; do not alter
  11754. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11755. */
  11756. constructor(
  11757. /** defines the manager's name */
  11758. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: string | null);
  11759. private _makePacked;
  11760. private _appendSpriteVertex;
  11761. /**
  11762. * Intersects the sprites with a ray
  11763. * @param ray defines the ray to intersect with
  11764. * @param camera defines the current active camera
  11765. * @param predicate defines a predicate used to select candidate sprites
  11766. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11767. * @returns null if no hit or a PickingInfo
  11768. */
  11769. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11770. /**
  11771. * Intersects the sprites with a ray
  11772. * @param ray defines the ray to intersect with
  11773. * @param camera defines the current active camera
  11774. * @param predicate defines a predicate used to select candidate sprites
  11775. * @returns null if no hit or a PickingInfo array
  11776. */
  11777. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11778. /**
  11779. * Render all child sprites
  11780. */
  11781. render(): void;
  11782. /**
  11783. * Release associated resources
  11784. */
  11785. dispose(): void;
  11786. }
  11787. }
  11788. declare module "babylonjs/Sprites/sprite" {
  11789. import { Vector3 } from "babylonjs/Maths/math.vector";
  11790. import { Nullable } from "babylonjs/types";
  11791. import { ActionManager } from "babylonjs/Actions/actionManager";
  11792. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11793. import { Color4 } from "babylonjs/Maths/math.color";
  11794. /**
  11795. * Class used to represent a sprite
  11796. * @see http://doc.babylonjs.com/babylon101/sprites
  11797. */
  11798. export class Sprite {
  11799. /** defines the name */
  11800. name: string;
  11801. /** Gets or sets the current world position */
  11802. position: Vector3;
  11803. /** Gets or sets the main color */
  11804. color: Color4;
  11805. /** Gets or sets the width */
  11806. width: number;
  11807. /** Gets or sets the height */
  11808. height: number;
  11809. /** Gets or sets rotation angle */
  11810. angle: number;
  11811. /** Gets or sets the cell index in the sprite sheet */
  11812. cellIndex: number;
  11813. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  11814. cellRef: string;
  11815. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  11816. invertU: number;
  11817. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  11818. invertV: number;
  11819. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  11820. disposeWhenFinishedAnimating: boolean;
  11821. /** Gets the list of attached animations */
  11822. animations: Animation[];
  11823. /** Gets or sets a boolean indicating if the sprite can be picked */
  11824. isPickable: boolean;
  11825. /**
  11826. * Gets or sets the associated action manager
  11827. */
  11828. actionManager: Nullable<ActionManager>;
  11829. private _animationStarted;
  11830. private _loopAnimation;
  11831. private _fromIndex;
  11832. private _toIndex;
  11833. private _delay;
  11834. private _direction;
  11835. private _manager;
  11836. private _time;
  11837. private _onAnimationEnd;
  11838. /**
  11839. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  11840. */
  11841. isVisible: boolean;
  11842. /**
  11843. * Gets or sets the sprite size
  11844. */
  11845. size: number;
  11846. /**
  11847. * Creates a new Sprite
  11848. * @param name defines the name
  11849. * @param manager defines the manager
  11850. */
  11851. constructor(
  11852. /** defines the name */
  11853. name: string, manager: ISpriteManager);
  11854. /**
  11855. * Starts an animation
  11856. * @param from defines the initial key
  11857. * @param to defines the end key
  11858. * @param loop defines if the animation must loop
  11859. * @param delay defines the start delay (in ms)
  11860. * @param onAnimationEnd defines a callback to call when animation ends
  11861. */
  11862. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: () => void): void;
  11863. /** Stops current animation (if any) */
  11864. stopAnimation(): void;
  11865. /** @hidden */
  11866. _animate(deltaTime: number): void;
  11867. /** Release associated resources */
  11868. dispose(): void;
  11869. }
  11870. }
  11871. declare module "babylonjs/Collisions/pickingInfo" {
  11872. import { Nullable } from "babylonjs/types";
  11873. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11874. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11875. import { Sprite } from "babylonjs/Sprites/sprite";
  11876. import { Ray } from "babylonjs/Culling/ray";
  11877. /**
  11878. * Information about the result of picking within a scene
  11879. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  11880. */
  11881. export class PickingInfo {
  11882. /** @hidden */
  11883. _pickingUnavailable: boolean;
  11884. /**
  11885. * If the pick collided with an object
  11886. */
  11887. hit: boolean;
  11888. /**
  11889. * Distance away where the pick collided
  11890. */
  11891. distance: number;
  11892. /**
  11893. * The location of pick collision
  11894. */
  11895. pickedPoint: Nullable<Vector3>;
  11896. /**
  11897. * The mesh corresponding the the pick collision
  11898. */
  11899. pickedMesh: Nullable<AbstractMesh>;
  11900. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  11901. bu: number;
  11902. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  11903. bv: number;
  11904. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  11905. faceId: number;
  11906. /** Id of the the submesh that was picked */
  11907. subMeshId: number;
  11908. /** If a sprite was picked, this will be the sprite the pick collided with */
  11909. pickedSprite: Nullable<Sprite>;
  11910. /**
  11911. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  11912. */
  11913. originMesh: Nullable<AbstractMesh>;
  11914. /**
  11915. * The ray that was used to perform the picking.
  11916. */
  11917. ray: Nullable<Ray>;
  11918. /**
  11919. * Gets the normal correspodning to the face the pick collided with
  11920. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  11921. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  11922. * @returns The normal correspodning to the face the pick collided with
  11923. */
  11924. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  11925. /**
  11926. * Gets the texture coordinates of where the pick occured
  11927. * @returns the vector containing the coordnates of the texture
  11928. */
  11929. getTextureCoordinates(): Nullable<Vector2>;
  11930. }
  11931. }
  11932. declare module "babylonjs/Events/pointerEvents" {
  11933. import { Nullable } from "babylonjs/types";
  11934. import { Vector2 } from "babylonjs/Maths/math.vector";
  11935. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11936. import { Ray } from "babylonjs/Culling/ray";
  11937. /**
  11938. * Gather the list of pointer event types as constants.
  11939. */
  11940. export class PointerEventTypes {
  11941. /**
  11942. * The pointerdown event is fired when a pointer becomes active. For mouse, it is fired when the device transitions from no buttons depressed to at least one button depressed. For touch, it is fired when physical contact is made with the digitizer. For pen, it is fired when the stylus makes physical contact with the digitizer.
  11943. */
  11944. static readonly POINTERDOWN: number;
  11945. /**
  11946. * The pointerup event is fired when a pointer is no longer active.
  11947. */
  11948. static readonly POINTERUP: number;
  11949. /**
  11950. * The pointermove event is fired when a pointer changes coordinates.
  11951. */
  11952. static readonly POINTERMOVE: number;
  11953. /**
  11954. * The pointerwheel event is fired when a mouse wheel has been rotated.
  11955. */
  11956. static readonly POINTERWHEEL: number;
  11957. /**
  11958. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  11959. */
  11960. static readonly POINTERPICK: number;
  11961. /**
  11962. * The pointertap event is fired when a the object has been touched and released without drag.
  11963. */
  11964. static readonly POINTERTAP: number;
  11965. /**
  11966. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  11967. */
  11968. static readonly POINTERDOUBLETAP: number;
  11969. }
  11970. /**
  11971. * Base class of pointer info types.
  11972. */
  11973. export class PointerInfoBase {
  11974. /**
  11975. * Defines the type of event (PointerEventTypes)
  11976. */
  11977. type: number;
  11978. /**
  11979. * Defines the related dom event
  11980. */
  11981. event: PointerEvent | MouseWheelEvent;
  11982. /**
  11983. * Instantiates the base class of pointers info.
  11984. * @param type Defines the type of event (PointerEventTypes)
  11985. * @param event Defines the related dom event
  11986. */
  11987. constructor(
  11988. /**
  11989. * Defines the type of event (PointerEventTypes)
  11990. */
  11991. type: number,
  11992. /**
  11993. * Defines the related dom event
  11994. */
  11995. event: PointerEvent | MouseWheelEvent);
  11996. }
  11997. /**
  11998. * This class is used to store pointer related info for the onPrePointerObservable event.
  11999. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  12000. */
  12001. export class PointerInfoPre extends PointerInfoBase {
  12002. /**
  12003. * Ray from a pointer if availible (eg. 6dof controller)
  12004. */
  12005. ray: Nullable<Ray>;
  12006. /**
  12007. * Defines the local position of the pointer on the canvas.
  12008. */
  12009. localPosition: Vector2;
  12010. /**
  12011. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  12012. */
  12013. skipOnPointerObservable: boolean;
  12014. /**
  12015. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  12016. * @param type Defines the type of event (PointerEventTypes)
  12017. * @param event Defines the related dom event
  12018. * @param localX Defines the local x coordinates of the pointer when the event occured
  12019. * @param localY Defines the local y coordinates of the pointer when the event occured
  12020. */
  12021. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  12022. }
  12023. /**
  12024. * This type contains all the data related to a pointer event in Babylon.js.
  12025. * The event member is an instance of PointerEvent for all types except PointerWheel and is of type MouseWheelEvent when type equals PointerWheel. The different event types can be found in the PointerEventTypes class.
  12026. */
  12027. export class PointerInfo extends PointerInfoBase {
  12028. /**
  12029. * Defines the picking info associated to the info (if any)\
  12030. */
  12031. pickInfo: Nullable<PickingInfo>;
  12032. /**
  12033. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  12034. * @param type Defines the type of event (PointerEventTypes)
  12035. * @param event Defines the related dom event
  12036. * @param pickInfo Defines the picking info associated to the info (if any)\
  12037. */
  12038. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  12039. /**
  12040. * Defines the picking info associated to the info (if any)\
  12041. */
  12042. pickInfo: Nullable<PickingInfo>);
  12043. }
  12044. /**
  12045. * Data relating to a touch event on the screen.
  12046. */
  12047. export interface PointerTouch {
  12048. /**
  12049. * X coordinate of touch.
  12050. */
  12051. x: number;
  12052. /**
  12053. * Y coordinate of touch.
  12054. */
  12055. y: number;
  12056. /**
  12057. * Id of touch. Unique for each finger.
  12058. */
  12059. pointerId: number;
  12060. /**
  12061. * Event type passed from DOM.
  12062. */
  12063. type: any;
  12064. }
  12065. }
  12066. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  12067. import { Observable } from "babylonjs/Misc/observable";
  12068. import { Nullable } from "babylonjs/types";
  12069. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  12070. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12071. /**
  12072. * Manage the mouse inputs to control the movement of a free camera.
  12073. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12074. */
  12075. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  12076. /**
  12077. * Define if touch is enabled in the mouse input
  12078. */
  12079. touchEnabled: boolean;
  12080. /**
  12081. * Defines the camera the input is attached to.
  12082. */
  12083. camera: FreeCamera;
  12084. /**
  12085. * Defines the buttons associated with the input to handle camera move.
  12086. */
  12087. buttons: number[];
  12088. /**
  12089. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  12090. */
  12091. angularSensibility: number;
  12092. private _pointerInput;
  12093. private _onMouseMove;
  12094. private _observer;
  12095. private previousPosition;
  12096. /**
  12097. * Observable for when a pointer move event occurs containing the move offset
  12098. */
  12099. onPointerMovedObservable: Observable<{
  12100. offsetX: number;
  12101. offsetY: number;
  12102. }>;
  12103. /**
  12104. * @hidden
  12105. * If the camera should be rotated automatically based on pointer movement
  12106. */
  12107. _allowCameraRotation: boolean;
  12108. /**
  12109. * Manage the mouse inputs to control the movement of a free camera.
  12110. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12111. * @param touchEnabled Defines if touch is enabled or not
  12112. */
  12113. constructor(
  12114. /**
  12115. * Define if touch is enabled in the mouse input
  12116. */
  12117. touchEnabled?: boolean);
  12118. /**
  12119. * Attach the input controls to a specific dom element to get the input from.
  12120. * @param element Defines the element the controls should be listened from
  12121. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12122. */
  12123. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12124. /**
  12125. * Called on JS contextmenu event.
  12126. * Override this method to provide functionality.
  12127. */
  12128. protected onContextMenu(evt: PointerEvent): void;
  12129. /**
  12130. * Detach the current controls from the specified dom element.
  12131. * @param element Defines the element to stop listening the inputs from
  12132. */
  12133. detachControl(element: Nullable<HTMLElement>): void;
  12134. /**
  12135. * Gets the class name of the current intput.
  12136. * @returns the class name
  12137. */
  12138. getClassName(): string;
  12139. /**
  12140. * Get the friendly name associated with the input class.
  12141. * @returns the input friendly name
  12142. */
  12143. getSimpleName(): string;
  12144. }
  12145. }
  12146. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  12147. import { Nullable } from "babylonjs/types";
  12148. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  12149. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12150. /**
  12151. * Manage the touch inputs to control the movement of a free camera.
  12152. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12153. */
  12154. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  12155. /**
  12156. * Defines the camera the input is attached to.
  12157. */
  12158. camera: FreeCamera;
  12159. /**
  12160. * Defines the touch sensibility for rotation.
  12161. * The higher the faster.
  12162. */
  12163. touchAngularSensibility: number;
  12164. /**
  12165. * Defines the touch sensibility for move.
  12166. * The higher the faster.
  12167. */
  12168. touchMoveSensibility: number;
  12169. private _offsetX;
  12170. private _offsetY;
  12171. private _pointerPressed;
  12172. private _pointerInput;
  12173. private _observer;
  12174. private _onLostFocus;
  12175. /**
  12176. * Attach the input controls to a specific dom element to get the input from.
  12177. * @param element Defines the element the controls should be listened from
  12178. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12179. */
  12180. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12181. /**
  12182. * Detach the current controls from the specified dom element.
  12183. * @param element Defines the element to stop listening the inputs from
  12184. */
  12185. detachControl(element: Nullable<HTMLElement>): void;
  12186. /**
  12187. * Update the current camera state depending on the inputs that have been used this frame.
  12188. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  12189. */
  12190. checkInputs(): void;
  12191. /**
  12192. * Gets the class name of the current intput.
  12193. * @returns the class name
  12194. */
  12195. getClassName(): string;
  12196. /**
  12197. * Get the friendly name associated with the input class.
  12198. * @returns the input friendly name
  12199. */
  12200. getSimpleName(): string;
  12201. }
  12202. }
  12203. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  12204. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12205. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  12206. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  12207. import { Nullable } from "babylonjs/types";
  12208. /**
  12209. * Default Inputs manager for the FreeCamera.
  12210. * It groups all the default supported inputs for ease of use.
  12211. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12212. */
  12213. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  12214. /**
  12215. * @hidden
  12216. */
  12217. _mouseInput: Nullable<FreeCameraMouseInput>;
  12218. /**
  12219. * Instantiates a new FreeCameraInputsManager.
  12220. * @param camera Defines the camera the inputs belong to
  12221. */
  12222. constructor(camera: FreeCamera);
  12223. /**
  12224. * Add keyboard input support to the input manager.
  12225. * @returns the current input manager
  12226. */
  12227. addKeyboard(): FreeCameraInputsManager;
  12228. /**
  12229. * Add mouse input support to the input manager.
  12230. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  12231. * @returns the current input manager
  12232. */
  12233. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  12234. /**
  12235. * Removes the mouse input support from the manager
  12236. * @returns the current input manager
  12237. */
  12238. removeMouse(): FreeCameraInputsManager;
  12239. /**
  12240. * Add touch input support to the input manager.
  12241. * @returns the current input manager
  12242. */
  12243. addTouch(): FreeCameraInputsManager;
  12244. /**
  12245. * Remove all attached input methods from a camera
  12246. */
  12247. clear(): void;
  12248. }
  12249. }
  12250. declare module "babylonjs/Cameras/freeCamera" {
  12251. import { Vector3 } from "babylonjs/Maths/math.vector";
  12252. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12253. import { Scene } from "babylonjs/scene";
  12254. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  12255. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  12256. /**
  12257. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  12258. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  12259. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  12260. */
  12261. export class FreeCamera extends TargetCamera {
  12262. /**
  12263. * Define the collision ellipsoid of the camera.
  12264. * This is helpful to simulate a camera body like the player body around the camera
  12265. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  12266. */
  12267. ellipsoid: Vector3;
  12268. /**
  12269. * Define an offset for the position of the ellipsoid around the camera.
  12270. * This can be helpful to determine the center of the body near the gravity center of the body
  12271. * instead of its head.
  12272. */
  12273. ellipsoidOffset: Vector3;
  12274. /**
  12275. * Enable or disable collisions of the camera with the rest of the scene objects.
  12276. */
  12277. checkCollisions: boolean;
  12278. /**
  12279. * Enable or disable gravity on the camera.
  12280. */
  12281. applyGravity: boolean;
  12282. /**
  12283. * Define the input manager associated to the camera.
  12284. */
  12285. inputs: FreeCameraInputsManager;
  12286. /**
  12287. * Gets the input sensibility for a mouse input. (default is 2000.0)
  12288. * Higher values reduce sensitivity.
  12289. */
  12290. /**
  12291. * Sets the input sensibility for a mouse input. (default is 2000.0)
  12292. * Higher values reduce sensitivity.
  12293. */
  12294. angularSensibility: number;
  12295. /**
  12296. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  12297. */
  12298. keysUp: number[];
  12299. /**
  12300. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  12301. */
  12302. keysDown: number[];
  12303. /**
  12304. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  12305. */
  12306. keysLeft: number[];
  12307. /**
  12308. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  12309. */
  12310. keysRight: number[];
  12311. /**
  12312. * Event raised when the camera collide with a mesh in the scene.
  12313. */
  12314. onCollide: (collidedMesh: AbstractMesh) => void;
  12315. private _collider;
  12316. private _needMoveForGravity;
  12317. private _oldPosition;
  12318. private _diffPosition;
  12319. private _newPosition;
  12320. /** @hidden */
  12321. _localDirection: Vector3;
  12322. /** @hidden */
  12323. _transformedDirection: Vector3;
  12324. /**
  12325. * Instantiates a Free Camera.
  12326. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  12327. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  12328. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  12329. * @param name Define the name of the camera in the scene
  12330. * @param position Define the start position of the camera in the scene
  12331. * @param scene Define the scene the camera belongs to
  12332. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  12333. */
  12334. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  12335. /**
  12336. * Attached controls to the current camera.
  12337. * @param element Defines the element the controls should be listened from
  12338. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12339. */
  12340. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12341. /**
  12342. * Detach the current controls from the camera.
  12343. * The camera will stop reacting to inputs.
  12344. * @param element Defines the element to stop listening the inputs from
  12345. */
  12346. detachControl(element: HTMLElement): void;
  12347. private _collisionMask;
  12348. /**
  12349. * Define a collision mask to limit the list of object the camera can collide with
  12350. */
  12351. collisionMask: number;
  12352. /** @hidden */
  12353. _collideWithWorld(displacement: Vector3): void;
  12354. private _onCollisionPositionChange;
  12355. /** @hidden */
  12356. _checkInputs(): void;
  12357. /** @hidden */
  12358. _decideIfNeedsToMove(): boolean;
  12359. /** @hidden */
  12360. _updatePosition(): void;
  12361. /**
  12362. * Destroy the camera and release the current resources hold by it.
  12363. */
  12364. dispose(): void;
  12365. /**
  12366. * Gets the current object class name.
  12367. * @return the class name
  12368. */
  12369. getClassName(): string;
  12370. }
  12371. }
  12372. declare module "babylonjs/Gamepads/gamepad" {
  12373. import { Observable } from "babylonjs/Misc/observable";
  12374. /**
  12375. * Represents a gamepad control stick position
  12376. */
  12377. export class StickValues {
  12378. /**
  12379. * The x component of the control stick
  12380. */
  12381. x: number;
  12382. /**
  12383. * The y component of the control stick
  12384. */
  12385. y: number;
  12386. /**
  12387. * Initializes the gamepad x and y control stick values
  12388. * @param x The x component of the gamepad control stick value
  12389. * @param y The y component of the gamepad control stick value
  12390. */
  12391. constructor(
  12392. /**
  12393. * The x component of the control stick
  12394. */
  12395. x: number,
  12396. /**
  12397. * The y component of the control stick
  12398. */
  12399. y: number);
  12400. }
  12401. /**
  12402. * An interface which manages callbacks for gamepad button changes
  12403. */
  12404. export interface GamepadButtonChanges {
  12405. /**
  12406. * Called when a gamepad has been changed
  12407. */
  12408. changed: boolean;
  12409. /**
  12410. * Called when a gamepad press event has been triggered
  12411. */
  12412. pressChanged: boolean;
  12413. /**
  12414. * Called when a touch event has been triggered
  12415. */
  12416. touchChanged: boolean;
  12417. /**
  12418. * Called when a value has changed
  12419. */
  12420. valueChanged: boolean;
  12421. }
  12422. /**
  12423. * Represents a gamepad
  12424. */
  12425. export class Gamepad {
  12426. /**
  12427. * The id of the gamepad
  12428. */
  12429. id: string;
  12430. /**
  12431. * The index of the gamepad
  12432. */
  12433. index: number;
  12434. /**
  12435. * The browser gamepad
  12436. */
  12437. browserGamepad: any;
  12438. /**
  12439. * Specifies what type of gamepad this represents
  12440. */
  12441. type: number;
  12442. private _leftStick;
  12443. private _rightStick;
  12444. /** @hidden */
  12445. _isConnected: boolean;
  12446. private _leftStickAxisX;
  12447. private _leftStickAxisY;
  12448. private _rightStickAxisX;
  12449. private _rightStickAxisY;
  12450. /**
  12451. * Triggered when the left control stick has been changed
  12452. */
  12453. private _onleftstickchanged;
  12454. /**
  12455. * Triggered when the right control stick has been changed
  12456. */
  12457. private _onrightstickchanged;
  12458. /**
  12459. * Represents a gamepad controller
  12460. */
  12461. static GAMEPAD: number;
  12462. /**
  12463. * Represents a generic controller
  12464. */
  12465. static GENERIC: number;
  12466. /**
  12467. * Represents an XBox controller
  12468. */
  12469. static XBOX: number;
  12470. /**
  12471. * Represents a pose-enabled controller
  12472. */
  12473. static POSE_ENABLED: number;
  12474. /**
  12475. * Represents an Dual Shock controller
  12476. */
  12477. static DUALSHOCK: number;
  12478. /**
  12479. * Specifies whether the left control stick should be Y-inverted
  12480. */
  12481. protected _invertLeftStickY: boolean;
  12482. /**
  12483. * Specifies if the gamepad has been connected
  12484. */
  12485. readonly isConnected: boolean;
  12486. /**
  12487. * Initializes the gamepad
  12488. * @param id The id of the gamepad
  12489. * @param index The index of the gamepad
  12490. * @param browserGamepad The browser gamepad
  12491. * @param leftStickX The x component of the left joystick
  12492. * @param leftStickY The y component of the left joystick
  12493. * @param rightStickX The x component of the right joystick
  12494. * @param rightStickY The y component of the right joystick
  12495. */
  12496. constructor(
  12497. /**
  12498. * The id of the gamepad
  12499. */
  12500. id: string,
  12501. /**
  12502. * The index of the gamepad
  12503. */
  12504. index: number,
  12505. /**
  12506. * The browser gamepad
  12507. */
  12508. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  12509. /**
  12510. * Callback triggered when the left joystick has changed
  12511. * @param callback
  12512. */
  12513. onleftstickchanged(callback: (values: StickValues) => void): void;
  12514. /**
  12515. * Callback triggered when the right joystick has changed
  12516. * @param callback
  12517. */
  12518. onrightstickchanged(callback: (values: StickValues) => void): void;
  12519. /**
  12520. * Gets the left joystick
  12521. */
  12522. /**
  12523. * Sets the left joystick values
  12524. */
  12525. leftStick: StickValues;
  12526. /**
  12527. * Gets the right joystick
  12528. */
  12529. /**
  12530. * Sets the right joystick value
  12531. */
  12532. rightStick: StickValues;
  12533. /**
  12534. * Updates the gamepad joystick positions
  12535. */
  12536. update(): void;
  12537. /**
  12538. * Disposes the gamepad
  12539. */
  12540. dispose(): void;
  12541. }
  12542. /**
  12543. * Represents a generic gamepad
  12544. */
  12545. export class GenericPad extends Gamepad {
  12546. private _buttons;
  12547. private _onbuttondown;
  12548. private _onbuttonup;
  12549. /**
  12550. * Observable triggered when a button has been pressed
  12551. */
  12552. onButtonDownObservable: Observable<number>;
  12553. /**
  12554. * Observable triggered when a button has been released
  12555. */
  12556. onButtonUpObservable: Observable<number>;
  12557. /**
  12558. * Callback triggered when a button has been pressed
  12559. * @param callback Called when a button has been pressed
  12560. */
  12561. onbuttondown(callback: (buttonPressed: number) => void): void;
  12562. /**
  12563. * Callback triggered when a button has been released
  12564. * @param callback Called when a button has been released
  12565. */
  12566. onbuttonup(callback: (buttonReleased: number) => void): void;
  12567. /**
  12568. * Initializes the generic gamepad
  12569. * @param id The id of the generic gamepad
  12570. * @param index The index of the generic gamepad
  12571. * @param browserGamepad The browser gamepad
  12572. */
  12573. constructor(id: string, index: number, browserGamepad: any);
  12574. private _setButtonValue;
  12575. /**
  12576. * Updates the generic gamepad
  12577. */
  12578. update(): void;
  12579. /**
  12580. * Disposes the generic gamepad
  12581. */
  12582. dispose(): void;
  12583. }
  12584. }
  12585. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  12586. import { Nullable } from "babylonjs/types";
  12587. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  12588. import { Scene } from "babylonjs/scene";
  12589. module "babylonjs/Engines/engine" {
  12590. interface Engine {
  12591. /**
  12592. * Creates a raw texture
  12593. * @param data defines the data to store in the texture
  12594. * @param width defines the width of the texture
  12595. * @param height defines the height of the texture
  12596. * @param format defines the format of the data
  12597. * @param generateMipMaps defines if the engine should generate the mip levels
  12598. * @param invertY defines if data must be stored with Y axis inverted
  12599. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  12600. * @param compression defines the compression used (null by default)
  12601. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12602. * @returns the raw texture inside an InternalTexture
  12603. */
  12604. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  12605. /**
  12606. * Update a raw texture
  12607. * @param texture defines the texture to update
  12608. * @param data defines the data to store in the texture
  12609. * @param format defines the format of the data
  12610. * @param invertY defines if data must be stored with Y axis inverted
  12611. */
  12612. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12613. /**
  12614. * Update a raw texture
  12615. * @param texture defines the texture to update
  12616. * @param data defines the data to store in the texture
  12617. * @param format defines the format of the data
  12618. * @param invertY defines if data must be stored with Y axis inverted
  12619. * @param compression defines the compression used (null by default)
  12620. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12621. */
  12622. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  12623. /**
  12624. * Creates a new raw cube texture
  12625. * @param data defines the array of data to use to create each face
  12626. * @param size defines the size of the textures
  12627. * @param format defines the format of the data
  12628. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12629. * @param generateMipMaps defines if the engine should generate the mip levels
  12630. * @param invertY defines if data must be stored with Y axis inverted
  12631. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12632. * @param compression defines the compression used (null by default)
  12633. * @returns the cube texture as an InternalTexture
  12634. */
  12635. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  12636. /**
  12637. * Update a raw cube texture
  12638. * @param texture defines the texture to udpdate
  12639. * @param data defines the data to store
  12640. * @param format defines the data format
  12641. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12642. * @param invertY defines if data must be stored with Y axis inverted
  12643. */
  12644. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  12645. /**
  12646. * Update a raw cube texture
  12647. * @param texture defines the texture to udpdate
  12648. * @param data defines the data to store
  12649. * @param format defines the data format
  12650. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12651. * @param invertY defines if data must be stored with Y axis inverted
  12652. * @param compression defines the compression used (null by default)
  12653. */
  12654. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  12655. /**
  12656. * Update a raw cube texture
  12657. * @param texture defines the texture to udpdate
  12658. * @param data defines the data to store
  12659. * @param format defines the data format
  12660. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12661. * @param invertY defines if data must be stored with Y axis inverted
  12662. * @param compression defines the compression used (null by default)
  12663. * @param level defines which level of the texture to update
  12664. */
  12665. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  12666. /**
  12667. * Creates a new raw cube texture from a specified url
  12668. * @param url defines the url where the data is located
  12669. * @param scene defines the current scene
  12670. * @param size defines the size of the textures
  12671. * @param format defines the format of the data
  12672. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12673. * @param noMipmap defines if the engine should avoid generating the mip levels
  12674. * @param callback defines a callback used to extract texture data from loaded data
  12675. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  12676. * @param onLoad defines a callback called when texture is loaded
  12677. * @param onError defines a callback called if there is an error
  12678. * @returns the cube texture as an InternalTexture
  12679. */
  12680. createRawCubeTextureFromUrl(url: string, scene: Scene, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>): InternalTexture;
  12681. /**
  12682. * Creates a new raw cube texture from a specified url
  12683. * @param url defines the url where the data is located
  12684. * @param scene defines the current scene
  12685. * @param size defines the size of the textures
  12686. * @param format defines the format of the data
  12687. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12688. * @param noMipmap defines if the engine should avoid generating the mip levels
  12689. * @param callback defines a callback used to extract texture data from loaded data
  12690. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  12691. * @param onLoad defines a callback called when texture is loaded
  12692. * @param onError defines a callback called if there is an error
  12693. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12694. * @param invertY defines if data must be stored with Y axis inverted
  12695. * @returns the cube texture as an InternalTexture
  12696. */
  12697. createRawCubeTextureFromUrl(url: string, scene: Scene, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>, samplingMode: number, invertY: boolean): InternalTexture;
  12698. /**
  12699. * Creates a new raw 3D texture
  12700. * @param data defines the data used to create the texture
  12701. * @param width defines the width of the texture
  12702. * @param height defines the height of the texture
  12703. * @param depth defines the depth of the texture
  12704. * @param format defines the format of the texture
  12705. * @param generateMipMaps defines if the engine must generate mip levels
  12706. * @param invertY defines if data must be stored with Y axis inverted
  12707. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12708. * @param compression defines the compressed used (can be null)
  12709. * @param textureType defines the compressed used (can be null)
  12710. * @returns a new raw 3D texture (stored in an InternalTexture)
  12711. */
  12712. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  12713. /**
  12714. * Update a raw 3D texture
  12715. * @param texture defines the texture to update
  12716. * @param data defines the data to store
  12717. * @param format defines the data format
  12718. * @param invertY defines if data must be stored with Y axis inverted
  12719. */
  12720. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12721. /**
  12722. * Update a raw 3D texture
  12723. * @param texture defines the texture to update
  12724. * @param data defines the data to store
  12725. * @param format defines the data format
  12726. * @param invertY defines if data must be stored with Y axis inverted
  12727. * @param compression defines the used compression (can be null)
  12728. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  12729. */
  12730. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  12731. }
  12732. }
  12733. }
  12734. declare module "babylonjs/Materials/Textures/rawTexture" {
  12735. import { Scene } from "babylonjs/scene";
  12736. import { Texture } from "babylonjs/Materials/Textures/texture";
  12737. import "babylonjs/Engines/Extensions/engine.rawTexture";
  12738. /**
  12739. * Raw texture can help creating a texture directly from an array of data.
  12740. * This can be super useful if you either get the data from an uncompressed source or
  12741. * if you wish to create your texture pixel by pixel.
  12742. */
  12743. export class RawTexture extends Texture {
  12744. /**
  12745. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12746. */
  12747. format: number;
  12748. private _engine;
  12749. /**
  12750. * Instantiates a new RawTexture.
  12751. * Raw texture can help creating a texture directly from an array of data.
  12752. * This can be super useful if you either get the data from an uncompressed source or
  12753. * if you wish to create your texture pixel by pixel.
  12754. * @param data define the array of data to use to create the texture
  12755. * @param width define the width of the texture
  12756. * @param height define the height of the texture
  12757. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12758. * @param scene define the scene the texture belongs to
  12759. * @param generateMipMaps define whether mip maps should be generated or not
  12760. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12761. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12762. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12763. */
  12764. constructor(data: ArrayBufferView, width: number, height: number,
  12765. /**
  12766. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12767. */
  12768. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  12769. /**
  12770. * Updates the texture underlying data.
  12771. * @param data Define the new data of the texture
  12772. */
  12773. update(data: ArrayBufferView): void;
  12774. /**
  12775. * Creates a luminance texture from some data.
  12776. * @param data Define the texture data
  12777. * @param width Define the width of the texture
  12778. * @param height Define the height of the texture
  12779. * @param scene Define the scene the texture belongs to
  12780. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12781. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12782. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12783. * @returns the luminance texture
  12784. */
  12785. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12786. /**
  12787. * Creates a luminance alpha texture from some data.
  12788. * @param data Define the texture data
  12789. * @param width Define the width of the texture
  12790. * @param height Define the height of the texture
  12791. * @param scene Define the scene the texture belongs to
  12792. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12793. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12794. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12795. * @returns the luminance alpha texture
  12796. */
  12797. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12798. /**
  12799. * Creates an alpha texture from some data.
  12800. * @param data Define the texture data
  12801. * @param width Define the width of the texture
  12802. * @param height Define the height of the texture
  12803. * @param scene Define the scene the texture belongs to
  12804. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12805. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12806. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12807. * @returns the alpha texture
  12808. */
  12809. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12810. /**
  12811. * Creates a RGB texture from some data.
  12812. * @param data Define the texture data
  12813. * @param width Define the width of the texture
  12814. * @param height Define the height of the texture
  12815. * @param scene Define the scene the texture belongs to
  12816. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12817. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12818. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12819. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12820. * @returns the RGB alpha texture
  12821. */
  12822. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12823. /**
  12824. * Creates a RGBA texture from some data.
  12825. * @param data Define the texture data
  12826. * @param width Define the width of the texture
  12827. * @param height Define the height of the texture
  12828. * @param scene Define the scene the texture belongs to
  12829. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12830. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12831. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12832. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12833. * @returns the RGBA texture
  12834. */
  12835. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12836. /**
  12837. * Creates a R texture from some data.
  12838. * @param data Define the texture data
  12839. * @param width Define the width of the texture
  12840. * @param height Define the height of the texture
  12841. * @param scene Define the scene the texture belongs to
  12842. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12843. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12844. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12845. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12846. * @returns the R texture
  12847. */
  12848. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12849. }
  12850. }
  12851. declare module "babylonjs/Maths/math.size" {
  12852. /**
  12853. * Interface for the size containing width and height
  12854. */
  12855. export interface ISize {
  12856. /**
  12857. * Width
  12858. */
  12859. width: number;
  12860. /**
  12861. * Heighht
  12862. */
  12863. height: number;
  12864. }
  12865. /**
  12866. * Size containing widht and height
  12867. */
  12868. export class Size implements ISize {
  12869. /**
  12870. * Width
  12871. */
  12872. width: number;
  12873. /**
  12874. * Height
  12875. */
  12876. height: number;
  12877. /**
  12878. * Creates a Size object from the given width and height (floats).
  12879. * @param width width of the new size
  12880. * @param height height of the new size
  12881. */
  12882. constructor(width: number, height: number);
  12883. /**
  12884. * Returns a string with the Size width and height
  12885. * @returns a string with the Size width and height
  12886. */
  12887. toString(): string;
  12888. /**
  12889. * "Size"
  12890. * @returns the string "Size"
  12891. */
  12892. getClassName(): string;
  12893. /**
  12894. * Returns the Size hash code.
  12895. * @returns a hash code for a unique width and height
  12896. */
  12897. getHashCode(): number;
  12898. /**
  12899. * Updates the current size from the given one.
  12900. * @param src the given size
  12901. */
  12902. copyFrom(src: Size): void;
  12903. /**
  12904. * Updates in place the current Size from the given floats.
  12905. * @param width width of the new size
  12906. * @param height height of the new size
  12907. * @returns the updated Size.
  12908. */
  12909. copyFromFloats(width: number, height: number): Size;
  12910. /**
  12911. * Updates in place the current Size from the given floats.
  12912. * @param width width to set
  12913. * @param height height to set
  12914. * @returns the updated Size.
  12915. */
  12916. set(width: number, height: number): Size;
  12917. /**
  12918. * Multiplies the width and height by numbers
  12919. * @param w factor to multiple the width by
  12920. * @param h factor to multiple the height by
  12921. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  12922. */
  12923. multiplyByFloats(w: number, h: number): Size;
  12924. /**
  12925. * Clones the size
  12926. * @returns a new Size copied from the given one.
  12927. */
  12928. clone(): Size;
  12929. /**
  12930. * True if the current Size and the given one width and height are strictly equal.
  12931. * @param other the other size to compare against
  12932. * @returns True if the current Size and the given one width and height are strictly equal.
  12933. */
  12934. equals(other: Size): boolean;
  12935. /**
  12936. * The surface of the Size : width * height (float).
  12937. */
  12938. readonly surface: number;
  12939. /**
  12940. * Create a new size of zero
  12941. * @returns a new Size set to (0.0, 0.0)
  12942. */
  12943. static Zero(): Size;
  12944. /**
  12945. * Sums the width and height of two sizes
  12946. * @param otherSize size to add to this size
  12947. * @returns a new Size set as the addition result of the current Size and the given one.
  12948. */
  12949. add(otherSize: Size): Size;
  12950. /**
  12951. * Subtracts the width and height of two
  12952. * @param otherSize size to subtract to this size
  12953. * @returns a new Size set as the subtraction result of the given one from the current Size.
  12954. */
  12955. subtract(otherSize: Size): Size;
  12956. /**
  12957. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  12958. * @param start starting size to lerp between
  12959. * @param end end size to lerp between
  12960. * @param amount amount to lerp between the start and end values
  12961. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  12962. */
  12963. static Lerp(start: Size, end: Size, amount: number): Size;
  12964. }
  12965. }
  12966. declare module "babylonjs/Animations/runtimeAnimation" {
  12967. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  12968. import { Animatable } from "babylonjs/Animations/animatable";
  12969. import { Scene } from "babylonjs/scene";
  12970. /**
  12971. * Defines a runtime animation
  12972. */
  12973. export class RuntimeAnimation {
  12974. private _events;
  12975. /**
  12976. * The current frame of the runtime animation
  12977. */
  12978. private _currentFrame;
  12979. /**
  12980. * The animation used by the runtime animation
  12981. */
  12982. private _animation;
  12983. /**
  12984. * The target of the runtime animation
  12985. */
  12986. private _target;
  12987. /**
  12988. * The initiating animatable
  12989. */
  12990. private _host;
  12991. /**
  12992. * The original value of the runtime animation
  12993. */
  12994. private _originalValue;
  12995. /**
  12996. * The original blend value of the runtime animation
  12997. */
  12998. private _originalBlendValue;
  12999. /**
  13000. * The offsets cache of the runtime animation
  13001. */
  13002. private _offsetsCache;
  13003. /**
  13004. * The high limits cache of the runtime animation
  13005. */
  13006. private _highLimitsCache;
  13007. /**
  13008. * Specifies if the runtime animation has been stopped
  13009. */
  13010. private _stopped;
  13011. /**
  13012. * The blending factor of the runtime animation
  13013. */
  13014. private _blendingFactor;
  13015. /**
  13016. * The BabylonJS scene
  13017. */
  13018. private _scene;
  13019. /**
  13020. * The current value of the runtime animation
  13021. */
  13022. private _currentValue;
  13023. /** @hidden */
  13024. _animationState: _IAnimationState;
  13025. /**
  13026. * The active target of the runtime animation
  13027. */
  13028. private _activeTargets;
  13029. private _currentActiveTarget;
  13030. private _directTarget;
  13031. /**
  13032. * The target path of the runtime animation
  13033. */
  13034. private _targetPath;
  13035. /**
  13036. * The weight of the runtime animation
  13037. */
  13038. private _weight;
  13039. /**
  13040. * The ratio offset of the runtime animation
  13041. */
  13042. private _ratioOffset;
  13043. /**
  13044. * The previous delay of the runtime animation
  13045. */
  13046. private _previousDelay;
  13047. /**
  13048. * The previous ratio of the runtime animation
  13049. */
  13050. private _previousRatio;
  13051. private _enableBlending;
  13052. private _keys;
  13053. private _minFrame;
  13054. private _maxFrame;
  13055. private _minValue;
  13056. private _maxValue;
  13057. private _targetIsArray;
  13058. /**
  13059. * Gets the current frame of the runtime animation
  13060. */
  13061. readonly currentFrame: number;
  13062. /**
  13063. * Gets the weight of the runtime animation
  13064. */
  13065. readonly weight: number;
  13066. /**
  13067. * Gets the current value of the runtime animation
  13068. */
  13069. readonly currentValue: any;
  13070. /**
  13071. * Gets the target path of the runtime animation
  13072. */
  13073. readonly targetPath: string;
  13074. /**
  13075. * Gets the actual target of the runtime animation
  13076. */
  13077. readonly target: any;
  13078. /** @hidden */
  13079. _onLoop: () => void;
  13080. /**
  13081. * Create a new RuntimeAnimation object
  13082. * @param target defines the target of the animation
  13083. * @param animation defines the source animation object
  13084. * @param scene defines the hosting scene
  13085. * @param host defines the initiating Animatable
  13086. */
  13087. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  13088. private _preparePath;
  13089. /**
  13090. * Gets the animation from the runtime animation
  13091. */
  13092. readonly animation: Animation;
  13093. /**
  13094. * Resets the runtime animation to the beginning
  13095. * @param restoreOriginal defines whether to restore the target property to the original value
  13096. */
  13097. reset(restoreOriginal?: boolean): void;
  13098. /**
  13099. * Specifies if the runtime animation is stopped
  13100. * @returns Boolean specifying if the runtime animation is stopped
  13101. */
  13102. isStopped(): boolean;
  13103. /**
  13104. * Disposes of the runtime animation
  13105. */
  13106. dispose(): void;
  13107. /**
  13108. * Apply the interpolated value to the target
  13109. * @param currentValue defines the value computed by the animation
  13110. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  13111. */
  13112. setValue(currentValue: any, weight: number): void;
  13113. private _getOriginalValues;
  13114. private _setValue;
  13115. /**
  13116. * Gets the loop pmode of the runtime animation
  13117. * @returns Loop Mode
  13118. */
  13119. private _getCorrectLoopMode;
  13120. /**
  13121. * Move the current animation to a given frame
  13122. * @param frame defines the frame to move to
  13123. */
  13124. goToFrame(frame: number): void;
  13125. /**
  13126. * @hidden Internal use only
  13127. */
  13128. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  13129. /**
  13130. * Execute the current animation
  13131. * @param delay defines the delay to add to the current frame
  13132. * @param from defines the lower bound of the animation range
  13133. * @param to defines the upper bound of the animation range
  13134. * @param loop defines if the current animation must loop
  13135. * @param speedRatio defines the current speed ratio
  13136. * @param weight defines the weight of the animation (default is -1 so no weight)
  13137. * @param onLoop optional callback called when animation loops
  13138. * @returns a boolean indicating if the animation is running
  13139. */
  13140. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  13141. }
  13142. }
  13143. declare module "babylonjs/Animations/animatable" {
  13144. import { Animation } from "babylonjs/Animations/animation";
  13145. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  13146. import { Nullable } from "babylonjs/types";
  13147. import { Observable } from "babylonjs/Misc/observable";
  13148. import { Scene } from "babylonjs/scene";
  13149. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  13150. import { Node } from "babylonjs/node";
  13151. /**
  13152. * Class used to store an actual running animation
  13153. */
  13154. export class Animatable {
  13155. /** defines the target object */
  13156. target: any;
  13157. /** defines the starting frame number (default is 0) */
  13158. fromFrame: number;
  13159. /** defines the ending frame number (default is 100) */
  13160. toFrame: number;
  13161. /** defines if the animation must loop (default is false) */
  13162. loopAnimation: boolean;
  13163. /** defines a callback to call when animation ends if it is not looping */
  13164. onAnimationEnd?: (() => void) | null | undefined;
  13165. /** defines a callback to call when animation loops */
  13166. onAnimationLoop?: (() => void) | null | undefined;
  13167. private _localDelayOffset;
  13168. private _pausedDelay;
  13169. private _runtimeAnimations;
  13170. private _paused;
  13171. private _scene;
  13172. private _speedRatio;
  13173. private _weight;
  13174. private _syncRoot;
  13175. /**
  13176. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  13177. * This will only apply for non looping animation (default is true)
  13178. */
  13179. disposeOnEnd: boolean;
  13180. /**
  13181. * Gets a boolean indicating if the animation has started
  13182. */
  13183. animationStarted: boolean;
  13184. /**
  13185. * Observer raised when the animation ends
  13186. */
  13187. onAnimationEndObservable: Observable<Animatable>;
  13188. /**
  13189. * Observer raised when the animation loops
  13190. */
  13191. onAnimationLoopObservable: Observable<Animatable>;
  13192. /**
  13193. * Gets the root Animatable used to synchronize and normalize animations
  13194. */
  13195. readonly syncRoot: Nullable<Animatable>;
  13196. /**
  13197. * Gets the current frame of the first RuntimeAnimation
  13198. * Used to synchronize Animatables
  13199. */
  13200. readonly masterFrame: number;
  13201. /**
  13202. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  13203. */
  13204. weight: number;
  13205. /**
  13206. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  13207. */
  13208. speedRatio: number;
  13209. /**
  13210. * Creates a new Animatable
  13211. * @param scene defines the hosting scene
  13212. * @param target defines the target object
  13213. * @param fromFrame defines the starting frame number (default is 0)
  13214. * @param toFrame defines the ending frame number (default is 100)
  13215. * @param loopAnimation defines if the animation must loop (default is false)
  13216. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  13217. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  13218. * @param animations defines a group of animation to add to the new Animatable
  13219. * @param onAnimationLoop defines a callback to call when animation loops
  13220. */
  13221. constructor(scene: Scene,
  13222. /** defines the target object */
  13223. target: any,
  13224. /** defines the starting frame number (default is 0) */
  13225. fromFrame?: number,
  13226. /** defines the ending frame number (default is 100) */
  13227. toFrame?: number,
  13228. /** defines if the animation must loop (default is false) */
  13229. loopAnimation?: boolean, speedRatio?: number,
  13230. /** defines a callback to call when animation ends if it is not looping */
  13231. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  13232. /** defines a callback to call when animation loops */
  13233. onAnimationLoop?: (() => void) | null | undefined);
  13234. /**
  13235. * Synchronize and normalize current Animatable with a source Animatable
  13236. * This is useful when using animation weights and when animations are not of the same length
  13237. * @param root defines the root Animatable to synchronize with
  13238. * @returns the current Animatable
  13239. */
  13240. syncWith(root: Animatable): Animatable;
  13241. /**
  13242. * Gets the list of runtime animations
  13243. * @returns an array of RuntimeAnimation
  13244. */
  13245. getAnimations(): RuntimeAnimation[];
  13246. /**
  13247. * Adds more animations to the current animatable
  13248. * @param target defines the target of the animations
  13249. * @param animations defines the new animations to add
  13250. */
  13251. appendAnimations(target: any, animations: Animation[]): void;
  13252. /**
  13253. * Gets the source animation for a specific property
  13254. * @param property defines the propertyu to look for
  13255. * @returns null or the source animation for the given property
  13256. */
  13257. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  13258. /**
  13259. * Gets the runtime animation for a specific property
  13260. * @param property defines the propertyu to look for
  13261. * @returns null or the runtime animation for the given property
  13262. */
  13263. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  13264. /**
  13265. * Resets the animatable to its original state
  13266. */
  13267. reset(): void;
  13268. /**
  13269. * Allows the animatable to blend with current running animations
  13270. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13271. * @param blendingSpeed defines the blending speed to use
  13272. */
  13273. enableBlending(blendingSpeed: number): void;
  13274. /**
  13275. * Disable animation blending
  13276. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13277. */
  13278. disableBlending(): void;
  13279. /**
  13280. * Jump directly to a given frame
  13281. * @param frame defines the frame to jump to
  13282. */
  13283. goToFrame(frame: number): void;
  13284. /**
  13285. * Pause the animation
  13286. */
  13287. pause(): void;
  13288. /**
  13289. * Restart the animation
  13290. */
  13291. restart(): void;
  13292. private _raiseOnAnimationEnd;
  13293. /**
  13294. * Stop and delete the current animation
  13295. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  13296. * @param targetMask - a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
  13297. */
  13298. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  13299. /**
  13300. * Wait asynchronously for the animation to end
  13301. * @returns a promise which will be fullfilled when the animation ends
  13302. */
  13303. waitAsync(): Promise<Animatable>;
  13304. /** @hidden */
  13305. _animate(delay: number): boolean;
  13306. }
  13307. module "babylonjs/scene" {
  13308. interface Scene {
  13309. /** @hidden */
  13310. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  13311. /** @hidden */
  13312. _processLateAnimationBindingsForMatrices(holder: {
  13313. totalWeight: number;
  13314. animations: RuntimeAnimation[];
  13315. originalValue: Matrix;
  13316. }): any;
  13317. /** @hidden */
  13318. _processLateAnimationBindingsForQuaternions(holder: {
  13319. totalWeight: number;
  13320. animations: RuntimeAnimation[];
  13321. originalValue: Quaternion;
  13322. }, refQuaternion: Quaternion): Quaternion;
  13323. /** @hidden */
  13324. _processLateAnimationBindings(): void;
  13325. /**
  13326. * Will start the animation sequence of a given target
  13327. * @param target defines the target
  13328. * @param from defines from which frame should animation start
  13329. * @param to defines until which frame should animation run.
  13330. * @param weight defines the weight to apply to the animation (1.0 by default)
  13331. * @param loop defines if the animation loops
  13332. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13333. * @param onAnimationEnd defines the function to be executed when the animation ends
  13334. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13335. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  13336. * @param onAnimationLoop defines the callback to call when an animation loops
  13337. * @returns the animatable object created for this animation
  13338. */
  13339. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  13340. /**
  13341. * Will start the animation sequence of a given target
  13342. * @param target defines the target
  13343. * @param from defines from which frame should animation start
  13344. * @param to defines until which frame should animation run.
  13345. * @param loop defines if the animation loops
  13346. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13347. * @param onAnimationEnd defines the function to be executed when the animation ends
  13348. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13349. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  13350. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  13351. * @param onAnimationLoop defines the callback to call when an animation loops
  13352. * @returns the animatable object created for this animation
  13353. */
  13354. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  13355. /**
  13356. * Will start the animation sequence of a given target and its hierarchy
  13357. * @param target defines the target
  13358. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  13359. * @param from defines from which frame should animation start
  13360. * @param to defines until which frame should animation run.
  13361. * @param loop defines if the animation loops
  13362. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13363. * @param onAnimationEnd defines the function to be executed when the animation ends
  13364. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13365. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  13366. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  13367. * @param onAnimationLoop defines the callback to call when an animation loops
  13368. * @returns the list of created animatables
  13369. */
  13370. beginHierarchyAnimation(target: any, directDescendantsOnly: boolean, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable[];
  13371. /**
  13372. * Begin a new animation on a given node
  13373. * @param target defines the target where the animation will take place
  13374. * @param animations defines the list of animations to start
  13375. * @param from defines the initial value
  13376. * @param to defines the final value
  13377. * @param loop defines if you want animation to loop (off by default)
  13378. * @param speedRatio defines the speed ratio to apply to all animations
  13379. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  13380. * @param onAnimationLoop defines the callback to call when an animation loops
  13381. * @returns the list of created animatables
  13382. */
  13383. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable;
  13384. /**
  13385. * Begin a new animation on a given node and its hierarchy
  13386. * @param target defines the root node where the animation will take place
  13387. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  13388. * @param animations defines the list of animations to start
  13389. * @param from defines the initial value
  13390. * @param to defines the final value
  13391. * @param loop defines if you want animation to loop (off by default)
  13392. * @param speedRatio defines the speed ratio to apply to all animations
  13393. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  13394. * @param onAnimationLoop defines the callback to call when an animation loops
  13395. * @returns the list of animatables created for all nodes
  13396. */
  13397. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable[];
  13398. /**
  13399. * Gets the animatable associated with a specific target
  13400. * @param target defines the target of the animatable
  13401. * @returns the required animatable if found
  13402. */
  13403. getAnimatableByTarget(target: any): Nullable<Animatable>;
  13404. /**
  13405. * Gets all animatables associated with a given target
  13406. * @param target defines the target to look animatables for
  13407. * @returns an array of Animatables
  13408. */
  13409. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  13410. /**
  13411. * Stops and removes all animations that have been applied to the scene
  13412. */
  13413. stopAllAnimations(): void;
  13414. /**
  13415. * Gets the current delta time used by animation engine
  13416. */
  13417. deltaTime: number;
  13418. }
  13419. }
  13420. module "babylonjs/Bones/bone" {
  13421. interface Bone {
  13422. /**
  13423. * Copy an animation range from another bone
  13424. * @param source defines the source bone
  13425. * @param rangeName defines the range name to copy
  13426. * @param frameOffset defines the frame offset
  13427. * @param rescaleAsRequired defines if rescaling must be applied if required
  13428. * @param skelDimensionsRatio defines the scaling ratio
  13429. * @returns true if operation was successful
  13430. */
  13431. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  13432. }
  13433. }
  13434. }
  13435. declare module "babylonjs/Animations/animationPropertiesOverride" {
  13436. /**
  13437. * Class used to override all child animations of a given target
  13438. */
  13439. export class AnimationPropertiesOverride {
  13440. /**
  13441. * Gets or sets a value indicating if animation blending must be used
  13442. */
  13443. enableBlending: boolean;
  13444. /**
  13445. * Gets or sets the blending speed to use when enableBlending is true
  13446. */
  13447. blendingSpeed: number;
  13448. /**
  13449. * Gets or sets the default loop mode to use
  13450. */
  13451. loopMode: number;
  13452. }
  13453. }
  13454. declare module "babylonjs/Bones/skeleton" {
  13455. import { Bone } from "babylonjs/Bones/bone";
  13456. import { Observable } from "babylonjs/Misc/observable";
  13457. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13458. import { Scene } from "babylonjs/scene";
  13459. import { Nullable } from "babylonjs/types";
  13460. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13461. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  13462. import { Animatable } from "babylonjs/Animations/animatable";
  13463. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  13464. import { Animation } from "babylonjs/Animations/animation";
  13465. import { AnimationRange } from "babylonjs/Animations/animationRange";
  13466. import { IInspectable } from "babylonjs/Misc/iInspectable";
  13467. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  13468. /**
  13469. * Class used to handle skinning animations
  13470. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  13471. */
  13472. export class Skeleton implements IAnimatable {
  13473. /** defines the skeleton name */
  13474. name: string;
  13475. /** defines the skeleton Id */
  13476. id: string;
  13477. /**
  13478. * Defines the list of child bones
  13479. */
  13480. bones: Bone[];
  13481. /**
  13482. * Defines an estimate of the dimension of the skeleton at rest
  13483. */
  13484. dimensionsAtRest: Vector3;
  13485. /**
  13486. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  13487. */
  13488. needInitialSkinMatrix: boolean;
  13489. /**
  13490. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  13491. */
  13492. overrideMesh: Nullable<AbstractMesh>;
  13493. /**
  13494. * Gets the list of animations attached to this skeleton
  13495. */
  13496. animations: Array<Animation>;
  13497. private _scene;
  13498. private _isDirty;
  13499. private _transformMatrices;
  13500. private _transformMatrixTexture;
  13501. private _meshesWithPoseMatrix;
  13502. private _animatables;
  13503. private _identity;
  13504. private _synchronizedWithMesh;
  13505. private _ranges;
  13506. private _lastAbsoluteTransformsUpdateId;
  13507. private _canUseTextureForBones;
  13508. private _uniqueId;
  13509. /** @hidden */
  13510. _numBonesWithLinkedTransformNode: number;
  13511. /** @hidden */
  13512. _hasWaitingData: Nullable<boolean>;
  13513. /**
  13514. * Specifies if the skeleton should be serialized
  13515. */
  13516. doNotSerialize: boolean;
  13517. private _useTextureToStoreBoneMatrices;
  13518. /**
  13519. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  13520. * Please note that this option is not available if the hardware does not support it
  13521. */
  13522. useTextureToStoreBoneMatrices: boolean;
  13523. private _animationPropertiesOverride;
  13524. /**
  13525. * Gets or sets the animation properties override
  13526. */
  13527. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  13528. /**
  13529. * List of inspectable custom properties (used by the Inspector)
  13530. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  13531. */
  13532. inspectableCustomProperties: IInspectable[];
  13533. /**
  13534. * An observable triggered before computing the skeleton's matrices
  13535. */
  13536. onBeforeComputeObservable: Observable<Skeleton>;
  13537. /**
  13538. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  13539. */
  13540. readonly isUsingTextureForMatrices: boolean;
  13541. /**
  13542. * Gets the unique ID of this skeleton
  13543. */
  13544. readonly uniqueId: number;
  13545. /**
  13546. * Creates a new skeleton
  13547. * @param name defines the skeleton name
  13548. * @param id defines the skeleton Id
  13549. * @param scene defines the hosting scene
  13550. */
  13551. constructor(
  13552. /** defines the skeleton name */
  13553. name: string,
  13554. /** defines the skeleton Id */
  13555. id: string, scene: Scene);
  13556. /**
  13557. * Gets the current object class name.
  13558. * @return the class name
  13559. */
  13560. getClassName(): string;
  13561. /**
  13562. * Returns an array containing the root bones
  13563. * @returns an array containing the root bones
  13564. */
  13565. getChildren(): Array<Bone>;
  13566. /**
  13567. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  13568. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  13569. * @returns a Float32Array containing matrices data
  13570. */
  13571. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  13572. /**
  13573. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  13574. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  13575. * @returns a raw texture containing the data
  13576. */
  13577. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  13578. /**
  13579. * Gets the current hosting scene
  13580. * @returns a scene object
  13581. */
  13582. getScene(): Scene;
  13583. /**
  13584. * Gets a string representing the current skeleton data
  13585. * @param fullDetails defines a boolean indicating if we want a verbose version
  13586. * @returns a string representing the current skeleton data
  13587. */
  13588. toString(fullDetails?: boolean): string;
  13589. /**
  13590. * Get bone's index searching by name
  13591. * @param name defines bone's name to search for
  13592. * @return the indice of the bone. Returns -1 if not found
  13593. */
  13594. getBoneIndexByName(name: string): number;
  13595. /**
  13596. * Creater a new animation range
  13597. * @param name defines the name of the range
  13598. * @param from defines the start key
  13599. * @param to defines the end key
  13600. */
  13601. createAnimationRange(name: string, from: number, to: number): void;
  13602. /**
  13603. * Delete a specific animation range
  13604. * @param name defines the name of the range
  13605. * @param deleteFrames defines if frames must be removed as well
  13606. */
  13607. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  13608. /**
  13609. * Gets a specific animation range
  13610. * @param name defines the name of the range to look for
  13611. * @returns the requested animation range or null if not found
  13612. */
  13613. getAnimationRange(name: string): Nullable<AnimationRange>;
  13614. /**
  13615. * Gets the list of all animation ranges defined on this skeleton
  13616. * @returns an array
  13617. */
  13618. getAnimationRanges(): Nullable<AnimationRange>[];
  13619. /**
  13620. * Copy animation range from a source skeleton.
  13621. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  13622. * @param source defines the source skeleton
  13623. * @param name defines the name of the range to copy
  13624. * @param rescaleAsRequired defines if rescaling must be applied if required
  13625. * @returns true if operation was successful
  13626. */
  13627. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  13628. /**
  13629. * Forces the skeleton to go to rest pose
  13630. */
  13631. returnToRest(): void;
  13632. private _getHighestAnimationFrame;
  13633. /**
  13634. * Begin a specific animation range
  13635. * @param name defines the name of the range to start
  13636. * @param loop defines if looping must be turned on (false by default)
  13637. * @param speedRatio defines the speed ratio to apply (1 by default)
  13638. * @param onAnimationEnd defines a callback which will be called when animation will end
  13639. * @returns a new animatable
  13640. */
  13641. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  13642. /** @hidden */
  13643. _markAsDirty(): void;
  13644. /** @hidden */
  13645. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  13646. /** @hidden */
  13647. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  13648. private _computeTransformMatrices;
  13649. /**
  13650. * Build all resources required to render a skeleton
  13651. */
  13652. prepare(): void;
  13653. /**
  13654. * Gets the list of animatables currently running for this skeleton
  13655. * @returns an array of animatables
  13656. */
  13657. getAnimatables(): IAnimatable[];
  13658. /**
  13659. * Clone the current skeleton
  13660. * @param name defines the name of the new skeleton
  13661. * @param id defines the id of the new skeleton
  13662. * @returns the new skeleton
  13663. */
  13664. clone(name: string, id?: string): Skeleton;
  13665. /**
  13666. * Enable animation blending for this skeleton
  13667. * @param blendingSpeed defines the blending speed to apply
  13668. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13669. */
  13670. enableBlending(blendingSpeed?: number): void;
  13671. /**
  13672. * Releases all resources associated with the current skeleton
  13673. */
  13674. dispose(): void;
  13675. /**
  13676. * Serialize the skeleton in a JSON object
  13677. * @returns a JSON object
  13678. */
  13679. serialize(): any;
  13680. /**
  13681. * Creates a new skeleton from serialized data
  13682. * @param parsedSkeleton defines the serialized data
  13683. * @param scene defines the hosting scene
  13684. * @returns a new skeleton
  13685. */
  13686. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  13687. /**
  13688. * Compute all node absolute transforms
  13689. * @param forceUpdate defines if computation must be done even if cache is up to date
  13690. */
  13691. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  13692. /**
  13693. * Gets the root pose matrix
  13694. * @returns a matrix
  13695. */
  13696. getPoseMatrix(): Nullable<Matrix>;
  13697. /**
  13698. * Sorts bones per internal index
  13699. */
  13700. sortBones(): void;
  13701. private _sortBones;
  13702. }
  13703. }
  13704. declare module "babylonjs/Bones/bone" {
  13705. import { Skeleton } from "babylonjs/Bones/skeleton";
  13706. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  13707. import { Nullable } from "babylonjs/types";
  13708. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13709. import { TransformNode } from "babylonjs/Meshes/transformNode";
  13710. import { Node } from "babylonjs/node";
  13711. import { Space } from "babylonjs/Maths/math.axis";
  13712. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  13713. /**
  13714. * Class used to store bone information
  13715. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  13716. */
  13717. export class Bone extends Node {
  13718. /**
  13719. * defines the bone name
  13720. */
  13721. name: string;
  13722. private static _tmpVecs;
  13723. private static _tmpQuat;
  13724. private static _tmpMats;
  13725. /**
  13726. * Gets the list of child bones
  13727. */
  13728. children: Bone[];
  13729. /** Gets the animations associated with this bone */
  13730. animations: import("babylonjs/Animations/animation").Animation[];
  13731. /**
  13732. * Gets or sets bone length
  13733. */
  13734. length: number;
  13735. /**
  13736. * @hidden Internal only
  13737. * Set this value to map this bone to a different index in the transform matrices
  13738. * Set this value to -1 to exclude the bone from the transform matrices
  13739. */
  13740. _index: Nullable<number>;
  13741. private _skeleton;
  13742. private _localMatrix;
  13743. private _restPose;
  13744. private _baseMatrix;
  13745. private _absoluteTransform;
  13746. private _invertedAbsoluteTransform;
  13747. private _parent;
  13748. private _scalingDeterminant;
  13749. private _worldTransform;
  13750. private _localScaling;
  13751. private _localRotation;
  13752. private _localPosition;
  13753. private _needToDecompose;
  13754. private _needToCompose;
  13755. /** @hidden */
  13756. _linkedTransformNode: Nullable<TransformNode>;
  13757. /** @hidden */
  13758. _waitingTransformNodeId: Nullable<string>;
  13759. /** @hidden */
  13760. /** @hidden */
  13761. _matrix: Matrix;
  13762. /**
  13763. * Create a new bone
  13764. * @param name defines the bone name
  13765. * @param skeleton defines the parent skeleton
  13766. * @param parentBone defines the parent (can be null if the bone is the root)
  13767. * @param localMatrix defines the local matrix
  13768. * @param restPose defines the rest pose matrix
  13769. * @param baseMatrix defines the base matrix
  13770. * @param index defines index of the bone in the hiearchy
  13771. */
  13772. constructor(
  13773. /**
  13774. * defines the bone name
  13775. */
  13776. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  13777. /**
  13778. * Gets the current object class name.
  13779. * @return the class name
  13780. */
  13781. getClassName(): string;
  13782. /**
  13783. * Gets the parent skeleton
  13784. * @returns a skeleton
  13785. */
  13786. getSkeleton(): Skeleton;
  13787. /**
  13788. * Gets parent bone
  13789. * @returns a bone or null if the bone is the root of the bone hierarchy
  13790. */
  13791. getParent(): Nullable<Bone>;
  13792. /**
  13793. * Returns an array containing the root bones
  13794. * @returns an array containing the root bones
  13795. */
  13796. getChildren(): Array<Bone>;
  13797. /**
  13798. * Gets the node index in matrix array generated for rendering
  13799. * @returns the node index
  13800. */
  13801. getIndex(): number;
  13802. /**
  13803. * Sets the parent bone
  13804. * @param parent defines the parent (can be null if the bone is the root)
  13805. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  13806. */
  13807. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  13808. /**
  13809. * Gets the local matrix
  13810. * @returns a matrix
  13811. */
  13812. getLocalMatrix(): Matrix;
  13813. /**
  13814. * Gets the base matrix (initial matrix which remains unchanged)
  13815. * @returns a matrix
  13816. */
  13817. getBaseMatrix(): Matrix;
  13818. /**
  13819. * Gets the rest pose matrix
  13820. * @returns a matrix
  13821. */
  13822. getRestPose(): Matrix;
  13823. /**
  13824. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  13825. */
  13826. getWorldMatrix(): Matrix;
  13827. /**
  13828. * Sets the local matrix to rest pose matrix
  13829. */
  13830. returnToRest(): void;
  13831. /**
  13832. * Gets the inverse of the absolute transform matrix.
  13833. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  13834. * @returns a matrix
  13835. */
  13836. getInvertedAbsoluteTransform(): Matrix;
  13837. /**
  13838. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  13839. * @returns a matrix
  13840. */
  13841. getAbsoluteTransform(): Matrix;
  13842. /**
  13843. * Links with the given transform node.
  13844. * The local matrix of this bone is copied from the transform node every frame.
  13845. * @param transformNode defines the transform node to link to
  13846. */
  13847. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  13848. /**
  13849. * Gets the node used to drive the bone's transformation
  13850. * @returns a transform node or null
  13851. */
  13852. getTransformNode(): Nullable<TransformNode>;
  13853. /** Gets or sets current position (in local space) */
  13854. position: Vector3;
  13855. /** Gets or sets current rotation (in local space) */
  13856. rotation: Vector3;
  13857. /** Gets or sets current rotation quaternion (in local space) */
  13858. rotationQuaternion: Quaternion;
  13859. /** Gets or sets current scaling (in local space) */
  13860. scaling: Vector3;
  13861. /**
  13862. * Gets the animation properties override
  13863. */
  13864. readonly animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  13865. private _decompose;
  13866. private _compose;
  13867. /**
  13868. * Update the base and local matrices
  13869. * @param matrix defines the new base or local matrix
  13870. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  13871. * @param updateLocalMatrix defines if the local matrix should be updated
  13872. */
  13873. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  13874. /** @hidden */
  13875. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  13876. /**
  13877. * Flag the bone as dirty (Forcing it to update everything)
  13878. */
  13879. markAsDirty(): void;
  13880. /** @hidden */
  13881. _markAsDirtyAndCompose(): void;
  13882. private _markAsDirtyAndDecompose;
  13883. /**
  13884. * Translate the bone in local or world space
  13885. * @param vec The amount to translate the bone
  13886. * @param space The space that the translation is in
  13887. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13888. */
  13889. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13890. /**
  13891. * Set the postion of the bone in local or world space
  13892. * @param position The position to set the bone
  13893. * @param space The space that the position is in
  13894. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13895. */
  13896. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13897. /**
  13898. * Set the absolute position of the bone (world space)
  13899. * @param position The position to set the bone
  13900. * @param mesh The mesh that this bone is attached to
  13901. */
  13902. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  13903. /**
  13904. * Scale the bone on the x, y and z axes (in local space)
  13905. * @param x The amount to scale the bone on the x axis
  13906. * @param y The amount to scale the bone on the y axis
  13907. * @param z The amount to scale the bone on the z axis
  13908. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  13909. */
  13910. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  13911. /**
  13912. * Set the bone scaling in local space
  13913. * @param scale defines the scaling vector
  13914. */
  13915. setScale(scale: Vector3): void;
  13916. /**
  13917. * Gets the current scaling in local space
  13918. * @returns the current scaling vector
  13919. */
  13920. getScale(): Vector3;
  13921. /**
  13922. * Gets the current scaling in local space and stores it in a target vector
  13923. * @param result defines the target vector
  13924. */
  13925. getScaleToRef(result: Vector3): void;
  13926. /**
  13927. * Set the yaw, pitch, and roll of the bone in local or world space
  13928. * @param yaw The rotation of the bone on the y axis
  13929. * @param pitch The rotation of the bone on the x axis
  13930. * @param roll The rotation of the bone on the z axis
  13931. * @param space The space that the axes of rotation are in
  13932. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13933. */
  13934. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  13935. /**
  13936. * Add a rotation to the bone on an axis in local or world space
  13937. * @param axis The axis to rotate the bone on
  13938. * @param amount The amount to rotate the bone
  13939. * @param space The space that the axis is in
  13940. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13941. */
  13942. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  13943. /**
  13944. * Set the rotation of the bone to a particular axis angle in local or world space
  13945. * @param axis The axis to rotate the bone on
  13946. * @param angle The angle that the bone should be rotated to
  13947. * @param space The space that the axis is in
  13948. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13949. */
  13950. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  13951. /**
  13952. * Set the euler rotation of the bone in local of world space
  13953. * @param rotation The euler rotation that the bone should be set to
  13954. * @param space The space that the rotation is in
  13955. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13956. */
  13957. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13958. /**
  13959. * Set the quaternion rotation of the bone in local of world space
  13960. * @param quat The quaternion rotation that the bone should be set to
  13961. * @param space The space that the rotation is in
  13962. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13963. */
  13964. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  13965. /**
  13966. * Set the rotation matrix of the bone in local of world space
  13967. * @param rotMat The rotation matrix that the bone should be set to
  13968. * @param space The space that the rotation is in
  13969. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13970. */
  13971. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  13972. private _rotateWithMatrix;
  13973. private _getNegativeRotationToRef;
  13974. /**
  13975. * Get the position of the bone in local or world space
  13976. * @param space The space that the returned position is in
  13977. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13978. * @returns The position of the bone
  13979. */
  13980. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  13981. /**
  13982. * Copy the position of the bone to a vector3 in local or world space
  13983. * @param space The space that the returned position is in
  13984. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13985. * @param result The vector3 to copy the position to
  13986. */
  13987. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  13988. /**
  13989. * Get the absolute position of the bone (world space)
  13990. * @param mesh The mesh that this bone is attached to
  13991. * @returns The absolute position of the bone
  13992. */
  13993. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  13994. /**
  13995. * Copy the absolute position of the bone (world space) to the result param
  13996. * @param mesh The mesh that this bone is attached to
  13997. * @param result The vector3 to copy the absolute position to
  13998. */
  13999. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  14000. /**
  14001. * Compute the absolute transforms of this bone and its children
  14002. */
  14003. computeAbsoluteTransforms(): void;
  14004. /**
  14005. * Get the world direction from an axis that is in the local space of the bone
  14006. * @param localAxis The local direction that is used to compute the world direction
  14007. * @param mesh The mesh that this bone is attached to
  14008. * @returns The world direction
  14009. */
  14010. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14011. /**
  14012. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  14013. * @param localAxis The local direction that is used to compute the world direction
  14014. * @param mesh The mesh that this bone is attached to
  14015. * @param result The vector3 that the world direction will be copied to
  14016. */
  14017. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14018. /**
  14019. * Get the euler rotation of the bone in local or world space
  14020. * @param space The space that the rotation should be in
  14021. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14022. * @returns The euler rotation
  14023. */
  14024. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  14025. /**
  14026. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  14027. * @param space The space that the rotation should be in
  14028. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14029. * @param result The vector3 that the rotation should be copied to
  14030. */
  14031. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14032. /**
  14033. * Get the quaternion rotation of the bone in either local or world space
  14034. * @param space The space that the rotation should be in
  14035. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14036. * @returns The quaternion rotation
  14037. */
  14038. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  14039. /**
  14040. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  14041. * @param space The space that the rotation should be in
  14042. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14043. * @param result The quaternion that the rotation should be copied to
  14044. */
  14045. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  14046. /**
  14047. * Get the rotation matrix of the bone in local or world space
  14048. * @param space The space that the rotation should be in
  14049. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14050. * @returns The rotation matrix
  14051. */
  14052. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  14053. /**
  14054. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  14055. * @param space The space that the rotation should be in
  14056. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14057. * @param result The quaternion that the rotation should be copied to
  14058. */
  14059. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  14060. /**
  14061. * Get the world position of a point that is in the local space of the bone
  14062. * @param position The local position
  14063. * @param mesh The mesh that this bone is attached to
  14064. * @returns The world position
  14065. */
  14066. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14067. /**
  14068. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  14069. * @param position The local position
  14070. * @param mesh The mesh that this bone is attached to
  14071. * @param result The vector3 that the world position should be copied to
  14072. */
  14073. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14074. /**
  14075. * Get the local position of a point that is in world space
  14076. * @param position The world position
  14077. * @param mesh The mesh that this bone is attached to
  14078. * @returns The local position
  14079. */
  14080. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14081. /**
  14082. * Get the local position of a point that is in world space and copy it to the result param
  14083. * @param position The world position
  14084. * @param mesh The mesh that this bone is attached to
  14085. * @param result The vector3 that the local position should be copied to
  14086. */
  14087. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14088. }
  14089. }
  14090. declare module "babylonjs/Meshes/transformNode" {
  14091. import { DeepImmutable } from "babylonjs/types";
  14092. import { Observable } from "babylonjs/Misc/observable";
  14093. import { Nullable } from "babylonjs/types";
  14094. import { Camera } from "babylonjs/Cameras/camera";
  14095. import { Scene } from "babylonjs/scene";
  14096. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14097. import { Node } from "babylonjs/node";
  14098. import { Bone } from "babylonjs/Bones/bone";
  14099. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14100. import { Space } from "babylonjs/Maths/math.axis";
  14101. /**
  14102. * A TransformNode is an object that is not rendered but can be used as a center of transformation. This can decrease memory usage and increase rendering speed compared to using an empty mesh as a parent and is less complicated than using a pivot matrix.
  14103. * @see https://doc.babylonjs.com/how_to/transformnode
  14104. */
  14105. export class TransformNode extends Node {
  14106. /**
  14107. * Object will not rotate to face the camera
  14108. */
  14109. static BILLBOARDMODE_NONE: number;
  14110. /**
  14111. * Object will rotate to face the camera but only on the x axis
  14112. */
  14113. static BILLBOARDMODE_X: number;
  14114. /**
  14115. * Object will rotate to face the camera but only on the y axis
  14116. */
  14117. static BILLBOARDMODE_Y: number;
  14118. /**
  14119. * Object will rotate to face the camera but only on the z axis
  14120. */
  14121. static BILLBOARDMODE_Z: number;
  14122. /**
  14123. * Object will rotate to face the camera
  14124. */
  14125. static BILLBOARDMODE_ALL: number;
  14126. /**
  14127. * Object will rotate to face the camera's position instead of orientation
  14128. */
  14129. static BILLBOARDMODE_USE_POSITION: number;
  14130. private _forward;
  14131. private _forwardInverted;
  14132. private _up;
  14133. private _right;
  14134. private _rightInverted;
  14135. private _position;
  14136. private _rotation;
  14137. private _rotationQuaternion;
  14138. protected _scaling: Vector3;
  14139. protected _isDirty: boolean;
  14140. private _transformToBoneReferal;
  14141. private _isAbsoluteSynced;
  14142. private _billboardMode;
  14143. /**
  14144. * Gets or sets the billboard mode. Default is 0.
  14145. *
  14146. * | Value | Type | Description |
  14147. * | --- | --- | --- |
  14148. * | 0 | BILLBOARDMODE_NONE | |
  14149. * | 1 | BILLBOARDMODE_X | |
  14150. * | 2 | BILLBOARDMODE_Y | |
  14151. * | 4 | BILLBOARDMODE_Z | |
  14152. * | 7 | BILLBOARDMODE_ALL | |
  14153. *
  14154. */
  14155. billboardMode: number;
  14156. private _preserveParentRotationForBillboard;
  14157. /**
  14158. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  14159. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  14160. */
  14161. preserveParentRotationForBillboard: boolean;
  14162. /**
  14163. * Multiplication factor on scale x/y/z when computing the world matrix. Eg. for a 1x1x1 cube setting this to 2 will make it a 2x2x2 cube
  14164. */
  14165. scalingDeterminant: number;
  14166. private _infiniteDistance;
  14167. /**
  14168. * Gets or sets the distance of the object to max, often used by skybox
  14169. */
  14170. infiniteDistance: boolean;
  14171. /**
  14172. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  14173. * By default the system will update normals to compensate
  14174. */
  14175. ignoreNonUniformScaling: boolean;
  14176. /**
  14177. * Gets or sets a boolean indicating that even if rotationQuaternion is defined, you can keep updating rotation property and Babylon.js will just mix both
  14178. */
  14179. reIntegrateRotationIntoRotationQuaternion: boolean;
  14180. /** @hidden */
  14181. _poseMatrix: Nullable<Matrix>;
  14182. /** @hidden */
  14183. _localMatrix: Matrix;
  14184. private _usePivotMatrix;
  14185. private _absolutePosition;
  14186. private _absoluteScaling;
  14187. private _absoluteRotationQuaternion;
  14188. private _pivotMatrix;
  14189. private _pivotMatrixInverse;
  14190. protected _postMultiplyPivotMatrix: boolean;
  14191. protected _isWorldMatrixFrozen: boolean;
  14192. /** @hidden */
  14193. _indexInSceneTransformNodesArray: number;
  14194. /**
  14195. * An event triggered after the world matrix is updated
  14196. */
  14197. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  14198. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  14199. /**
  14200. * Gets a string identifying the name of the class
  14201. * @returns "TransformNode" string
  14202. */
  14203. getClassName(): string;
  14204. /**
  14205. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  14206. */
  14207. position: Vector3;
  14208. /**
  14209. * Gets or sets the rotation property : a Vector3 defining the rotation value in radians around each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  14210. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  14211. */
  14212. rotation: Vector3;
  14213. /**
  14214. * Gets or sets the scaling property : a Vector3 defining the node scaling along each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  14215. */
  14216. scaling: Vector3;
  14217. /**
  14218. * Gets or sets the rotation Quaternion property : this a Quaternion object defining the node rotation by using a unit quaternion (undefined by default, but can be null).
  14219. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  14220. */
  14221. rotationQuaternion: Nullable<Quaternion>;
  14222. /**
  14223. * The forward direction of that transform in world space.
  14224. */
  14225. readonly forward: Vector3;
  14226. /**
  14227. * The up direction of that transform in world space.
  14228. */
  14229. readonly up: Vector3;
  14230. /**
  14231. * The right direction of that transform in world space.
  14232. */
  14233. readonly right: Vector3;
  14234. /**
  14235. * Copies the parameter passed Matrix into the mesh Pose matrix.
  14236. * @param matrix the matrix to copy the pose from
  14237. * @returns this TransformNode.
  14238. */
  14239. updatePoseMatrix(matrix: Matrix): TransformNode;
  14240. /**
  14241. * Returns the mesh Pose matrix.
  14242. * @returns the pose matrix
  14243. */
  14244. getPoseMatrix(): Matrix;
  14245. /** @hidden */
  14246. _isSynchronized(): boolean;
  14247. /** @hidden */
  14248. _initCache(): void;
  14249. /**
  14250. * Flag the transform node as dirty (Forcing it to update everything)
  14251. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  14252. * @returns this transform node
  14253. */
  14254. markAsDirty(property: string): TransformNode;
  14255. /**
  14256. * Returns the current mesh absolute position.
  14257. * Returns a Vector3.
  14258. */
  14259. readonly absolutePosition: Vector3;
  14260. /**
  14261. * Returns the current mesh absolute scaling.
  14262. * Returns a Vector3.
  14263. */
  14264. readonly absoluteScaling: Vector3;
  14265. /**
  14266. * Returns the current mesh absolute rotation.
  14267. * Returns a Quaternion.
  14268. */
  14269. readonly absoluteRotationQuaternion: Quaternion;
  14270. /**
  14271. * Sets a new matrix to apply before all other transformation
  14272. * @param matrix defines the transform matrix
  14273. * @returns the current TransformNode
  14274. */
  14275. setPreTransformMatrix(matrix: Matrix): TransformNode;
  14276. /**
  14277. * Sets a new pivot matrix to the current node
  14278. * @param matrix defines the new pivot matrix to use
  14279. * @param postMultiplyPivotMatrix defines if the pivot matrix must be cancelled in the world matrix. When this parameter is set to true (default), the inverse of the pivot matrix is also applied at the end to cancel the transformation effect
  14280. * @returns the current TransformNode
  14281. */
  14282. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  14283. /**
  14284. * Returns the mesh pivot matrix.
  14285. * Default : Identity.
  14286. * @returns the matrix
  14287. */
  14288. getPivotMatrix(): Matrix;
  14289. /**
  14290. * Instantiate (when possible) or clone that node with its hierarchy
  14291. * @param newParent defines the new parent to use for the instance (or clone)
  14292. * @param options defines options to configure how copy is done
  14293. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  14294. * @returns an instance (or a clone) of the current node with its hiearchy
  14295. */
  14296. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  14297. doNotInstantiate: boolean;
  14298. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  14299. /**
  14300. * Prevents the World matrix to be computed any longer
  14301. * @param newWorldMatrix defines an optional matrix to use as world matrix
  14302. * @returns the TransformNode.
  14303. */
  14304. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  14305. /**
  14306. * Allows back the World matrix computation.
  14307. * @returns the TransformNode.
  14308. */
  14309. unfreezeWorldMatrix(): this;
  14310. /**
  14311. * True if the World matrix has been frozen.
  14312. */
  14313. readonly isWorldMatrixFrozen: boolean;
  14314. /**
  14315. * Retuns the mesh absolute position in the World.
  14316. * @returns a Vector3.
  14317. */
  14318. getAbsolutePosition(): Vector3;
  14319. /**
  14320. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  14321. * @param absolutePosition the absolute position to set
  14322. * @returns the TransformNode.
  14323. */
  14324. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  14325. /**
  14326. * Sets the mesh position in its local space.
  14327. * @param vector3 the position to set in localspace
  14328. * @returns the TransformNode.
  14329. */
  14330. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  14331. /**
  14332. * Returns the mesh position in the local space from the current World matrix values.
  14333. * @returns a new Vector3.
  14334. */
  14335. getPositionExpressedInLocalSpace(): Vector3;
  14336. /**
  14337. * Translates the mesh along the passed Vector3 in its local space.
  14338. * @param vector3 the distance to translate in localspace
  14339. * @returns the TransformNode.
  14340. */
  14341. locallyTranslate(vector3: Vector3): TransformNode;
  14342. private static _lookAtVectorCache;
  14343. /**
  14344. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  14345. * @param targetPoint the position (must be in same space as current mesh) to look at
  14346. * @param yawCor optional yaw (y-axis) correction in radians
  14347. * @param pitchCor optional pitch (x-axis) correction in radians
  14348. * @param rollCor optional roll (z-axis) correction in radians
  14349. * @param space the choosen space of the target
  14350. * @returns the TransformNode.
  14351. */
  14352. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  14353. /**
  14354. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  14355. * This Vector3 is expressed in the World space.
  14356. * @param localAxis axis to rotate
  14357. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  14358. */
  14359. getDirection(localAxis: Vector3): Vector3;
  14360. /**
  14361. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  14362. * localAxis is expressed in the mesh local space.
  14363. * result is computed in the Wordl space from the mesh World matrix.
  14364. * @param localAxis axis to rotate
  14365. * @param result the resulting transformnode
  14366. * @returns this TransformNode.
  14367. */
  14368. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  14369. /**
  14370. * Sets this transform node rotation to the given local axis.
  14371. * @param localAxis the axis in local space
  14372. * @param yawCor optional yaw (y-axis) correction in radians
  14373. * @param pitchCor optional pitch (x-axis) correction in radians
  14374. * @param rollCor optional roll (z-axis) correction in radians
  14375. * @returns this TransformNode
  14376. */
  14377. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  14378. /**
  14379. * Sets a new pivot point to the current node
  14380. * @param point defines the new pivot point to use
  14381. * @param space defines if the point is in world or local space (local by default)
  14382. * @returns the current TransformNode
  14383. */
  14384. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  14385. /**
  14386. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  14387. * @returns the pivot point
  14388. */
  14389. getPivotPoint(): Vector3;
  14390. /**
  14391. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  14392. * @param result the vector3 to store the result
  14393. * @returns this TransformNode.
  14394. */
  14395. getPivotPointToRef(result: Vector3): TransformNode;
  14396. /**
  14397. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  14398. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  14399. */
  14400. getAbsolutePivotPoint(): Vector3;
  14401. /**
  14402. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  14403. * @param result vector3 to store the result
  14404. * @returns this TransformNode.
  14405. */
  14406. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  14407. /**
  14408. * Defines the passed node as the parent of the current node.
  14409. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  14410. * @see https://doc.babylonjs.com/how_to/parenting
  14411. * @param node the node ot set as the parent
  14412. * @returns this TransformNode.
  14413. */
  14414. setParent(node: Nullable<Node>): TransformNode;
  14415. private _nonUniformScaling;
  14416. /**
  14417. * True if the scaling property of this object is non uniform eg. (1,2,1)
  14418. */
  14419. readonly nonUniformScaling: boolean;
  14420. /** @hidden */
  14421. _updateNonUniformScalingState(value: boolean): boolean;
  14422. /**
  14423. * Attach the current TransformNode to another TransformNode associated with a bone
  14424. * @param bone Bone affecting the TransformNode
  14425. * @param affectedTransformNode TransformNode associated with the bone
  14426. * @returns this object
  14427. */
  14428. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  14429. /**
  14430. * Detach the transform node if its associated with a bone
  14431. * @returns this object
  14432. */
  14433. detachFromBone(): TransformNode;
  14434. private static _rotationAxisCache;
  14435. /**
  14436. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  14437. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  14438. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  14439. * The passed axis is also normalized.
  14440. * @param axis the axis to rotate around
  14441. * @param amount the amount to rotate in radians
  14442. * @param space Space to rotate in (Default: local)
  14443. * @returns the TransformNode.
  14444. */
  14445. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  14446. /**
  14447. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  14448. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  14449. * The passed axis is also normalized. .
  14450. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  14451. * @param point the point to rotate around
  14452. * @param axis the axis to rotate around
  14453. * @param amount the amount to rotate in radians
  14454. * @returns the TransformNode
  14455. */
  14456. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  14457. /**
  14458. * Translates the mesh along the axis vector for the passed distance in the given space.
  14459. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  14460. * @param axis the axis to translate in
  14461. * @param distance the distance to translate
  14462. * @param space Space to rotate in (Default: local)
  14463. * @returns the TransformNode.
  14464. */
  14465. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  14466. /**
  14467. * Adds a rotation step to the mesh current rotation.
  14468. * x, y, z are Euler angles expressed in radians.
  14469. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  14470. * This means this rotation is made in the mesh local space only.
  14471. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  14472. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  14473. * ```javascript
  14474. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  14475. * ```
  14476. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  14477. * Under the hood, only quaternions are used. So it's a little faster is you use .rotationQuaternion because it doesn't need to translate them back to Euler angles.
  14478. * @param x Rotation to add
  14479. * @param y Rotation to add
  14480. * @param z Rotation to add
  14481. * @returns the TransformNode.
  14482. */
  14483. addRotation(x: number, y: number, z: number): TransformNode;
  14484. /**
  14485. * @hidden
  14486. */
  14487. protected _getEffectiveParent(): Nullable<Node>;
  14488. /**
  14489. * Computes the world matrix of the node
  14490. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  14491. * @returns the world matrix
  14492. */
  14493. computeWorldMatrix(force?: boolean): Matrix;
  14494. protected _afterComputeWorldMatrix(): void;
  14495. /**
  14496. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  14497. * @param func callback function to add
  14498. *
  14499. * @returns the TransformNode.
  14500. */
  14501. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  14502. /**
  14503. * Removes a registered callback function.
  14504. * @param func callback function to remove
  14505. * @returns the TransformNode.
  14506. */
  14507. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  14508. /**
  14509. * Gets the position of the current mesh in camera space
  14510. * @param camera defines the camera to use
  14511. * @returns a position
  14512. */
  14513. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  14514. /**
  14515. * Returns the distance from the mesh to the active camera
  14516. * @param camera defines the camera to use
  14517. * @returns the distance
  14518. */
  14519. getDistanceToCamera(camera?: Nullable<Camera>): number;
  14520. /**
  14521. * Clone the current transform node
  14522. * @param name Name of the new clone
  14523. * @param newParent New parent for the clone
  14524. * @param doNotCloneChildren Do not clone children hierarchy
  14525. * @returns the new transform node
  14526. */
  14527. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  14528. /**
  14529. * Serializes the objects information.
  14530. * @param currentSerializationObject defines the object to serialize in
  14531. * @returns the serialized object
  14532. */
  14533. serialize(currentSerializationObject?: any): any;
  14534. /**
  14535. * Returns a new TransformNode object parsed from the source provided.
  14536. * @param parsedTransformNode is the source.
  14537. * @param scene the scne the object belongs to
  14538. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  14539. * @returns a new TransformNode object parsed from the source provided.
  14540. */
  14541. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  14542. /**
  14543. * Get all child-transformNodes of this node
  14544. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  14545. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  14546. * @returns an array of TransformNode
  14547. */
  14548. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  14549. /**
  14550. * Releases resources associated with this transform node.
  14551. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  14552. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  14553. */
  14554. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  14555. /**
  14556. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  14557. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  14558. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  14559. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  14560. * @returns the current mesh
  14561. */
  14562. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  14563. private _syncAbsoluteScalingAndRotation;
  14564. }
  14565. }
  14566. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  14567. import { Observable } from "babylonjs/Misc/observable";
  14568. import { Nullable } from "babylonjs/types";
  14569. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14570. import { TransformNode } from "babylonjs/Meshes/transformNode";
  14571. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14572. import { Ray } from "babylonjs/Culling/ray";
  14573. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  14574. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  14575. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  14576. /**
  14577. * Defines the types of pose enabled controllers that are supported
  14578. */
  14579. export enum PoseEnabledControllerType {
  14580. /**
  14581. * HTC Vive
  14582. */
  14583. VIVE = 0,
  14584. /**
  14585. * Oculus Rift
  14586. */
  14587. OCULUS = 1,
  14588. /**
  14589. * Windows mixed reality
  14590. */
  14591. WINDOWS = 2,
  14592. /**
  14593. * Samsung gear VR
  14594. */
  14595. GEAR_VR = 3,
  14596. /**
  14597. * Google Daydream
  14598. */
  14599. DAYDREAM = 4,
  14600. /**
  14601. * Generic
  14602. */
  14603. GENERIC = 5
  14604. }
  14605. /**
  14606. * Defines the MutableGamepadButton interface for the state of a gamepad button
  14607. */
  14608. export interface MutableGamepadButton {
  14609. /**
  14610. * Value of the button/trigger
  14611. */
  14612. value: number;
  14613. /**
  14614. * If the button/trigger is currently touched
  14615. */
  14616. touched: boolean;
  14617. /**
  14618. * If the button/trigger is currently pressed
  14619. */
  14620. pressed: boolean;
  14621. }
  14622. /**
  14623. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  14624. * @hidden
  14625. */
  14626. export interface ExtendedGamepadButton extends GamepadButton {
  14627. /**
  14628. * If the button/trigger is currently pressed
  14629. */
  14630. readonly pressed: boolean;
  14631. /**
  14632. * If the button/trigger is currently touched
  14633. */
  14634. readonly touched: boolean;
  14635. /**
  14636. * Value of the button/trigger
  14637. */
  14638. readonly value: number;
  14639. }
  14640. /** @hidden */
  14641. export interface _GamePadFactory {
  14642. /**
  14643. * Returns wether or not the current gamepad can be created for this type of controller.
  14644. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  14645. * @returns true if it can be created, otherwise false
  14646. */
  14647. canCreate(gamepadInfo: any): boolean;
  14648. /**
  14649. * Creates a new instance of the Gamepad.
  14650. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  14651. * @returns the new gamepad instance
  14652. */
  14653. create(gamepadInfo: any): Gamepad;
  14654. }
  14655. /**
  14656. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  14657. */
  14658. export class PoseEnabledControllerHelper {
  14659. /** @hidden */
  14660. static _ControllerFactories: _GamePadFactory[];
  14661. /** @hidden */
  14662. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  14663. /**
  14664. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  14665. * @param vrGamepad the gamepad to initialized
  14666. * @returns a vr controller of the type the gamepad identified as
  14667. */
  14668. static InitiateController(vrGamepad: any): Gamepad;
  14669. }
  14670. /**
  14671. * Defines the PoseEnabledController object that contains state of a vr capable controller
  14672. */
  14673. export class PoseEnabledController extends Gamepad implements PoseControlled {
  14674. /**
  14675. * If the controller is used in a webXR session
  14676. */
  14677. isXR: boolean;
  14678. private _deviceRoomPosition;
  14679. private _deviceRoomRotationQuaternion;
  14680. /**
  14681. * The device position in babylon space
  14682. */
  14683. devicePosition: Vector3;
  14684. /**
  14685. * The device rotation in babylon space
  14686. */
  14687. deviceRotationQuaternion: Quaternion;
  14688. /**
  14689. * The scale factor of the device in babylon space
  14690. */
  14691. deviceScaleFactor: number;
  14692. /**
  14693. * (Likely devicePosition should be used instead) The device position in its room space
  14694. */
  14695. position: Vector3;
  14696. /**
  14697. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  14698. */
  14699. rotationQuaternion: Quaternion;
  14700. /**
  14701. * The type of controller (Eg. Windows mixed reality)
  14702. */
  14703. controllerType: PoseEnabledControllerType;
  14704. protected _calculatedPosition: Vector3;
  14705. private _calculatedRotation;
  14706. /**
  14707. * The raw pose from the device
  14708. */
  14709. rawPose: DevicePose;
  14710. private _trackPosition;
  14711. private _maxRotationDistFromHeadset;
  14712. private _draggedRoomRotation;
  14713. /**
  14714. * @hidden
  14715. */
  14716. _disableTrackPosition(fixedPosition: Vector3): void;
  14717. /**
  14718. * Internal, the mesh attached to the controller
  14719. * @hidden
  14720. */
  14721. _mesh: Nullable<AbstractMesh>;
  14722. private _poseControlledCamera;
  14723. private _leftHandSystemQuaternion;
  14724. /**
  14725. * Internal, matrix used to convert room space to babylon space
  14726. * @hidden
  14727. */
  14728. _deviceToWorld: Matrix;
  14729. /**
  14730. * Node to be used when casting a ray from the controller
  14731. * @hidden
  14732. */
  14733. _pointingPoseNode: Nullable<TransformNode>;
  14734. /**
  14735. * Name of the child mesh that can be used to cast a ray from the controller
  14736. */
  14737. static readonly POINTING_POSE: string;
  14738. /**
  14739. * Creates a new PoseEnabledController from a gamepad
  14740. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  14741. */
  14742. constructor(browserGamepad: any);
  14743. private _workingMatrix;
  14744. /**
  14745. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  14746. */
  14747. update(): void;
  14748. /**
  14749. * Updates only the pose device and mesh without doing any button event checking
  14750. */
  14751. protected _updatePoseAndMesh(): void;
  14752. /**
  14753. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  14754. * @param poseData raw pose fromthe device
  14755. */
  14756. updateFromDevice(poseData: DevicePose): void;
  14757. /**
  14758. * @hidden
  14759. */
  14760. _meshAttachedObservable: Observable<AbstractMesh>;
  14761. /**
  14762. * Attaches a mesh to the controller
  14763. * @param mesh the mesh to be attached
  14764. */
  14765. attachToMesh(mesh: AbstractMesh): void;
  14766. /**
  14767. * Attaches the controllers mesh to a camera
  14768. * @param camera the camera the mesh should be attached to
  14769. */
  14770. attachToPoseControlledCamera(camera: TargetCamera): void;
  14771. /**
  14772. * Disposes of the controller
  14773. */
  14774. dispose(): void;
  14775. /**
  14776. * The mesh that is attached to the controller
  14777. */
  14778. readonly mesh: Nullable<AbstractMesh>;
  14779. /**
  14780. * Gets the ray of the controller in the direction the controller is pointing
  14781. * @param length the length the resulting ray should be
  14782. * @returns a ray in the direction the controller is pointing
  14783. */
  14784. getForwardRay(length?: number): Ray;
  14785. }
  14786. }
  14787. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  14788. import { Observable } from "babylonjs/Misc/observable";
  14789. import { Scene } from "babylonjs/scene";
  14790. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14791. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  14792. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  14793. import { Nullable } from "babylonjs/types";
  14794. /**
  14795. * Defines the WebVRController object that represents controllers tracked in 3D space
  14796. */
  14797. export abstract class WebVRController extends PoseEnabledController {
  14798. /**
  14799. * Internal, the default controller model for the controller
  14800. */
  14801. protected _defaultModel: Nullable<AbstractMesh>;
  14802. /**
  14803. * Fired when the trigger state has changed
  14804. */
  14805. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  14806. /**
  14807. * Fired when the main button state has changed
  14808. */
  14809. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  14810. /**
  14811. * Fired when the secondary button state has changed
  14812. */
  14813. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  14814. /**
  14815. * Fired when the pad state has changed
  14816. */
  14817. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  14818. /**
  14819. * Fired when controllers stick values have changed
  14820. */
  14821. onPadValuesChangedObservable: Observable<StickValues>;
  14822. /**
  14823. * Array of button availible on the controller
  14824. */
  14825. protected _buttons: Array<MutableGamepadButton>;
  14826. private _onButtonStateChange;
  14827. /**
  14828. * Fired when a controller button's state has changed
  14829. * @param callback the callback containing the button that was modified
  14830. */
  14831. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  14832. /**
  14833. * X and Y axis corresponding to the controllers joystick
  14834. */
  14835. pad: StickValues;
  14836. /**
  14837. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  14838. */
  14839. hand: string;
  14840. /**
  14841. * The default controller model for the controller
  14842. */
  14843. readonly defaultModel: Nullable<AbstractMesh>;
  14844. /**
  14845. * Creates a new WebVRController from a gamepad
  14846. * @param vrGamepad the gamepad that the WebVRController should be created from
  14847. */
  14848. constructor(vrGamepad: any);
  14849. /**
  14850. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  14851. */
  14852. update(): void;
  14853. /**
  14854. * Function to be called when a button is modified
  14855. */
  14856. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  14857. /**
  14858. * Loads a mesh and attaches it to the controller
  14859. * @param scene the scene the mesh should be added to
  14860. * @param meshLoaded callback for when the mesh has been loaded
  14861. */
  14862. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  14863. private _setButtonValue;
  14864. private _changes;
  14865. private _checkChanges;
  14866. /**
  14867. * Disposes of th webVRCOntroller
  14868. */
  14869. dispose(): void;
  14870. }
  14871. }
  14872. declare module "babylonjs/Lights/hemisphericLight" {
  14873. import { Nullable } from "babylonjs/types";
  14874. import { Scene } from "babylonjs/scene";
  14875. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14876. import { Color3 } from "babylonjs/Maths/math.color";
  14877. import { Effect } from "babylonjs/Materials/effect";
  14878. import { Light } from "babylonjs/Lights/light";
  14879. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  14880. /**
  14881. * The HemisphericLight simulates the ambient environment light,
  14882. * so the passed direction is the light reflection direction, not the incoming direction.
  14883. */
  14884. export class HemisphericLight extends Light {
  14885. /**
  14886. * The groundColor is the light in the opposite direction to the one specified during creation.
  14887. * You can think of the diffuse and specular light as coming from the centre of the object in the given direction and the groundColor light in the opposite direction.
  14888. */
  14889. groundColor: Color3;
  14890. /**
  14891. * The light reflection direction, not the incoming direction.
  14892. */
  14893. direction: Vector3;
  14894. /**
  14895. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  14896. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  14897. * The HemisphericLight can't cast shadows.
  14898. * Documentation : https://doc.babylonjs.com/babylon101/lights
  14899. * @param name The friendly name of the light
  14900. * @param direction The direction of the light reflection
  14901. * @param scene The scene the light belongs to
  14902. */
  14903. constructor(name: string, direction: Vector3, scene: Scene);
  14904. protected _buildUniformLayout(): void;
  14905. /**
  14906. * Returns the string "HemisphericLight".
  14907. * @return The class name
  14908. */
  14909. getClassName(): string;
  14910. /**
  14911. * Sets the HemisphericLight direction towards the passed target (Vector3).
  14912. * Returns the updated direction.
  14913. * @param target The target the direction should point to
  14914. * @return The computed direction
  14915. */
  14916. setDirectionToTarget(target: Vector3): Vector3;
  14917. /**
  14918. * Returns the shadow generator associated to the light.
  14919. * @returns Always null for hemispheric lights because it does not support shadows.
  14920. */
  14921. getShadowGenerator(): Nullable<IShadowGenerator>;
  14922. /**
  14923. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  14924. * @param effect The effect to update
  14925. * @param lightIndex The index of the light in the effect to update
  14926. * @returns The hemispheric light
  14927. */
  14928. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  14929. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  14930. /**
  14931. * Computes the world matrix of the node
  14932. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  14933. * @param useWasUpdatedFlag defines a reserved property
  14934. * @returns the world matrix
  14935. */
  14936. computeWorldMatrix(): Matrix;
  14937. /**
  14938. * Returns the integer 3.
  14939. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  14940. */
  14941. getTypeID(): number;
  14942. /**
  14943. * Prepares the list of defines specific to the light type.
  14944. * @param defines the list of defines
  14945. * @param lightIndex defines the index of the light for the effect
  14946. */
  14947. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  14948. }
  14949. }
  14950. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  14951. /** @hidden */
  14952. export var vrMultiviewToSingleviewPixelShader: {
  14953. name: string;
  14954. shader: string;
  14955. };
  14956. }
  14957. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  14958. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  14959. import { Scene } from "babylonjs/scene";
  14960. /**
  14961. * Renders to multiple views with a single draw call
  14962. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  14963. */
  14964. export class MultiviewRenderTarget extends RenderTargetTexture {
  14965. /**
  14966. * Creates a multiview render target
  14967. * @param scene scene used with the render target
  14968. * @param size the size of the render target (used for each view)
  14969. */
  14970. constructor(scene: Scene, size?: number | {
  14971. width: number;
  14972. height: number;
  14973. } | {
  14974. ratio: number;
  14975. });
  14976. /**
  14977. * @hidden
  14978. * @param faceIndex the face index, if its a cube texture
  14979. */
  14980. _bindFrameBuffer(faceIndex?: number): void;
  14981. /**
  14982. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  14983. * @returns the view count
  14984. */
  14985. getViewCount(): number;
  14986. }
  14987. }
  14988. declare module "babylonjs/Maths/math.frustum" {
  14989. import { Matrix } from "babylonjs/Maths/math.vector";
  14990. import { DeepImmutable } from "babylonjs/types";
  14991. import { Plane } from "babylonjs/Maths/math.plane";
  14992. /**
  14993. * Represents a camera frustum
  14994. */
  14995. export class Frustum {
  14996. /**
  14997. * Gets the planes representing the frustum
  14998. * @param transform matrix to be applied to the returned planes
  14999. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  15000. */
  15001. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  15002. /**
  15003. * Gets the near frustum plane transformed by the transform matrix
  15004. * @param transform transformation matrix to be applied to the resulting frustum plane
  15005. * @param frustumPlane the resuling frustum plane
  15006. */
  15007. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15008. /**
  15009. * Gets the far frustum plane transformed by the transform matrix
  15010. * @param transform transformation matrix to be applied to the resulting frustum plane
  15011. * @param frustumPlane the resuling frustum plane
  15012. */
  15013. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15014. /**
  15015. * Gets the left frustum plane transformed by the transform matrix
  15016. * @param transform transformation matrix to be applied to the resulting frustum plane
  15017. * @param frustumPlane the resuling frustum plane
  15018. */
  15019. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15020. /**
  15021. * Gets the right frustum plane transformed by the transform matrix
  15022. * @param transform transformation matrix to be applied to the resulting frustum plane
  15023. * @param frustumPlane the resuling frustum plane
  15024. */
  15025. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15026. /**
  15027. * Gets the top frustum plane transformed by the transform matrix
  15028. * @param transform transformation matrix to be applied to the resulting frustum plane
  15029. * @param frustumPlane the resuling frustum plane
  15030. */
  15031. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15032. /**
  15033. * Gets the bottom frustum plane transformed by the transform matrix
  15034. * @param transform transformation matrix to be applied to the resulting frustum plane
  15035. * @param frustumPlane the resuling frustum plane
  15036. */
  15037. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15038. /**
  15039. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  15040. * @param transform transformation matrix to be applied to the resulting frustum planes
  15041. * @param frustumPlanes the resuling frustum planes
  15042. */
  15043. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  15044. }
  15045. }
  15046. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  15047. import { Camera } from "babylonjs/Cameras/camera";
  15048. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  15049. import { Nullable } from "babylonjs/types";
  15050. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  15051. import { Matrix } from "babylonjs/Maths/math.vector";
  15052. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  15053. module "babylonjs/Engines/engine" {
  15054. interface Engine {
  15055. /**
  15056. * Creates a new multiview render target
  15057. * @param width defines the width of the texture
  15058. * @param height defines the height of the texture
  15059. * @returns the created multiview texture
  15060. */
  15061. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  15062. /**
  15063. * Binds a multiview framebuffer to be drawn to
  15064. * @param multiviewTexture texture to bind
  15065. */
  15066. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  15067. }
  15068. }
  15069. module "babylonjs/Cameras/camera" {
  15070. interface Camera {
  15071. /**
  15072. * @hidden
  15073. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  15074. */
  15075. _useMultiviewToSingleView: boolean;
  15076. /**
  15077. * @hidden
  15078. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  15079. */
  15080. _multiviewTexture: Nullable<RenderTargetTexture>;
  15081. /**
  15082. * @hidden
  15083. * ensures the multiview texture of the camera exists and has the specified width/height
  15084. * @param width height to set on the multiview texture
  15085. * @param height width to set on the multiview texture
  15086. */
  15087. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  15088. }
  15089. }
  15090. module "babylonjs/scene" {
  15091. interface Scene {
  15092. /** @hidden */
  15093. _transformMatrixR: Matrix;
  15094. /** @hidden */
  15095. _multiviewSceneUbo: Nullable<UniformBuffer>;
  15096. /** @hidden */
  15097. _createMultiviewUbo(): void;
  15098. /** @hidden */
  15099. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  15100. /** @hidden */
  15101. _renderMultiviewToSingleView(camera: Camera): void;
  15102. }
  15103. }
  15104. }
  15105. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  15106. import { Camera } from "babylonjs/Cameras/camera";
  15107. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  15108. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  15109. import "babylonjs/Engines/Extensions/engine.multiview";
  15110. /**
  15111. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  15112. * This will not be used for webXR as it supports displaying texture arrays directly
  15113. */
  15114. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  15115. /**
  15116. * Initializes a VRMultiviewToSingleview
  15117. * @param name name of the post process
  15118. * @param camera camera to be applied to
  15119. * @param scaleFactor scaling factor to the size of the output texture
  15120. */
  15121. constructor(name: string, camera: Camera, scaleFactor: number);
  15122. }
  15123. }
  15124. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  15125. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  15126. import { Nullable } from "babylonjs/types";
  15127. import { Size } from "babylonjs/Maths/math.size";
  15128. import { Observable } from "babylonjs/Misc/observable";
  15129. /**
  15130. * Interface used to define additional presentation attributes
  15131. */
  15132. export interface IVRPresentationAttributes {
  15133. /**
  15134. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  15135. */
  15136. highRefreshRate: boolean;
  15137. /**
  15138. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  15139. */
  15140. foveationLevel: number;
  15141. }
  15142. module "babylonjs/Engines/engine" {
  15143. interface Engine {
  15144. /** @hidden */
  15145. _vrDisplay: any;
  15146. /** @hidden */
  15147. _vrSupported: boolean;
  15148. /** @hidden */
  15149. _oldSize: Size;
  15150. /** @hidden */
  15151. _oldHardwareScaleFactor: number;
  15152. /** @hidden */
  15153. _vrExclusivePointerMode: boolean;
  15154. /** @hidden */
  15155. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  15156. /** @hidden */
  15157. _onVRDisplayPointerRestricted: () => void;
  15158. /** @hidden */
  15159. _onVRDisplayPointerUnrestricted: () => void;
  15160. /** @hidden */
  15161. _onVrDisplayConnect: Nullable<(display: any) => void>;
  15162. /** @hidden */
  15163. _onVrDisplayDisconnect: Nullable<() => void>;
  15164. /** @hidden */
  15165. _onVrDisplayPresentChange: Nullable<() => void>;
  15166. /**
  15167. * Observable signaled when VR display mode changes
  15168. */
  15169. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  15170. /**
  15171. * Observable signaled when VR request present is complete
  15172. */
  15173. onVRRequestPresentComplete: Observable<boolean>;
  15174. /**
  15175. * Observable signaled when VR request present starts
  15176. */
  15177. onVRRequestPresentStart: Observable<Engine>;
  15178. /**
  15179. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  15180. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  15181. */
  15182. isInVRExclusivePointerMode: boolean;
  15183. /**
  15184. * Gets a boolean indicating if a webVR device was detected
  15185. * @returns true if a webVR device was detected
  15186. */
  15187. isVRDevicePresent(): boolean;
  15188. /**
  15189. * Gets the current webVR device
  15190. * @returns the current webVR device (or null)
  15191. */
  15192. getVRDevice(): any;
  15193. /**
  15194. * Initializes a webVR display and starts listening to display change events
  15195. * The onVRDisplayChangedObservable will be notified upon these changes
  15196. * @returns A promise containing a VRDisplay and if vr is supported
  15197. */
  15198. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  15199. /** @hidden */
  15200. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  15201. /**
  15202. * Gets or sets the presentation attributes used to configure VR rendering
  15203. */
  15204. vrPresentationAttributes?: IVRPresentationAttributes;
  15205. /**
  15206. * Call this function to switch to webVR mode
  15207. * Will do nothing if webVR is not supported or if there is no webVR device
  15208. * @see http://doc.babylonjs.com/how_to/webvr_camera
  15209. */
  15210. enableVR(): void;
  15211. /** @hidden */
  15212. _onVRFullScreenTriggered(): void;
  15213. }
  15214. }
  15215. }
  15216. declare module "babylonjs/Cameras/VR/webVRCamera" {
  15217. import { Nullable } from "babylonjs/types";
  15218. import { Observable } from "babylonjs/Misc/observable";
  15219. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  15220. import { Scene } from "babylonjs/scene";
  15221. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  15222. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  15223. import { Node } from "babylonjs/node";
  15224. import { Ray } from "babylonjs/Culling/ray";
  15225. import "babylonjs/Cameras/RigModes/webVRRigMode";
  15226. import "babylonjs/Engines/Extensions/engine.webVR";
  15227. /**
  15228. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  15229. * IMPORTANT!! The data is right-hand data.
  15230. * @export
  15231. * @interface DevicePose
  15232. */
  15233. export interface DevicePose {
  15234. /**
  15235. * The position of the device, values in array are [x,y,z].
  15236. */
  15237. readonly position: Nullable<Float32Array>;
  15238. /**
  15239. * The linearVelocity of the device, values in array are [x,y,z].
  15240. */
  15241. readonly linearVelocity: Nullable<Float32Array>;
  15242. /**
  15243. * The linearAcceleration of the device, values in array are [x,y,z].
  15244. */
  15245. readonly linearAcceleration: Nullable<Float32Array>;
  15246. /**
  15247. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  15248. */
  15249. readonly orientation: Nullable<Float32Array>;
  15250. /**
  15251. * The angularVelocity of the device, values in array are [x,y,z].
  15252. */
  15253. readonly angularVelocity: Nullable<Float32Array>;
  15254. /**
  15255. * The angularAcceleration of the device, values in array are [x,y,z].
  15256. */
  15257. readonly angularAcceleration: Nullable<Float32Array>;
  15258. }
  15259. /**
  15260. * Interface representing a pose controlled object in Babylon.
  15261. * A pose controlled object has both regular pose values as well as pose values
  15262. * from an external device such as a VR head mounted display
  15263. */
  15264. export interface PoseControlled {
  15265. /**
  15266. * The position of the object in babylon space.
  15267. */
  15268. position: Vector3;
  15269. /**
  15270. * The rotation quaternion of the object in babylon space.
  15271. */
  15272. rotationQuaternion: Quaternion;
  15273. /**
  15274. * The position of the device in babylon space.
  15275. */
  15276. devicePosition?: Vector3;
  15277. /**
  15278. * The rotation quaternion of the device in babylon space.
  15279. */
  15280. deviceRotationQuaternion: Quaternion;
  15281. /**
  15282. * The raw pose coming from the device.
  15283. */
  15284. rawPose: Nullable<DevicePose>;
  15285. /**
  15286. * The scale of the device to be used when translating from device space to babylon space.
  15287. */
  15288. deviceScaleFactor: number;
  15289. /**
  15290. * Updates the poseControlled values based on the input device pose.
  15291. * @param poseData the pose data to update the object with
  15292. */
  15293. updateFromDevice(poseData: DevicePose): void;
  15294. }
  15295. /**
  15296. * Set of options to customize the webVRCamera
  15297. */
  15298. export interface WebVROptions {
  15299. /**
  15300. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  15301. */
  15302. trackPosition?: boolean;
  15303. /**
  15304. * Sets the scale of the vrDevice in babylon space. (default: 1)
  15305. */
  15306. positionScale?: number;
  15307. /**
  15308. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  15309. */
  15310. displayName?: string;
  15311. /**
  15312. * Should the native controller meshes be initialized. (default: true)
  15313. */
  15314. controllerMeshes?: boolean;
  15315. /**
  15316. * Creating a default HemiLight only on controllers. (default: true)
  15317. */
  15318. defaultLightingOnControllers?: boolean;
  15319. /**
  15320. * If you don't want to use the default VR button of the helper. (default: false)
  15321. */
  15322. useCustomVRButton?: boolean;
  15323. /**
  15324. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  15325. */
  15326. customVRButton?: HTMLButtonElement;
  15327. /**
  15328. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  15329. */
  15330. rayLength?: number;
  15331. /**
  15332. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  15333. */
  15334. defaultHeight?: number;
  15335. /**
  15336. * If multiview should be used if availible (default: false)
  15337. */
  15338. useMultiview?: boolean;
  15339. }
  15340. /**
  15341. * This represents a WebVR camera.
  15342. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  15343. * @example http://doc.babylonjs.com/how_to/webvr_camera
  15344. */
  15345. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  15346. private webVROptions;
  15347. /**
  15348. * @hidden
  15349. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  15350. */
  15351. _vrDevice: any;
  15352. /**
  15353. * The rawPose of the vrDevice.
  15354. */
  15355. rawPose: Nullable<DevicePose>;
  15356. private _onVREnabled;
  15357. private _specsVersion;
  15358. private _attached;
  15359. private _frameData;
  15360. protected _descendants: Array<Node>;
  15361. private _deviceRoomPosition;
  15362. /** @hidden */
  15363. _deviceRoomRotationQuaternion: Quaternion;
  15364. private _standingMatrix;
  15365. /**
  15366. * Represents device position in babylon space.
  15367. */
  15368. devicePosition: Vector3;
  15369. /**
  15370. * Represents device rotation in babylon space.
  15371. */
  15372. deviceRotationQuaternion: Quaternion;
  15373. /**
  15374. * The scale of the device to be used when translating from device space to babylon space.
  15375. */
  15376. deviceScaleFactor: number;
  15377. private _deviceToWorld;
  15378. private _worldToDevice;
  15379. /**
  15380. * References to the webVR controllers for the vrDevice.
  15381. */
  15382. controllers: Array<WebVRController>;
  15383. /**
  15384. * Emits an event when a controller is attached.
  15385. */
  15386. onControllersAttachedObservable: Observable<WebVRController[]>;
  15387. /**
  15388. * Emits an event when a controller's mesh has been loaded;
  15389. */
  15390. onControllerMeshLoadedObservable: Observable<WebVRController>;
  15391. /**
  15392. * Emits an event when the HMD's pose has been updated.
  15393. */
  15394. onPoseUpdatedFromDeviceObservable: Observable<any>;
  15395. private _poseSet;
  15396. /**
  15397. * If the rig cameras be used as parent instead of this camera.
  15398. */
  15399. rigParenting: boolean;
  15400. private _lightOnControllers;
  15401. private _defaultHeight?;
  15402. /**
  15403. * Instantiates a WebVRFreeCamera.
  15404. * @param name The name of the WebVRFreeCamera
  15405. * @param position The starting anchor position for the camera
  15406. * @param scene The scene the camera belongs to
  15407. * @param webVROptions a set of customizable options for the webVRCamera
  15408. */
  15409. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  15410. /**
  15411. * Gets the device distance from the ground in meters.
  15412. * @returns the distance in meters from the vrDevice to ground in device space. If standing matrix is not supported for the vrDevice 0 is returned.
  15413. */
  15414. deviceDistanceToRoomGround(): number;
  15415. /**
  15416. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  15417. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  15418. */
  15419. useStandingMatrix(callback?: (bool: boolean) => void): void;
  15420. /**
  15421. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  15422. * @returns A promise with a boolean set to if the standing matrix is supported.
  15423. */
  15424. useStandingMatrixAsync(): Promise<boolean>;
  15425. /**
  15426. * Disposes the camera
  15427. */
  15428. dispose(): void;
  15429. /**
  15430. * Gets a vrController by name.
  15431. * @param name The name of the controller to retreive
  15432. * @returns the controller matching the name specified or null if not found
  15433. */
  15434. getControllerByName(name: string): Nullable<WebVRController>;
  15435. private _leftController;
  15436. /**
  15437. * The controller corresponding to the users left hand.
  15438. */
  15439. readonly leftController: Nullable<WebVRController>;
  15440. private _rightController;
  15441. /**
  15442. * The controller corresponding to the users right hand.
  15443. */
  15444. readonly rightController: Nullable<WebVRController>;
  15445. /**
  15446. * Casts a ray forward from the vrCamera's gaze.
  15447. * @param length Length of the ray (default: 100)
  15448. * @returns the ray corresponding to the gaze
  15449. */
  15450. getForwardRay(length?: number): Ray;
  15451. /**
  15452. * @hidden
  15453. * Updates the camera based on device's frame data
  15454. */
  15455. _checkInputs(): void;
  15456. /**
  15457. * Updates the poseControlled values based on the input device pose.
  15458. * @param poseData Pose coming from the device
  15459. */
  15460. updateFromDevice(poseData: DevicePose): void;
  15461. private _htmlElementAttached;
  15462. private _detachIfAttached;
  15463. /**
  15464. * WebVR's attach control will start broadcasting frames to the device.
  15465. * Note that in certain browsers (chrome for example) this function must be called
  15466. * within a user-interaction callback. Example:
  15467. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  15468. *
  15469. * @param element html element to attach the vrDevice to
  15470. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  15471. */
  15472. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  15473. /**
  15474. * Detaches the camera from the html element and disables VR
  15475. *
  15476. * @param element html element to detach from
  15477. */
  15478. detachControl(element: HTMLElement): void;
  15479. /**
  15480. * @returns the name of this class
  15481. */
  15482. getClassName(): string;
  15483. /**
  15484. * Calls resetPose on the vrDisplay
  15485. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  15486. */
  15487. resetToCurrentRotation(): void;
  15488. /**
  15489. * @hidden
  15490. * Updates the rig cameras (left and right eye)
  15491. */
  15492. _updateRigCameras(): void;
  15493. private _workingVector;
  15494. private _oneVector;
  15495. private _workingMatrix;
  15496. private updateCacheCalled;
  15497. private _correctPositionIfNotTrackPosition;
  15498. /**
  15499. * @hidden
  15500. * Updates the cached values of the camera
  15501. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  15502. */
  15503. _updateCache(ignoreParentClass?: boolean): void;
  15504. /**
  15505. * @hidden
  15506. * Get current device position in babylon world
  15507. */
  15508. _computeDevicePosition(): void;
  15509. /**
  15510. * Updates the current device position and rotation in the babylon world
  15511. */
  15512. update(): void;
  15513. /**
  15514. * @hidden
  15515. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  15516. * @returns an identity matrix
  15517. */
  15518. _getViewMatrix(): Matrix;
  15519. private _tmpMatrix;
  15520. /**
  15521. * This function is called by the two RIG cameras.
  15522. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  15523. * @hidden
  15524. */
  15525. _getWebVRViewMatrix(): Matrix;
  15526. /** @hidden */
  15527. _getWebVRProjectionMatrix(): Matrix;
  15528. private _onGamepadConnectedObserver;
  15529. private _onGamepadDisconnectedObserver;
  15530. private _updateCacheWhenTrackingDisabledObserver;
  15531. /**
  15532. * Initializes the controllers and their meshes
  15533. */
  15534. initControllers(): void;
  15535. }
  15536. }
  15537. declare module "babylonjs/PostProcesses/postProcess" {
  15538. import { Nullable } from "babylonjs/types";
  15539. import { SmartArray } from "babylonjs/Misc/smartArray";
  15540. import { Observable } from "babylonjs/Misc/observable";
  15541. import { Vector2 } from "babylonjs/Maths/math.vector";
  15542. import { Camera } from "babylonjs/Cameras/camera";
  15543. import { Effect } from "babylonjs/Materials/effect";
  15544. import "babylonjs/Shaders/postprocess.vertex";
  15545. import { IInspectable } from "babylonjs/Misc/iInspectable";
  15546. import { Engine } from "babylonjs/Engines/engine";
  15547. import { Color4 } from "babylonjs/Maths/math.color";
  15548. import "babylonjs/Engines/Extensions/engine.renderTarget";
  15549. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  15550. /**
  15551. * Size options for a post process
  15552. */
  15553. export type PostProcessOptions = {
  15554. width: number;
  15555. height: number;
  15556. };
  15557. /**
  15558. * PostProcess can be used to apply a shader to a texture after it has been rendered
  15559. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  15560. */
  15561. export class PostProcess {
  15562. /** Name of the PostProcess. */
  15563. name: string;
  15564. /**
  15565. * Gets or sets the unique id of the post process
  15566. */
  15567. uniqueId: number;
  15568. /**
  15569. * Width of the texture to apply the post process on
  15570. */
  15571. width: number;
  15572. /**
  15573. * Height of the texture to apply the post process on
  15574. */
  15575. height: number;
  15576. /**
  15577. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  15578. * @hidden
  15579. */
  15580. _outputTexture: Nullable<InternalTexture>;
  15581. /**
  15582. * Sampling mode used by the shader
  15583. * See https://doc.babylonjs.com/classes/3.1/texture
  15584. */
  15585. renderTargetSamplingMode: number;
  15586. /**
  15587. * Clear color to use when screen clearing
  15588. */
  15589. clearColor: Color4;
  15590. /**
  15591. * If the buffer needs to be cleared before applying the post process. (default: true)
  15592. * Should be set to false if shader will overwrite all previous pixels.
  15593. */
  15594. autoClear: boolean;
  15595. /**
  15596. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  15597. */
  15598. alphaMode: number;
  15599. /**
  15600. * Sets the setAlphaBlendConstants of the babylon engine
  15601. */
  15602. alphaConstants: Color4;
  15603. /**
  15604. * Animations to be used for the post processing
  15605. */
  15606. animations: import("babylonjs/Animations/animation").Animation[];
  15607. /**
  15608. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  15609. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  15610. */
  15611. enablePixelPerfectMode: boolean;
  15612. /**
  15613. * Force the postprocess to be applied without taking in account viewport
  15614. */
  15615. forceFullscreenViewport: boolean;
  15616. /**
  15617. * List of inspectable custom properties (used by the Inspector)
  15618. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  15619. */
  15620. inspectableCustomProperties: IInspectable[];
  15621. /**
  15622. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  15623. *
  15624. * | Value | Type | Description |
  15625. * | ----- | ----------------------------------- | ----------- |
  15626. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  15627. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  15628. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  15629. *
  15630. */
  15631. scaleMode: number;
  15632. /**
  15633. * Force textures to be a power of two (default: false)
  15634. */
  15635. alwaysForcePOT: boolean;
  15636. private _samples;
  15637. /**
  15638. * Number of sample textures (default: 1)
  15639. */
  15640. samples: number;
  15641. /**
  15642. * Modify the scale of the post process to be the same as the viewport (default: false)
  15643. */
  15644. adaptScaleToCurrentViewport: boolean;
  15645. private _camera;
  15646. private _scene;
  15647. private _engine;
  15648. private _options;
  15649. private _reusable;
  15650. private _textureType;
  15651. /**
  15652. * Smart array of input and output textures for the post process.
  15653. * @hidden
  15654. */
  15655. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  15656. /**
  15657. * The index in _textures that corresponds to the output texture.
  15658. * @hidden
  15659. */
  15660. _currentRenderTextureInd: number;
  15661. private _effect;
  15662. private _samplers;
  15663. private _fragmentUrl;
  15664. private _vertexUrl;
  15665. private _parameters;
  15666. private _scaleRatio;
  15667. protected _indexParameters: any;
  15668. private _shareOutputWithPostProcess;
  15669. private _texelSize;
  15670. private _forcedOutputTexture;
  15671. /**
  15672. * Returns the fragment url or shader name used in the post process.
  15673. * @returns the fragment url or name in the shader store.
  15674. */
  15675. getEffectName(): string;
  15676. /**
  15677. * An event triggered when the postprocess is activated.
  15678. */
  15679. onActivateObservable: Observable<Camera>;
  15680. private _onActivateObserver;
  15681. /**
  15682. * A function that is added to the onActivateObservable
  15683. */
  15684. onActivate: Nullable<(camera: Camera) => void>;
  15685. /**
  15686. * An event triggered when the postprocess changes its size.
  15687. */
  15688. onSizeChangedObservable: Observable<PostProcess>;
  15689. private _onSizeChangedObserver;
  15690. /**
  15691. * A function that is added to the onSizeChangedObservable
  15692. */
  15693. onSizeChanged: (postProcess: PostProcess) => void;
  15694. /**
  15695. * An event triggered when the postprocess applies its effect.
  15696. */
  15697. onApplyObservable: Observable<Effect>;
  15698. private _onApplyObserver;
  15699. /**
  15700. * A function that is added to the onApplyObservable
  15701. */
  15702. onApply: (effect: Effect) => void;
  15703. /**
  15704. * An event triggered before rendering the postprocess
  15705. */
  15706. onBeforeRenderObservable: Observable<Effect>;
  15707. private _onBeforeRenderObserver;
  15708. /**
  15709. * A function that is added to the onBeforeRenderObservable
  15710. */
  15711. onBeforeRender: (effect: Effect) => void;
  15712. /**
  15713. * An event triggered after rendering the postprocess
  15714. */
  15715. onAfterRenderObservable: Observable<Effect>;
  15716. private _onAfterRenderObserver;
  15717. /**
  15718. * A function that is added to the onAfterRenderObservable
  15719. */
  15720. onAfterRender: (efect: Effect) => void;
  15721. /**
  15722. * The input texture for this post process and the output texture of the previous post process. When added to a pipeline the previous post process will
  15723. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  15724. */
  15725. inputTexture: InternalTexture;
  15726. /**
  15727. * Gets the camera which post process is applied to.
  15728. * @returns The camera the post process is applied to.
  15729. */
  15730. getCamera(): Camera;
  15731. /**
  15732. * Gets the texel size of the postprocess.
  15733. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  15734. */
  15735. readonly texelSize: Vector2;
  15736. /**
  15737. * Creates a new instance PostProcess
  15738. * @param name The name of the PostProcess.
  15739. * @param fragmentUrl The url of the fragment shader to be used.
  15740. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  15741. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  15742. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  15743. * @param camera The camera to apply the render pass to.
  15744. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  15745. * @param engine The engine which the post process will be applied. (default: current engine)
  15746. * @param reusable If the post process can be reused on the same frame. (default: false)
  15747. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  15748. * @param textureType Type of textures used when performing the post process. (default: 0)
  15749. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  15750. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  15751. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  15752. */
  15753. constructor(
  15754. /** Name of the PostProcess. */
  15755. name: string, fragmentUrl: string, parameters: Nullable<string[]>, samplers: Nullable<string[]>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, defines?: Nullable<string>, textureType?: number, vertexUrl?: string, indexParameters?: any, blockCompilation?: boolean);
  15756. /**
  15757. * Gets a string idenfifying the name of the class
  15758. * @returns "PostProcess" string
  15759. */
  15760. getClassName(): string;
  15761. /**
  15762. * Gets the engine which this post process belongs to.
  15763. * @returns The engine the post process was enabled with.
  15764. */
  15765. getEngine(): Engine;
  15766. /**
  15767. * The effect that is created when initializing the post process.
  15768. * @returns The created effect corresponding the the postprocess.
  15769. */
  15770. getEffect(): Effect;
  15771. /**
  15772. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  15773. * @param postProcess The post process to share the output with.
  15774. * @returns This post process.
  15775. */
  15776. shareOutputWith(postProcess: PostProcess): PostProcess;
  15777. /**
  15778. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  15779. * This should be called if the post process that shares output with this post process is disabled/disposed.
  15780. */
  15781. useOwnOutput(): void;
  15782. /**
  15783. * Updates the effect with the current post process compile time values and recompiles the shader.
  15784. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  15785. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  15786. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  15787. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  15788. * @param onCompiled Called when the shader has been compiled.
  15789. * @param onError Called if there is an error when compiling a shader.
  15790. */
  15791. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15792. /**
  15793. * The post process is reusable if it can be used multiple times within one frame.
  15794. * @returns If the post process is reusable
  15795. */
  15796. isReusable(): boolean;
  15797. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  15798. markTextureDirty(): void;
  15799. /**
  15800. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  15801. * When this post process is used in a pipeline, this is call will bind the input texture of this post process to the output of the previous.
  15802. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  15803. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  15804. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  15805. * @returns The target texture that was bound to be written to.
  15806. */
  15807. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  15808. /**
  15809. * If the post process is supported.
  15810. */
  15811. readonly isSupported: boolean;
  15812. /**
  15813. * The aspect ratio of the output texture.
  15814. */
  15815. readonly aspectRatio: number;
  15816. /**
  15817. * Get a value indicating if the post-process is ready to be used
  15818. * @returns true if the post-process is ready (shader is compiled)
  15819. */
  15820. isReady(): boolean;
  15821. /**
  15822. * Binds all textures and uniforms to the shader, this will be run on every pass.
  15823. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  15824. */
  15825. apply(): Nullable<Effect>;
  15826. private _disposeTextures;
  15827. /**
  15828. * Disposes the post process.
  15829. * @param camera The camera to dispose the post process on.
  15830. */
  15831. dispose(camera?: Camera): void;
  15832. }
  15833. }
  15834. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  15835. /** @hidden */
  15836. export var kernelBlurVaryingDeclaration: {
  15837. name: string;
  15838. shader: string;
  15839. };
  15840. }
  15841. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  15842. /** @hidden */
  15843. export var kernelBlurFragment: {
  15844. name: string;
  15845. shader: string;
  15846. };
  15847. }
  15848. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  15849. /** @hidden */
  15850. export var kernelBlurFragment2: {
  15851. name: string;
  15852. shader: string;
  15853. };
  15854. }
  15855. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  15856. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  15857. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  15858. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  15859. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  15860. /** @hidden */
  15861. export var kernelBlurPixelShader: {
  15862. name: string;
  15863. shader: string;
  15864. };
  15865. }
  15866. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  15867. /** @hidden */
  15868. export var kernelBlurVertex: {
  15869. name: string;
  15870. shader: string;
  15871. };
  15872. }
  15873. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  15874. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  15875. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  15876. /** @hidden */
  15877. export var kernelBlurVertexShader: {
  15878. name: string;
  15879. shader: string;
  15880. };
  15881. }
  15882. declare module "babylonjs/PostProcesses/blurPostProcess" {
  15883. import { Vector2 } from "babylonjs/Maths/math.vector";
  15884. import { Nullable } from "babylonjs/types";
  15885. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  15886. import { Camera } from "babylonjs/Cameras/camera";
  15887. import { Effect } from "babylonjs/Materials/effect";
  15888. import { Engine } from "babylonjs/Engines/engine";
  15889. import "babylonjs/Shaders/kernelBlur.fragment";
  15890. import "babylonjs/Shaders/kernelBlur.vertex";
  15891. /**
  15892. * The Blur Post Process which blurs an image based on a kernel and direction.
  15893. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  15894. */
  15895. export class BlurPostProcess extends PostProcess {
  15896. /** The direction in which to blur the image. */
  15897. direction: Vector2;
  15898. private blockCompilation;
  15899. protected _kernel: number;
  15900. protected _idealKernel: number;
  15901. protected _packedFloat: boolean;
  15902. private _staticDefines;
  15903. /**
  15904. * Sets the length in pixels of the blur sample region
  15905. */
  15906. /**
  15907. * Gets the length in pixels of the blur sample region
  15908. */
  15909. kernel: number;
  15910. /**
  15911. * Sets wether or not the blur needs to unpack/repack floats
  15912. */
  15913. /**
  15914. * Gets wether or not the blur is unpacking/repacking floats
  15915. */
  15916. packedFloat: boolean;
  15917. /**
  15918. * Creates a new instance BlurPostProcess
  15919. * @param name The name of the effect.
  15920. * @param direction The direction in which to blur the image.
  15921. * @param kernel The size of the kernel to be used when computing the blur. eg. Size of 3 will blur the center pixel by 2 pixels surrounding it.
  15922. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  15923. * @param camera The camera to apply the render pass to.
  15924. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  15925. * @param engine The engine which the post process will be applied. (default: current engine)
  15926. * @param reusable If the post process can be reused on the same frame. (default: false)
  15927. * @param textureType Type of textures used when performing the post process. (default: 0)
  15928. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  15929. */
  15930. constructor(name: string,
  15931. /** The direction in which to blur the image. */
  15932. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  15933. /**
  15934. * Updates the effect with the current post process compile time values and recompiles the shader.
  15935. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  15936. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  15937. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  15938. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  15939. * @param onCompiled Called when the shader has been compiled.
  15940. * @param onError Called if there is an error when compiling a shader.
  15941. */
  15942. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15943. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15944. /**
  15945. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  15946. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  15947. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  15948. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  15949. * The gaps between physical kernels are compensated for in the weighting of the samples
  15950. * @param idealKernel Ideal blur kernel.
  15951. * @return Nearest best kernel.
  15952. */
  15953. protected _nearestBestKernel(idealKernel: number): number;
  15954. /**
  15955. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  15956. * @param x The point on the Gaussian distribution to sample.
  15957. * @return the value of the Gaussian function at x.
  15958. */
  15959. protected _gaussianWeight(x: number): number;
  15960. /**
  15961. * Generates a string that can be used as a floating point number in GLSL.
  15962. * @param x Value to print.
  15963. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  15964. * @return GLSL float string.
  15965. */
  15966. protected _glslFloat(x: number, decimalFigures?: number): string;
  15967. }
  15968. }
  15969. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  15970. import { Scene } from "babylonjs/scene";
  15971. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  15972. import { Plane } from "babylonjs/Maths/math.plane";
  15973. /**
  15974. * Mirror texture can be used to simulate the view from a mirror in a scene.
  15975. * It will dynamically be rendered every frame to adapt to the camera point of view.
  15976. * You can then easily use it as a reflectionTexture on a flat surface.
  15977. * In case the surface is not a plane, please consider relying on reflection probes.
  15978. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  15979. */
  15980. export class MirrorTexture extends RenderTargetTexture {
  15981. private scene;
  15982. /**
  15983. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  15984. * It is possible to directly set the mirrorPlane by directly using a Plane(a, b, c, d) where a, b and c give the plane normal vector (a, b, c) and d is a scalar displacement from the mirrorPlane to the origin. However in all but the very simplest of situations it is more straight forward to set it to the reflector as stated in the doc.
  15985. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  15986. */
  15987. mirrorPlane: Plane;
  15988. /**
  15989. * Define the blur ratio used to blur the reflection if needed.
  15990. */
  15991. blurRatio: number;
  15992. /**
  15993. * Define the adaptive blur kernel used to blur the reflection if needed.
  15994. * This will autocompute the closest best match for the `blurKernel`
  15995. */
  15996. adaptiveBlurKernel: number;
  15997. /**
  15998. * Define the blur kernel used to blur the reflection if needed.
  15999. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16000. */
  16001. blurKernel: number;
  16002. /**
  16003. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  16004. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16005. */
  16006. blurKernelX: number;
  16007. /**
  16008. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  16009. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16010. */
  16011. blurKernelY: number;
  16012. private _autoComputeBlurKernel;
  16013. protected _onRatioRescale(): void;
  16014. private _updateGammaSpace;
  16015. private _imageProcessingConfigChangeObserver;
  16016. private _transformMatrix;
  16017. private _mirrorMatrix;
  16018. private _savedViewMatrix;
  16019. private _blurX;
  16020. private _blurY;
  16021. private _adaptiveBlurKernel;
  16022. private _blurKernelX;
  16023. private _blurKernelY;
  16024. private _blurRatio;
  16025. /**
  16026. * Instantiates a Mirror Texture.
  16027. * Mirror texture can be used to simulate the view from a mirror in a scene.
  16028. * It will dynamically be rendered every frame to adapt to the camera point of view.
  16029. * You can then easily use it as a reflectionTexture on a flat surface.
  16030. * In case the surface is not a plane, please consider relying on reflection probes.
  16031. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  16032. * @param name
  16033. * @param size
  16034. * @param scene
  16035. * @param generateMipMaps
  16036. * @param type
  16037. * @param samplingMode
  16038. * @param generateDepthBuffer
  16039. */
  16040. constructor(name: string, size: number | {
  16041. width: number;
  16042. height: number;
  16043. } | {
  16044. ratio: number;
  16045. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  16046. private _preparePostProcesses;
  16047. /**
  16048. * Clone the mirror texture.
  16049. * @returns the cloned texture
  16050. */
  16051. clone(): MirrorTexture;
  16052. /**
  16053. * Serialize the texture to a JSON representation you could use in Parse later on
  16054. * @returns the serialized JSON representation
  16055. */
  16056. serialize(): any;
  16057. /**
  16058. * Dispose the texture and release its associated resources.
  16059. */
  16060. dispose(): void;
  16061. }
  16062. }
  16063. declare module "babylonjs/Materials/Textures/texture" {
  16064. import { Observable } from "babylonjs/Misc/observable";
  16065. import { Nullable } from "babylonjs/types";
  16066. import { Matrix } from "babylonjs/Maths/math.vector";
  16067. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16068. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16069. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  16070. import { Scene } from "babylonjs/scene";
  16071. /**
  16072. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  16073. * @see http://doc.babylonjs.com/babylon101/materials#texture
  16074. */
  16075. export class Texture extends BaseTexture {
  16076. /**
  16077. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  16078. */
  16079. static SerializeBuffers: boolean;
  16080. /** @hidden */
  16081. static _CubeTextureParser: (jsonTexture: any, scene: import("babylonjs/scene").Scene, rootUrl: string) => import("babylonjs/Materials/Textures/cubeTexture").CubeTexture;
  16082. /** @hidden */
  16083. static _CreateMirror: (name: string, renderTargetSize: number, scene: import("babylonjs/scene").Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/mirrorTexture").MirrorTexture;
  16084. /** @hidden */
  16085. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: import("babylonjs/scene").Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture;
  16086. /** nearest is mag = nearest and min = nearest and mip = linear */
  16087. static readonly NEAREST_SAMPLINGMODE: number;
  16088. /** nearest is mag = nearest and min = nearest and mip = linear */
  16089. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  16090. /** Bilinear is mag = linear and min = linear and mip = nearest */
  16091. static readonly BILINEAR_SAMPLINGMODE: number;
  16092. /** Bilinear is mag = linear and min = linear and mip = nearest */
  16093. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  16094. /** Trilinear is mag = linear and min = linear and mip = linear */
  16095. static readonly TRILINEAR_SAMPLINGMODE: number;
  16096. /** Trilinear is mag = linear and min = linear and mip = linear */
  16097. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  16098. /** mag = nearest and min = nearest and mip = nearest */
  16099. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  16100. /** mag = nearest and min = linear and mip = nearest */
  16101. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  16102. /** mag = nearest and min = linear and mip = linear */
  16103. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  16104. /** mag = nearest and min = linear and mip = none */
  16105. static readonly NEAREST_LINEAR: number;
  16106. /** mag = nearest and min = nearest and mip = none */
  16107. static readonly NEAREST_NEAREST: number;
  16108. /** mag = linear and min = nearest and mip = nearest */
  16109. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  16110. /** mag = linear and min = nearest and mip = linear */
  16111. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  16112. /** mag = linear and min = linear and mip = none */
  16113. static readonly LINEAR_LINEAR: number;
  16114. /** mag = linear and min = nearest and mip = none */
  16115. static readonly LINEAR_NEAREST: number;
  16116. /** Explicit coordinates mode */
  16117. static readonly EXPLICIT_MODE: number;
  16118. /** Spherical coordinates mode */
  16119. static readonly SPHERICAL_MODE: number;
  16120. /** Planar coordinates mode */
  16121. static readonly PLANAR_MODE: number;
  16122. /** Cubic coordinates mode */
  16123. static readonly CUBIC_MODE: number;
  16124. /** Projection coordinates mode */
  16125. static readonly PROJECTION_MODE: number;
  16126. /** Inverse Cubic coordinates mode */
  16127. static readonly SKYBOX_MODE: number;
  16128. /** Inverse Cubic coordinates mode */
  16129. static readonly INVCUBIC_MODE: number;
  16130. /** Equirectangular coordinates mode */
  16131. static readonly EQUIRECTANGULAR_MODE: number;
  16132. /** Equirectangular Fixed coordinates mode */
  16133. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  16134. /** Equirectangular Fixed Mirrored coordinates mode */
  16135. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  16136. /** Texture is not repeating outside of 0..1 UVs */
  16137. static readonly CLAMP_ADDRESSMODE: number;
  16138. /** Texture is repeating outside of 0..1 UVs */
  16139. static readonly WRAP_ADDRESSMODE: number;
  16140. /** Texture is repeating and mirrored */
  16141. static readonly MIRROR_ADDRESSMODE: number;
  16142. /**
  16143. * Gets or sets a boolean which defines if the texture url must be build from the serialized URL instead of just using the name and loading them side by side with the scene file
  16144. */
  16145. static UseSerializedUrlIfAny: boolean;
  16146. /**
  16147. * Define the url of the texture.
  16148. */
  16149. url: Nullable<string>;
  16150. /**
  16151. * Define an offset on the texture to offset the u coordinates of the UVs
  16152. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  16153. */
  16154. uOffset: number;
  16155. /**
  16156. * Define an offset on the texture to offset the v coordinates of the UVs
  16157. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  16158. */
  16159. vOffset: number;
  16160. /**
  16161. * Define an offset on the texture to scale the u coordinates of the UVs
  16162. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  16163. */
  16164. uScale: number;
  16165. /**
  16166. * Define an offset on the texture to scale the v coordinates of the UVs
  16167. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  16168. */
  16169. vScale: number;
  16170. /**
  16171. * Define an offset on the texture to rotate around the u coordinates of the UVs
  16172. * @see http://doc.babylonjs.com/how_to/more_materials
  16173. */
  16174. uAng: number;
  16175. /**
  16176. * Define an offset on the texture to rotate around the v coordinates of the UVs
  16177. * @see http://doc.babylonjs.com/how_to/more_materials
  16178. */
  16179. vAng: number;
  16180. /**
  16181. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  16182. * @see http://doc.babylonjs.com/how_to/more_materials
  16183. */
  16184. wAng: number;
  16185. /**
  16186. * Defines the center of rotation (U)
  16187. */
  16188. uRotationCenter: number;
  16189. /**
  16190. * Defines the center of rotation (V)
  16191. */
  16192. vRotationCenter: number;
  16193. /**
  16194. * Defines the center of rotation (W)
  16195. */
  16196. wRotationCenter: number;
  16197. /**
  16198. * Are mip maps generated for this texture or not.
  16199. */
  16200. readonly noMipmap: boolean;
  16201. /**
  16202. * List of inspectable custom properties (used by the Inspector)
  16203. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16204. */
  16205. inspectableCustomProperties: Nullable<IInspectable[]>;
  16206. private _noMipmap;
  16207. /** @hidden */
  16208. _invertY: boolean;
  16209. private _rowGenerationMatrix;
  16210. private _cachedTextureMatrix;
  16211. private _projectionModeMatrix;
  16212. private _t0;
  16213. private _t1;
  16214. private _t2;
  16215. private _cachedUOffset;
  16216. private _cachedVOffset;
  16217. private _cachedUScale;
  16218. private _cachedVScale;
  16219. private _cachedUAng;
  16220. private _cachedVAng;
  16221. private _cachedWAng;
  16222. private _cachedProjectionMatrixId;
  16223. private _cachedCoordinatesMode;
  16224. /** @hidden */
  16225. protected _initialSamplingMode: number;
  16226. /** @hidden */
  16227. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  16228. private _deleteBuffer;
  16229. protected _format: Nullable<number>;
  16230. private _delayedOnLoad;
  16231. private _delayedOnError;
  16232. private _mimeType?;
  16233. /**
  16234. * Observable triggered once the texture has been loaded.
  16235. */
  16236. onLoadObservable: Observable<Texture>;
  16237. protected _isBlocking: boolean;
  16238. /**
  16239. * Is the texture preventing material to render while loading.
  16240. * If false, a default texture will be used instead of the loading one during the preparation step.
  16241. */
  16242. isBlocking: boolean;
  16243. /**
  16244. * Get the current sampling mode associated with the texture.
  16245. */
  16246. readonly samplingMode: number;
  16247. /**
  16248. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  16249. */
  16250. readonly invertY: boolean;
  16251. /**
  16252. * Instantiates a new texture.
  16253. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  16254. * @see http://doc.babylonjs.com/babylon101/materials#texture
  16255. * @param url defines the url of the picture to load as a texture
  16256. * @param scene defines the scene or engine the texture will belong to
  16257. * @param noMipmap defines if the texture will require mip maps or not
  16258. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  16259. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16260. * @param onLoad defines a callback triggered when the texture has been loaded
  16261. * @param onError defines a callback triggered when an error occurred during the loading session
  16262. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  16263. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  16264. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16265. * @param mimeType defines an optional mime type information
  16266. */
  16267. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | ThinEngine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, deleteBuffer?: boolean, format?: number, mimeType?: string);
  16268. /**
  16269. * Update the url (and optional buffer) of this texture if url was null during construction.
  16270. * @param url the url of the texture
  16271. * @param buffer the buffer of the texture (defaults to null)
  16272. * @param onLoad callback called when the texture is loaded (defaults to null)
  16273. */
  16274. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  16275. /**
  16276. * Finish the loading sequence of a texture flagged as delayed load.
  16277. * @hidden
  16278. */
  16279. delayLoad(): void;
  16280. private _prepareRowForTextureGeneration;
  16281. /**
  16282. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  16283. * @returns the transform matrix of the texture.
  16284. */
  16285. getTextureMatrix(): Matrix;
  16286. /**
  16287. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  16288. * @returns The reflection texture transform
  16289. */
  16290. getReflectionTextureMatrix(): Matrix;
  16291. /**
  16292. * Clones the texture.
  16293. * @returns the cloned texture
  16294. */
  16295. clone(): Texture;
  16296. /**
  16297. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  16298. * @returns The JSON representation of the texture
  16299. */
  16300. serialize(): any;
  16301. /**
  16302. * Get the current class name of the texture useful for serialization or dynamic coding.
  16303. * @returns "Texture"
  16304. */
  16305. getClassName(): string;
  16306. /**
  16307. * Dispose the texture and release its associated resources.
  16308. */
  16309. dispose(): void;
  16310. /**
  16311. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  16312. * @param parsedTexture Define the JSON representation of the texture
  16313. * @param scene Define the scene the parsed texture should be instantiated in
  16314. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  16315. * @returns The parsed texture if successful
  16316. */
  16317. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  16318. /**
  16319. * Creates a texture from its base 64 representation.
  16320. * @param data Define the base64 payload without the data: prefix
  16321. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  16322. * @param scene Define the scene the texture should belong to
  16323. * @param noMipmap Forces the texture to not create mip map information if true
  16324. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16325. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16326. * @param onLoad define a callback triggered when the texture has been loaded
  16327. * @param onError define a callback triggered when an error occurred during the loading session
  16328. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16329. * @returns the created texture
  16330. */
  16331. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  16332. /**
  16333. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  16334. * @param data Define the base64 payload without the data: prefix
  16335. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  16336. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  16337. * @param scene Define the scene the texture should belong to
  16338. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  16339. * @param noMipmap Forces the texture to not create mip map information if true
  16340. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16341. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16342. * @param onLoad define a callback triggered when the texture has been loaded
  16343. * @param onError define a callback triggered when an error occurred during the loading session
  16344. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16345. * @returns the created texture
  16346. */
  16347. static LoadFromDataString(name: string, buffer: any, scene: Scene, deleteBuffer?: boolean, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number): Texture;
  16348. }
  16349. }
  16350. declare module "babylonjs/PostProcesses/postProcessManager" {
  16351. import { Nullable } from "babylonjs/types";
  16352. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16353. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  16354. import { Scene } from "babylonjs/scene";
  16355. /**
  16356. * PostProcessManager is used to manage one or more post processes or post process pipelines
  16357. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  16358. */
  16359. export class PostProcessManager {
  16360. private _scene;
  16361. private _indexBuffer;
  16362. private _vertexBuffers;
  16363. /**
  16364. * Creates a new instance PostProcess
  16365. * @param scene The scene that the post process is associated with.
  16366. */
  16367. constructor(scene: Scene);
  16368. private _prepareBuffers;
  16369. private _buildIndexBuffer;
  16370. /**
  16371. * Rebuilds the vertex buffers of the manager.
  16372. * @hidden
  16373. */
  16374. _rebuild(): void;
  16375. /**
  16376. * Prepares a frame to be run through a post process.
  16377. * @param sourceTexture The input texture to the post procesess. (default: null)
  16378. * @param postProcesses An array of post processes to be run. (default: null)
  16379. * @returns True if the post processes were able to be run.
  16380. * @hidden
  16381. */
  16382. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  16383. /**
  16384. * Manually render a set of post processes to a texture.
  16385. * @param postProcesses An array of post processes to be run.
  16386. * @param targetTexture The target texture to render to.
  16387. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  16388. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  16389. * @param lodLevel defines which lod of the texture to render to
  16390. */
  16391. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  16392. /**
  16393. * Finalize the result of the output of the postprocesses.
  16394. * @param doNotPresent If true the result will not be displayed to the screen.
  16395. * @param targetTexture The target texture to render to.
  16396. * @param faceIndex The index of the face to bind the target texture to.
  16397. * @param postProcesses The array of post processes to render.
  16398. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  16399. * @hidden
  16400. */
  16401. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  16402. /**
  16403. * Disposes of the post process manager.
  16404. */
  16405. dispose(): void;
  16406. }
  16407. }
  16408. declare module "babylonjs/Misc/gradients" {
  16409. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16410. /** Interface used by value gradients (color, factor, ...) */
  16411. export interface IValueGradient {
  16412. /**
  16413. * Gets or sets the gradient value (between 0 and 1)
  16414. */
  16415. gradient: number;
  16416. }
  16417. /** Class used to store color4 gradient */
  16418. export class ColorGradient implements IValueGradient {
  16419. /**
  16420. * Gets or sets the gradient value (between 0 and 1)
  16421. */
  16422. gradient: number;
  16423. /**
  16424. * Gets or sets first associated color
  16425. */
  16426. color1: Color4;
  16427. /**
  16428. * Gets or sets second associated color
  16429. */
  16430. color2?: Color4;
  16431. /**
  16432. * Will get a color picked randomly between color1 and color2.
  16433. * If color2 is undefined then color1 will be used
  16434. * @param result defines the target Color4 to store the result in
  16435. */
  16436. getColorToRef(result: Color4): void;
  16437. }
  16438. /** Class used to store color 3 gradient */
  16439. export class Color3Gradient implements IValueGradient {
  16440. /**
  16441. * Gets or sets the gradient value (between 0 and 1)
  16442. */
  16443. gradient: number;
  16444. /**
  16445. * Gets or sets the associated color
  16446. */
  16447. color: Color3;
  16448. }
  16449. /** Class used to store factor gradient */
  16450. export class FactorGradient implements IValueGradient {
  16451. /**
  16452. * Gets or sets the gradient value (between 0 and 1)
  16453. */
  16454. gradient: number;
  16455. /**
  16456. * Gets or sets first associated factor
  16457. */
  16458. factor1: number;
  16459. /**
  16460. * Gets or sets second associated factor
  16461. */
  16462. factor2?: number;
  16463. /**
  16464. * Will get a number picked randomly between factor1 and factor2.
  16465. * If factor2 is undefined then factor1 will be used
  16466. * @returns the picked number
  16467. */
  16468. getFactor(): number;
  16469. }
  16470. /**
  16471. * Helper used to simplify some generic gradient tasks
  16472. */
  16473. export class GradientHelper {
  16474. /**
  16475. * Gets the current gradient from an array of IValueGradient
  16476. * @param ratio defines the current ratio to get
  16477. * @param gradients defines the array of IValueGradient
  16478. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  16479. */
  16480. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  16481. }
  16482. }
  16483. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  16484. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16485. import { Nullable } from "babylonjs/types";
  16486. module "babylonjs/Engines/thinEngine" {
  16487. interface ThinEngine {
  16488. /**
  16489. * Creates a dynamic texture
  16490. * @param width defines the width of the texture
  16491. * @param height defines the height of the texture
  16492. * @param generateMipMaps defines if the engine should generate the mip levels
  16493. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  16494. * @returns the dynamic texture inside an InternalTexture
  16495. */
  16496. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  16497. /**
  16498. * Update the content of a dynamic texture
  16499. * @param texture defines the texture to update
  16500. * @param canvas defines the canvas containing the source
  16501. * @param invertY defines if data must be stored with Y axis inverted
  16502. * @param premulAlpha defines if alpha is stored as premultiplied
  16503. * @param format defines the format of the data
  16504. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  16505. */
  16506. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  16507. }
  16508. }
  16509. }
  16510. declare module "babylonjs/Misc/canvasGenerator" {
  16511. /**
  16512. * Helper class used to generate a canvas to manipulate images
  16513. */
  16514. export class CanvasGenerator {
  16515. /**
  16516. * Create a new canvas (or offscreen canvas depending on the context)
  16517. * @param width defines the expected width
  16518. * @param height defines the expected height
  16519. * @return a new canvas or offscreen canvas
  16520. */
  16521. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  16522. }
  16523. }
  16524. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  16525. import { Scene } from "babylonjs/scene";
  16526. import { Texture } from "babylonjs/Materials/Textures/texture";
  16527. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  16528. /**
  16529. * A class extending Texture allowing drawing on a texture
  16530. * @see http://doc.babylonjs.com/how_to/dynamictexture
  16531. */
  16532. export class DynamicTexture extends Texture {
  16533. private _generateMipMaps;
  16534. private _canvas;
  16535. private _context;
  16536. private _engine;
  16537. /**
  16538. * Creates a DynamicTexture
  16539. * @param name defines the name of the texture
  16540. * @param options provides 3 alternatives for width and height of texture, a canvas, object with width and height properties, number for both width and height
  16541. * @param scene defines the scene where you want the texture
  16542. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  16543. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  16544. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  16545. */
  16546. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  16547. /**
  16548. * Get the current class name of the texture useful for serialization or dynamic coding.
  16549. * @returns "DynamicTexture"
  16550. */
  16551. getClassName(): string;
  16552. /**
  16553. * Gets the current state of canRescale
  16554. */
  16555. readonly canRescale: boolean;
  16556. private _recreate;
  16557. /**
  16558. * Scales the texture
  16559. * @param ratio the scale factor to apply to both width and height
  16560. */
  16561. scale(ratio: number): void;
  16562. /**
  16563. * Resizes the texture
  16564. * @param width the new width
  16565. * @param height the new height
  16566. */
  16567. scaleTo(width: number, height: number): void;
  16568. /**
  16569. * Gets the context of the canvas used by the texture
  16570. * @returns the canvas context of the dynamic texture
  16571. */
  16572. getContext(): CanvasRenderingContext2D;
  16573. /**
  16574. * Clears the texture
  16575. */
  16576. clear(): void;
  16577. /**
  16578. * Updates the texture
  16579. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  16580. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  16581. */
  16582. update(invertY?: boolean, premulAlpha?: boolean): void;
  16583. /**
  16584. * Draws text onto the texture
  16585. * @param text defines the text to be drawn
  16586. * @param x defines the placement of the text from the left
  16587. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  16588. * @param font defines the font to be used with font-style, font-size, font-name
  16589. * @param color defines the color used for the text
  16590. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  16591. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  16592. * @param update defines whether texture is immediately update (default is true)
  16593. */
  16594. drawText(text: string, x: number, y: number, font: string, color: string, clearColor: string, invertY?: boolean, update?: boolean): void;
  16595. /**
  16596. * Clones the texture
  16597. * @returns the clone of the texture.
  16598. */
  16599. clone(): DynamicTexture;
  16600. /**
  16601. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  16602. * @returns a serialized dynamic texture object
  16603. */
  16604. serialize(): any;
  16605. /** @hidden */
  16606. _rebuild(): void;
  16607. }
  16608. }
  16609. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  16610. import { Scene } from "babylonjs/scene";
  16611. import { ISceneComponent } from "babylonjs/sceneComponent";
  16612. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  16613. module "babylonjs/abstractScene" {
  16614. interface AbstractScene {
  16615. /**
  16616. * The list of procedural textures added to the scene
  16617. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16618. */
  16619. proceduralTextures: Array<ProceduralTexture>;
  16620. }
  16621. }
  16622. /**
  16623. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  16624. * in a given scene.
  16625. */
  16626. export class ProceduralTextureSceneComponent implements ISceneComponent {
  16627. /**
  16628. * The component name helpfull to identify the component in the list of scene components.
  16629. */
  16630. readonly name: string;
  16631. /**
  16632. * The scene the component belongs to.
  16633. */
  16634. scene: Scene;
  16635. /**
  16636. * Creates a new instance of the component for the given scene
  16637. * @param scene Defines the scene to register the component in
  16638. */
  16639. constructor(scene: Scene);
  16640. /**
  16641. * Registers the component in a given scene
  16642. */
  16643. register(): void;
  16644. /**
  16645. * Rebuilds the elements related to this component in case of
  16646. * context lost for instance.
  16647. */
  16648. rebuild(): void;
  16649. /**
  16650. * Disposes the component and the associated ressources.
  16651. */
  16652. dispose(): void;
  16653. private _beforeClear;
  16654. }
  16655. }
  16656. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  16657. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16658. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  16659. module "babylonjs/Engines/thinEngine" {
  16660. interface ThinEngine {
  16661. /**
  16662. * Creates a new render target cube texture
  16663. * @param size defines the size of the texture
  16664. * @param options defines the options used to create the texture
  16665. * @returns a new render target cube texture stored in an InternalTexture
  16666. */
  16667. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  16668. }
  16669. }
  16670. }
  16671. declare module "babylonjs/Shaders/procedural.vertex" {
  16672. /** @hidden */
  16673. export var proceduralVertexShader: {
  16674. name: string;
  16675. shader: string;
  16676. };
  16677. }
  16678. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  16679. import { Observable } from "babylonjs/Misc/observable";
  16680. import { Nullable } from "babylonjs/types";
  16681. import { Scene } from "babylonjs/scene";
  16682. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  16683. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  16684. import { Effect } from "babylonjs/Materials/effect";
  16685. import { Texture } from "babylonjs/Materials/Textures/texture";
  16686. import "babylonjs/Engines/Extensions/engine.renderTarget";
  16687. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  16688. import "babylonjs/Shaders/procedural.vertex";
  16689. /**
  16690. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes calmpler' images.
  16691. * This is the base class of any Procedural texture and contains most of the shareable code.
  16692. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16693. */
  16694. export class ProceduralTexture extends Texture {
  16695. isCube: boolean;
  16696. /**
  16697. * Define if the texture is enabled or not (disabled texture will not render)
  16698. */
  16699. isEnabled: boolean;
  16700. /**
  16701. * Define if the texture must be cleared before rendering (default is true)
  16702. */
  16703. autoClear: boolean;
  16704. /**
  16705. * Callback called when the texture is generated
  16706. */
  16707. onGenerated: () => void;
  16708. /**
  16709. * Event raised when the texture is generated
  16710. */
  16711. onGeneratedObservable: Observable<ProceduralTexture>;
  16712. /** @hidden */
  16713. _generateMipMaps: boolean;
  16714. /** @hidden **/
  16715. _effect: Effect;
  16716. /** @hidden */
  16717. _textures: {
  16718. [key: string]: Texture;
  16719. };
  16720. private _size;
  16721. private _currentRefreshId;
  16722. private _refreshRate;
  16723. private _vertexBuffers;
  16724. private _indexBuffer;
  16725. private _uniforms;
  16726. private _samplers;
  16727. private _fragment;
  16728. private _floats;
  16729. private _ints;
  16730. private _floatsArrays;
  16731. private _colors3;
  16732. private _colors4;
  16733. private _vectors2;
  16734. private _vectors3;
  16735. private _matrices;
  16736. private _fallbackTexture;
  16737. private _fallbackTextureUsed;
  16738. private _engine;
  16739. private _cachedDefines;
  16740. private _contentUpdateId;
  16741. private _contentData;
  16742. /**
  16743. * Instantiates a new procedural texture.
  16744. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes called 'refMaps' or 'sampler' images.
  16745. * This is the base class of any Procedural texture and contains most of the shareable code.
  16746. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16747. * @param name Define the name of the texture
  16748. * @param size Define the size of the texture to create
  16749. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  16750. * @param scene Define the scene the texture belongs to
  16751. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  16752. * @param generateMipMaps Define if the texture should creates mip maps or not
  16753. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  16754. */
  16755. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  16756. /**
  16757. * The effect that is created when initializing the post process.
  16758. * @returns The created effect corresponding the the postprocess.
  16759. */
  16760. getEffect(): Effect;
  16761. /**
  16762. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  16763. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  16764. */
  16765. getContent(): Nullable<ArrayBufferView>;
  16766. private _createIndexBuffer;
  16767. /** @hidden */
  16768. _rebuild(): void;
  16769. /**
  16770. * Resets the texture in order to recreate its associated resources.
  16771. * This can be called in case of context loss
  16772. */
  16773. reset(): void;
  16774. protected _getDefines(): string;
  16775. /**
  16776. * Is the texture ready to be used ? (rendered at least once)
  16777. * @returns true if ready, otherwise, false.
  16778. */
  16779. isReady(): boolean;
  16780. /**
  16781. * Resets the refresh counter of the texture and start bak from scratch.
  16782. * Could be useful to regenerate the texture if it is setup to render only once.
  16783. */
  16784. resetRefreshCounter(): void;
  16785. /**
  16786. * Set the fragment shader to use in order to render the texture.
  16787. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  16788. */
  16789. setFragment(fragment: any): void;
  16790. /**
  16791. * Define the refresh rate of the texture or the rendering frequency.
  16792. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  16793. */
  16794. refreshRate: number;
  16795. /** @hidden */
  16796. _shouldRender(): boolean;
  16797. /**
  16798. * Get the size the texture is rendering at.
  16799. * @returns the size (texture is always squared)
  16800. */
  16801. getRenderSize(): number;
  16802. /**
  16803. * Resize the texture to new value.
  16804. * @param size Define the new size the texture should have
  16805. * @param generateMipMaps Define whether the new texture should create mip maps
  16806. */
  16807. resize(size: number, generateMipMaps: boolean): void;
  16808. private _checkUniform;
  16809. /**
  16810. * Set a texture in the shader program used to render.
  16811. * @param name Define the name of the uniform samplers as defined in the shader
  16812. * @param texture Define the texture to bind to this sampler
  16813. * @return the texture itself allowing "fluent" like uniform updates
  16814. */
  16815. setTexture(name: string, texture: Texture): ProceduralTexture;
  16816. /**
  16817. * Set a float in the shader.
  16818. * @param name Define the name of the uniform as defined in the shader
  16819. * @param value Define the value to give to the uniform
  16820. * @return the texture itself allowing "fluent" like uniform updates
  16821. */
  16822. setFloat(name: string, value: number): ProceduralTexture;
  16823. /**
  16824. * Set a int in the shader.
  16825. * @param name Define the name of the uniform as defined in the shader
  16826. * @param value Define the value to give to the uniform
  16827. * @return the texture itself allowing "fluent" like uniform updates
  16828. */
  16829. setInt(name: string, value: number): ProceduralTexture;
  16830. /**
  16831. * Set an array of floats in the shader.
  16832. * @param name Define the name of the uniform as defined in the shader
  16833. * @param value Define the value to give to the uniform
  16834. * @return the texture itself allowing "fluent" like uniform updates
  16835. */
  16836. setFloats(name: string, value: number[]): ProceduralTexture;
  16837. /**
  16838. * Set a vec3 in the shader from a Color3.
  16839. * @param name Define the name of the uniform as defined in the shader
  16840. * @param value Define the value to give to the uniform
  16841. * @return the texture itself allowing "fluent" like uniform updates
  16842. */
  16843. setColor3(name: string, value: Color3): ProceduralTexture;
  16844. /**
  16845. * Set a vec4 in the shader from a Color4.
  16846. * @param name Define the name of the uniform as defined in the shader
  16847. * @param value Define the value to give to the uniform
  16848. * @return the texture itself allowing "fluent" like uniform updates
  16849. */
  16850. setColor4(name: string, value: Color4): ProceduralTexture;
  16851. /**
  16852. * Set a vec2 in the shader from a Vector2.
  16853. * @param name Define the name of the uniform as defined in the shader
  16854. * @param value Define the value to give to the uniform
  16855. * @return the texture itself allowing "fluent" like uniform updates
  16856. */
  16857. setVector2(name: string, value: Vector2): ProceduralTexture;
  16858. /**
  16859. * Set a vec3 in the shader from a Vector3.
  16860. * @param name Define the name of the uniform as defined in the shader
  16861. * @param value Define the value to give to the uniform
  16862. * @return the texture itself allowing "fluent" like uniform updates
  16863. */
  16864. setVector3(name: string, value: Vector3): ProceduralTexture;
  16865. /**
  16866. * Set a mat4 in the shader from a MAtrix.
  16867. * @param name Define the name of the uniform as defined in the shader
  16868. * @param value Define the value to give to the uniform
  16869. * @return the texture itself allowing "fluent" like uniform updates
  16870. */
  16871. setMatrix(name: string, value: Matrix): ProceduralTexture;
  16872. /**
  16873. * Render the texture to its associated render target.
  16874. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  16875. */
  16876. render(useCameraPostProcess?: boolean): void;
  16877. /**
  16878. * Clone the texture.
  16879. * @returns the cloned texture
  16880. */
  16881. clone(): ProceduralTexture;
  16882. /**
  16883. * Dispose the texture and release its asoociated resources.
  16884. */
  16885. dispose(): void;
  16886. }
  16887. }
  16888. declare module "babylonjs/Particles/baseParticleSystem" {
  16889. import { Nullable } from "babylonjs/types";
  16890. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  16891. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16892. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  16893. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  16894. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16895. import { Scene } from "babylonjs/scene";
  16896. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  16897. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  16898. import { Texture } from "babylonjs/Materials/Textures/texture";
  16899. import { Color4 } from "babylonjs/Maths/math.color";
  16900. import { Animation } from "babylonjs/Animations/animation";
  16901. /**
  16902. * This represents the base class for particle system in Babylon.
  16903. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  16904. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  16905. * @example https://doc.babylonjs.com/babylon101/particles
  16906. */
  16907. export class BaseParticleSystem {
  16908. /**
  16909. * Source color is added to the destination color without alpha affecting the result
  16910. */
  16911. static BLENDMODE_ONEONE: number;
  16912. /**
  16913. * Blend current color and particle color using particle’s alpha
  16914. */
  16915. static BLENDMODE_STANDARD: number;
  16916. /**
  16917. * Add current color and particle color multiplied by particle’s alpha
  16918. */
  16919. static BLENDMODE_ADD: number;
  16920. /**
  16921. * Multiply current color with particle color
  16922. */
  16923. static BLENDMODE_MULTIPLY: number;
  16924. /**
  16925. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  16926. */
  16927. static BLENDMODE_MULTIPLYADD: number;
  16928. /**
  16929. * List of animations used by the particle system.
  16930. */
  16931. animations: Animation[];
  16932. /**
  16933. * The id of the Particle system.
  16934. */
  16935. id: string;
  16936. /**
  16937. * The friendly name of the Particle system.
  16938. */
  16939. name: string;
  16940. /**
  16941. * The rendering group used by the Particle system to chose when to render.
  16942. */
  16943. renderingGroupId: number;
  16944. /**
  16945. * The emitter represents the Mesh or position we are attaching the particle system to.
  16946. */
  16947. emitter: Nullable<AbstractMesh | Vector3>;
  16948. /**
  16949. * The maximum number of particles to emit per frame
  16950. */
  16951. emitRate: number;
  16952. /**
  16953. * If you want to launch only a few particles at once, that can be done, as well.
  16954. */
  16955. manualEmitCount: number;
  16956. /**
  16957. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  16958. */
  16959. updateSpeed: number;
  16960. /**
  16961. * The amount of time the particle system is running (depends of the overall update speed).
  16962. */
  16963. targetStopDuration: number;
  16964. /**
  16965. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  16966. */
  16967. disposeOnStop: boolean;
  16968. /**
  16969. * Minimum power of emitting particles.
  16970. */
  16971. minEmitPower: number;
  16972. /**
  16973. * Maximum power of emitting particles.
  16974. */
  16975. maxEmitPower: number;
  16976. /**
  16977. * Minimum life time of emitting particles.
  16978. */
  16979. minLifeTime: number;
  16980. /**
  16981. * Maximum life time of emitting particles.
  16982. */
  16983. maxLifeTime: number;
  16984. /**
  16985. * Minimum Size of emitting particles.
  16986. */
  16987. minSize: number;
  16988. /**
  16989. * Maximum Size of emitting particles.
  16990. */
  16991. maxSize: number;
  16992. /**
  16993. * Minimum scale of emitting particles on X axis.
  16994. */
  16995. minScaleX: number;
  16996. /**
  16997. * Maximum scale of emitting particles on X axis.
  16998. */
  16999. maxScaleX: number;
  17000. /**
  17001. * Minimum scale of emitting particles on Y axis.
  17002. */
  17003. minScaleY: number;
  17004. /**
  17005. * Maximum scale of emitting particles on Y axis.
  17006. */
  17007. maxScaleY: number;
  17008. /**
  17009. * Gets or sets the minimal initial rotation in radians.
  17010. */
  17011. minInitialRotation: number;
  17012. /**
  17013. * Gets or sets the maximal initial rotation in radians.
  17014. */
  17015. maxInitialRotation: number;
  17016. /**
  17017. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  17018. */
  17019. minAngularSpeed: number;
  17020. /**
  17021. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  17022. */
  17023. maxAngularSpeed: number;
  17024. /**
  17025. * The texture used to render each particle. (this can be a spritesheet)
  17026. */
  17027. particleTexture: Nullable<Texture>;
  17028. /**
  17029. * The layer mask we are rendering the particles through.
  17030. */
  17031. layerMask: number;
  17032. /**
  17033. * This can help using your own shader to render the particle system.
  17034. * The according effect will be created
  17035. */
  17036. customShader: any;
  17037. /**
  17038. * By default particle system starts as soon as they are created. This prevents the
  17039. * automatic start to happen and let you decide when to start emitting particles.
  17040. */
  17041. preventAutoStart: boolean;
  17042. private _noiseTexture;
  17043. /**
  17044. * Gets or sets a texture used to add random noise to particle positions
  17045. */
  17046. noiseTexture: Nullable<ProceduralTexture>;
  17047. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  17048. noiseStrength: Vector3;
  17049. /**
  17050. * Callback triggered when the particle animation is ending.
  17051. */
  17052. onAnimationEnd: Nullable<() => void>;
  17053. /**
  17054. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  17055. */
  17056. blendMode: number;
  17057. /**
  17058. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  17059. * to override the particles.
  17060. */
  17061. forceDepthWrite: boolean;
  17062. /** Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0 */
  17063. preWarmCycles: number;
  17064. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  17065. preWarmStepOffset: number;
  17066. /**
  17067. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  17068. */
  17069. spriteCellChangeSpeed: number;
  17070. /**
  17071. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  17072. */
  17073. startSpriteCellID: number;
  17074. /**
  17075. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  17076. */
  17077. endSpriteCellID: number;
  17078. /**
  17079. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  17080. */
  17081. spriteCellWidth: number;
  17082. /**
  17083. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  17084. */
  17085. spriteCellHeight: number;
  17086. /**
  17087. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  17088. */
  17089. spriteRandomStartCell: boolean;
  17090. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  17091. translationPivot: Vector2;
  17092. /** @hidden */
  17093. protected _isAnimationSheetEnabled: boolean;
  17094. /**
  17095. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  17096. */
  17097. beginAnimationOnStart: boolean;
  17098. /**
  17099. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  17100. */
  17101. beginAnimationFrom: number;
  17102. /**
  17103. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  17104. */
  17105. beginAnimationTo: number;
  17106. /**
  17107. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  17108. */
  17109. beginAnimationLoop: boolean;
  17110. /**
  17111. * Gets or sets a world offset applied to all particles
  17112. */
  17113. worldOffset: Vector3;
  17114. /**
  17115. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  17116. */
  17117. isAnimationSheetEnabled: boolean;
  17118. /**
  17119. * Get hosting scene
  17120. * @returns the scene
  17121. */
  17122. getScene(): Scene;
  17123. /**
  17124. * You can use gravity if you want to give an orientation to your particles.
  17125. */
  17126. gravity: Vector3;
  17127. protected _colorGradients: Nullable<Array<ColorGradient>>;
  17128. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  17129. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  17130. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  17131. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  17132. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  17133. protected _dragGradients: Nullable<Array<FactorGradient>>;
  17134. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  17135. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  17136. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  17137. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  17138. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  17139. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  17140. /**
  17141. * Defines the delay in milliseconds before starting the system (0 by default)
  17142. */
  17143. startDelay: number;
  17144. /**
  17145. * Gets the current list of drag gradients.
  17146. * You must use addDragGradient and removeDragGradient to udpate this list
  17147. * @returns the list of drag gradients
  17148. */
  17149. getDragGradients(): Nullable<Array<FactorGradient>>;
  17150. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  17151. limitVelocityDamping: number;
  17152. /**
  17153. * Gets the current list of limit velocity gradients.
  17154. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  17155. * @returns the list of limit velocity gradients
  17156. */
  17157. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  17158. /**
  17159. * Gets the current list of color gradients.
  17160. * You must use addColorGradient and removeColorGradient to udpate this list
  17161. * @returns the list of color gradients
  17162. */
  17163. getColorGradients(): Nullable<Array<ColorGradient>>;
  17164. /**
  17165. * Gets the current list of size gradients.
  17166. * You must use addSizeGradient and removeSizeGradient to udpate this list
  17167. * @returns the list of size gradients
  17168. */
  17169. getSizeGradients(): Nullable<Array<FactorGradient>>;
  17170. /**
  17171. * Gets the current list of color remap gradients.
  17172. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  17173. * @returns the list of color remap gradients
  17174. */
  17175. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  17176. /**
  17177. * Gets the current list of alpha remap gradients.
  17178. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  17179. * @returns the list of alpha remap gradients
  17180. */
  17181. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  17182. /**
  17183. * Gets the current list of life time gradients.
  17184. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  17185. * @returns the list of life time gradients
  17186. */
  17187. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  17188. /**
  17189. * Gets the current list of angular speed gradients.
  17190. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  17191. * @returns the list of angular speed gradients
  17192. */
  17193. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  17194. /**
  17195. * Gets the current list of velocity gradients.
  17196. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  17197. * @returns the list of velocity gradients
  17198. */
  17199. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  17200. /**
  17201. * Gets the current list of start size gradients.
  17202. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  17203. * @returns the list of start size gradients
  17204. */
  17205. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  17206. /**
  17207. * Gets the current list of emit rate gradients.
  17208. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  17209. * @returns the list of emit rate gradients
  17210. */
  17211. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  17212. /**
  17213. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  17214. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17215. */
  17216. direction1: Vector3;
  17217. /**
  17218. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  17219. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17220. */
  17221. direction2: Vector3;
  17222. /**
  17223. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  17224. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17225. */
  17226. minEmitBox: Vector3;
  17227. /**
  17228. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  17229. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17230. */
  17231. maxEmitBox: Vector3;
  17232. /**
  17233. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  17234. */
  17235. color1: Color4;
  17236. /**
  17237. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  17238. */
  17239. color2: Color4;
  17240. /**
  17241. * Color the particle will have at the end of its lifetime
  17242. */
  17243. colorDead: Color4;
  17244. /**
  17245. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  17246. */
  17247. textureMask: Color4;
  17248. /**
  17249. * The particle emitter type defines the emitter used by the particle system.
  17250. * It can be for example box, sphere, or cone...
  17251. */
  17252. particleEmitterType: IParticleEmitterType;
  17253. /** @hidden */
  17254. _isSubEmitter: boolean;
  17255. /**
  17256. * Gets or sets the billboard mode to use when isBillboardBased = true.
  17257. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  17258. */
  17259. billboardMode: number;
  17260. protected _isBillboardBased: boolean;
  17261. /**
  17262. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  17263. */
  17264. isBillboardBased: boolean;
  17265. /**
  17266. * The scene the particle system belongs to.
  17267. */
  17268. protected _scene: Scene;
  17269. /**
  17270. * Local cache of defines for image processing.
  17271. */
  17272. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  17273. /**
  17274. * Default configuration related to image processing available in the standard Material.
  17275. */
  17276. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  17277. /**
  17278. * Gets the image processing configuration used either in this material.
  17279. */
  17280. /**
  17281. * Sets the Default image processing configuration used either in the this material.
  17282. *
  17283. * If sets to null, the scene one is in use.
  17284. */
  17285. imageProcessingConfiguration: ImageProcessingConfiguration;
  17286. /**
  17287. * Attaches a new image processing configuration to the Standard Material.
  17288. * @param configuration
  17289. */
  17290. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  17291. /** @hidden */
  17292. protected _reset(): void;
  17293. /** @hidden */
  17294. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  17295. /**
  17296. * Instantiates a particle system.
  17297. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  17298. * @param name The name of the particle system
  17299. */
  17300. constructor(name: string);
  17301. /**
  17302. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  17303. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  17304. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  17305. * @returns the emitter
  17306. */
  17307. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  17308. /**
  17309. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  17310. * @param radius The radius of the hemisphere to emit from
  17311. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  17312. * @returns the emitter
  17313. */
  17314. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  17315. /**
  17316. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  17317. * @param radius The radius of the sphere to emit from
  17318. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  17319. * @returns the emitter
  17320. */
  17321. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  17322. /**
  17323. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  17324. * @param radius The radius of the sphere to emit from
  17325. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  17326. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  17327. * @returns the emitter
  17328. */
  17329. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  17330. /**
  17331. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  17332. * @param radius The radius of the emission cylinder
  17333. * @param height The height of the emission cylinder
  17334. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  17335. * @param directionRandomizer How much to randomize the particle direction [0-1]
  17336. * @returns the emitter
  17337. */
  17338. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  17339. /**
  17340. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  17341. * @param radius The radius of the cylinder to emit from
  17342. * @param height The height of the emission cylinder
  17343. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  17344. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  17345. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  17346. * @returns the emitter
  17347. */
  17348. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  17349. /**
  17350. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  17351. * @param radius The radius of the cone to emit from
  17352. * @param angle The base angle of the cone
  17353. * @returns the emitter
  17354. */
  17355. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  17356. /**
  17357. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  17358. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  17359. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  17360. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17361. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17362. * @returns the emitter
  17363. */
  17364. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  17365. }
  17366. }
  17367. declare module "babylonjs/Particles/subEmitter" {
  17368. import { Scene } from "babylonjs/scene";
  17369. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  17370. /**
  17371. * Type of sub emitter
  17372. */
  17373. export enum SubEmitterType {
  17374. /**
  17375. * Attached to the particle over it's lifetime
  17376. */
  17377. ATTACHED = 0,
  17378. /**
  17379. * Created when the particle dies
  17380. */
  17381. END = 1
  17382. }
  17383. /**
  17384. * Sub emitter class used to emit particles from an existing particle
  17385. */
  17386. export class SubEmitter {
  17387. /**
  17388. * the particle system to be used by the sub emitter
  17389. */
  17390. particleSystem: ParticleSystem;
  17391. /**
  17392. * Type of the submitter (Default: END)
  17393. */
  17394. type: SubEmitterType;
  17395. /**
  17396. * If the particle should inherit the direction from the particle it's attached to. (+Y will face the direction the particle is moving) (Default: false)
  17397. * Note: This only is supported when using an emitter of type Mesh
  17398. */
  17399. inheritDirection: boolean;
  17400. /**
  17401. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  17402. */
  17403. inheritedVelocityAmount: number;
  17404. /**
  17405. * Creates a sub emitter
  17406. * @param particleSystem the particle system to be used by the sub emitter
  17407. */
  17408. constructor(
  17409. /**
  17410. * the particle system to be used by the sub emitter
  17411. */
  17412. particleSystem: ParticleSystem);
  17413. /**
  17414. * Clones the sub emitter
  17415. * @returns the cloned sub emitter
  17416. */
  17417. clone(): SubEmitter;
  17418. /**
  17419. * Serialize current object to a JSON object
  17420. * @returns the serialized object
  17421. */
  17422. serialize(): any;
  17423. /** @hidden */
  17424. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  17425. /**
  17426. * Creates a new SubEmitter from a serialized JSON version
  17427. * @param serializationObject defines the JSON object to read from
  17428. * @param scene defines the hosting scene
  17429. * @param rootUrl defines the rootUrl for data loading
  17430. * @returns a new SubEmitter
  17431. */
  17432. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  17433. /** Release associated resources */
  17434. dispose(): void;
  17435. }
  17436. }
  17437. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  17438. /** @hidden */
  17439. export var clipPlaneFragmentDeclaration: {
  17440. name: string;
  17441. shader: string;
  17442. };
  17443. }
  17444. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  17445. /** @hidden */
  17446. export var imageProcessingDeclaration: {
  17447. name: string;
  17448. shader: string;
  17449. };
  17450. }
  17451. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  17452. /** @hidden */
  17453. export var imageProcessingFunctions: {
  17454. name: string;
  17455. shader: string;
  17456. };
  17457. }
  17458. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  17459. /** @hidden */
  17460. export var clipPlaneFragment: {
  17461. name: string;
  17462. shader: string;
  17463. };
  17464. }
  17465. declare module "babylonjs/Shaders/particles.fragment" {
  17466. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17467. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  17468. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  17469. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  17470. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17471. /** @hidden */
  17472. export var particlesPixelShader: {
  17473. name: string;
  17474. shader: string;
  17475. };
  17476. }
  17477. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  17478. /** @hidden */
  17479. export var clipPlaneVertexDeclaration: {
  17480. name: string;
  17481. shader: string;
  17482. };
  17483. }
  17484. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  17485. /** @hidden */
  17486. export var clipPlaneVertex: {
  17487. name: string;
  17488. shader: string;
  17489. };
  17490. }
  17491. declare module "babylonjs/Shaders/particles.vertex" {
  17492. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17493. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17494. /** @hidden */
  17495. export var particlesVertexShader: {
  17496. name: string;
  17497. shader: string;
  17498. };
  17499. }
  17500. declare module "babylonjs/Particles/particleSystem" {
  17501. import { Nullable } from "babylonjs/types";
  17502. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  17503. import { Observable } from "babylonjs/Misc/observable";
  17504. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17505. import { Effect } from "babylonjs/Materials/effect";
  17506. import { Scene, IDisposable } from "babylonjs/scene";
  17507. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17508. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  17509. import { Particle } from "babylonjs/Particles/particle";
  17510. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  17511. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  17512. import "babylonjs/Shaders/particles.fragment";
  17513. import "babylonjs/Shaders/particles.vertex";
  17514. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  17515. /**
  17516. * This represents a particle system in Babylon.
  17517. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  17518. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  17519. * @example https://doc.babylonjs.com/babylon101/particles
  17520. */
  17521. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  17522. /**
  17523. * Billboard mode will only apply to Y axis
  17524. */
  17525. static readonly BILLBOARDMODE_Y: number;
  17526. /**
  17527. * Billboard mode will apply to all axes
  17528. */
  17529. static readonly BILLBOARDMODE_ALL: number;
  17530. /**
  17531. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  17532. */
  17533. static readonly BILLBOARDMODE_STRETCHED: number;
  17534. /**
  17535. * This function can be defined to provide custom update for active particles.
  17536. * This function will be called instead of regular update (age, position, color, etc.).
  17537. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  17538. */
  17539. updateFunction: (particles: Particle[]) => void;
  17540. private _emitterWorldMatrix;
  17541. /**
  17542. * This function can be defined to specify initial direction for every new particle.
  17543. * It by default use the emitterType defined function
  17544. */
  17545. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void;
  17546. /**
  17547. * This function can be defined to specify initial position for every new particle.
  17548. * It by default use the emitterType defined function
  17549. */
  17550. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void;
  17551. /**
  17552. * @hidden
  17553. */
  17554. _inheritedVelocityOffset: Vector3;
  17555. /**
  17556. * An event triggered when the system is disposed
  17557. */
  17558. onDisposeObservable: Observable<ParticleSystem>;
  17559. private _onDisposeObserver;
  17560. /**
  17561. * Sets a callback that will be triggered when the system is disposed
  17562. */
  17563. onDispose: () => void;
  17564. private _particles;
  17565. private _epsilon;
  17566. private _capacity;
  17567. private _stockParticles;
  17568. private _newPartsExcess;
  17569. private _vertexData;
  17570. private _vertexBuffer;
  17571. private _vertexBuffers;
  17572. private _spriteBuffer;
  17573. private _indexBuffer;
  17574. private _effect;
  17575. private _customEffect;
  17576. private _cachedDefines;
  17577. private _scaledColorStep;
  17578. private _colorDiff;
  17579. private _scaledDirection;
  17580. private _scaledGravity;
  17581. private _currentRenderId;
  17582. private _alive;
  17583. private _useInstancing;
  17584. private _started;
  17585. private _stopped;
  17586. private _actualFrame;
  17587. private _scaledUpdateSpeed;
  17588. private _vertexBufferSize;
  17589. /** @hidden */
  17590. _currentEmitRateGradient: Nullable<FactorGradient>;
  17591. /** @hidden */
  17592. _currentEmitRate1: number;
  17593. /** @hidden */
  17594. _currentEmitRate2: number;
  17595. /** @hidden */
  17596. _currentStartSizeGradient: Nullable<FactorGradient>;
  17597. /** @hidden */
  17598. _currentStartSize1: number;
  17599. /** @hidden */
  17600. _currentStartSize2: number;
  17601. private readonly _rawTextureWidth;
  17602. private _rampGradientsTexture;
  17603. private _useRampGradients;
  17604. /** Gets or sets a boolean indicating that ramp gradients must be used
  17605. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  17606. */
  17607. useRampGradients: boolean;
  17608. /**
  17609. * The Sub-emitters templates that will be used to generate the sub particle system to be associated with the system, this property is used by the root particle system only.
  17610. * When a particle is spawned, an array will be chosen at random and all the emitters in that array will be attached to the particle. (Default: [])
  17611. */
  17612. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  17613. private _subEmitters;
  17614. /**
  17615. * @hidden
  17616. * If the particle systems emitter should be disposed when the particle system is disposed
  17617. */
  17618. _disposeEmitterOnDispose: boolean;
  17619. /**
  17620. * The current active Sub-systems, this property is used by the root particle system only.
  17621. */
  17622. activeSubSystems: Array<ParticleSystem>;
  17623. private _rootParticleSystem;
  17624. /**
  17625. * Gets the current list of active particles
  17626. */
  17627. readonly particles: Particle[];
  17628. /**
  17629. * Returns the string "ParticleSystem"
  17630. * @returns a string containing the class name
  17631. */
  17632. getClassName(): string;
  17633. /**
  17634. * Instantiates a particle system.
  17635. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  17636. * @param name The name of the particle system
  17637. * @param capacity The max number of particles alive at the same time
  17638. * @param scene The scene the particle system belongs to
  17639. * @param customEffect a custom effect used to change the way particles are rendered by default
  17640. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  17641. * @param epsilon Offset used to render the particles
  17642. */
  17643. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  17644. private _addFactorGradient;
  17645. private _removeFactorGradient;
  17646. /**
  17647. * Adds a new life time gradient
  17648. * @param gradient defines the gradient to use (between 0 and 1)
  17649. * @param factor defines the life time factor to affect to the specified gradient
  17650. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17651. * @returns the current particle system
  17652. */
  17653. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17654. /**
  17655. * Remove a specific life time gradient
  17656. * @param gradient defines the gradient to remove
  17657. * @returns the current particle system
  17658. */
  17659. removeLifeTimeGradient(gradient: number): IParticleSystem;
  17660. /**
  17661. * Adds a new size gradient
  17662. * @param gradient defines the gradient to use (between 0 and 1)
  17663. * @param factor defines the size factor to affect to the specified gradient
  17664. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17665. * @returns the current particle system
  17666. */
  17667. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17668. /**
  17669. * Remove a specific size gradient
  17670. * @param gradient defines the gradient to remove
  17671. * @returns the current particle system
  17672. */
  17673. removeSizeGradient(gradient: number): IParticleSystem;
  17674. /**
  17675. * Adds a new color remap gradient
  17676. * @param gradient defines the gradient to use (between 0 and 1)
  17677. * @param min defines the color remap minimal range
  17678. * @param max defines the color remap maximal range
  17679. * @returns the current particle system
  17680. */
  17681. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  17682. /**
  17683. * Remove a specific color remap gradient
  17684. * @param gradient defines the gradient to remove
  17685. * @returns the current particle system
  17686. */
  17687. removeColorRemapGradient(gradient: number): IParticleSystem;
  17688. /**
  17689. * Adds a new alpha remap gradient
  17690. * @param gradient defines the gradient to use (between 0 and 1)
  17691. * @param min defines the alpha remap minimal range
  17692. * @param max defines the alpha remap maximal range
  17693. * @returns the current particle system
  17694. */
  17695. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  17696. /**
  17697. * Remove a specific alpha remap gradient
  17698. * @param gradient defines the gradient to remove
  17699. * @returns the current particle system
  17700. */
  17701. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  17702. /**
  17703. * Adds a new angular speed gradient
  17704. * @param gradient defines the gradient to use (between 0 and 1)
  17705. * @param factor defines the angular speed to affect to the specified gradient
  17706. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17707. * @returns the current particle system
  17708. */
  17709. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17710. /**
  17711. * Remove a specific angular speed gradient
  17712. * @param gradient defines the gradient to remove
  17713. * @returns the current particle system
  17714. */
  17715. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  17716. /**
  17717. * Adds a new velocity gradient
  17718. * @param gradient defines the gradient to use (between 0 and 1)
  17719. * @param factor defines the velocity to affect to the specified gradient
  17720. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17721. * @returns the current particle system
  17722. */
  17723. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17724. /**
  17725. * Remove a specific velocity gradient
  17726. * @param gradient defines the gradient to remove
  17727. * @returns the current particle system
  17728. */
  17729. removeVelocityGradient(gradient: number): IParticleSystem;
  17730. /**
  17731. * Adds a new limit velocity gradient
  17732. * @param gradient defines the gradient to use (between 0 and 1)
  17733. * @param factor defines the limit velocity value to affect to the specified gradient
  17734. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17735. * @returns the current particle system
  17736. */
  17737. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17738. /**
  17739. * Remove a specific limit velocity gradient
  17740. * @param gradient defines the gradient to remove
  17741. * @returns the current particle system
  17742. */
  17743. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  17744. /**
  17745. * Adds a new drag gradient
  17746. * @param gradient defines the gradient to use (between 0 and 1)
  17747. * @param factor defines the drag value to affect to the specified gradient
  17748. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17749. * @returns the current particle system
  17750. */
  17751. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17752. /**
  17753. * Remove a specific drag gradient
  17754. * @param gradient defines the gradient to remove
  17755. * @returns the current particle system
  17756. */
  17757. removeDragGradient(gradient: number): IParticleSystem;
  17758. /**
  17759. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  17760. * @param gradient defines the gradient to use (between 0 and 1)
  17761. * @param factor defines the emit rate value to affect to the specified gradient
  17762. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17763. * @returns the current particle system
  17764. */
  17765. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17766. /**
  17767. * Remove a specific emit rate gradient
  17768. * @param gradient defines the gradient to remove
  17769. * @returns the current particle system
  17770. */
  17771. removeEmitRateGradient(gradient: number): IParticleSystem;
  17772. /**
  17773. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  17774. * @param gradient defines the gradient to use (between 0 and 1)
  17775. * @param factor defines the start size value to affect to the specified gradient
  17776. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17777. * @returns the current particle system
  17778. */
  17779. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17780. /**
  17781. * Remove a specific start size gradient
  17782. * @param gradient defines the gradient to remove
  17783. * @returns the current particle system
  17784. */
  17785. removeStartSizeGradient(gradient: number): IParticleSystem;
  17786. private _createRampGradientTexture;
  17787. /**
  17788. * Gets the current list of ramp gradients.
  17789. * You must use addRampGradient and removeRampGradient to udpate this list
  17790. * @returns the list of ramp gradients
  17791. */
  17792. getRampGradients(): Nullable<Array<Color3Gradient>>;
  17793. /**
  17794. * Adds a new ramp gradient used to remap particle colors
  17795. * @param gradient defines the gradient to use (between 0 and 1)
  17796. * @param color defines the color to affect to the specified gradient
  17797. * @returns the current particle system
  17798. */
  17799. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  17800. /**
  17801. * Remove a specific ramp gradient
  17802. * @param gradient defines the gradient to remove
  17803. * @returns the current particle system
  17804. */
  17805. removeRampGradient(gradient: number): ParticleSystem;
  17806. /**
  17807. * Adds a new color gradient
  17808. * @param gradient defines the gradient to use (between 0 and 1)
  17809. * @param color1 defines the color to affect to the specified gradient
  17810. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  17811. * @returns this particle system
  17812. */
  17813. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  17814. /**
  17815. * Remove a specific color gradient
  17816. * @param gradient defines the gradient to remove
  17817. * @returns this particle system
  17818. */
  17819. removeColorGradient(gradient: number): IParticleSystem;
  17820. private _fetchR;
  17821. protected _reset(): void;
  17822. private _resetEffect;
  17823. private _createVertexBuffers;
  17824. private _createIndexBuffer;
  17825. /**
  17826. * Gets the maximum number of particles active at the same time.
  17827. * @returns The max number of active particles.
  17828. */
  17829. getCapacity(): number;
  17830. /**
  17831. * Gets whether there are still active particles in the system.
  17832. * @returns True if it is alive, otherwise false.
  17833. */
  17834. isAlive(): boolean;
  17835. /**
  17836. * Gets if the system has been started. (Note: this will still be true after stop is called)
  17837. * @returns True if it has been started, otherwise false.
  17838. */
  17839. isStarted(): boolean;
  17840. private _prepareSubEmitterInternalArray;
  17841. /**
  17842. * Starts the particle system and begins to emit
  17843. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  17844. */
  17845. start(delay?: number): void;
  17846. /**
  17847. * Stops the particle system.
  17848. * @param stopSubEmitters if true it will stop the current system and all created sub-Systems if false it will stop the current root system only, this param is used by the root particle system only. the default value is true.
  17849. */
  17850. stop(stopSubEmitters?: boolean): void;
  17851. /**
  17852. * Remove all active particles
  17853. */
  17854. reset(): void;
  17855. /**
  17856. * @hidden (for internal use only)
  17857. */
  17858. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  17859. /**
  17860. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  17861. * Its lifetime will start back at 0.
  17862. */
  17863. recycleParticle: (particle: Particle) => void;
  17864. private _stopSubEmitters;
  17865. private _createParticle;
  17866. private _removeFromRoot;
  17867. private _emitFromParticle;
  17868. private _update;
  17869. /** @hidden */
  17870. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  17871. /** @hidden */
  17872. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  17873. /** @hidden */
  17874. private _getEffect;
  17875. /**
  17876. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  17877. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  17878. */
  17879. animate(preWarmOnly?: boolean): void;
  17880. private _appendParticleVertices;
  17881. /**
  17882. * Rebuilds the particle system.
  17883. */
  17884. rebuild(): void;
  17885. /**
  17886. * Is this system ready to be used/rendered
  17887. * @return true if the system is ready
  17888. */
  17889. isReady(): boolean;
  17890. private _render;
  17891. /**
  17892. * Renders the particle system in its current state.
  17893. * @returns the current number of particles
  17894. */
  17895. render(): number;
  17896. /**
  17897. * Disposes the particle system and free the associated resources
  17898. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  17899. */
  17900. dispose(disposeTexture?: boolean): void;
  17901. /**
  17902. * Clones the particle system.
  17903. * @param name The name of the cloned object
  17904. * @param newEmitter The new emitter to use
  17905. * @returns the cloned particle system
  17906. */
  17907. clone(name: string, newEmitter: any): ParticleSystem;
  17908. /**
  17909. * Serializes the particle system to a JSON object.
  17910. * @returns the JSON object
  17911. */
  17912. serialize(): any;
  17913. /** @hidden */
  17914. static _Serialize(serializationObject: any, particleSystem: IParticleSystem): void;
  17915. /** @hidden */
  17916. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  17917. /**
  17918. * Parses a JSON object to create a particle system.
  17919. * @param parsedParticleSystem The JSON object to parse
  17920. * @param scene The scene to create the particle system in
  17921. * @param rootUrl The root url to use to load external dependencies like texture
  17922. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  17923. * @returns the Parsed particle system
  17924. */
  17925. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  17926. }
  17927. }
  17928. declare module "babylonjs/Particles/particle" {
  17929. import { Nullable } from "babylonjs/types";
  17930. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  17931. import { Color4 } from "babylonjs/Maths/math.color";
  17932. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  17933. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  17934. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  17935. /**
  17936. * A particle represents one of the element emitted by a particle system.
  17937. * This is mainly define by its coordinates, direction, velocity and age.
  17938. */
  17939. export class Particle {
  17940. /**
  17941. * The particle system the particle belongs to.
  17942. */
  17943. particleSystem: ParticleSystem;
  17944. private static _Count;
  17945. /**
  17946. * Unique ID of the particle
  17947. */
  17948. id: number;
  17949. /**
  17950. * The world position of the particle in the scene.
  17951. */
  17952. position: Vector3;
  17953. /**
  17954. * The world direction of the particle in the scene.
  17955. */
  17956. direction: Vector3;
  17957. /**
  17958. * The color of the particle.
  17959. */
  17960. color: Color4;
  17961. /**
  17962. * The color change of the particle per step.
  17963. */
  17964. colorStep: Color4;
  17965. /**
  17966. * Defines how long will the life of the particle be.
  17967. */
  17968. lifeTime: number;
  17969. /**
  17970. * The current age of the particle.
  17971. */
  17972. age: number;
  17973. /**
  17974. * The current size of the particle.
  17975. */
  17976. size: number;
  17977. /**
  17978. * The current scale of the particle.
  17979. */
  17980. scale: Vector2;
  17981. /**
  17982. * The current angle of the particle.
  17983. */
  17984. angle: number;
  17985. /**
  17986. * Defines how fast is the angle changing.
  17987. */
  17988. angularSpeed: number;
  17989. /**
  17990. * Defines the cell index used by the particle to be rendered from a sprite.
  17991. */
  17992. cellIndex: number;
  17993. /**
  17994. * The information required to support color remapping
  17995. */
  17996. remapData: Vector4;
  17997. /** @hidden */
  17998. _randomCellOffset?: number;
  17999. /** @hidden */
  18000. _initialDirection: Nullable<Vector3>;
  18001. /** @hidden */
  18002. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  18003. /** @hidden */
  18004. _initialStartSpriteCellID: number;
  18005. /** @hidden */
  18006. _initialEndSpriteCellID: number;
  18007. /** @hidden */
  18008. _currentColorGradient: Nullable<ColorGradient>;
  18009. /** @hidden */
  18010. _currentColor1: Color4;
  18011. /** @hidden */
  18012. _currentColor2: Color4;
  18013. /** @hidden */
  18014. _currentSizeGradient: Nullable<FactorGradient>;
  18015. /** @hidden */
  18016. _currentSize1: number;
  18017. /** @hidden */
  18018. _currentSize2: number;
  18019. /** @hidden */
  18020. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  18021. /** @hidden */
  18022. _currentAngularSpeed1: number;
  18023. /** @hidden */
  18024. _currentAngularSpeed2: number;
  18025. /** @hidden */
  18026. _currentVelocityGradient: Nullable<FactorGradient>;
  18027. /** @hidden */
  18028. _currentVelocity1: number;
  18029. /** @hidden */
  18030. _currentVelocity2: number;
  18031. /** @hidden */
  18032. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  18033. /** @hidden */
  18034. _currentLimitVelocity1: number;
  18035. /** @hidden */
  18036. _currentLimitVelocity2: number;
  18037. /** @hidden */
  18038. _currentDragGradient: Nullable<FactorGradient>;
  18039. /** @hidden */
  18040. _currentDrag1: number;
  18041. /** @hidden */
  18042. _currentDrag2: number;
  18043. /** @hidden */
  18044. _randomNoiseCoordinates1: Vector3;
  18045. /** @hidden */
  18046. _randomNoiseCoordinates2: Vector3;
  18047. /**
  18048. * Creates a new instance Particle
  18049. * @param particleSystem the particle system the particle belongs to
  18050. */
  18051. constructor(
  18052. /**
  18053. * The particle system the particle belongs to.
  18054. */
  18055. particleSystem: ParticleSystem);
  18056. private updateCellInfoFromSystem;
  18057. /**
  18058. * Defines how the sprite cell index is updated for the particle
  18059. */
  18060. updateCellIndex(): void;
  18061. /** @hidden */
  18062. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  18063. /** @hidden */
  18064. _inheritParticleInfoToSubEmitters(): void;
  18065. /** @hidden */
  18066. _reset(): void;
  18067. /**
  18068. * Copy the properties of particle to another one.
  18069. * @param other the particle to copy the information to.
  18070. */
  18071. copyTo(other: Particle): void;
  18072. }
  18073. }
  18074. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  18075. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18076. import { Effect } from "babylonjs/Materials/effect";
  18077. import { Particle } from "babylonjs/Particles/particle";
  18078. /**
  18079. * Particle emitter represents a volume emitting particles.
  18080. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  18081. */
  18082. export interface IParticleEmitterType {
  18083. /**
  18084. * Called by the particle System when the direction is computed for the created particle.
  18085. * @param worldMatrix is the world matrix of the particle system
  18086. * @param directionToUpdate is the direction vector to update with the result
  18087. * @param particle is the particle we are computed the direction for
  18088. */
  18089. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18090. /**
  18091. * Called by the particle System when the position is computed for the created particle.
  18092. * @param worldMatrix is the world matrix of the particle system
  18093. * @param positionToUpdate is the position vector to update with the result
  18094. * @param particle is the particle we are computed the position for
  18095. */
  18096. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18097. /**
  18098. * Clones the current emitter and returns a copy of it
  18099. * @returns the new emitter
  18100. */
  18101. clone(): IParticleEmitterType;
  18102. /**
  18103. * Called by the GPUParticleSystem to setup the update shader
  18104. * @param effect defines the update shader
  18105. */
  18106. applyToShader(effect: Effect): void;
  18107. /**
  18108. * Returns a string to use to update the GPU particles update shader
  18109. * @returns the effect defines string
  18110. */
  18111. getEffectDefines(): string;
  18112. /**
  18113. * Returns a string representing the class name
  18114. * @returns a string containing the class name
  18115. */
  18116. getClassName(): string;
  18117. /**
  18118. * Serializes the particle system to a JSON object.
  18119. * @returns the JSON object
  18120. */
  18121. serialize(): any;
  18122. /**
  18123. * Parse properties from a JSON object
  18124. * @param serializationObject defines the JSON object
  18125. */
  18126. parse(serializationObject: any): void;
  18127. }
  18128. }
  18129. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  18130. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18131. import { Effect } from "babylonjs/Materials/effect";
  18132. import { Particle } from "babylonjs/Particles/particle";
  18133. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18134. /**
  18135. * Particle emitter emitting particles from the inside of a box.
  18136. * It emits the particles randomly between 2 given directions.
  18137. */
  18138. export class BoxParticleEmitter implements IParticleEmitterType {
  18139. /**
  18140. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18141. */
  18142. direction1: Vector3;
  18143. /**
  18144. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18145. */
  18146. direction2: Vector3;
  18147. /**
  18148. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  18149. */
  18150. minEmitBox: Vector3;
  18151. /**
  18152. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  18153. */
  18154. maxEmitBox: Vector3;
  18155. /**
  18156. * Creates a new instance BoxParticleEmitter
  18157. */
  18158. constructor();
  18159. /**
  18160. * Called by the particle System when the direction is computed for the created particle.
  18161. * @param worldMatrix is the world matrix of the particle system
  18162. * @param directionToUpdate is the direction vector to update with the result
  18163. * @param particle is the particle we are computed the direction for
  18164. */
  18165. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18166. /**
  18167. * Called by the particle System when the position is computed for the created particle.
  18168. * @param worldMatrix is the world matrix of the particle system
  18169. * @param positionToUpdate is the position vector to update with the result
  18170. * @param particle is the particle we are computed the position for
  18171. */
  18172. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18173. /**
  18174. * Clones the current emitter and returns a copy of it
  18175. * @returns the new emitter
  18176. */
  18177. clone(): BoxParticleEmitter;
  18178. /**
  18179. * Called by the GPUParticleSystem to setup the update shader
  18180. * @param effect defines the update shader
  18181. */
  18182. applyToShader(effect: Effect): void;
  18183. /**
  18184. * Returns a string to use to update the GPU particles update shader
  18185. * @returns a string containng the defines string
  18186. */
  18187. getEffectDefines(): string;
  18188. /**
  18189. * Returns the string "BoxParticleEmitter"
  18190. * @returns a string containing the class name
  18191. */
  18192. getClassName(): string;
  18193. /**
  18194. * Serializes the particle system to a JSON object.
  18195. * @returns the JSON object
  18196. */
  18197. serialize(): any;
  18198. /**
  18199. * Parse properties from a JSON object
  18200. * @param serializationObject defines the JSON object
  18201. */
  18202. parse(serializationObject: any): void;
  18203. }
  18204. }
  18205. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  18206. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18207. import { Effect } from "babylonjs/Materials/effect";
  18208. import { Particle } from "babylonjs/Particles/particle";
  18209. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18210. /**
  18211. * Particle emitter emitting particles from the inside of a cone.
  18212. * It emits the particles alongside the cone volume from the base to the particle.
  18213. * The emission direction might be randomized.
  18214. */
  18215. export class ConeParticleEmitter implements IParticleEmitterType {
  18216. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  18217. directionRandomizer: number;
  18218. private _radius;
  18219. private _angle;
  18220. private _height;
  18221. /**
  18222. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  18223. */
  18224. radiusRange: number;
  18225. /**
  18226. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  18227. */
  18228. heightRange: number;
  18229. /**
  18230. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  18231. */
  18232. emitFromSpawnPointOnly: boolean;
  18233. /**
  18234. * Gets or sets the radius of the emission cone
  18235. */
  18236. radius: number;
  18237. /**
  18238. * Gets or sets the angle of the emission cone
  18239. */
  18240. angle: number;
  18241. private _buildHeight;
  18242. /**
  18243. * Creates a new instance ConeParticleEmitter
  18244. * @param radius the radius of the emission cone (1 by default)
  18245. * @param angle the cone base angle (PI by default)
  18246. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  18247. */
  18248. constructor(radius?: number, angle?: number,
  18249. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  18250. directionRandomizer?: number);
  18251. /**
  18252. * Called by the particle System when the direction is computed for the created particle.
  18253. * @param worldMatrix is the world matrix of the particle system
  18254. * @param directionToUpdate is the direction vector to update with the result
  18255. * @param particle is the particle we are computed the direction for
  18256. */
  18257. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18258. /**
  18259. * Called by the particle System when the position is computed for the created particle.
  18260. * @param worldMatrix is the world matrix of the particle system
  18261. * @param positionToUpdate is the position vector to update with the result
  18262. * @param particle is the particle we are computed the position for
  18263. */
  18264. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18265. /**
  18266. * Clones the current emitter and returns a copy of it
  18267. * @returns the new emitter
  18268. */
  18269. clone(): ConeParticleEmitter;
  18270. /**
  18271. * Called by the GPUParticleSystem to setup the update shader
  18272. * @param effect defines the update shader
  18273. */
  18274. applyToShader(effect: Effect): void;
  18275. /**
  18276. * Returns a string to use to update the GPU particles update shader
  18277. * @returns a string containng the defines string
  18278. */
  18279. getEffectDefines(): string;
  18280. /**
  18281. * Returns the string "ConeParticleEmitter"
  18282. * @returns a string containing the class name
  18283. */
  18284. getClassName(): string;
  18285. /**
  18286. * Serializes the particle system to a JSON object.
  18287. * @returns the JSON object
  18288. */
  18289. serialize(): any;
  18290. /**
  18291. * Parse properties from a JSON object
  18292. * @param serializationObject defines the JSON object
  18293. */
  18294. parse(serializationObject: any): void;
  18295. }
  18296. }
  18297. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  18298. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18299. import { Effect } from "babylonjs/Materials/effect";
  18300. import { Particle } from "babylonjs/Particles/particle";
  18301. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18302. /**
  18303. * Particle emitter emitting particles from the inside of a cylinder.
  18304. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  18305. */
  18306. export class CylinderParticleEmitter implements IParticleEmitterType {
  18307. /**
  18308. * The radius of the emission cylinder.
  18309. */
  18310. radius: number;
  18311. /**
  18312. * The height of the emission cylinder.
  18313. */
  18314. height: number;
  18315. /**
  18316. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18317. */
  18318. radiusRange: number;
  18319. /**
  18320. * How much to randomize the particle direction [0-1].
  18321. */
  18322. directionRandomizer: number;
  18323. /**
  18324. * Creates a new instance CylinderParticleEmitter
  18325. * @param radius the radius of the emission cylinder (1 by default)
  18326. * @param height the height of the emission cylinder (1 by default)
  18327. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18328. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18329. */
  18330. constructor(
  18331. /**
  18332. * The radius of the emission cylinder.
  18333. */
  18334. radius?: number,
  18335. /**
  18336. * The height of the emission cylinder.
  18337. */
  18338. height?: number,
  18339. /**
  18340. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18341. */
  18342. radiusRange?: number,
  18343. /**
  18344. * How much to randomize the particle direction [0-1].
  18345. */
  18346. directionRandomizer?: number);
  18347. /**
  18348. * Called by the particle System when the direction is computed for the created particle.
  18349. * @param worldMatrix is the world matrix of the particle system
  18350. * @param directionToUpdate is the direction vector to update with the result
  18351. * @param particle is the particle we are computed the direction for
  18352. */
  18353. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18354. /**
  18355. * Called by the particle System when the position is computed for the created particle.
  18356. * @param worldMatrix is the world matrix of the particle system
  18357. * @param positionToUpdate is the position vector to update with the result
  18358. * @param particle is the particle we are computed the position for
  18359. */
  18360. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18361. /**
  18362. * Clones the current emitter and returns a copy of it
  18363. * @returns the new emitter
  18364. */
  18365. clone(): CylinderParticleEmitter;
  18366. /**
  18367. * Called by the GPUParticleSystem to setup the update shader
  18368. * @param effect defines the update shader
  18369. */
  18370. applyToShader(effect: Effect): void;
  18371. /**
  18372. * Returns a string to use to update the GPU particles update shader
  18373. * @returns a string containng the defines string
  18374. */
  18375. getEffectDefines(): string;
  18376. /**
  18377. * Returns the string "CylinderParticleEmitter"
  18378. * @returns a string containing the class name
  18379. */
  18380. getClassName(): string;
  18381. /**
  18382. * Serializes the particle system to a JSON object.
  18383. * @returns the JSON object
  18384. */
  18385. serialize(): any;
  18386. /**
  18387. * Parse properties from a JSON object
  18388. * @param serializationObject defines the JSON object
  18389. */
  18390. parse(serializationObject: any): void;
  18391. }
  18392. /**
  18393. * Particle emitter emitting particles from the inside of a cylinder.
  18394. * It emits the particles randomly between two vectors.
  18395. */
  18396. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  18397. /**
  18398. * The min limit of the emission direction.
  18399. */
  18400. direction1: Vector3;
  18401. /**
  18402. * The max limit of the emission direction.
  18403. */
  18404. direction2: Vector3;
  18405. /**
  18406. * Creates a new instance CylinderDirectedParticleEmitter
  18407. * @param radius the radius of the emission cylinder (1 by default)
  18408. * @param height the height of the emission cylinder (1 by default)
  18409. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18410. * @param direction1 the min limit of the emission direction (up vector by default)
  18411. * @param direction2 the max limit of the emission direction (up vector by default)
  18412. */
  18413. constructor(radius?: number, height?: number, radiusRange?: number,
  18414. /**
  18415. * The min limit of the emission direction.
  18416. */
  18417. direction1?: Vector3,
  18418. /**
  18419. * The max limit of the emission direction.
  18420. */
  18421. direction2?: Vector3);
  18422. /**
  18423. * Called by the particle System when the direction is computed for the created particle.
  18424. * @param worldMatrix is the world matrix of the particle system
  18425. * @param directionToUpdate is the direction vector to update with the result
  18426. * @param particle is the particle we are computed the direction for
  18427. */
  18428. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18429. /**
  18430. * Clones the current emitter and returns a copy of it
  18431. * @returns the new emitter
  18432. */
  18433. clone(): CylinderDirectedParticleEmitter;
  18434. /**
  18435. * Called by the GPUParticleSystem to setup the update shader
  18436. * @param effect defines the update shader
  18437. */
  18438. applyToShader(effect: Effect): void;
  18439. /**
  18440. * Returns a string to use to update the GPU particles update shader
  18441. * @returns a string containng the defines string
  18442. */
  18443. getEffectDefines(): string;
  18444. /**
  18445. * Returns the string "CylinderDirectedParticleEmitter"
  18446. * @returns a string containing the class name
  18447. */
  18448. getClassName(): string;
  18449. /**
  18450. * Serializes the particle system to a JSON object.
  18451. * @returns the JSON object
  18452. */
  18453. serialize(): any;
  18454. /**
  18455. * Parse properties from a JSON object
  18456. * @param serializationObject defines the JSON object
  18457. */
  18458. parse(serializationObject: any): void;
  18459. }
  18460. }
  18461. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  18462. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18463. import { Effect } from "babylonjs/Materials/effect";
  18464. import { Particle } from "babylonjs/Particles/particle";
  18465. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18466. /**
  18467. * Particle emitter emitting particles from the inside of a hemisphere.
  18468. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  18469. */
  18470. export class HemisphericParticleEmitter implements IParticleEmitterType {
  18471. /**
  18472. * The radius of the emission hemisphere.
  18473. */
  18474. radius: number;
  18475. /**
  18476. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18477. */
  18478. radiusRange: number;
  18479. /**
  18480. * How much to randomize the particle direction [0-1].
  18481. */
  18482. directionRandomizer: number;
  18483. /**
  18484. * Creates a new instance HemisphericParticleEmitter
  18485. * @param radius the radius of the emission hemisphere (1 by default)
  18486. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18487. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18488. */
  18489. constructor(
  18490. /**
  18491. * The radius of the emission hemisphere.
  18492. */
  18493. radius?: number,
  18494. /**
  18495. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18496. */
  18497. radiusRange?: number,
  18498. /**
  18499. * How much to randomize the particle direction [0-1].
  18500. */
  18501. directionRandomizer?: number);
  18502. /**
  18503. * Called by the particle System when the direction is computed for the created particle.
  18504. * @param worldMatrix is the world matrix of the particle system
  18505. * @param directionToUpdate is the direction vector to update with the result
  18506. * @param particle is the particle we are computed the direction for
  18507. */
  18508. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18509. /**
  18510. * Called by the particle System when the position is computed for the created particle.
  18511. * @param worldMatrix is the world matrix of the particle system
  18512. * @param positionToUpdate is the position vector to update with the result
  18513. * @param particle is the particle we are computed the position for
  18514. */
  18515. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18516. /**
  18517. * Clones the current emitter and returns a copy of it
  18518. * @returns the new emitter
  18519. */
  18520. clone(): HemisphericParticleEmitter;
  18521. /**
  18522. * Called by the GPUParticleSystem to setup the update shader
  18523. * @param effect defines the update shader
  18524. */
  18525. applyToShader(effect: Effect): void;
  18526. /**
  18527. * Returns a string to use to update the GPU particles update shader
  18528. * @returns a string containng the defines string
  18529. */
  18530. getEffectDefines(): string;
  18531. /**
  18532. * Returns the string "HemisphericParticleEmitter"
  18533. * @returns a string containing the class name
  18534. */
  18535. getClassName(): string;
  18536. /**
  18537. * Serializes the particle system to a JSON object.
  18538. * @returns the JSON object
  18539. */
  18540. serialize(): any;
  18541. /**
  18542. * Parse properties from a JSON object
  18543. * @param serializationObject defines the JSON object
  18544. */
  18545. parse(serializationObject: any): void;
  18546. }
  18547. }
  18548. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  18549. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18550. import { Effect } from "babylonjs/Materials/effect";
  18551. import { Particle } from "babylonjs/Particles/particle";
  18552. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18553. /**
  18554. * Particle emitter emitting particles from a point.
  18555. * It emits the particles randomly between 2 given directions.
  18556. */
  18557. export class PointParticleEmitter implements IParticleEmitterType {
  18558. /**
  18559. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18560. */
  18561. direction1: Vector3;
  18562. /**
  18563. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18564. */
  18565. direction2: Vector3;
  18566. /**
  18567. * Creates a new instance PointParticleEmitter
  18568. */
  18569. constructor();
  18570. /**
  18571. * Called by the particle System when the direction is computed for the created particle.
  18572. * @param worldMatrix is the world matrix of the particle system
  18573. * @param directionToUpdate is the direction vector to update with the result
  18574. * @param particle is the particle we are computed the direction for
  18575. */
  18576. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18577. /**
  18578. * Called by the particle System when the position is computed for the created particle.
  18579. * @param worldMatrix is the world matrix of the particle system
  18580. * @param positionToUpdate is the position vector to update with the result
  18581. * @param particle is the particle we are computed the position for
  18582. */
  18583. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18584. /**
  18585. * Clones the current emitter and returns a copy of it
  18586. * @returns the new emitter
  18587. */
  18588. clone(): PointParticleEmitter;
  18589. /**
  18590. * Called by the GPUParticleSystem to setup the update shader
  18591. * @param effect defines the update shader
  18592. */
  18593. applyToShader(effect: Effect): void;
  18594. /**
  18595. * Returns a string to use to update the GPU particles update shader
  18596. * @returns a string containng the defines string
  18597. */
  18598. getEffectDefines(): string;
  18599. /**
  18600. * Returns the string "PointParticleEmitter"
  18601. * @returns a string containing the class name
  18602. */
  18603. getClassName(): string;
  18604. /**
  18605. * Serializes the particle system to a JSON object.
  18606. * @returns the JSON object
  18607. */
  18608. serialize(): any;
  18609. /**
  18610. * Parse properties from a JSON object
  18611. * @param serializationObject defines the JSON object
  18612. */
  18613. parse(serializationObject: any): void;
  18614. }
  18615. }
  18616. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  18617. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18618. import { Effect } from "babylonjs/Materials/effect";
  18619. import { Particle } from "babylonjs/Particles/particle";
  18620. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18621. /**
  18622. * Particle emitter emitting particles from the inside of a sphere.
  18623. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  18624. */
  18625. export class SphereParticleEmitter implements IParticleEmitterType {
  18626. /**
  18627. * The radius of the emission sphere.
  18628. */
  18629. radius: number;
  18630. /**
  18631. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18632. */
  18633. radiusRange: number;
  18634. /**
  18635. * How much to randomize the particle direction [0-1].
  18636. */
  18637. directionRandomizer: number;
  18638. /**
  18639. * Creates a new instance SphereParticleEmitter
  18640. * @param radius the radius of the emission sphere (1 by default)
  18641. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18642. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18643. */
  18644. constructor(
  18645. /**
  18646. * The radius of the emission sphere.
  18647. */
  18648. radius?: number,
  18649. /**
  18650. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18651. */
  18652. radiusRange?: number,
  18653. /**
  18654. * How much to randomize the particle direction [0-1].
  18655. */
  18656. directionRandomizer?: number);
  18657. /**
  18658. * Called by the particle System when the direction is computed for the created particle.
  18659. * @param worldMatrix is the world matrix of the particle system
  18660. * @param directionToUpdate is the direction vector to update with the result
  18661. * @param particle is the particle we are computed the direction for
  18662. */
  18663. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18664. /**
  18665. * Called by the particle System when the position is computed for the created particle.
  18666. * @param worldMatrix is the world matrix of the particle system
  18667. * @param positionToUpdate is the position vector to update with the result
  18668. * @param particle is the particle we are computed the position for
  18669. */
  18670. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18671. /**
  18672. * Clones the current emitter and returns a copy of it
  18673. * @returns the new emitter
  18674. */
  18675. clone(): SphereParticleEmitter;
  18676. /**
  18677. * Called by the GPUParticleSystem to setup the update shader
  18678. * @param effect defines the update shader
  18679. */
  18680. applyToShader(effect: Effect): void;
  18681. /**
  18682. * Returns a string to use to update the GPU particles update shader
  18683. * @returns a string containng the defines string
  18684. */
  18685. getEffectDefines(): string;
  18686. /**
  18687. * Returns the string "SphereParticleEmitter"
  18688. * @returns a string containing the class name
  18689. */
  18690. getClassName(): string;
  18691. /**
  18692. * Serializes the particle system to a JSON object.
  18693. * @returns the JSON object
  18694. */
  18695. serialize(): any;
  18696. /**
  18697. * Parse properties from a JSON object
  18698. * @param serializationObject defines the JSON object
  18699. */
  18700. parse(serializationObject: any): void;
  18701. }
  18702. /**
  18703. * Particle emitter emitting particles from the inside of a sphere.
  18704. * It emits the particles randomly between two vectors.
  18705. */
  18706. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  18707. /**
  18708. * The min limit of the emission direction.
  18709. */
  18710. direction1: Vector3;
  18711. /**
  18712. * The max limit of the emission direction.
  18713. */
  18714. direction2: Vector3;
  18715. /**
  18716. * Creates a new instance SphereDirectedParticleEmitter
  18717. * @param radius the radius of the emission sphere (1 by default)
  18718. * @param direction1 the min limit of the emission direction (up vector by default)
  18719. * @param direction2 the max limit of the emission direction (up vector by default)
  18720. */
  18721. constructor(radius?: number,
  18722. /**
  18723. * The min limit of the emission direction.
  18724. */
  18725. direction1?: Vector3,
  18726. /**
  18727. * The max limit of the emission direction.
  18728. */
  18729. direction2?: Vector3);
  18730. /**
  18731. * Called by the particle System when the direction is computed for the created particle.
  18732. * @param worldMatrix is the world matrix of the particle system
  18733. * @param directionToUpdate is the direction vector to update with the result
  18734. * @param particle is the particle we are computed the direction for
  18735. */
  18736. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18737. /**
  18738. * Clones the current emitter and returns a copy of it
  18739. * @returns the new emitter
  18740. */
  18741. clone(): SphereDirectedParticleEmitter;
  18742. /**
  18743. * Called by the GPUParticleSystem to setup the update shader
  18744. * @param effect defines the update shader
  18745. */
  18746. applyToShader(effect: Effect): void;
  18747. /**
  18748. * Returns a string to use to update the GPU particles update shader
  18749. * @returns a string containng the defines string
  18750. */
  18751. getEffectDefines(): string;
  18752. /**
  18753. * Returns the string "SphereDirectedParticleEmitter"
  18754. * @returns a string containing the class name
  18755. */
  18756. getClassName(): string;
  18757. /**
  18758. * Serializes the particle system to a JSON object.
  18759. * @returns the JSON object
  18760. */
  18761. serialize(): any;
  18762. /**
  18763. * Parse properties from a JSON object
  18764. * @param serializationObject defines the JSON object
  18765. */
  18766. parse(serializationObject: any): void;
  18767. }
  18768. }
  18769. declare module "babylonjs/Particles/EmitterTypes/index" {
  18770. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  18771. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  18772. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  18773. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  18774. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18775. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  18776. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  18777. }
  18778. declare module "babylonjs/Particles/IParticleSystem" {
  18779. import { Nullable } from "babylonjs/types";
  18780. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  18781. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  18782. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18783. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  18784. import { Texture } from "babylonjs/Materials/Textures/texture";
  18785. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  18786. import { Scene } from "babylonjs/scene";
  18787. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  18788. import { Animation } from "babylonjs/Animations/animation";
  18789. /**
  18790. * Interface representing a particle system in Babylon.js.
  18791. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  18792. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  18793. */
  18794. export interface IParticleSystem {
  18795. /**
  18796. * List of animations used by the particle system.
  18797. */
  18798. animations: Animation[];
  18799. /**
  18800. * The id of the Particle system.
  18801. */
  18802. id: string;
  18803. /**
  18804. * The name of the Particle system.
  18805. */
  18806. name: string;
  18807. /**
  18808. * The emitter represents the Mesh or position we are attaching the particle system to.
  18809. */
  18810. emitter: Nullable<AbstractMesh | Vector3>;
  18811. /**
  18812. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  18813. */
  18814. isBillboardBased: boolean;
  18815. /**
  18816. * The rendering group used by the Particle system to chose when to render.
  18817. */
  18818. renderingGroupId: number;
  18819. /**
  18820. * The layer mask we are rendering the particles through.
  18821. */
  18822. layerMask: number;
  18823. /**
  18824. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  18825. */
  18826. updateSpeed: number;
  18827. /**
  18828. * The amount of time the particle system is running (depends of the overall update speed).
  18829. */
  18830. targetStopDuration: number;
  18831. /**
  18832. * The texture used to render each particle. (this can be a spritesheet)
  18833. */
  18834. particleTexture: Nullable<Texture>;
  18835. /**
  18836. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  18837. */
  18838. blendMode: number;
  18839. /**
  18840. * Minimum life time of emitting particles.
  18841. */
  18842. minLifeTime: number;
  18843. /**
  18844. * Maximum life time of emitting particles.
  18845. */
  18846. maxLifeTime: number;
  18847. /**
  18848. * Minimum Size of emitting particles.
  18849. */
  18850. minSize: number;
  18851. /**
  18852. * Maximum Size of emitting particles.
  18853. */
  18854. maxSize: number;
  18855. /**
  18856. * Minimum scale of emitting particles on X axis.
  18857. */
  18858. minScaleX: number;
  18859. /**
  18860. * Maximum scale of emitting particles on X axis.
  18861. */
  18862. maxScaleX: number;
  18863. /**
  18864. * Minimum scale of emitting particles on Y axis.
  18865. */
  18866. minScaleY: number;
  18867. /**
  18868. * Maximum scale of emitting particles on Y axis.
  18869. */
  18870. maxScaleY: number;
  18871. /**
  18872. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  18873. */
  18874. color1: Color4;
  18875. /**
  18876. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  18877. */
  18878. color2: Color4;
  18879. /**
  18880. * Color the particle will have at the end of its lifetime.
  18881. */
  18882. colorDead: Color4;
  18883. /**
  18884. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  18885. */
  18886. emitRate: number;
  18887. /**
  18888. * You can use gravity if you want to give an orientation to your particles.
  18889. */
  18890. gravity: Vector3;
  18891. /**
  18892. * Minimum power of emitting particles.
  18893. */
  18894. minEmitPower: number;
  18895. /**
  18896. * Maximum power of emitting particles.
  18897. */
  18898. maxEmitPower: number;
  18899. /**
  18900. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  18901. */
  18902. minAngularSpeed: number;
  18903. /**
  18904. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  18905. */
  18906. maxAngularSpeed: number;
  18907. /**
  18908. * Gets or sets the minimal initial rotation in radians.
  18909. */
  18910. minInitialRotation: number;
  18911. /**
  18912. * Gets or sets the maximal initial rotation in radians.
  18913. */
  18914. maxInitialRotation: number;
  18915. /**
  18916. * The particle emitter type defines the emitter used by the particle system.
  18917. * It can be for example box, sphere, or cone...
  18918. */
  18919. particleEmitterType: Nullable<IParticleEmitterType>;
  18920. /**
  18921. * Defines the delay in milliseconds before starting the system (0 by default)
  18922. */
  18923. startDelay: number;
  18924. /**
  18925. * Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0
  18926. */
  18927. preWarmCycles: number;
  18928. /**
  18929. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  18930. */
  18931. preWarmStepOffset: number;
  18932. /**
  18933. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  18934. */
  18935. spriteCellChangeSpeed: number;
  18936. /**
  18937. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  18938. */
  18939. startSpriteCellID: number;
  18940. /**
  18941. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  18942. */
  18943. endSpriteCellID: number;
  18944. /**
  18945. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  18946. */
  18947. spriteCellWidth: number;
  18948. /**
  18949. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  18950. */
  18951. spriteCellHeight: number;
  18952. /**
  18953. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  18954. */
  18955. spriteRandomStartCell: boolean;
  18956. /**
  18957. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  18958. */
  18959. isAnimationSheetEnabled: boolean;
  18960. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  18961. translationPivot: Vector2;
  18962. /**
  18963. * Gets or sets a texture used to add random noise to particle positions
  18964. */
  18965. noiseTexture: Nullable<BaseTexture>;
  18966. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  18967. noiseStrength: Vector3;
  18968. /**
  18969. * Gets or sets the billboard mode to use when isBillboardBased = true.
  18970. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  18971. */
  18972. billboardMode: number;
  18973. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  18974. limitVelocityDamping: number;
  18975. /**
  18976. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  18977. */
  18978. beginAnimationOnStart: boolean;
  18979. /**
  18980. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  18981. */
  18982. beginAnimationFrom: number;
  18983. /**
  18984. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  18985. */
  18986. beginAnimationTo: number;
  18987. /**
  18988. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  18989. */
  18990. beginAnimationLoop: boolean;
  18991. /**
  18992. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  18993. */
  18994. disposeOnStop: boolean;
  18995. /**
  18996. * Gets the maximum number of particles active at the same time.
  18997. * @returns The max number of active particles.
  18998. */
  18999. getCapacity(): number;
  19000. /**
  19001. * Gets if the system has been started. (Note: this will still be true after stop is called)
  19002. * @returns True if it has been started, otherwise false.
  19003. */
  19004. isStarted(): boolean;
  19005. /**
  19006. * Animates the particle system for this frame.
  19007. */
  19008. animate(): void;
  19009. /**
  19010. * Renders the particle system in its current state.
  19011. * @returns the current number of particles
  19012. */
  19013. render(): number;
  19014. /**
  19015. * Dispose the particle system and frees its associated resources.
  19016. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  19017. */
  19018. dispose(disposeTexture?: boolean): void;
  19019. /**
  19020. * Clones the particle system.
  19021. * @param name The name of the cloned object
  19022. * @param newEmitter The new emitter to use
  19023. * @returns the cloned particle system
  19024. */
  19025. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  19026. /**
  19027. * Serializes the particle system to a JSON object.
  19028. * @returns the JSON object
  19029. */
  19030. serialize(): any;
  19031. /**
  19032. * Rebuild the particle system
  19033. */
  19034. rebuild(): void;
  19035. /**
  19036. * Starts the particle system and begins to emit
  19037. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  19038. */
  19039. start(delay?: number): void;
  19040. /**
  19041. * Stops the particle system.
  19042. */
  19043. stop(): void;
  19044. /**
  19045. * Remove all active particles
  19046. */
  19047. reset(): void;
  19048. /**
  19049. * Is this system ready to be used/rendered
  19050. * @return true if the system is ready
  19051. */
  19052. isReady(): boolean;
  19053. /**
  19054. * Adds a new color gradient
  19055. * @param gradient defines the gradient to use (between 0 and 1)
  19056. * @param color1 defines the color to affect to the specified gradient
  19057. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  19058. * @returns the current particle system
  19059. */
  19060. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  19061. /**
  19062. * Remove a specific color gradient
  19063. * @param gradient defines the gradient to remove
  19064. * @returns the current particle system
  19065. */
  19066. removeColorGradient(gradient: number): IParticleSystem;
  19067. /**
  19068. * Adds a new size gradient
  19069. * @param gradient defines the gradient to use (between 0 and 1)
  19070. * @param factor defines the size factor to affect to the specified gradient
  19071. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19072. * @returns the current particle system
  19073. */
  19074. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19075. /**
  19076. * Remove a specific size gradient
  19077. * @param gradient defines the gradient to remove
  19078. * @returns the current particle system
  19079. */
  19080. removeSizeGradient(gradient: number): IParticleSystem;
  19081. /**
  19082. * Gets the current list of color gradients.
  19083. * You must use addColorGradient and removeColorGradient to udpate this list
  19084. * @returns the list of color gradients
  19085. */
  19086. getColorGradients(): Nullable<Array<ColorGradient>>;
  19087. /**
  19088. * Gets the current list of size gradients.
  19089. * You must use addSizeGradient and removeSizeGradient to udpate this list
  19090. * @returns the list of size gradients
  19091. */
  19092. getSizeGradients(): Nullable<Array<FactorGradient>>;
  19093. /**
  19094. * Gets the current list of angular speed gradients.
  19095. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  19096. * @returns the list of angular speed gradients
  19097. */
  19098. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  19099. /**
  19100. * Adds a new angular speed gradient
  19101. * @param gradient defines the gradient to use (between 0 and 1)
  19102. * @param factor defines the angular speed to affect to the specified gradient
  19103. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19104. * @returns the current particle system
  19105. */
  19106. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19107. /**
  19108. * Remove a specific angular speed gradient
  19109. * @param gradient defines the gradient to remove
  19110. * @returns the current particle system
  19111. */
  19112. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  19113. /**
  19114. * Gets the current list of velocity gradients.
  19115. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  19116. * @returns the list of velocity gradients
  19117. */
  19118. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  19119. /**
  19120. * Adds a new velocity gradient
  19121. * @param gradient defines the gradient to use (between 0 and 1)
  19122. * @param factor defines the velocity to affect to the specified gradient
  19123. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19124. * @returns the current particle system
  19125. */
  19126. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19127. /**
  19128. * Remove a specific velocity gradient
  19129. * @param gradient defines the gradient to remove
  19130. * @returns the current particle system
  19131. */
  19132. removeVelocityGradient(gradient: number): IParticleSystem;
  19133. /**
  19134. * Gets the current list of limit velocity gradients.
  19135. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  19136. * @returns the list of limit velocity gradients
  19137. */
  19138. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  19139. /**
  19140. * Adds a new limit velocity gradient
  19141. * @param gradient defines the gradient to use (between 0 and 1)
  19142. * @param factor defines the limit velocity to affect to the specified gradient
  19143. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19144. * @returns the current particle system
  19145. */
  19146. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19147. /**
  19148. * Remove a specific limit velocity gradient
  19149. * @param gradient defines the gradient to remove
  19150. * @returns the current particle system
  19151. */
  19152. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  19153. /**
  19154. * Adds a new drag gradient
  19155. * @param gradient defines the gradient to use (between 0 and 1)
  19156. * @param factor defines the drag to affect to the specified gradient
  19157. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19158. * @returns the current particle system
  19159. */
  19160. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19161. /**
  19162. * Remove a specific drag gradient
  19163. * @param gradient defines the gradient to remove
  19164. * @returns the current particle system
  19165. */
  19166. removeDragGradient(gradient: number): IParticleSystem;
  19167. /**
  19168. * Gets the current list of drag gradients.
  19169. * You must use addDragGradient and removeDragGradient to udpate this list
  19170. * @returns the list of drag gradients
  19171. */
  19172. getDragGradients(): Nullable<Array<FactorGradient>>;
  19173. /**
  19174. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  19175. * @param gradient defines the gradient to use (between 0 and 1)
  19176. * @param factor defines the emit rate to affect to the specified gradient
  19177. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19178. * @returns the current particle system
  19179. */
  19180. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19181. /**
  19182. * Remove a specific emit rate gradient
  19183. * @param gradient defines the gradient to remove
  19184. * @returns the current particle system
  19185. */
  19186. removeEmitRateGradient(gradient: number): IParticleSystem;
  19187. /**
  19188. * Gets the current list of emit rate gradients.
  19189. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  19190. * @returns the list of emit rate gradients
  19191. */
  19192. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  19193. /**
  19194. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  19195. * @param gradient defines the gradient to use (between 0 and 1)
  19196. * @param factor defines the start size to affect to the specified gradient
  19197. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19198. * @returns the current particle system
  19199. */
  19200. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19201. /**
  19202. * Remove a specific start size gradient
  19203. * @param gradient defines the gradient to remove
  19204. * @returns the current particle system
  19205. */
  19206. removeStartSizeGradient(gradient: number): IParticleSystem;
  19207. /**
  19208. * Gets the current list of start size gradients.
  19209. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  19210. * @returns the list of start size gradients
  19211. */
  19212. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  19213. /**
  19214. * Adds a new life time gradient
  19215. * @param gradient defines the gradient to use (between 0 and 1)
  19216. * @param factor defines the life time factor to affect to the specified gradient
  19217. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19218. * @returns the current particle system
  19219. */
  19220. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19221. /**
  19222. * Remove a specific life time gradient
  19223. * @param gradient defines the gradient to remove
  19224. * @returns the current particle system
  19225. */
  19226. removeLifeTimeGradient(gradient: number): IParticleSystem;
  19227. /**
  19228. * Gets the current list of life time gradients.
  19229. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  19230. * @returns the list of life time gradients
  19231. */
  19232. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  19233. /**
  19234. * Gets the current list of color gradients.
  19235. * You must use addColorGradient and removeColorGradient to udpate this list
  19236. * @returns the list of color gradients
  19237. */
  19238. getColorGradients(): Nullable<Array<ColorGradient>>;
  19239. /**
  19240. * Adds a new ramp gradient used to remap particle colors
  19241. * @param gradient defines the gradient to use (between 0 and 1)
  19242. * @param color defines the color to affect to the specified gradient
  19243. * @returns the current particle system
  19244. */
  19245. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  19246. /**
  19247. * Gets the current list of ramp gradients.
  19248. * You must use addRampGradient and removeRampGradient to udpate this list
  19249. * @returns the list of ramp gradients
  19250. */
  19251. getRampGradients(): Nullable<Array<Color3Gradient>>;
  19252. /** Gets or sets a boolean indicating that ramp gradients must be used
  19253. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  19254. */
  19255. useRampGradients: boolean;
  19256. /**
  19257. * Adds a new color remap gradient
  19258. * @param gradient defines the gradient to use (between 0 and 1)
  19259. * @param min defines the color remap minimal range
  19260. * @param max defines the color remap maximal range
  19261. * @returns the current particle system
  19262. */
  19263. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  19264. /**
  19265. * Gets the current list of color remap gradients.
  19266. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  19267. * @returns the list of color remap gradients
  19268. */
  19269. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  19270. /**
  19271. * Adds a new alpha remap gradient
  19272. * @param gradient defines the gradient to use (between 0 and 1)
  19273. * @param min defines the alpha remap minimal range
  19274. * @param max defines the alpha remap maximal range
  19275. * @returns the current particle system
  19276. */
  19277. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  19278. /**
  19279. * Gets the current list of alpha remap gradients.
  19280. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  19281. * @returns the list of alpha remap gradients
  19282. */
  19283. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  19284. /**
  19285. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  19286. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  19287. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  19288. * @returns the emitter
  19289. */
  19290. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  19291. /**
  19292. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  19293. * @param radius The radius of the hemisphere to emit from
  19294. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  19295. * @returns the emitter
  19296. */
  19297. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  19298. /**
  19299. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  19300. * @param radius The radius of the sphere to emit from
  19301. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  19302. * @returns the emitter
  19303. */
  19304. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  19305. /**
  19306. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  19307. * @param radius The radius of the sphere to emit from
  19308. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  19309. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  19310. * @returns the emitter
  19311. */
  19312. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  19313. /**
  19314. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  19315. * @param radius The radius of the emission cylinder
  19316. * @param height The height of the emission cylinder
  19317. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  19318. * @param directionRandomizer How much to randomize the particle direction [0-1]
  19319. * @returns the emitter
  19320. */
  19321. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  19322. /**
  19323. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  19324. * @param radius The radius of the cylinder to emit from
  19325. * @param height The height of the emission cylinder
  19326. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  19327. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  19328. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  19329. * @returns the emitter
  19330. */
  19331. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  19332. /**
  19333. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  19334. * @param radius The radius of the cone to emit from
  19335. * @param angle The base angle of the cone
  19336. * @returns the emitter
  19337. */
  19338. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  19339. /**
  19340. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  19341. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  19342. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  19343. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  19344. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  19345. * @returns the emitter
  19346. */
  19347. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  19348. /**
  19349. * Get hosting scene
  19350. * @returns the scene
  19351. */
  19352. getScene(): Scene;
  19353. }
  19354. }
  19355. declare module "babylonjs/Meshes/instancedMesh" {
  19356. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  19357. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  19358. import { Camera } from "babylonjs/Cameras/camera";
  19359. import { Node } from "babylonjs/node";
  19360. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19361. import { Mesh } from "babylonjs/Meshes/mesh";
  19362. import { Material } from "babylonjs/Materials/material";
  19363. import { Skeleton } from "babylonjs/Bones/skeleton";
  19364. import { Light } from "babylonjs/Lights/light";
  19365. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  19366. /**
  19367. * Creates an instance based on a source mesh.
  19368. */
  19369. export class InstancedMesh extends AbstractMesh {
  19370. private _sourceMesh;
  19371. private _currentLOD;
  19372. /** @hidden */
  19373. _indexInSourceMeshInstanceArray: number;
  19374. constructor(name: string, source: Mesh);
  19375. /**
  19376. * Returns the string "InstancedMesh".
  19377. */
  19378. getClassName(): string;
  19379. /** Gets the list of lights affecting that mesh */
  19380. readonly lightSources: Light[];
  19381. _resyncLightSources(): void;
  19382. _resyncLighSource(light: Light): void;
  19383. _removeLightSource(light: Light, dispose: boolean): void;
  19384. /**
  19385. * If the source mesh receives shadows
  19386. */
  19387. readonly receiveShadows: boolean;
  19388. /**
  19389. * The material of the source mesh
  19390. */
  19391. readonly material: Nullable<Material>;
  19392. /**
  19393. * Visibility of the source mesh
  19394. */
  19395. readonly visibility: number;
  19396. /**
  19397. * Skeleton of the source mesh
  19398. */
  19399. readonly skeleton: Nullable<Skeleton>;
  19400. /**
  19401. * Rendering ground id of the source mesh
  19402. */
  19403. renderingGroupId: number;
  19404. /**
  19405. * Returns the total number of vertices (integer).
  19406. */
  19407. getTotalVertices(): number;
  19408. /**
  19409. * Returns a positive integer : the total number of indices in this mesh geometry.
  19410. * @returns the numner of indices or zero if the mesh has no geometry.
  19411. */
  19412. getTotalIndices(): number;
  19413. /**
  19414. * The source mesh of the instance
  19415. */
  19416. readonly sourceMesh: Mesh;
  19417. /**
  19418. * Is this node ready to be used/rendered
  19419. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  19420. * @return {boolean} is it ready
  19421. */
  19422. isReady(completeCheck?: boolean): boolean;
  19423. /**
  19424. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  19425. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  19426. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  19427. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  19428. */
  19429. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  19430. /**
  19431. * Sets the vertex data of the mesh geometry for the requested `kind`.
  19432. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  19433. * The `data` are either a numeric array either a Float32Array.
  19434. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  19435. * The parameter `stride` is an optional positive integer, it is usually automatically deducted from the `kind` (3 for positions or normals, 2 for UV, etc).
  19436. * Note that a new underlying VertexBuffer object is created each call.
  19437. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  19438. *
  19439. * Possible `kind` values :
  19440. * - VertexBuffer.PositionKind
  19441. * - VertexBuffer.UVKind
  19442. * - VertexBuffer.UV2Kind
  19443. * - VertexBuffer.UV3Kind
  19444. * - VertexBuffer.UV4Kind
  19445. * - VertexBuffer.UV5Kind
  19446. * - VertexBuffer.UV6Kind
  19447. * - VertexBuffer.ColorKind
  19448. * - VertexBuffer.MatricesIndicesKind
  19449. * - VertexBuffer.MatricesIndicesExtraKind
  19450. * - VertexBuffer.MatricesWeightsKind
  19451. * - VertexBuffer.MatricesWeightsExtraKind
  19452. *
  19453. * Returns the Mesh.
  19454. */
  19455. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  19456. /**
  19457. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  19458. * If the mesh has no geometry, it is simply returned as it is.
  19459. * The `data` are either a numeric array either a Float32Array.
  19460. * No new underlying VertexBuffer object is created.
  19461. * If the `kind` is the `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  19462. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  19463. *
  19464. * Possible `kind` values :
  19465. * - VertexBuffer.PositionKind
  19466. * - VertexBuffer.UVKind
  19467. * - VertexBuffer.UV2Kind
  19468. * - VertexBuffer.UV3Kind
  19469. * - VertexBuffer.UV4Kind
  19470. * - VertexBuffer.UV5Kind
  19471. * - VertexBuffer.UV6Kind
  19472. * - VertexBuffer.ColorKind
  19473. * - VertexBuffer.MatricesIndicesKind
  19474. * - VertexBuffer.MatricesIndicesExtraKind
  19475. * - VertexBuffer.MatricesWeightsKind
  19476. * - VertexBuffer.MatricesWeightsExtraKind
  19477. *
  19478. * Returns the Mesh.
  19479. */
  19480. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  19481. /**
  19482. * Sets the mesh indices.
  19483. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  19484. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  19485. * This method creates a new index buffer each call.
  19486. * Returns the Mesh.
  19487. */
  19488. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  19489. /**
  19490. * Boolean : True if the mesh owns the requested kind of data.
  19491. */
  19492. isVerticesDataPresent(kind: string): boolean;
  19493. /**
  19494. * Returns an array of indices (IndicesArray).
  19495. */
  19496. getIndices(): Nullable<IndicesArray>;
  19497. readonly _positions: Nullable<Vector3[]>;
  19498. /**
  19499. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  19500. * This means the mesh underlying bounding box and sphere are recomputed.
  19501. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  19502. * @returns the current mesh
  19503. */
  19504. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  19505. /** @hidden */
  19506. _preActivate(): InstancedMesh;
  19507. /** @hidden */
  19508. _activate(renderId: number, intermediateRendering: boolean): boolean;
  19509. /** @hidden */
  19510. _postActivate(): void;
  19511. getWorldMatrix(): Matrix;
  19512. readonly isAnInstance: boolean;
  19513. /**
  19514. * Returns the current associated LOD AbstractMesh.
  19515. */
  19516. getLOD(camera: Camera): AbstractMesh;
  19517. /** @hidden */
  19518. _syncSubMeshes(): InstancedMesh;
  19519. /** @hidden */
  19520. _generatePointsArray(): boolean;
  19521. /**
  19522. * Creates a new InstancedMesh from the current mesh.
  19523. * - name (string) : the cloned mesh name
  19524. * - newParent (optional Node) : the optional Node to parent the clone to.
  19525. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  19526. *
  19527. * Returns the clone.
  19528. */
  19529. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  19530. /**
  19531. * Disposes the InstancedMesh.
  19532. * Returns nothing.
  19533. */
  19534. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  19535. }
  19536. module "babylonjs/Meshes/mesh" {
  19537. interface Mesh {
  19538. /**
  19539. * Register a custom buffer that will be instanced
  19540. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  19541. * @param kind defines the buffer kind
  19542. * @param stride defines the stride in floats
  19543. */
  19544. registerInstancedBuffer(kind: string, stride: number): void;
  19545. /** @hidden */
  19546. _userInstancedBuffersStorage: {
  19547. data: {
  19548. [key: string]: Float32Array;
  19549. };
  19550. sizes: {
  19551. [key: string]: number;
  19552. };
  19553. vertexBuffers: {
  19554. [key: string]: Nullable<VertexBuffer>;
  19555. };
  19556. strides: {
  19557. [key: string]: number;
  19558. };
  19559. };
  19560. }
  19561. }
  19562. module "babylonjs/Meshes/abstractMesh" {
  19563. interface AbstractMesh {
  19564. /**
  19565. * Object used to store instanced buffers defined by user
  19566. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  19567. */
  19568. instancedBuffers: {
  19569. [key: string]: any;
  19570. };
  19571. }
  19572. }
  19573. }
  19574. declare module "babylonjs/Materials/shaderMaterial" {
  19575. import { Scene } from "babylonjs/scene";
  19576. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  19577. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19578. import { Mesh } from "babylonjs/Meshes/mesh";
  19579. import { BaseSubMesh } from "babylonjs/Meshes/subMesh";
  19580. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  19581. import { Texture } from "babylonjs/Materials/Textures/texture";
  19582. import { Material } from "babylonjs/Materials/material";
  19583. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  19584. /**
  19585. * Defines the options associated with the creation of a shader material.
  19586. */
  19587. export interface IShaderMaterialOptions {
  19588. /**
  19589. * Does the material work in alpha blend mode
  19590. */
  19591. needAlphaBlending: boolean;
  19592. /**
  19593. * Does the material work in alpha test mode
  19594. */
  19595. needAlphaTesting: boolean;
  19596. /**
  19597. * The list of attribute names used in the shader
  19598. */
  19599. attributes: string[];
  19600. /**
  19601. * The list of unifrom names used in the shader
  19602. */
  19603. uniforms: string[];
  19604. /**
  19605. * The list of UBO names used in the shader
  19606. */
  19607. uniformBuffers: string[];
  19608. /**
  19609. * The list of sampler names used in the shader
  19610. */
  19611. samplers: string[];
  19612. /**
  19613. * The list of defines used in the shader
  19614. */
  19615. defines: string[];
  19616. }
  19617. /**
  19618. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  19619. *
  19620. * This returned material effects how the mesh will look based on the code in the shaders.
  19621. *
  19622. * @see http://doc.babylonjs.com/how_to/shader_material
  19623. */
  19624. export class ShaderMaterial extends Material {
  19625. private _shaderPath;
  19626. private _options;
  19627. private _textures;
  19628. private _textureArrays;
  19629. private _floats;
  19630. private _ints;
  19631. private _floatsArrays;
  19632. private _colors3;
  19633. private _colors3Arrays;
  19634. private _colors4;
  19635. private _colors4Arrays;
  19636. private _vectors2;
  19637. private _vectors3;
  19638. private _vectors4;
  19639. private _matrices;
  19640. private _matrices3x3;
  19641. private _matrices2x2;
  19642. private _vectors2Arrays;
  19643. private _vectors3Arrays;
  19644. private _vectors4Arrays;
  19645. private _cachedWorldViewMatrix;
  19646. private _cachedWorldViewProjectionMatrix;
  19647. private _renderId;
  19648. /**
  19649. * Instantiate a new shader material.
  19650. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  19651. * This returned material effects how the mesh will look based on the code in the shaders.
  19652. * @see http://doc.babylonjs.com/how_to/shader_material
  19653. * @param name Define the name of the material in the scene
  19654. * @param scene Define the scene the material belongs to
  19655. * @param shaderPath Defines the route to the shader code in one of three ways:
  19656. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  19657. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  19658. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  19659. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  19660. * @param options Define the options used to create the shader
  19661. */
  19662. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  19663. /**
  19664. * Gets the options used to compile the shader.
  19665. * They can be modified to trigger a new compilation
  19666. */
  19667. readonly options: IShaderMaterialOptions;
  19668. /**
  19669. * Gets the current class name of the material e.g. "ShaderMaterial"
  19670. * Mainly use in serialization.
  19671. * @returns the class name
  19672. */
  19673. getClassName(): string;
  19674. /**
  19675. * Specifies if the material will require alpha blending
  19676. * @returns a boolean specifying if alpha blending is needed
  19677. */
  19678. needAlphaBlending(): boolean;
  19679. /**
  19680. * Specifies if this material should be rendered in alpha test mode
  19681. * @returns a boolean specifying if an alpha test is needed.
  19682. */
  19683. needAlphaTesting(): boolean;
  19684. private _checkUniform;
  19685. /**
  19686. * Set a texture in the shader.
  19687. * @param name Define the name of the uniform samplers as defined in the shader
  19688. * @param texture Define the texture to bind to this sampler
  19689. * @return the material itself allowing "fluent" like uniform updates
  19690. */
  19691. setTexture(name: string, texture: Texture): ShaderMaterial;
  19692. /**
  19693. * Set a texture array in the shader.
  19694. * @param name Define the name of the uniform sampler array as defined in the shader
  19695. * @param textures Define the list of textures to bind to this sampler
  19696. * @return the material itself allowing "fluent" like uniform updates
  19697. */
  19698. setTextureArray(name: string, textures: Texture[]): ShaderMaterial;
  19699. /**
  19700. * Set a float in the shader.
  19701. * @param name Define the name of the uniform as defined in the shader
  19702. * @param value Define the value to give to the uniform
  19703. * @return the material itself allowing "fluent" like uniform updates
  19704. */
  19705. setFloat(name: string, value: number): ShaderMaterial;
  19706. /**
  19707. * Set a int in the shader.
  19708. * @param name Define the name of the uniform as defined in the shader
  19709. * @param value Define the value to give to the uniform
  19710. * @return the material itself allowing "fluent" like uniform updates
  19711. */
  19712. setInt(name: string, value: number): ShaderMaterial;
  19713. /**
  19714. * Set an array of floats in the shader.
  19715. * @param name Define the name of the uniform as defined in the shader
  19716. * @param value Define the value to give to the uniform
  19717. * @return the material itself allowing "fluent" like uniform updates
  19718. */
  19719. setFloats(name: string, value: number[]): ShaderMaterial;
  19720. /**
  19721. * Set a vec3 in the shader from a Color3.
  19722. * @param name Define the name of the uniform as defined in the shader
  19723. * @param value Define the value to give to the uniform
  19724. * @return the material itself allowing "fluent" like uniform updates
  19725. */
  19726. setColor3(name: string, value: Color3): ShaderMaterial;
  19727. /**
  19728. * Set a vec3 array in the shader from a Color3 array.
  19729. * @param name Define the name of the uniform as defined in the shader
  19730. * @param value Define the value to give to the uniform
  19731. * @return the material itself allowing "fluent" like uniform updates
  19732. */
  19733. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  19734. /**
  19735. * Set a vec4 in the shader from a Color4.
  19736. * @param name Define the name of the uniform as defined in the shader
  19737. * @param value Define the value to give to the uniform
  19738. * @return the material itself allowing "fluent" like uniform updates
  19739. */
  19740. setColor4(name: string, value: Color4): ShaderMaterial;
  19741. /**
  19742. * Set a vec4 array in the shader from a Color4 array.
  19743. * @param name Define the name of the uniform as defined in the shader
  19744. * @param value Define the value to give to the uniform
  19745. * @return the material itself allowing "fluent" like uniform updates
  19746. */
  19747. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  19748. /**
  19749. * Set a vec2 in the shader from a Vector2.
  19750. * @param name Define the name of the uniform as defined in the shader
  19751. * @param value Define the value to give to the uniform
  19752. * @return the material itself allowing "fluent" like uniform updates
  19753. */
  19754. setVector2(name: string, value: Vector2): ShaderMaterial;
  19755. /**
  19756. * Set a vec3 in the shader from a Vector3.
  19757. * @param name Define the name of the uniform as defined in the shader
  19758. * @param value Define the value to give to the uniform
  19759. * @return the material itself allowing "fluent" like uniform updates
  19760. */
  19761. setVector3(name: string, value: Vector3): ShaderMaterial;
  19762. /**
  19763. * Set a vec4 in the shader from a Vector4.
  19764. * @param name Define the name of the uniform as defined in the shader
  19765. * @param value Define the value to give to the uniform
  19766. * @return the material itself allowing "fluent" like uniform updates
  19767. */
  19768. setVector4(name: string, value: Vector4): ShaderMaterial;
  19769. /**
  19770. * Set a mat4 in the shader from a Matrix.
  19771. * @param name Define the name of the uniform as defined in the shader
  19772. * @param value Define the value to give to the uniform
  19773. * @return the material itself allowing "fluent" like uniform updates
  19774. */
  19775. setMatrix(name: string, value: Matrix): ShaderMaterial;
  19776. /**
  19777. * Set a mat3 in the shader from a Float32Array.
  19778. * @param name Define the name of the uniform as defined in the shader
  19779. * @param value Define the value to give to the uniform
  19780. * @return the material itself allowing "fluent" like uniform updates
  19781. */
  19782. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  19783. /**
  19784. * Set a mat2 in the shader from a Float32Array.
  19785. * @param name Define the name of the uniform as defined in the shader
  19786. * @param value Define the value to give to the uniform
  19787. * @return the material itself allowing "fluent" like uniform updates
  19788. */
  19789. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  19790. /**
  19791. * Set a vec2 array in the shader from a number array.
  19792. * @param name Define the name of the uniform as defined in the shader
  19793. * @param value Define the value to give to the uniform
  19794. * @return the material itself allowing "fluent" like uniform updates
  19795. */
  19796. setArray2(name: string, value: number[]): ShaderMaterial;
  19797. /**
  19798. * Set a vec3 array in the shader from a number array.
  19799. * @param name Define the name of the uniform as defined in the shader
  19800. * @param value Define the value to give to the uniform
  19801. * @return the material itself allowing "fluent" like uniform updates
  19802. */
  19803. setArray3(name: string, value: number[]): ShaderMaterial;
  19804. /**
  19805. * Set a vec4 array in the shader from a number array.
  19806. * @param name Define the name of the uniform as defined in the shader
  19807. * @param value Define the value to give to the uniform
  19808. * @return the material itself allowing "fluent" like uniform updates
  19809. */
  19810. setArray4(name: string, value: number[]): ShaderMaterial;
  19811. private _checkCache;
  19812. /**
  19813. * Specifies that the submesh is ready to be used
  19814. * @param mesh defines the mesh to check
  19815. * @param subMesh defines which submesh to check
  19816. * @param useInstances specifies that instances should be used
  19817. * @returns a boolean indicating that the submesh is ready or not
  19818. */
  19819. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  19820. /**
  19821. * Checks if the material is ready to render the requested mesh
  19822. * @param mesh Define the mesh to render
  19823. * @param useInstances Define whether or not the material is used with instances
  19824. * @returns true if ready, otherwise false
  19825. */
  19826. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  19827. /**
  19828. * Binds the world matrix to the material
  19829. * @param world defines the world transformation matrix
  19830. */
  19831. bindOnlyWorldMatrix(world: Matrix): void;
  19832. /**
  19833. * Binds the material to the mesh
  19834. * @param world defines the world transformation matrix
  19835. * @param mesh defines the mesh to bind the material to
  19836. */
  19837. bind(world: Matrix, mesh?: Mesh): void;
  19838. /**
  19839. * Gets the active textures from the material
  19840. * @returns an array of textures
  19841. */
  19842. getActiveTextures(): BaseTexture[];
  19843. /**
  19844. * Specifies if the material uses a texture
  19845. * @param texture defines the texture to check against the material
  19846. * @returns a boolean specifying if the material uses the texture
  19847. */
  19848. hasTexture(texture: BaseTexture): boolean;
  19849. /**
  19850. * Makes a duplicate of the material, and gives it a new name
  19851. * @param name defines the new name for the duplicated material
  19852. * @returns the cloned material
  19853. */
  19854. clone(name: string): ShaderMaterial;
  19855. /**
  19856. * Disposes the material
  19857. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  19858. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  19859. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  19860. */
  19861. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  19862. /**
  19863. * Serializes this material in a JSON representation
  19864. * @returns the serialized material object
  19865. */
  19866. serialize(): any;
  19867. /**
  19868. * Creates a shader material from parsed shader material data
  19869. * @param source defines the JSON represnetation of the material
  19870. * @param scene defines the hosting scene
  19871. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  19872. * @returns a new material
  19873. */
  19874. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  19875. }
  19876. }
  19877. declare module "babylonjs/Shaders/color.fragment" {
  19878. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  19879. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  19880. /** @hidden */
  19881. export var colorPixelShader: {
  19882. name: string;
  19883. shader: string;
  19884. };
  19885. }
  19886. declare module "babylonjs/Shaders/color.vertex" {
  19887. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  19888. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  19889. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  19890. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  19891. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  19892. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  19893. /** @hidden */
  19894. export var colorVertexShader: {
  19895. name: string;
  19896. shader: string;
  19897. };
  19898. }
  19899. declare module "babylonjs/Meshes/linesMesh" {
  19900. import { Nullable } from "babylonjs/types";
  19901. import { Scene } from "babylonjs/scene";
  19902. import { Color3 } from "babylonjs/Maths/math.color";
  19903. import { Node } from "babylonjs/node";
  19904. import { SubMesh } from "babylonjs/Meshes/subMesh";
  19905. import { Mesh } from "babylonjs/Meshes/mesh";
  19906. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  19907. import { Effect } from "babylonjs/Materials/effect";
  19908. import { Material } from "babylonjs/Materials/material";
  19909. import "babylonjs/Shaders/color.fragment";
  19910. import "babylonjs/Shaders/color.vertex";
  19911. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19912. /**
  19913. * Line mesh
  19914. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  19915. */
  19916. export class LinesMesh extends Mesh {
  19917. /**
  19918. * If vertex color should be applied to the mesh
  19919. */
  19920. readonly useVertexColor?: boolean | undefined;
  19921. /**
  19922. * If vertex alpha should be applied to the mesh
  19923. */
  19924. readonly useVertexAlpha?: boolean | undefined;
  19925. /**
  19926. * Color of the line (Default: White)
  19927. */
  19928. color: Color3;
  19929. /**
  19930. * Alpha of the line (Default: 1)
  19931. */
  19932. alpha: number;
  19933. /**
  19934. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  19935. * This margin is expressed in world space coordinates, so its value may vary.
  19936. * Default value is 0.1
  19937. */
  19938. intersectionThreshold: number;
  19939. private _colorShader;
  19940. private color4;
  19941. /**
  19942. * Creates a new LinesMesh
  19943. * @param name defines the name
  19944. * @param scene defines the hosting scene
  19945. * @param parent defines the parent mesh if any
  19946. * @param source defines the optional source LinesMesh used to clone data from
  19947. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  19948. * When false, achieved by calling a clone(), also passing False.
  19949. * This will make creation of children, recursive.
  19950. * @param useVertexColor defines if this LinesMesh supports vertex color
  19951. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  19952. */
  19953. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  19954. /**
  19955. * If vertex color should be applied to the mesh
  19956. */
  19957. useVertexColor?: boolean | undefined,
  19958. /**
  19959. * If vertex alpha should be applied to the mesh
  19960. */
  19961. useVertexAlpha?: boolean | undefined);
  19962. private _addClipPlaneDefine;
  19963. private _removeClipPlaneDefine;
  19964. isReady(): boolean;
  19965. /**
  19966. * Returns the string "LineMesh"
  19967. */
  19968. getClassName(): string;
  19969. /**
  19970. * @hidden
  19971. */
  19972. /**
  19973. * @hidden
  19974. */
  19975. material: Material;
  19976. /**
  19977. * @hidden
  19978. */
  19979. readonly checkCollisions: boolean;
  19980. /** @hidden */
  19981. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  19982. /** @hidden */
  19983. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  19984. /**
  19985. * Disposes of the line mesh
  19986. * @param doNotRecurse If children should be disposed
  19987. */
  19988. dispose(doNotRecurse?: boolean): void;
  19989. /**
  19990. * Returns a new LineMesh object cloned from the current one.
  19991. */
  19992. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  19993. /**
  19994. * Creates a new InstancedLinesMesh object from the mesh model.
  19995. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  19996. * @param name defines the name of the new instance
  19997. * @returns a new InstancedLinesMesh
  19998. */
  19999. createInstance(name: string): InstancedLinesMesh;
  20000. }
  20001. /**
  20002. * Creates an instance based on a source LinesMesh
  20003. */
  20004. export class InstancedLinesMesh extends InstancedMesh {
  20005. /**
  20006. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  20007. * This margin is expressed in world space coordinates, so its value may vary.
  20008. * Initilized with the intersectionThreshold value of the source LinesMesh
  20009. */
  20010. intersectionThreshold: number;
  20011. constructor(name: string, source: LinesMesh);
  20012. /**
  20013. * Returns the string "InstancedLinesMesh".
  20014. */
  20015. getClassName(): string;
  20016. }
  20017. }
  20018. declare module "babylonjs/Shaders/line.fragment" {
  20019. /** @hidden */
  20020. export var linePixelShader: {
  20021. name: string;
  20022. shader: string;
  20023. };
  20024. }
  20025. declare module "babylonjs/Shaders/line.vertex" {
  20026. /** @hidden */
  20027. export var lineVertexShader: {
  20028. name: string;
  20029. shader: string;
  20030. };
  20031. }
  20032. declare module "babylonjs/Rendering/edgesRenderer" {
  20033. import { Nullable } from "babylonjs/types";
  20034. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  20035. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20036. import { Vector3 } from "babylonjs/Maths/math.vector";
  20037. import { IDisposable } from "babylonjs/scene";
  20038. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  20039. import "babylonjs/Shaders/line.fragment";
  20040. import "babylonjs/Shaders/line.vertex";
  20041. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  20042. module "babylonjs/Meshes/abstractMesh" {
  20043. interface AbstractMesh {
  20044. /**
  20045. * Gets the edgesRenderer associated with the mesh
  20046. */
  20047. edgesRenderer: Nullable<EdgesRenderer>;
  20048. }
  20049. }
  20050. module "babylonjs/Meshes/linesMesh" {
  20051. interface LinesMesh {
  20052. /**
  20053. * Enables the edge rendering mode on the mesh.
  20054. * This mode makes the mesh edges visible
  20055. * @param epsilon defines the maximal distance between two angles to detect a face
  20056. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  20057. * @returns the currentAbstractMesh
  20058. * @see https://www.babylonjs-playground.com/#19O9TU#0
  20059. */
  20060. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  20061. }
  20062. }
  20063. module "babylonjs/Meshes/linesMesh" {
  20064. interface InstancedLinesMesh {
  20065. /**
  20066. * Enables the edge rendering mode on the mesh.
  20067. * This mode makes the mesh edges visible
  20068. * @param epsilon defines the maximal distance between two angles to detect a face
  20069. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  20070. * @returns the current InstancedLinesMesh
  20071. * @see https://www.babylonjs-playground.com/#19O9TU#0
  20072. */
  20073. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  20074. }
  20075. }
  20076. /**
  20077. * Defines the minimum contract an Edges renderer should follow.
  20078. */
  20079. export interface IEdgesRenderer extends IDisposable {
  20080. /**
  20081. * Gets or sets a boolean indicating if the edgesRenderer is active
  20082. */
  20083. isEnabled: boolean;
  20084. /**
  20085. * Renders the edges of the attached mesh,
  20086. */
  20087. render(): void;
  20088. /**
  20089. * Checks wether or not the edges renderer is ready to render.
  20090. * @return true if ready, otherwise false.
  20091. */
  20092. isReady(): boolean;
  20093. }
  20094. /**
  20095. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  20096. */
  20097. export class EdgesRenderer implements IEdgesRenderer {
  20098. /**
  20099. * Define the size of the edges with an orthographic camera
  20100. */
  20101. edgesWidthScalerForOrthographic: number;
  20102. /**
  20103. * Define the size of the edges with a perspective camera
  20104. */
  20105. edgesWidthScalerForPerspective: number;
  20106. protected _source: AbstractMesh;
  20107. protected _linesPositions: number[];
  20108. protected _linesNormals: number[];
  20109. protected _linesIndices: number[];
  20110. protected _epsilon: number;
  20111. protected _indicesCount: number;
  20112. protected _lineShader: ShaderMaterial;
  20113. protected _ib: DataBuffer;
  20114. protected _buffers: {
  20115. [key: string]: Nullable<VertexBuffer>;
  20116. };
  20117. protected _checkVerticesInsteadOfIndices: boolean;
  20118. private _meshRebuildObserver;
  20119. private _meshDisposeObserver;
  20120. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  20121. isEnabled: boolean;
  20122. /**
  20123. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  20124. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  20125. * @param source Mesh used to create edges
  20126. * @param epsilon sum of angles in adjacency to check for edge
  20127. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  20128. * @param generateEdgesLines - should generate Lines or only prepare resources.
  20129. */
  20130. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  20131. protected _prepareRessources(): void;
  20132. /** @hidden */
  20133. _rebuild(): void;
  20134. /**
  20135. * Releases the required resources for the edges renderer
  20136. */
  20137. dispose(): void;
  20138. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  20139. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  20140. /**
  20141. * Checks if the pair of p0 and p1 is en edge
  20142. * @param faceIndex
  20143. * @param edge
  20144. * @param faceNormals
  20145. * @param p0
  20146. * @param p1
  20147. * @private
  20148. */
  20149. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  20150. /**
  20151. * push line into the position, normal and index buffer
  20152. * @protected
  20153. */
  20154. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  20155. /**
  20156. * Generates lines edges from adjacencjes
  20157. * @private
  20158. */
  20159. _generateEdgesLines(): void;
  20160. /**
  20161. * Checks wether or not the edges renderer is ready to render.
  20162. * @return true if ready, otherwise false.
  20163. */
  20164. isReady(): boolean;
  20165. /**
  20166. * Renders the edges of the attached mesh,
  20167. */
  20168. render(): void;
  20169. }
  20170. /**
  20171. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  20172. */
  20173. export class LineEdgesRenderer extends EdgesRenderer {
  20174. /**
  20175. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  20176. * @param source LineMesh used to generate edges
  20177. * @param epsilon not important (specified angle for edge detection)
  20178. * @param checkVerticesInsteadOfIndices not important for LineMesh
  20179. */
  20180. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  20181. /**
  20182. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  20183. */
  20184. _generateEdgesLines(): void;
  20185. }
  20186. }
  20187. declare module "babylonjs/Rendering/renderingGroup" {
  20188. import { SmartArray } from "babylonjs/Misc/smartArray";
  20189. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20190. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20191. import { Nullable } from "babylonjs/types";
  20192. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  20193. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  20194. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  20195. import { Material } from "babylonjs/Materials/material";
  20196. import { Scene } from "babylonjs/scene";
  20197. /**
  20198. * This represents the object necessary to create a rendering group.
  20199. * This is exclusively used and created by the rendering manager.
  20200. * To modify the behavior, you use the available helpers in your scene or meshes.
  20201. * @hidden
  20202. */
  20203. export class RenderingGroup {
  20204. index: number;
  20205. private static _zeroVector;
  20206. private _scene;
  20207. private _opaqueSubMeshes;
  20208. private _transparentSubMeshes;
  20209. private _alphaTestSubMeshes;
  20210. private _depthOnlySubMeshes;
  20211. private _particleSystems;
  20212. private _spriteManagers;
  20213. private _opaqueSortCompareFn;
  20214. private _alphaTestSortCompareFn;
  20215. private _transparentSortCompareFn;
  20216. private _renderOpaque;
  20217. private _renderAlphaTest;
  20218. private _renderTransparent;
  20219. /** @hidden */
  20220. _edgesRenderers: SmartArray<IEdgesRenderer>;
  20221. onBeforeTransparentRendering: () => void;
  20222. /**
  20223. * Set the opaque sort comparison function.
  20224. * If null the sub meshes will be render in the order they were created
  20225. */
  20226. opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20227. /**
  20228. * Set the alpha test sort comparison function.
  20229. * If null the sub meshes will be render in the order they were created
  20230. */
  20231. alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20232. /**
  20233. * Set the transparent sort comparison function.
  20234. * If null the sub meshes will be render in the order they were created
  20235. */
  20236. transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20237. /**
  20238. * Creates a new rendering group.
  20239. * @param index The rendering group index
  20240. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  20241. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  20242. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  20243. */
  20244. constructor(index: number, scene: Scene, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>);
  20245. /**
  20246. * Render all the sub meshes contained in the group.
  20247. * @param customRenderFunction Used to override the default render behaviour of the group.
  20248. * @returns true if rendered some submeshes.
  20249. */
  20250. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  20251. /**
  20252. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  20253. * @param subMeshes The submeshes to render
  20254. */
  20255. private renderOpaqueSorted;
  20256. /**
  20257. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  20258. * @param subMeshes The submeshes to render
  20259. */
  20260. private renderAlphaTestSorted;
  20261. /**
  20262. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  20263. * @param subMeshes The submeshes to render
  20264. */
  20265. private renderTransparentSorted;
  20266. /**
  20267. * Renders the submeshes in a specified order.
  20268. * @param subMeshes The submeshes to sort before render
  20269. * @param sortCompareFn The comparison function use to sort
  20270. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  20271. * @param transparent Specifies to activate blending if true
  20272. */
  20273. private static renderSorted;
  20274. /**
  20275. * Renders the submeshes in the order they were dispatched (no sort applied).
  20276. * @param subMeshes The submeshes to render
  20277. */
  20278. private static renderUnsorted;
  20279. /**
  20280. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20281. * are rendered back to front if in the same alpha index.
  20282. *
  20283. * @param a The first submesh
  20284. * @param b The second submesh
  20285. * @returns The result of the comparison
  20286. */
  20287. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  20288. /**
  20289. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20290. * are rendered back to front.
  20291. *
  20292. * @param a The first submesh
  20293. * @param b The second submesh
  20294. * @returns The result of the comparison
  20295. */
  20296. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  20297. /**
  20298. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20299. * are rendered front to back (prevent overdraw).
  20300. *
  20301. * @param a The first submesh
  20302. * @param b The second submesh
  20303. * @returns The result of the comparison
  20304. */
  20305. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  20306. /**
  20307. * Resets the different lists of submeshes to prepare a new frame.
  20308. */
  20309. prepare(): void;
  20310. dispose(): void;
  20311. /**
  20312. * Inserts the submesh in its correct queue depending on its material.
  20313. * @param subMesh The submesh to dispatch
  20314. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  20315. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  20316. */
  20317. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  20318. dispatchSprites(spriteManager: ISpriteManager): void;
  20319. dispatchParticles(particleSystem: IParticleSystem): void;
  20320. private _renderParticles;
  20321. private _renderSprites;
  20322. }
  20323. }
  20324. declare module "babylonjs/Rendering/renderingManager" {
  20325. import { Nullable } from "babylonjs/types";
  20326. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20327. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20328. import { SmartArray } from "babylonjs/Misc/smartArray";
  20329. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  20330. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  20331. import { Material } from "babylonjs/Materials/material";
  20332. import { Scene } from "babylonjs/scene";
  20333. import { Camera } from "babylonjs/Cameras/camera";
  20334. /**
  20335. * Interface describing the different options available in the rendering manager
  20336. * regarding Auto Clear between groups.
  20337. */
  20338. export interface IRenderingManagerAutoClearSetup {
  20339. /**
  20340. * Defines whether or not autoclear is enable.
  20341. */
  20342. autoClear: boolean;
  20343. /**
  20344. * Defines whether or not to autoclear the depth buffer.
  20345. */
  20346. depth: boolean;
  20347. /**
  20348. * Defines whether or not to autoclear the stencil buffer.
  20349. */
  20350. stencil: boolean;
  20351. }
  20352. /**
  20353. * This class is used by the onRenderingGroupObservable
  20354. */
  20355. export class RenderingGroupInfo {
  20356. /**
  20357. * The Scene that being rendered
  20358. */
  20359. scene: Scene;
  20360. /**
  20361. * The camera currently used for the rendering pass
  20362. */
  20363. camera: Nullable<Camera>;
  20364. /**
  20365. * The ID of the renderingGroup being processed
  20366. */
  20367. renderingGroupId: number;
  20368. }
  20369. /**
  20370. * This is the manager responsible of all the rendering for meshes sprites and particles.
  20371. * It is enable to manage the different groups as well as the different necessary sort functions.
  20372. * This should not be used directly aside of the few static configurations
  20373. */
  20374. export class RenderingManager {
  20375. /**
  20376. * The max id used for rendering groups (not included)
  20377. */
  20378. static MAX_RENDERINGGROUPS: number;
  20379. /**
  20380. * The min id used for rendering groups (included)
  20381. */
  20382. static MIN_RENDERINGGROUPS: number;
  20383. /**
  20384. * Used to globally prevent autoclearing scenes.
  20385. */
  20386. static AUTOCLEAR: boolean;
  20387. /**
  20388. * @hidden
  20389. */
  20390. _useSceneAutoClearSetup: boolean;
  20391. private _scene;
  20392. private _renderingGroups;
  20393. private _depthStencilBufferAlreadyCleaned;
  20394. private _autoClearDepthStencil;
  20395. private _customOpaqueSortCompareFn;
  20396. private _customAlphaTestSortCompareFn;
  20397. private _customTransparentSortCompareFn;
  20398. private _renderingGroupInfo;
  20399. /**
  20400. * Instantiates a new rendering group for a particular scene
  20401. * @param scene Defines the scene the groups belongs to
  20402. */
  20403. constructor(scene: Scene);
  20404. private _clearDepthStencilBuffer;
  20405. /**
  20406. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  20407. * @hidden
  20408. */
  20409. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  20410. /**
  20411. * Resets the different information of the group to prepare a new frame
  20412. * @hidden
  20413. */
  20414. reset(): void;
  20415. /**
  20416. * Dispose and release the group and its associated resources.
  20417. * @hidden
  20418. */
  20419. dispose(): void;
  20420. /**
  20421. * Clear the info related to rendering groups preventing retention points during dispose.
  20422. */
  20423. freeRenderingGroups(): void;
  20424. private _prepareRenderingGroup;
  20425. /**
  20426. * Add a sprite manager to the rendering manager in order to render it this frame.
  20427. * @param spriteManager Define the sprite manager to render
  20428. */
  20429. dispatchSprites(spriteManager: ISpriteManager): void;
  20430. /**
  20431. * Add a particle system to the rendering manager in order to render it this frame.
  20432. * @param particleSystem Define the particle system to render
  20433. */
  20434. dispatchParticles(particleSystem: IParticleSystem): void;
  20435. /**
  20436. * Add a submesh to the manager in order to render it this frame
  20437. * @param subMesh The submesh to dispatch
  20438. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  20439. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  20440. */
  20441. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  20442. /**
  20443. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  20444. * This allowed control for front to back rendering or reversly depending of the special needs.
  20445. *
  20446. * @param renderingGroupId The rendering group id corresponding to its index
  20447. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  20448. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  20449. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  20450. */
  20451. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  20452. /**
  20453. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  20454. *
  20455. * @param renderingGroupId The rendering group id corresponding to its index
  20456. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  20457. * @param depth Automatically clears depth between groups if true and autoClear is true.
  20458. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  20459. */
  20460. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  20461. /**
  20462. * Gets the current auto clear configuration for one rendering group of the rendering
  20463. * manager.
  20464. * @param index the rendering group index to get the information for
  20465. * @returns The auto clear setup for the requested rendering group
  20466. */
  20467. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  20468. }
  20469. }
  20470. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  20471. import { Observable } from "babylonjs/Misc/observable";
  20472. import { SmartArray } from "babylonjs/Misc/smartArray";
  20473. import { Nullable } from "babylonjs/types";
  20474. import { Camera } from "babylonjs/Cameras/camera";
  20475. import { Scene } from "babylonjs/scene";
  20476. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20477. import { Color4 } from "babylonjs/Maths/math.color";
  20478. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  20479. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20480. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20481. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20482. import { Texture } from "babylonjs/Materials/Textures/texture";
  20483. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20484. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  20485. import "babylonjs/Engines/Extensions/engine.renderTarget";
  20486. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  20487. import { Engine } from "babylonjs/Engines/engine";
  20488. /**
  20489. * This Helps creating a texture that will be created from a camera in your scene.
  20490. * It is basically a dynamic texture that could be used to create special effects for instance.
  20491. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  20492. */
  20493. export class RenderTargetTexture extends Texture {
  20494. isCube: boolean;
  20495. /**
  20496. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  20497. */
  20498. static readonly REFRESHRATE_RENDER_ONCE: number;
  20499. /**
  20500. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  20501. */
  20502. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  20503. /**
  20504. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  20505. * the central point of your effect and can save a lot of performances.
  20506. */
  20507. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  20508. /**
  20509. * Use this predicate to dynamically define the list of mesh you want to render.
  20510. * If set, the renderList property will be overwritten.
  20511. */
  20512. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  20513. private _renderList;
  20514. /**
  20515. * Use this list to define the list of mesh you want to render.
  20516. */
  20517. renderList: Nullable<Array<AbstractMesh>>;
  20518. private _hookArray;
  20519. /**
  20520. * Define if particles should be rendered in your texture.
  20521. */
  20522. renderParticles: boolean;
  20523. /**
  20524. * Define if sprites should be rendered in your texture.
  20525. */
  20526. renderSprites: boolean;
  20527. /**
  20528. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  20529. */
  20530. coordinatesMode: number;
  20531. /**
  20532. * Define the camera used to render the texture.
  20533. */
  20534. activeCamera: Nullable<Camera>;
  20535. /**
  20536. * Override the render function of the texture with your own one.
  20537. */
  20538. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  20539. /**
  20540. * Define if camera post processes should be use while rendering the texture.
  20541. */
  20542. useCameraPostProcesses: boolean;
  20543. /**
  20544. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  20545. */
  20546. ignoreCameraViewport: boolean;
  20547. private _postProcessManager;
  20548. private _postProcesses;
  20549. private _resizeObserver;
  20550. /**
  20551. * An event triggered when the texture is unbind.
  20552. */
  20553. onBeforeBindObservable: Observable<RenderTargetTexture>;
  20554. /**
  20555. * An event triggered when the texture is unbind.
  20556. */
  20557. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  20558. private _onAfterUnbindObserver;
  20559. /**
  20560. * Set a after unbind callback in the texture.
  20561. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  20562. */
  20563. onAfterUnbind: () => void;
  20564. /**
  20565. * An event triggered before rendering the texture
  20566. */
  20567. onBeforeRenderObservable: Observable<number>;
  20568. private _onBeforeRenderObserver;
  20569. /**
  20570. * Set a before render callback in the texture.
  20571. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  20572. */
  20573. onBeforeRender: (faceIndex: number) => void;
  20574. /**
  20575. * An event triggered after rendering the texture
  20576. */
  20577. onAfterRenderObservable: Observable<number>;
  20578. private _onAfterRenderObserver;
  20579. /**
  20580. * Set a after render callback in the texture.
  20581. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  20582. */
  20583. onAfterRender: (faceIndex: number) => void;
  20584. /**
  20585. * An event triggered after the texture clear
  20586. */
  20587. onClearObservable: Observable<Engine>;
  20588. private _onClearObserver;
  20589. /**
  20590. * Set a clear callback in the texture.
  20591. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  20592. */
  20593. onClear: (Engine: Engine) => void;
  20594. /**
  20595. * An event triggered when the texture is resized.
  20596. */
  20597. onResizeObservable: Observable<RenderTargetTexture>;
  20598. /**
  20599. * Define the clear color of the Render Target if it should be different from the scene.
  20600. */
  20601. clearColor: Color4;
  20602. protected _size: number | {
  20603. width: number;
  20604. height: number;
  20605. };
  20606. protected _initialSizeParameter: number | {
  20607. width: number;
  20608. height: number;
  20609. } | {
  20610. ratio: number;
  20611. };
  20612. protected _sizeRatio: Nullable<number>;
  20613. /** @hidden */
  20614. _generateMipMaps: boolean;
  20615. protected _renderingManager: RenderingManager;
  20616. /** @hidden */
  20617. _waitingRenderList: string[];
  20618. protected _doNotChangeAspectRatio: boolean;
  20619. protected _currentRefreshId: number;
  20620. protected _refreshRate: number;
  20621. protected _textureMatrix: Matrix;
  20622. protected _samples: number;
  20623. protected _renderTargetOptions: RenderTargetCreationOptions;
  20624. /**
  20625. * Gets render target creation options that were used.
  20626. */
  20627. readonly renderTargetOptions: RenderTargetCreationOptions;
  20628. protected _engine: Engine;
  20629. protected _onRatioRescale(): void;
  20630. /**
  20631. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  20632. * It must define where the camera used to render the texture is set
  20633. */
  20634. boundingBoxPosition: Vector3;
  20635. private _boundingBoxSize;
  20636. /**
  20637. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  20638. * When defined, the cubemap will switch to local mode
  20639. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  20640. * @example https://www.babylonjs-playground.com/#RNASML
  20641. */
  20642. boundingBoxSize: Vector3;
  20643. /**
  20644. * In case the RTT has been created with a depth texture, get the associated
  20645. * depth texture.
  20646. * Otherwise, return null.
  20647. */
  20648. depthStencilTexture: Nullable<InternalTexture>;
  20649. /**
  20650. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  20651. * or used a shadow, depth texture...
  20652. * @param name The friendly name of the texture
  20653. * @param size The size of the RTT (number if square, or {width: number, height:number} or {ratio:} to define a ratio from the main scene)
  20654. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  20655. * @param generateMipMaps True if mip maps need to be generated after render.
  20656. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  20657. * @param type The type of the buffer in the RTT (int, half float, float...)
  20658. * @param isCube True if a cube texture needs to be created
  20659. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  20660. * @param generateDepthBuffer True to generate a depth buffer
  20661. * @param generateStencilBuffer True to generate a stencil buffer
  20662. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  20663. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  20664. * @param delayAllocation if the texture allocation should be delayed (default: false)
  20665. */
  20666. constructor(name: string, size: number | {
  20667. width: number;
  20668. height: number;
  20669. } | {
  20670. ratio: number;
  20671. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  20672. /**
  20673. * Creates a depth stencil texture.
  20674. * This is only available in WebGL 2 or with the depth texture extension available.
  20675. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  20676. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  20677. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  20678. */
  20679. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  20680. private _processSizeParameter;
  20681. /**
  20682. * Define the number of samples to use in case of MSAA.
  20683. * It defaults to one meaning no MSAA has been enabled.
  20684. */
  20685. samples: number;
  20686. /**
  20687. * Resets the refresh counter of the texture and start bak from scratch.
  20688. * Could be useful to regenerate the texture if it is setup to render only once.
  20689. */
  20690. resetRefreshCounter(): void;
  20691. /**
  20692. * Define the refresh rate of the texture or the rendering frequency.
  20693. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  20694. */
  20695. refreshRate: number;
  20696. /**
  20697. * Adds a post process to the render target rendering passes.
  20698. * @param postProcess define the post process to add
  20699. */
  20700. addPostProcess(postProcess: PostProcess): void;
  20701. /**
  20702. * Clear all the post processes attached to the render target
  20703. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  20704. */
  20705. clearPostProcesses(dispose?: boolean): void;
  20706. /**
  20707. * Remove one of the post process from the list of attached post processes to the texture
  20708. * @param postProcess define the post process to remove from the list
  20709. */
  20710. removePostProcess(postProcess: PostProcess): void;
  20711. /** @hidden */
  20712. _shouldRender(): boolean;
  20713. /**
  20714. * Gets the actual render size of the texture.
  20715. * @returns the width of the render size
  20716. */
  20717. getRenderSize(): number;
  20718. /**
  20719. * Gets the actual render width of the texture.
  20720. * @returns the width of the render size
  20721. */
  20722. getRenderWidth(): number;
  20723. /**
  20724. * Gets the actual render height of the texture.
  20725. * @returns the height of the render size
  20726. */
  20727. getRenderHeight(): number;
  20728. /**
  20729. * Get if the texture can be rescaled or not.
  20730. */
  20731. readonly canRescale: boolean;
  20732. /**
  20733. * Resize the texture using a ratio.
  20734. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  20735. */
  20736. scale(ratio: number): void;
  20737. /**
  20738. * Get the texture reflection matrix used to rotate/transform the reflection.
  20739. * @returns the reflection matrix
  20740. */
  20741. getReflectionTextureMatrix(): Matrix;
  20742. /**
  20743. * Resize the texture to a new desired size.
  20744. * Be carrefull as it will recreate all the data in the new texture.
  20745. * @param size Define the new size. It can be:
  20746. * - a number for squared texture,
  20747. * - an object containing { width: number, height: number }
  20748. * - or an object containing a ratio { ratio: number }
  20749. */
  20750. resize(size: number | {
  20751. width: number;
  20752. height: number;
  20753. } | {
  20754. ratio: number;
  20755. }): void;
  20756. /**
  20757. * Renders all the objects from the render list into the texture.
  20758. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  20759. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  20760. */
  20761. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  20762. private _bestReflectionRenderTargetDimension;
  20763. /**
  20764. * @hidden
  20765. * @param faceIndex face index to bind to if this is a cubetexture
  20766. */
  20767. _bindFrameBuffer(faceIndex?: number): void;
  20768. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  20769. private renderToTarget;
  20770. /**
  20771. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  20772. * This allowed control for front to back rendering or reversly depending of the special needs.
  20773. *
  20774. * @param renderingGroupId The rendering group id corresponding to its index
  20775. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  20776. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  20777. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  20778. */
  20779. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  20780. /**
  20781. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  20782. *
  20783. * @param renderingGroupId The rendering group id corresponding to its index
  20784. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  20785. */
  20786. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  20787. /**
  20788. * Clones the texture.
  20789. * @returns the cloned texture
  20790. */
  20791. clone(): RenderTargetTexture;
  20792. /**
  20793. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  20794. * @returns The JSON representation of the texture
  20795. */
  20796. serialize(): any;
  20797. /**
  20798. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  20799. */
  20800. disposeFramebufferObjects(): void;
  20801. /**
  20802. * Dispose the texture and release its associated resources.
  20803. */
  20804. dispose(): void;
  20805. /** @hidden */
  20806. _rebuild(): void;
  20807. /**
  20808. * Clear the info related to rendering groups preventing retention point in material dispose.
  20809. */
  20810. freeRenderingGroups(): void;
  20811. /**
  20812. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20813. * @returns the view count
  20814. */
  20815. getViewCount(): number;
  20816. }
  20817. }
  20818. declare module "babylonjs/Materials/material" {
  20819. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  20820. import { SmartArray } from "babylonjs/Misc/smartArray";
  20821. import { Observable } from "babylonjs/Misc/observable";
  20822. import { Nullable } from "babylonjs/types";
  20823. import { Scene } from "babylonjs/scene";
  20824. import { Matrix } from "babylonjs/Maths/math.vector";
  20825. import { BaseSubMesh, SubMesh } from "babylonjs/Meshes/subMesh";
  20826. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20827. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20828. import { Effect } from "babylonjs/Materials/effect";
  20829. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20830. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20831. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20832. import { IInspectable } from "babylonjs/Misc/iInspectable";
  20833. import { Mesh } from "babylonjs/Meshes/mesh";
  20834. import { Animation } from "babylonjs/Animations/animation";
  20835. /**
  20836. * Options for compiling materials.
  20837. */
  20838. export interface IMaterialCompilationOptions {
  20839. /**
  20840. * Defines whether clip planes are enabled.
  20841. */
  20842. clipPlane: boolean;
  20843. /**
  20844. * Defines whether instances are enabled.
  20845. */
  20846. useInstances: boolean;
  20847. }
  20848. /**
  20849. * Base class for the main features of a material in Babylon.js
  20850. */
  20851. export class Material implements IAnimatable {
  20852. /**
  20853. * Returns the triangle fill mode
  20854. */
  20855. static readonly TriangleFillMode: number;
  20856. /**
  20857. * Returns the wireframe mode
  20858. */
  20859. static readonly WireFrameFillMode: number;
  20860. /**
  20861. * Returns the point fill mode
  20862. */
  20863. static readonly PointFillMode: number;
  20864. /**
  20865. * Returns the point list draw mode
  20866. */
  20867. static readonly PointListDrawMode: number;
  20868. /**
  20869. * Returns the line list draw mode
  20870. */
  20871. static readonly LineListDrawMode: number;
  20872. /**
  20873. * Returns the line loop draw mode
  20874. */
  20875. static readonly LineLoopDrawMode: number;
  20876. /**
  20877. * Returns the line strip draw mode
  20878. */
  20879. static readonly LineStripDrawMode: number;
  20880. /**
  20881. * Returns the triangle strip draw mode
  20882. */
  20883. static readonly TriangleStripDrawMode: number;
  20884. /**
  20885. * Returns the triangle fan draw mode
  20886. */
  20887. static readonly TriangleFanDrawMode: number;
  20888. /**
  20889. * Stores the clock-wise side orientation
  20890. */
  20891. static readonly ClockWiseSideOrientation: number;
  20892. /**
  20893. * Stores the counter clock-wise side orientation
  20894. */
  20895. static readonly CounterClockWiseSideOrientation: number;
  20896. /**
  20897. * The dirty texture flag value
  20898. */
  20899. static readonly TextureDirtyFlag: number;
  20900. /**
  20901. * The dirty light flag value
  20902. */
  20903. static readonly LightDirtyFlag: number;
  20904. /**
  20905. * The dirty fresnel flag value
  20906. */
  20907. static readonly FresnelDirtyFlag: number;
  20908. /**
  20909. * The dirty attribute flag value
  20910. */
  20911. static readonly AttributesDirtyFlag: number;
  20912. /**
  20913. * The dirty misc flag value
  20914. */
  20915. static readonly MiscDirtyFlag: number;
  20916. /**
  20917. * The all dirty flag value
  20918. */
  20919. static readonly AllDirtyFlag: number;
  20920. /**
  20921. * The ID of the material
  20922. */
  20923. id: string;
  20924. /**
  20925. * Gets or sets the unique id of the material
  20926. */
  20927. uniqueId: number;
  20928. /**
  20929. * The name of the material
  20930. */
  20931. name: string;
  20932. /**
  20933. * Gets or sets user defined metadata
  20934. */
  20935. metadata: any;
  20936. /**
  20937. * For internal use only. Please do not use.
  20938. */
  20939. reservedDataStore: any;
  20940. /**
  20941. * Specifies if the ready state should be checked on each call
  20942. */
  20943. checkReadyOnEveryCall: boolean;
  20944. /**
  20945. * Specifies if the ready state should be checked once
  20946. */
  20947. checkReadyOnlyOnce: boolean;
  20948. /**
  20949. * The state of the material
  20950. */
  20951. state: string;
  20952. /**
  20953. * The alpha value of the material
  20954. */
  20955. protected _alpha: number;
  20956. /**
  20957. * List of inspectable custom properties (used by the Inspector)
  20958. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  20959. */
  20960. inspectableCustomProperties: IInspectable[];
  20961. /**
  20962. * Sets the alpha value of the material
  20963. */
  20964. /**
  20965. * Gets the alpha value of the material
  20966. */
  20967. alpha: number;
  20968. /**
  20969. * Specifies if back face culling is enabled
  20970. */
  20971. protected _backFaceCulling: boolean;
  20972. /**
  20973. * Sets the back-face culling state
  20974. */
  20975. /**
  20976. * Gets the back-face culling state
  20977. */
  20978. backFaceCulling: boolean;
  20979. /**
  20980. * Stores the value for side orientation
  20981. */
  20982. sideOrientation: number;
  20983. /**
  20984. * Callback triggered when the material is compiled
  20985. */
  20986. onCompiled: Nullable<(effect: Effect) => void>;
  20987. /**
  20988. * Callback triggered when an error occurs
  20989. */
  20990. onError: Nullable<(effect: Effect, errors: string) => void>;
  20991. /**
  20992. * Callback triggered to get the render target textures
  20993. */
  20994. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  20995. /**
  20996. * Gets a boolean indicating that current material needs to register RTT
  20997. */
  20998. readonly hasRenderTargetTextures: boolean;
  20999. /**
  21000. * Specifies if the material should be serialized
  21001. */
  21002. doNotSerialize: boolean;
  21003. /**
  21004. * @hidden
  21005. */
  21006. _storeEffectOnSubMeshes: boolean;
  21007. /**
  21008. * Stores the animations for the material
  21009. */
  21010. animations: Nullable<Array<Animation>>;
  21011. /**
  21012. * An event triggered when the material is disposed
  21013. */
  21014. onDisposeObservable: Observable<Material>;
  21015. /**
  21016. * An observer which watches for dispose events
  21017. */
  21018. private _onDisposeObserver;
  21019. private _onUnBindObservable;
  21020. /**
  21021. * Called during a dispose event
  21022. */
  21023. onDispose: () => void;
  21024. private _onBindObservable;
  21025. /**
  21026. * An event triggered when the material is bound
  21027. */
  21028. readonly onBindObservable: Observable<AbstractMesh>;
  21029. /**
  21030. * An observer which watches for bind events
  21031. */
  21032. private _onBindObserver;
  21033. /**
  21034. * Called during a bind event
  21035. */
  21036. onBind: (Mesh: AbstractMesh) => void;
  21037. /**
  21038. * An event triggered when the material is unbound
  21039. */
  21040. readonly onUnBindObservable: Observable<Material>;
  21041. /**
  21042. * Stores the value of the alpha mode
  21043. */
  21044. private _alphaMode;
  21045. /**
  21046. * Sets the value of the alpha mode.
  21047. *
  21048. * | Value | Type | Description |
  21049. * | --- | --- | --- |
  21050. * | 0 | ALPHA_DISABLE | |
  21051. * | 1 | ALPHA_ADD | |
  21052. * | 2 | ALPHA_COMBINE | |
  21053. * | 3 | ALPHA_SUBTRACT | |
  21054. * | 4 | ALPHA_MULTIPLY | |
  21055. * | 5 | ALPHA_MAXIMIZED | |
  21056. * | 6 | ALPHA_ONEONE | |
  21057. * | 7 | ALPHA_PREMULTIPLIED | |
  21058. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  21059. * | 9 | ALPHA_INTERPOLATE | |
  21060. * | 10 | ALPHA_SCREENMODE | |
  21061. *
  21062. */
  21063. /**
  21064. * Gets the value of the alpha mode
  21065. */
  21066. alphaMode: number;
  21067. /**
  21068. * Stores the state of the need depth pre-pass value
  21069. */
  21070. private _needDepthPrePass;
  21071. /**
  21072. * Sets the need depth pre-pass value
  21073. */
  21074. /**
  21075. * Gets the depth pre-pass value
  21076. */
  21077. needDepthPrePass: boolean;
  21078. /**
  21079. * Specifies if depth writing should be disabled
  21080. */
  21081. disableDepthWrite: boolean;
  21082. /**
  21083. * Specifies if depth writing should be forced
  21084. */
  21085. forceDepthWrite: boolean;
  21086. /**
  21087. * Specifies if there should be a separate pass for culling
  21088. */
  21089. separateCullingPass: boolean;
  21090. /**
  21091. * Stores the state specifing if fog should be enabled
  21092. */
  21093. private _fogEnabled;
  21094. /**
  21095. * Sets the state for enabling fog
  21096. */
  21097. /**
  21098. * Gets the value of the fog enabled state
  21099. */
  21100. fogEnabled: boolean;
  21101. /**
  21102. * Stores the size of points
  21103. */
  21104. pointSize: number;
  21105. /**
  21106. * Stores the z offset value
  21107. */
  21108. zOffset: number;
  21109. /**
  21110. * Gets a value specifying if wireframe mode is enabled
  21111. */
  21112. /**
  21113. * Sets the state of wireframe mode
  21114. */
  21115. wireframe: boolean;
  21116. /**
  21117. * Gets the value specifying if point clouds are enabled
  21118. */
  21119. /**
  21120. * Sets the state of point cloud mode
  21121. */
  21122. pointsCloud: boolean;
  21123. /**
  21124. * Gets the material fill mode
  21125. */
  21126. /**
  21127. * Sets the material fill mode
  21128. */
  21129. fillMode: number;
  21130. /**
  21131. * @hidden
  21132. * Stores the effects for the material
  21133. */
  21134. _effect: Nullable<Effect>;
  21135. /**
  21136. * @hidden
  21137. * Specifies if the material was previously ready
  21138. */
  21139. _wasPreviouslyReady: boolean;
  21140. /**
  21141. * Specifies if uniform buffers should be used
  21142. */
  21143. private _useUBO;
  21144. /**
  21145. * Stores a reference to the scene
  21146. */
  21147. private _scene;
  21148. /**
  21149. * Stores the fill mode state
  21150. */
  21151. private _fillMode;
  21152. /**
  21153. * Specifies if the depth write state should be cached
  21154. */
  21155. private _cachedDepthWriteState;
  21156. /**
  21157. * Stores the uniform buffer
  21158. */
  21159. protected _uniformBuffer: UniformBuffer;
  21160. /** @hidden */
  21161. _indexInSceneMaterialArray: number;
  21162. /** @hidden */
  21163. meshMap: Nullable<{
  21164. [id: string]: AbstractMesh | undefined;
  21165. }>;
  21166. /**
  21167. * Creates a material instance
  21168. * @param name defines the name of the material
  21169. * @param scene defines the scene to reference
  21170. * @param doNotAdd specifies if the material should be added to the scene
  21171. */
  21172. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  21173. /**
  21174. * Returns a string representation of the current material
  21175. * @param fullDetails defines a boolean indicating which levels of logging is desired
  21176. * @returns a string with material information
  21177. */
  21178. toString(fullDetails?: boolean): string;
  21179. /**
  21180. * Gets the class name of the material
  21181. * @returns a string with the class name of the material
  21182. */
  21183. getClassName(): string;
  21184. /**
  21185. * Specifies if updates for the material been locked
  21186. */
  21187. readonly isFrozen: boolean;
  21188. /**
  21189. * Locks updates for the material
  21190. */
  21191. freeze(): void;
  21192. /**
  21193. * Unlocks updates for the material
  21194. */
  21195. unfreeze(): void;
  21196. /**
  21197. * Specifies if the material is ready to be used
  21198. * @param mesh defines the mesh to check
  21199. * @param useInstances specifies if instances should be used
  21200. * @returns a boolean indicating if the material is ready to be used
  21201. */
  21202. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  21203. /**
  21204. * Specifies that the submesh is ready to be used
  21205. * @param mesh defines the mesh to check
  21206. * @param subMesh defines which submesh to check
  21207. * @param useInstances specifies that instances should be used
  21208. * @returns a boolean indicating that the submesh is ready or not
  21209. */
  21210. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  21211. /**
  21212. * Returns the material effect
  21213. * @returns the effect associated with the material
  21214. */
  21215. getEffect(): Nullable<Effect>;
  21216. /**
  21217. * Returns the current scene
  21218. * @returns a Scene
  21219. */
  21220. getScene(): Scene;
  21221. /**
  21222. * Specifies if the material will require alpha blending
  21223. * @returns a boolean specifying if alpha blending is needed
  21224. */
  21225. needAlphaBlending(): boolean;
  21226. /**
  21227. * Specifies if the mesh will require alpha blending
  21228. * @param mesh defines the mesh to check
  21229. * @returns a boolean specifying if alpha blending is needed for the mesh
  21230. */
  21231. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  21232. /**
  21233. * Specifies if this material should be rendered in alpha test mode
  21234. * @returns a boolean specifying if an alpha test is needed.
  21235. */
  21236. needAlphaTesting(): boolean;
  21237. /**
  21238. * Gets the texture used for the alpha test
  21239. * @returns the texture to use for alpha testing
  21240. */
  21241. getAlphaTestTexture(): Nullable<BaseTexture>;
  21242. /**
  21243. * Marks the material to indicate that it needs to be re-calculated
  21244. */
  21245. markDirty(): void;
  21246. /** @hidden */
  21247. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  21248. /**
  21249. * Binds the material to the mesh
  21250. * @param world defines the world transformation matrix
  21251. * @param mesh defines the mesh to bind the material to
  21252. */
  21253. bind(world: Matrix, mesh?: Mesh): void;
  21254. /**
  21255. * Binds the submesh to the material
  21256. * @param world defines the world transformation matrix
  21257. * @param mesh defines the mesh containing the submesh
  21258. * @param subMesh defines the submesh to bind the material to
  21259. */
  21260. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  21261. /**
  21262. * Binds the world matrix to the material
  21263. * @param world defines the world transformation matrix
  21264. */
  21265. bindOnlyWorldMatrix(world: Matrix): void;
  21266. /**
  21267. * Binds the scene's uniform buffer to the effect.
  21268. * @param effect defines the effect to bind to the scene uniform buffer
  21269. * @param sceneUbo defines the uniform buffer storing scene data
  21270. */
  21271. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  21272. /**
  21273. * Binds the view matrix to the effect
  21274. * @param effect defines the effect to bind the view matrix to
  21275. */
  21276. bindView(effect: Effect): void;
  21277. /**
  21278. * Binds the view projection matrix to the effect
  21279. * @param effect defines the effect to bind the view projection matrix to
  21280. */
  21281. bindViewProjection(effect: Effect): void;
  21282. /**
  21283. * Specifies if material alpha testing should be turned on for the mesh
  21284. * @param mesh defines the mesh to check
  21285. */
  21286. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  21287. /**
  21288. * Processes to execute after binding the material to a mesh
  21289. * @param mesh defines the rendered mesh
  21290. */
  21291. protected _afterBind(mesh?: Mesh): void;
  21292. /**
  21293. * Unbinds the material from the mesh
  21294. */
  21295. unbind(): void;
  21296. /**
  21297. * Gets the active textures from the material
  21298. * @returns an array of textures
  21299. */
  21300. getActiveTextures(): BaseTexture[];
  21301. /**
  21302. * Specifies if the material uses a texture
  21303. * @param texture defines the texture to check against the material
  21304. * @returns a boolean specifying if the material uses the texture
  21305. */
  21306. hasTexture(texture: BaseTexture): boolean;
  21307. /**
  21308. * Makes a duplicate of the material, and gives it a new name
  21309. * @param name defines the new name for the duplicated material
  21310. * @returns the cloned material
  21311. */
  21312. clone(name: string): Nullable<Material>;
  21313. /**
  21314. * Gets the meshes bound to the material
  21315. * @returns an array of meshes bound to the material
  21316. */
  21317. getBindedMeshes(): AbstractMesh[];
  21318. /**
  21319. * Force shader compilation
  21320. * @param mesh defines the mesh associated with this material
  21321. * @param onCompiled defines a function to execute once the material is compiled
  21322. * @param options defines the options to configure the compilation
  21323. * @param onError defines a function to execute if the material fails compiling
  21324. */
  21325. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  21326. /**
  21327. * Force shader compilation
  21328. * @param mesh defines the mesh that will use this material
  21329. * @param options defines additional options for compiling the shaders
  21330. * @returns a promise that resolves when the compilation completes
  21331. */
  21332. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  21333. private static readonly _AllDirtyCallBack;
  21334. private static readonly _ImageProcessingDirtyCallBack;
  21335. private static readonly _TextureDirtyCallBack;
  21336. private static readonly _FresnelDirtyCallBack;
  21337. private static readonly _MiscDirtyCallBack;
  21338. private static readonly _LightsDirtyCallBack;
  21339. private static readonly _AttributeDirtyCallBack;
  21340. private static _FresnelAndMiscDirtyCallBack;
  21341. private static _TextureAndMiscDirtyCallBack;
  21342. private static readonly _DirtyCallbackArray;
  21343. private static readonly _RunDirtyCallBacks;
  21344. /**
  21345. * Marks a define in the material to indicate that it needs to be re-computed
  21346. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  21347. */
  21348. markAsDirty(flag: number): void;
  21349. /**
  21350. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  21351. * @param func defines a function which checks material defines against the submeshes
  21352. */
  21353. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  21354. /**
  21355. * Indicates that we need to re-calculated for all submeshes
  21356. */
  21357. protected _markAllSubMeshesAsAllDirty(): void;
  21358. /**
  21359. * Indicates that image processing needs to be re-calculated for all submeshes
  21360. */
  21361. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  21362. /**
  21363. * Indicates that textures need to be re-calculated for all submeshes
  21364. */
  21365. protected _markAllSubMeshesAsTexturesDirty(): void;
  21366. /**
  21367. * Indicates that fresnel needs to be re-calculated for all submeshes
  21368. */
  21369. protected _markAllSubMeshesAsFresnelDirty(): void;
  21370. /**
  21371. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  21372. */
  21373. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  21374. /**
  21375. * Indicates that lights need to be re-calculated for all submeshes
  21376. */
  21377. protected _markAllSubMeshesAsLightsDirty(): void;
  21378. /**
  21379. * Indicates that attributes need to be re-calculated for all submeshes
  21380. */
  21381. protected _markAllSubMeshesAsAttributesDirty(): void;
  21382. /**
  21383. * Indicates that misc needs to be re-calculated for all submeshes
  21384. */
  21385. protected _markAllSubMeshesAsMiscDirty(): void;
  21386. /**
  21387. * Indicates that textures and misc need to be re-calculated for all submeshes
  21388. */
  21389. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  21390. /**
  21391. * Disposes the material
  21392. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  21393. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  21394. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  21395. */
  21396. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  21397. /** @hidden */
  21398. private releaseVertexArrayObject;
  21399. /**
  21400. * Serializes this material
  21401. * @returns the serialized material object
  21402. */
  21403. serialize(): any;
  21404. /**
  21405. * Creates a material from parsed material data
  21406. * @param parsedMaterial defines parsed material data
  21407. * @param scene defines the hosting scene
  21408. * @param rootUrl defines the root URL to use to load textures
  21409. * @returns a new material
  21410. */
  21411. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  21412. }
  21413. }
  21414. declare module "babylonjs/Materials/multiMaterial" {
  21415. import { Nullable } from "babylonjs/types";
  21416. import { Scene } from "babylonjs/scene";
  21417. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21418. import { BaseSubMesh } from "babylonjs/Meshes/subMesh";
  21419. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21420. import { Material } from "babylonjs/Materials/material";
  21421. /**
  21422. * A multi-material is used to apply different materials to different parts of the same object without the need of
  21423. * separate meshes. This can be use to improve performances.
  21424. * @see http://doc.babylonjs.com/how_to/multi_materials
  21425. */
  21426. export class MultiMaterial extends Material {
  21427. private _subMaterials;
  21428. /**
  21429. * Gets or Sets the list of Materials used within the multi material.
  21430. * They need to be ordered according to the submeshes order in the associated mesh
  21431. */
  21432. subMaterials: Nullable<Material>[];
  21433. /**
  21434. * Function used to align with Node.getChildren()
  21435. * @returns the list of Materials used within the multi material
  21436. */
  21437. getChildren(): Nullable<Material>[];
  21438. /**
  21439. * Instantiates a new Multi Material
  21440. * A multi-material is used to apply different materials to different parts of the same object without the need of
  21441. * separate meshes. This can be use to improve performances.
  21442. * @see http://doc.babylonjs.com/how_to/multi_materials
  21443. * @param name Define the name in the scene
  21444. * @param scene Define the scene the material belongs to
  21445. */
  21446. constructor(name: string, scene: Scene);
  21447. private _hookArray;
  21448. /**
  21449. * Get one of the submaterial by its index in the submaterials array
  21450. * @param index The index to look the sub material at
  21451. * @returns The Material if the index has been defined
  21452. */
  21453. getSubMaterial(index: number): Nullable<Material>;
  21454. /**
  21455. * Get the list of active textures for the whole sub materials list.
  21456. * @returns All the textures that will be used during the rendering
  21457. */
  21458. getActiveTextures(): BaseTexture[];
  21459. /**
  21460. * Gets the current class name of the material e.g. "MultiMaterial"
  21461. * Mainly use in serialization.
  21462. * @returns the class name
  21463. */
  21464. getClassName(): string;
  21465. /**
  21466. * Checks if the material is ready to render the requested sub mesh
  21467. * @param mesh Define the mesh the submesh belongs to
  21468. * @param subMesh Define the sub mesh to look readyness for
  21469. * @param useInstances Define whether or not the material is used with instances
  21470. * @returns true if ready, otherwise false
  21471. */
  21472. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  21473. /**
  21474. * Clones the current material and its related sub materials
  21475. * @param name Define the name of the newly cloned material
  21476. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  21477. * @returns the cloned material
  21478. */
  21479. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  21480. /**
  21481. * Serializes the materials into a JSON representation.
  21482. * @returns the JSON representation
  21483. */
  21484. serialize(): any;
  21485. /**
  21486. * Dispose the material and release its associated resources
  21487. * @param forceDisposeEffect Define if we want to force disposing the associated effect (if false the shader is not released and could be reuse later on)
  21488. * @param forceDisposeTextures Define if we want to force disposing the associated textures (if false, they will not be disposed and can still be use elsewhere in the app)
  21489. * @param forceDisposeChildren Define if we want to force disposing the associated submaterials (if false, they will not be disposed and can still be use elsewhere in the app)
  21490. */
  21491. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  21492. /**
  21493. * Creates a MultiMaterial from parsed MultiMaterial data.
  21494. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  21495. * @param scene defines the hosting scene
  21496. * @returns a new MultiMaterial
  21497. */
  21498. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  21499. }
  21500. }
  21501. declare module "babylonjs/Meshes/subMesh" {
  21502. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  21503. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  21504. import { Engine } from "babylonjs/Engines/engine";
  21505. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  21506. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  21507. import { Effect } from "babylonjs/Materials/effect";
  21508. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  21509. import { Plane } from "babylonjs/Maths/math.plane";
  21510. import { Collider } from "babylonjs/Collisions/collider";
  21511. import { Material } from "babylonjs/Materials/material";
  21512. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  21513. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21514. import { Mesh } from "babylonjs/Meshes/mesh";
  21515. import { Ray } from "babylonjs/Culling/ray";
  21516. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  21517. /**
  21518. * Base class for submeshes
  21519. */
  21520. export class BaseSubMesh {
  21521. /** @hidden */
  21522. _materialDefines: Nullable<MaterialDefines>;
  21523. /** @hidden */
  21524. _materialEffect: Nullable<Effect>;
  21525. /**
  21526. * Gets associated effect
  21527. */
  21528. readonly effect: Nullable<Effect>;
  21529. /**
  21530. * Sets associated effect (effect used to render this submesh)
  21531. * @param effect defines the effect to associate with
  21532. * @param defines defines the set of defines used to compile this effect
  21533. */
  21534. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  21535. }
  21536. /**
  21537. * Defines a subdivision inside a mesh
  21538. */
  21539. export class SubMesh extends BaseSubMesh implements ICullable {
  21540. /** the material index to use */
  21541. materialIndex: number;
  21542. /** vertex index start */
  21543. verticesStart: number;
  21544. /** vertices count */
  21545. verticesCount: number;
  21546. /** index start */
  21547. indexStart: number;
  21548. /** indices count */
  21549. indexCount: number;
  21550. /** @hidden */
  21551. _linesIndexCount: number;
  21552. private _mesh;
  21553. private _renderingMesh;
  21554. private _boundingInfo;
  21555. private _linesIndexBuffer;
  21556. /** @hidden */
  21557. _lastColliderWorldVertices: Nullable<Vector3[]>;
  21558. /** @hidden */
  21559. _trianglePlanes: Plane[];
  21560. /** @hidden */
  21561. _lastColliderTransformMatrix: Nullable<Matrix>;
  21562. /** @hidden */
  21563. _renderId: number;
  21564. /** @hidden */
  21565. _alphaIndex: number;
  21566. /** @hidden */
  21567. _distanceToCamera: number;
  21568. /** @hidden */
  21569. _id: number;
  21570. private _currentMaterial;
  21571. /**
  21572. * Add a new submesh to a mesh
  21573. * @param materialIndex defines the material index to use
  21574. * @param verticesStart defines vertex index start
  21575. * @param verticesCount defines vertices count
  21576. * @param indexStart defines index start
  21577. * @param indexCount defines indices count
  21578. * @param mesh defines the parent mesh
  21579. * @param renderingMesh defines an optional rendering mesh
  21580. * @param createBoundingBox defines if bounding box should be created for this submesh
  21581. * @returns the new submesh
  21582. */
  21583. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  21584. /**
  21585. * Creates a new submesh
  21586. * @param materialIndex defines the material index to use
  21587. * @param verticesStart defines vertex index start
  21588. * @param verticesCount defines vertices count
  21589. * @param indexStart defines index start
  21590. * @param indexCount defines indices count
  21591. * @param mesh defines the parent mesh
  21592. * @param renderingMesh defines an optional rendering mesh
  21593. * @param createBoundingBox defines if bounding box should be created for this submesh
  21594. */
  21595. constructor(
  21596. /** the material index to use */
  21597. materialIndex: number,
  21598. /** vertex index start */
  21599. verticesStart: number,
  21600. /** vertices count */
  21601. verticesCount: number,
  21602. /** index start */
  21603. indexStart: number,
  21604. /** indices count */
  21605. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean);
  21606. /**
  21607. * Returns true if this submesh covers the entire parent mesh
  21608. * @ignorenaming
  21609. */
  21610. readonly IsGlobal: boolean;
  21611. /**
  21612. * Returns the submesh BoudingInfo object
  21613. * @returns current bounding info (or mesh's one if the submesh is global)
  21614. */
  21615. getBoundingInfo(): BoundingInfo;
  21616. /**
  21617. * Sets the submesh BoundingInfo
  21618. * @param boundingInfo defines the new bounding info to use
  21619. * @returns the SubMesh
  21620. */
  21621. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  21622. /**
  21623. * Returns the mesh of the current submesh
  21624. * @return the parent mesh
  21625. */
  21626. getMesh(): AbstractMesh;
  21627. /**
  21628. * Returns the rendering mesh of the submesh
  21629. * @returns the rendering mesh (could be different from parent mesh)
  21630. */
  21631. getRenderingMesh(): Mesh;
  21632. /**
  21633. * Returns the submesh material
  21634. * @returns null or the current material
  21635. */
  21636. getMaterial(): Nullable<Material>;
  21637. /**
  21638. * Sets a new updated BoundingInfo object to the submesh
  21639. * @param data defines an optional position array to use to determine the bounding info
  21640. * @returns the SubMesh
  21641. */
  21642. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  21643. /** @hidden */
  21644. _checkCollision(collider: Collider): boolean;
  21645. /**
  21646. * Updates the submesh BoundingInfo
  21647. * @param world defines the world matrix to use to update the bounding info
  21648. * @returns the submesh
  21649. */
  21650. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  21651. /**
  21652. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  21653. * @param frustumPlanes defines the frustum planes
  21654. * @returns true if the submesh is intersecting with the frustum
  21655. */
  21656. isInFrustum(frustumPlanes: Plane[]): boolean;
  21657. /**
  21658. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  21659. * @param frustumPlanes defines the frustum planes
  21660. * @returns true if the submesh is inside the frustum
  21661. */
  21662. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  21663. /**
  21664. * Renders the submesh
  21665. * @param enableAlphaMode defines if alpha needs to be used
  21666. * @returns the submesh
  21667. */
  21668. render(enableAlphaMode: boolean): SubMesh;
  21669. /**
  21670. * @hidden
  21671. */
  21672. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  21673. /**
  21674. * Checks if the submesh intersects with a ray
  21675. * @param ray defines the ray to test
  21676. * @returns true is the passed ray intersects the submesh bounding box
  21677. */
  21678. canIntersects(ray: Ray): boolean;
  21679. /**
  21680. * Intersects current submesh with a ray
  21681. * @param ray defines the ray to test
  21682. * @param positions defines mesh's positions array
  21683. * @param indices defines mesh's indices array
  21684. * @param fastCheck defines if only bounding info should be used
  21685. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  21686. * @returns intersection info or null if no intersection
  21687. */
  21688. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  21689. /** @hidden */
  21690. private _intersectLines;
  21691. /** @hidden */
  21692. private _intersectUnIndexedLines;
  21693. /** @hidden */
  21694. private _intersectTriangles;
  21695. /** @hidden */
  21696. private _intersectUnIndexedTriangles;
  21697. /** @hidden */
  21698. _rebuild(): void;
  21699. /**
  21700. * Creates a new submesh from the passed mesh
  21701. * @param newMesh defines the new hosting mesh
  21702. * @param newRenderingMesh defines an optional rendering mesh
  21703. * @returns the new submesh
  21704. */
  21705. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  21706. /**
  21707. * Release associated resources
  21708. */
  21709. dispose(): void;
  21710. /**
  21711. * Gets the class name
  21712. * @returns the string "SubMesh".
  21713. */
  21714. getClassName(): string;
  21715. /**
  21716. * Creates a new submesh from indices data
  21717. * @param materialIndex the index of the main mesh material
  21718. * @param startIndex the index where to start the copy in the mesh indices array
  21719. * @param indexCount the number of indices to copy then from the startIndex
  21720. * @param mesh the main mesh to create the submesh from
  21721. * @param renderingMesh the optional rendering mesh
  21722. * @returns a new submesh
  21723. */
  21724. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  21725. }
  21726. }
  21727. declare module "babylonjs/Loading/sceneLoaderFlags" {
  21728. /**
  21729. * Class used to represent data loading progression
  21730. */
  21731. export class SceneLoaderFlags {
  21732. private static _ForceFullSceneLoadingForIncremental;
  21733. private static _ShowLoadingScreen;
  21734. private static _CleanBoneMatrixWeights;
  21735. private static _loggingLevel;
  21736. /**
  21737. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  21738. */
  21739. static ForceFullSceneLoadingForIncremental: boolean;
  21740. /**
  21741. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  21742. */
  21743. static ShowLoadingScreen: boolean;
  21744. /**
  21745. * Defines the current logging level (while loading the scene)
  21746. * @ignorenaming
  21747. */
  21748. static loggingLevel: number;
  21749. /**
  21750. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  21751. */
  21752. static CleanBoneMatrixWeights: boolean;
  21753. }
  21754. }
  21755. declare module "babylonjs/Meshes/geometry" {
  21756. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  21757. import { Scene } from "babylonjs/scene";
  21758. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  21759. import { Engine } from "babylonjs/Engines/engine";
  21760. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  21761. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  21762. import { Effect } from "babylonjs/Materials/effect";
  21763. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  21764. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  21765. import { Mesh } from "babylonjs/Meshes/mesh";
  21766. /**
  21767. * Class used to store geometry data (vertex buffers + index buffer)
  21768. */
  21769. export class Geometry implements IGetSetVerticesData {
  21770. /**
  21771. * Gets or sets the ID of the geometry
  21772. */
  21773. id: string;
  21774. /**
  21775. * Gets or sets the unique ID of the geometry
  21776. */
  21777. uniqueId: number;
  21778. /**
  21779. * Gets the delay loading state of the geometry (none by default which means not delayed)
  21780. */
  21781. delayLoadState: number;
  21782. /**
  21783. * Gets the file containing the data to load when running in delay load state
  21784. */
  21785. delayLoadingFile: Nullable<string>;
  21786. /**
  21787. * Callback called when the geometry is updated
  21788. */
  21789. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  21790. private _scene;
  21791. private _engine;
  21792. private _meshes;
  21793. private _totalVertices;
  21794. /** @hidden */
  21795. _indices: IndicesArray;
  21796. /** @hidden */
  21797. _vertexBuffers: {
  21798. [key: string]: VertexBuffer;
  21799. };
  21800. private _isDisposed;
  21801. private _extend;
  21802. private _boundingBias;
  21803. /** @hidden */
  21804. _delayInfo: Array<string>;
  21805. private _indexBuffer;
  21806. private _indexBufferIsUpdatable;
  21807. /** @hidden */
  21808. _boundingInfo: Nullable<BoundingInfo>;
  21809. /** @hidden */
  21810. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  21811. /** @hidden */
  21812. _softwareSkinningFrameId: number;
  21813. private _vertexArrayObjects;
  21814. private _updatable;
  21815. /** @hidden */
  21816. _positions: Nullable<Vector3[]>;
  21817. /**
  21818. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  21819. */
  21820. /**
  21821. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  21822. */
  21823. boundingBias: Vector2;
  21824. /**
  21825. * Static function used to attach a new empty geometry to a mesh
  21826. * @param mesh defines the mesh to attach the geometry to
  21827. * @returns the new Geometry
  21828. */
  21829. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  21830. /**
  21831. * Creates a new geometry
  21832. * @param id defines the unique ID
  21833. * @param scene defines the hosting scene
  21834. * @param vertexData defines the VertexData used to get geometry data
  21835. * @param updatable defines if geometry must be updatable (false by default)
  21836. * @param mesh defines the mesh that will be associated with the geometry
  21837. */
  21838. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  21839. /**
  21840. * Gets the current extend of the geometry
  21841. */
  21842. readonly extend: {
  21843. minimum: Vector3;
  21844. maximum: Vector3;
  21845. };
  21846. /**
  21847. * Gets the hosting scene
  21848. * @returns the hosting Scene
  21849. */
  21850. getScene(): Scene;
  21851. /**
  21852. * Gets the hosting engine
  21853. * @returns the hosting Engine
  21854. */
  21855. getEngine(): Engine;
  21856. /**
  21857. * Defines if the geometry is ready to use
  21858. * @returns true if the geometry is ready to be used
  21859. */
  21860. isReady(): boolean;
  21861. /**
  21862. * Gets a value indicating that the geometry should not be serialized
  21863. */
  21864. readonly doNotSerialize: boolean;
  21865. /** @hidden */
  21866. _rebuild(): void;
  21867. /**
  21868. * Affects all geometry data in one call
  21869. * @param vertexData defines the geometry data
  21870. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  21871. */
  21872. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  21873. /**
  21874. * Set specific vertex data
  21875. * @param kind defines the data kind (Position, normal, etc...)
  21876. * @param data defines the vertex data to use
  21877. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  21878. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  21879. */
  21880. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  21881. /**
  21882. * Removes a specific vertex data
  21883. * @param kind defines the data kind (Position, normal, etc...)
  21884. */
  21885. removeVerticesData(kind: string): void;
  21886. /**
  21887. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  21888. * @param buffer defines the vertex buffer to use
  21889. * @param totalVertices defines the total number of vertices for position kind (could be null)
  21890. */
  21891. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  21892. /**
  21893. * Update a specific vertex buffer
  21894. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  21895. * It will do nothing if the buffer is not updatable
  21896. * @param kind defines the data kind (Position, normal, etc...)
  21897. * @param data defines the data to use
  21898. * @param offset defines the offset in the target buffer where to store the data
  21899. * @param useBytes set to true if the offset is in bytes
  21900. */
  21901. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  21902. /**
  21903. * Update a specific vertex buffer
  21904. * This function will create a new buffer if the current one is not updatable
  21905. * @param kind defines the data kind (Position, normal, etc...)
  21906. * @param data defines the data to use
  21907. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  21908. */
  21909. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  21910. private _updateBoundingInfo;
  21911. /** @hidden */
  21912. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  21913. /**
  21914. * Gets total number of vertices
  21915. * @returns the total number of vertices
  21916. */
  21917. getTotalVertices(): number;
  21918. /**
  21919. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  21920. * @param kind defines the data kind (Position, normal, etc...)
  21921. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  21922. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  21923. * @returns a float array containing vertex data
  21924. */
  21925. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  21926. /**
  21927. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  21928. * @param kind defines the data kind (Position, normal, etc...)
  21929. * @returns true if the vertex buffer with the specified kind is updatable
  21930. */
  21931. isVertexBufferUpdatable(kind: string): boolean;
  21932. /**
  21933. * Gets a specific vertex buffer
  21934. * @param kind defines the data kind (Position, normal, etc...)
  21935. * @returns a VertexBuffer
  21936. */
  21937. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  21938. /**
  21939. * Returns all vertex buffers
  21940. * @return an object holding all vertex buffers indexed by kind
  21941. */
  21942. getVertexBuffers(): Nullable<{
  21943. [key: string]: VertexBuffer;
  21944. }>;
  21945. /**
  21946. * Gets a boolean indicating if specific vertex buffer is present
  21947. * @param kind defines the data kind (Position, normal, etc...)
  21948. * @returns true if data is present
  21949. */
  21950. isVerticesDataPresent(kind: string): boolean;
  21951. /**
  21952. * Gets a list of all attached data kinds (Position, normal, etc...)
  21953. * @returns a list of string containing all kinds
  21954. */
  21955. getVerticesDataKinds(): string[];
  21956. /**
  21957. * Update index buffer
  21958. * @param indices defines the indices to store in the index buffer
  21959. * @param offset defines the offset in the target buffer where to store the data
  21960. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  21961. */
  21962. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  21963. /**
  21964. * Creates a new index buffer
  21965. * @param indices defines the indices to store in the index buffer
  21966. * @param totalVertices defines the total number of vertices (could be null)
  21967. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  21968. */
  21969. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  21970. /**
  21971. * Return the total number of indices
  21972. * @returns the total number of indices
  21973. */
  21974. getTotalIndices(): number;
  21975. /**
  21976. * Gets the index buffer array
  21977. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  21978. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  21979. * @returns the index buffer array
  21980. */
  21981. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  21982. /**
  21983. * Gets the index buffer
  21984. * @return the index buffer
  21985. */
  21986. getIndexBuffer(): Nullable<DataBuffer>;
  21987. /** @hidden */
  21988. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  21989. /**
  21990. * Release the associated resources for a specific mesh
  21991. * @param mesh defines the source mesh
  21992. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  21993. */
  21994. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  21995. /**
  21996. * Apply current geometry to a given mesh
  21997. * @param mesh defines the mesh to apply geometry to
  21998. */
  21999. applyToMesh(mesh: Mesh): void;
  22000. private _updateExtend;
  22001. private _applyToMesh;
  22002. private notifyUpdate;
  22003. /**
  22004. * Load the geometry if it was flagged as delay loaded
  22005. * @param scene defines the hosting scene
  22006. * @param onLoaded defines a callback called when the geometry is loaded
  22007. */
  22008. load(scene: Scene, onLoaded?: () => void): void;
  22009. private _queueLoad;
  22010. /**
  22011. * Invert the geometry to move from a right handed system to a left handed one.
  22012. */
  22013. toLeftHanded(): void;
  22014. /** @hidden */
  22015. _resetPointsArrayCache(): void;
  22016. /** @hidden */
  22017. _generatePointsArray(): boolean;
  22018. /**
  22019. * Gets a value indicating if the geometry is disposed
  22020. * @returns true if the geometry was disposed
  22021. */
  22022. isDisposed(): boolean;
  22023. private _disposeVertexArrayObjects;
  22024. /**
  22025. * Free all associated resources
  22026. */
  22027. dispose(): void;
  22028. /**
  22029. * Clone the current geometry into a new geometry
  22030. * @param id defines the unique ID of the new geometry
  22031. * @returns a new geometry object
  22032. */
  22033. copy(id: string): Geometry;
  22034. /**
  22035. * Serialize the current geometry info (and not the vertices data) into a JSON object
  22036. * @return a JSON representation of the current geometry data (without the vertices data)
  22037. */
  22038. serialize(): any;
  22039. private toNumberArray;
  22040. /**
  22041. * Serialize all vertices data into a JSON oject
  22042. * @returns a JSON representation of the current geometry data
  22043. */
  22044. serializeVerticeData(): any;
  22045. /**
  22046. * Extracts a clone of a mesh geometry
  22047. * @param mesh defines the source mesh
  22048. * @param id defines the unique ID of the new geometry object
  22049. * @returns the new geometry object
  22050. */
  22051. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  22052. /**
  22053. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  22054. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  22055. * Be aware Math.random() could cause collisions, but:
  22056. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  22057. * @returns a string containing a new GUID
  22058. */
  22059. static RandomId(): string;
  22060. /** @hidden */
  22061. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  22062. private static _CleanMatricesWeights;
  22063. /**
  22064. * Create a new geometry from persisted data (Using .babylon file format)
  22065. * @param parsedVertexData defines the persisted data
  22066. * @param scene defines the hosting scene
  22067. * @param rootUrl defines the root url to use to load assets (like delayed data)
  22068. * @returns the new geometry object
  22069. */
  22070. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  22071. }
  22072. }
  22073. declare module "babylonjs/Meshes/mesh.vertexData" {
  22074. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  22075. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  22076. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  22077. import { Geometry } from "babylonjs/Meshes/geometry";
  22078. import { Mesh } from "babylonjs/Meshes/mesh";
  22079. /**
  22080. * Define an interface for all classes that will get and set the data on vertices
  22081. */
  22082. export interface IGetSetVerticesData {
  22083. /**
  22084. * Gets a boolean indicating if specific vertex data is present
  22085. * @param kind defines the vertex data kind to use
  22086. * @returns true is data kind is present
  22087. */
  22088. isVerticesDataPresent(kind: string): boolean;
  22089. /**
  22090. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  22091. * @param kind defines the data kind (Position, normal, etc...)
  22092. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  22093. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22094. * @returns a float array containing vertex data
  22095. */
  22096. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  22097. /**
  22098. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  22099. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  22100. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22101. * @returns the indices array or an empty array if the mesh has no geometry
  22102. */
  22103. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  22104. /**
  22105. * Set specific vertex data
  22106. * @param kind defines the data kind (Position, normal, etc...)
  22107. * @param data defines the vertex data to use
  22108. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  22109. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  22110. */
  22111. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  22112. /**
  22113. * Update a specific associated vertex buffer
  22114. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  22115. * - VertexBuffer.PositionKind
  22116. * - VertexBuffer.UVKind
  22117. * - VertexBuffer.UV2Kind
  22118. * - VertexBuffer.UV3Kind
  22119. * - VertexBuffer.UV4Kind
  22120. * - VertexBuffer.UV5Kind
  22121. * - VertexBuffer.UV6Kind
  22122. * - VertexBuffer.ColorKind
  22123. * - VertexBuffer.MatricesIndicesKind
  22124. * - VertexBuffer.MatricesIndicesExtraKind
  22125. * - VertexBuffer.MatricesWeightsKind
  22126. * - VertexBuffer.MatricesWeightsExtraKind
  22127. * @param data defines the data source
  22128. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  22129. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  22130. */
  22131. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  22132. /**
  22133. * Creates a new index buffer
  22134. * @param indices defines the indices to store in the index buffer
  22135. * @param totalVertices defines the total number of vertices (could be null)
  22136. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  22137. */
  22138. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  22139. }
  22140. /**
  22141. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  22142. */
  22143. export class VertexData {
  22144. /**
  22145. * Mesh side orientation : usually the external or front surface
  22146. */
  22147. static readonly FRONTSIDE: number;
  22148. /**
  22149. * Mesh side orientation : usually the internal or back surface
  22150. */
  22151. static readonly BACKSIDE: number;
  22152. /**
  22153. * Mesh side orientation : both internal and external or front and back surfaces
  22154. */
  22155. static readonly DOUBLESIDE: number;
  22156. /**
  22157. * Mesh side orientation : by default, `FRONTSIDE`
  22158. */
  22159. static readonly DEFAULTSIDE: number;
  22160. /**
  22161. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  22162. */
  22163. positions: Nullable<FloatArray>;
  22164. /**
  22165. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  22166. */
  22167. normals: Nullable<FloatArray>;
  22168. /**
  22169. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  22170. */
  22171. tangents: Nullable<FloatArray>;
  22172. /**
  22173. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22174. */
  22175. uvs: Nullable<FloatArray>;
  22176. /**
  22177. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22178. */
  22179. uvs2: Nullable<FloatArray>;
  22180. /**
  22181. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22182. */
  22183. uvs3: Nullable<FloatArray>;
  22184. /**
  22185. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22186. */
  22187. uvs4: Nullable<FloatArray>;
  22188. /**
  22189. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22190. */
  22191. uvs5: Nullable<FloatArray>;
  22192. /**
  22193. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22194. */
  22195. uvs6: Nullable<FloatArray>;
  22196. /**
  22197. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  22198. */
  22199. colors: Nullable<FloatArray>;
  22200. /**
  22201. * An array containing the list of indices to the array of matrices produced by bones, each vertex have up to 4 indices (8 if the matricesIndicesExtra is set).
  22202. */
  22203. matricesIndices: Nullable<FloatArray>;
  22204. /**
  22205. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  22206. */
  22207. matricesWeights: Nullable<FloatArray>;
  22208. /**
  22209. * An array extending the number of possible indices
  22210. */
  22211. matricesIndicesExtra: Nullable<FloatArray>;
  22212. /**
  22213. * An array extending the number of possible weights when the number of indices is extended
  22214. */
  22215. matricesWeightsExtra: Nullable<FloatArray>;
  22216. /**
  22217. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  22218. */
  22219. indices: Nullable<IndicesArray>;
  22220. /**
  22221. * Uses the passed data array to set the set the values for the specified kind of data
  22222. * @param data a linear array of floating numbers
  22223. * @param kind the type of data that is being set, eg positions, colors etc
  22224. */
  22225. set(data: FloatArray, kind: string): void;
  22226. /**
  22227. * Associates the vertexData to the passed Mesh.
  22228. * Sets it as updatable or not (default `false`)
  22229. * @param mesh the mesh the vertexData is applied to
  22230. * @param updatable when used and having the value true allows new data to update the vertexData
  22231. * @returns the VertexData
  22232. */
  22233. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  22234. /**
  22235. * Associates the vertexData to the passed Geometry.
  22236. * Sets it as updatable or not (default `false`)
  22237. * @param geometry the geometry the vertexData is applied to
  22238. * @param updatable when used and having the value true allows new data to update the vertexData
  22239. * @returns VertexData
  22240. */
  22241. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  22242. /**
  22243. * Updates the associated mesh
  22244. * @param mesh the mesh to be updated
  22245. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  22246. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  22247. * @returns VertexData
  22248. */
  22249. updateMesh(mesh: Mesh): VertexData;
  22250. /**
  22251. * Updates the associated geometry
  22252. * @param geometry the geometry to be updated
  22253. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  22254. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  22255. * @returns VertexData.
  22256. */
  22257. updateGeometry(geometry: Geometry): VertexData;
  22258. private _applyTo;
  22259. private _update;
  22260. /**
  22261. * Transforms each position and each normal of the vertexData according to the passed Matrix
  22262. * @param matrix the transforming matrix
  22263. * @returns the VertexData
  22264. */
  22265. transform(matrix: Matrix): VertexData;
  22266. /**
  22267. * Merges the passed VertexData into the current one
  22268. * @param other the VertexData to be merged into the current one
  22269. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  22270. * @returns the modified VertexData
  22271. */
  22272. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  22273. private _mergeElement;
  22274. private _validate;
  22275. /**
  22276. * Serializes the VertexData
  22277. * @returns a serialized object
  22278. */
  22279. serialize(): any;
  22280. /**
  22281. * Extracts the vertexData from a mesh
  22282. * @param mesh the mesh from which to extract the VertexData
  22283. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  22284. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  22285. * @returns the object VertexData associated to the passed mesh
  22286. */
  22287. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  22288. /**
  22289. * Extracts the vertexData from the geometry
  22290. * @param geometry the geometry from which to extract the VertexData
  22291. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  22292. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  22293. * @returns the object VertexData associated to the passed mesh
  22294. */
  22295. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  22296. private static _ExtractFrom;
  22297. /**
  22298. * Creates the VertexData for a Ribbon
  22299. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  22300. * * pathArray array of paths, each of which an array of successive Vector3
  22301. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  22302. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  22303. * * offset a positive integer, only used when pathArray contains a single path (offset = 10 means the point 1 is joined to the point 11), default rounded half size of the pathArray length
  22304. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22305. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22306. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22307. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  22308. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  22309. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  22310. * @returns the VertexData of the ribbon
  22311. */
  22312. static CreateRibbon(options: {
  22313. pathArray: Vector3[][];
  22314. closeArray?: boolean;
  22315. closePath?: boolean;
  22316. offset?: number;
  22317. sideOrientation?: number;
  22318. frontUVs?: Vector4;
  22319. backUVs?: Vector4;
  22320. invertUV?: boolean;
  22321. uvs?: Vector2[];
  22322. colors?: Color4[];
  22323. }): VertexData;
  22324. /**
  22325. * Creates the VertexData for a box
  22326. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22327. * * size sets the width, height and depth of the box to the value of size, optional default 1
  22328. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  22329. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  22330. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  22331. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  22332. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  22333. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22334. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22335. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22336. * @returns the VertexData of the box
  22337. */
  22338. static CreateBox(options: {
  22339. size?: number;
  22340. width?: number;
  22341. height?: number;
  22342. depth?: number;
  22343. faceUV?: Vector4[];
  22344. faceColors?: Color4[];
  22345. sideOrientation?: number;
  22346. frontUVs?: Vector4;
  22347. backUVs?: Vector4;
  22348. }): VertexData;
  22349. /**
  22350. * Creates the VertexData for a tiled box
  22351. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22352. * * faceTiles sets the pattern, tile size and number of tiles for a face
  22353. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  22354. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  22355. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22356. * @returns the VertexData of the box
  22357. */
  22358. static CreateTiledBox(options: {
  22359. pattern?: number;
  22360. width?: number;
  22361. height?: number;
  22362. depth?: number;
  22363. tileSize?: number;
  22364. tileWidth?: number;
  22365. tileHeight?: number;
  22366. alignHorizontal?: number;
  22367. alignVertical?: number;
  22368. faceUV?: Vector4[];
  22369. faceColors?: Color4[];
  22370. sideOrientation?: number;
  22371. }): VertexData;
  22372. /**
  22373. * Creates the VertexData for a tiled plane
  22374. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22375. * * pattern a limited pattern arrangement depending on the number
  22376. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  22377. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  22378. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  22379. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22380. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22381. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22382. * @returns the VertexData of the tiled plane
  22383. */
  22384. static CreateTiledPlane(options: {
  22385. pattern?: number;
  22386. tileSize?: number;
  22387. tileWidth?: number;
  22388. tileHeight?: number;
  22389. size?: number;
  22390. width?: number;
  22391. height?: number;
  22392. alignHorizontal?: number;
  22393. alignVertical?: number;
  22394. sideOrientation?: number;
  22395. frontUVs?: Vector4;
  22396. backUVs?: Vector4;
  22397. }): VertexData;
  22398. /**
  22399. * Creates the VertexData for an ellipsoid, defaults to a sphere
  22400. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22401. * * segments sets the number of horizontal strips optional, default 32
  22402. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  22403. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  22404. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  22405. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  22406. * * arc a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the circumference (latitude) given by the arc value, optional, default 1
  22407. * * slice a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the height (latitude) given by the arc value, optional, default 1
  22408. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22409. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22410. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22411. * @returns the VertexData of the ellipsoid
  22412. */
  22413. static CreateSphere(options: {
  22414. segments?: number;
  22415. diameter?: number;
  22416. diameterX?: number;
  22417. diameterY?: number;
  22418. diameterZ?: number;
  22419. arc?: number;
  22420. slice?: number;
  22421. sideOrientation?: number;
  22422. frontUVs?: Vector4;
  22423. backUVs?: Vector4;
  22424. }): VertexData;
  22425. /**
  22426. * Creates the VertexData for a cylinder, cone or prism
  22427. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22428. * * height sets the height (y direction) of the cylinder, optional, default 2
  22429. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  22430. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  22431. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  22432. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  22433. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  22434. * * arc a number from 0 to 1, to create an unclosed cylinder based on the fraction of the circumference given by the arc value, optional, default 1
  22435. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22436. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22437. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  22438. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  22439. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22440. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22441. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22442. * @returns the VertexData of the cylinder, cone or prism
  22443. */
  22444. static CreateCylinder(options: {
  22445. height?: number;
  22446. diameterTop?: number;
  22447. diameterBottom?: number;
  22448. diameter?: number;
  22449. tessellation?: number;
  22450. subdivisions?: number;
  22451. arc?: number;
  22452. faceColors?: Color4[];
  22453. faceUV?: Vector4[];
  22454. hasRings?: boolean;
  22455. enclose?: boolean;
  22456. sideOrientation?: number;
  22457. frontUVs?: Vector4;
  22458. backUVs?: Vector4;
  22459. }): VertexData;
  22460. /**
  22461. * Creates the VertexData for a torus
  22462. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22463. * * diameter the diameter of the torus, optional default 1
  22464. * * thickness the diameter of the tube forming the torus, optional default 0.5
  22465. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  22466. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22467. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22468. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22469. * @returns the VertexData of the torus
  22470. */
  22471. static CreateTorus(options: {
  22472. diameter?: number;
  22473. thickness?: number;
  22474. tessellation?: number;
  22475. sideOrientation?: number;
  22476. frontUVs?: Vector4;
  22477. backUVs?: Vector4;
  22478. }): VertexData;
  22479. /**
  22480. * Creates the VertexData of the LineSystem
  22481. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  22482. * - lines an array of lines, each line being an array of successive Vector3
  22483. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  22484. * @returns the VertexData of the LineSystem
  22485. */
  22486. static CreateLineSystem(options: {
  22487. lines: Vector3[][];
  22488. colors?: Nullable<Color4[][]>;
  22489. }): VertexData;
  22490. /**
  22491. * Create the VertexData for a DashedLines
  22492. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  22493. * - points an array successive Vector3
  22494. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  22495. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  22496. * - dashNb the intended total number of dashes, optional, default 200
  22497. * @returns the VertexData for the DashedLines
  22498. */
  22499. static CreateDashedLines(options: {
  22500. points: Vector3[];
  22501. dashSize?: number;
  22502. gapSize?: number;
  22503. dashNb?: number;
  22504. }): VertexData;
  22505. /**
  22506. * Creates the VertexData for a Ground
  22507. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  22508. * - width the width (x direction) of the ground, optional, default 1
  22509. * - height the height (z direction) of the ground, optional, default 1
  22510. * - subdivisions the number of subdivisions per side, optional, default 1
  22511. * @returns the VertexData of the Ground
  22512. */
  22513. static CreateGround(options: {
  22514. width?: number;
  22515. height?: number;
  22516. subdivisions?: number;
  22517. subdivisionsX?: number;
  22518. subdivisionsY?: number;
  22519. }): VertexData;
  22520. /**
  22521. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  22522. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  22523. * * xmin the ground minimum X coordinate, optional, default -1
  22524. * * zmin the ground minimum Z coordinate, optional, default -1
  22525. * * xmax the ground maximum X coordinate, optional, default 1
  22526. * * zmax the ground maximum Z coordinate, optional, default 1
  22527. * * subdivisions a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the ground width and height creating 'tiles', default {w: 6, h: 6}
  22528. * * precision a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the tile width and height, default {w: 2, h: 2}
  22529. * @returns the VertexData of the TiledGround
  22530. */
  22531. static CreateTiledGround(options: {
  22532. xmin: number;
  22533. zmin: number;
  22534. xmax: number;
  22535. zmax: number;
  22536. subdivisions?: {
  22537. w: number;
  22538. h: number;
  22539. };
  22540. precision?: {
  22541. w: number;
  22542. h: number;
  22543. };
  22544. }): VertexData;
  22545. /**
  22546. * Creates the VertexData of the Ground designed from a heightmap
  22547. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  22548. * * width the width (x direction) of the ground
  22549. * * height the height (z direction) of the ground
  22550. * * subdivisions the number of subdivisions per side
  22551. * * minHeight the minimum altitude on the ground, optional, default 0
  22552. * * maxHeight the maximum altitude on the ground, optional default 1
  22553. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  22554. * * buffer the array holding the image color data
  22555. * * bufferWidth the width of image
  22556. * * bufferHeight the height of image
  22557. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  22558. * @returns the VertexData of the Ground designed from a heightmap
  22559. */
  22560. static CreateGroundFromHeightMap(options: {
  22561. width: number;
  22562. height: number;
  22563. subdivisions: number;
  22564. minHeight: number;
  22565. maxHeight: number;
  22566. colorFilter: Color3;
  22567. buffer: Uint8Array;
  22568. bufferWidth: number;
  22569. bufferHeight: number;
  22570. alphaFilter: number;
  22571. }): VertexData;
  22572. /**
  22573. * Creates the VertexData for a Plane
  22574. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  22575. * * size sets the width and height of the plane to the value of size, optional default 1
  22576. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  22577. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  22578. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22579. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22580. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22581. * @returns the VertexData of the box
  22582. */
  22583. static CreatePlane(options: {
  22584. size?: number;
  22585. width?: number;
  22586. height?: number;
  22587. sideOrientation?: number;
  22588. frontUVs?: Vector4;
  22589. backUVs?: Vector4;
  22590. }): VertexData;
  22591. /**
  22592. * Creates the VertexData of the Disc or regular Polygon
  22593. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  22594. * * radius the radius of the disc, optional default 0.5
  22595. * * tessellation the number of polygon sides, optional, default 64
  22596. * * arc a number from 0 to 1, to create an unclosed polygon based on the fraction of the circumference given by the arc value, optional, default 1
  22597. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22598. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22599. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22600. * @returns the VertexData of the box
  22601. */
  22602. static CreateDisc(options: {
  22603. radius?: number;
  22604. tessellation?: number;
  22605. arc?: number;
  22606. sideOrientation?: number;
  22607. frontUVs?: Vector4;
  22608. backUVs?: Vector4;
  22609. }): VertexData;
  22610. /**
  22611. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  22612. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  22613. * @param polygon a mesh built from polygonTriangulation.build()
  22614. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22615. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22616. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22617. * @param frontUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22618. * @param backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22619. * @returns the VertexData of the Polygon
  22620. */
  22621. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4): VertexData;
  22622. /**
  22623. * Creates the VertexData of the IcoSphere
  22624. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  22625. * * radius the radius of the IcoSphere, optional default 1
  22626. * * radiusX allows stretching in the x direction, optional, default radius
  22627. * * radiusY allows stretching in the y direction, optional, default radius
  22628. * * radiusZ allows stretching in the z direction, optional, default radius
  22629. * * flat when true creates a flat shaded mesh, optional, default true
  22630. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  22631. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22632. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22633. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22634. * @returns the VertexData of the IcoSphere
  22635. */
  22636. static CreateIcoSphere(options: {
  22637. radius?: number;
  22638. radiusX?: number;
  22639. radiusY?: number;
  22640. radiusZ?: number;
  22641. flat?: boolean;
  22642. subdivisions?: number;
  22643. sideOrientation?: number;
  22644. frontUVs?: Vector4;
  22645. backUVs?: Vector4;
  22646. }): VertexData;
  22647. /**
  22648. * Creates the VertexData for a Polyhedron
  22649. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  22650. * * type provided types are:
  22651. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  22652. * * 9 : Pentagonal Pyramid (J2), 10 : Triangular Dipyramid (J12), 11 : Pentagonal Dipyramid (J13), 12 : Elongated Square Dipyramid (J15), 13 : Elongated Pentagonal Dipyramid (J16), 14 : Elongated Pentagonal Cupola (J20)
  22653. * * size the size of the IcoSphere, optional default 1
  22654. * * sizeX allows stretching in the x direction, optional, default size
  22655. * * sizeY allows stretching in the y direction, optional, default size
  22656. * * sizeZ allows stretching in the z direction, optional, default size
  22657. * * custom a number that overwrites the type to create from an extended set of polyhedron from https://www.babylonjs-playground.com/#21QRSK#15 with minimised editor
  22658. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22659. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22660. * * flat when true creates a flat shaded mesh, optional, default true
  22661. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  22662. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22663. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22664. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22665. * @returns the VertexData of the Polyhedron
  22666. */
  22667. static CreatePolyhedron(options: {
  22668. type?: number;
  22669. size?: number;
  22670. sizeX?: number;
  22671. sizeY?: number;
  22672. sizeZ?: number;
  22673. custom?: any;
  22674. faceUV?: Vector4[];
  22675. faceColors?: Color4[];
  22676. flat?: boolean;
  22677. sideOrientation?: number;
  22678. frontUVs?: Vector4;
  22679. backUVs?: Vector4;
  22680. }): VertexData;
  22681. /**
  22682. * Creates the VertexData for a TorusKnot
  22683. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  22684. * * radius the radius of the torus knot, optional, default 2
  22685. * * tube the thickness of the tube, optional, default 0.5
  22686. * * radialSegments the number of sides on each tube segments, optional, default 32
  22687. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  22688. * * p the number of windings around the z axis, optional, default 2
  22689. * * q the number of windings around the x axis, optional, default 3
  22690. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22691. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22692. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22693. * @returns the VertexData of the Torus Knot
  22694. */
  22695. static CreateTorusKnot(options: {
  22696. radius?: number;
  22697. tube?: number;
  22698. radialSegments?: number;
  22699. tubularSegments?: number;
  22700. p?: number;
  22701. q?: number;
  22702. sideOrientation?: number;
  22703. frontUVs?: Vector4;
  22704. backUVs?: Vector4;
  22705. }): VertexData;
  22706. /**
  22707. * Compute normals for given positions and indices
  22708. * @param positions an array of vertex positions, [...., x, y, z, ......]
  22709. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  22710. * @param normals an array of vertex normals, [...., x, y, z, ......]
  22711. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  22712. * * facetNormals : optional array of facet normals (vector3)
  22713. * * facetPositions : optional array of facet positions (vector3)
  22714. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  22715. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  22716. * * bInfo : optional bounding info, required for facetPartitioning computation
  22717. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  22718. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  22719. * * useRightHandedSystem: optional boolean to for right handed system computation
  22720. * * depthSort : optional boolean to enable the facet depth sort computation
  22721. * * distanceTo : optional Vector3 to compute the facet depth from this location
  22722. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  22723. */
  22724. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  22725. facetNormals?: any;
  22726. facetPositions?: any;
  22727. facetPartitioning?: any;
  22728. ratio?: number;
  22729. bInfo?: any;
  22730. bbSize?: Vector3;
  22731. subDiv?: any;
  22732. useRightHandedSystem?: boolean;
  22733. depthSort?: boolean;
  22734. distanceTo?: Vector3;
  22735. depthSortedFacets?: any;
  22736. }): void;
  22737. /** @hidden */
  22738. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  22739. /**
  22740. * Applies VertexData created from the imported parameters to the geometry
  22741. * @param parsedVertexData the parsed data from an imported file
  22742. * @param geometry the geometry to apply the VertexData to
  22743. */
  22744. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  22745. }
  22746. }
  22747. declare module "babylonjs/Morph/morphTarget" {
  22748. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  22749. import { Observable } from "babylonjs/Misc/observable";
  22750. import { Nullable, FloatArray } from "babylonjs/types";
  22751. import { Scene } from "babylonjs/scene";
  22752. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22753. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  22754. /**
  22755. * Defines a target to use with MorphTargetManager
  22756. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  22757. */
  22758. export class MorphTarget implements IAnimatable {
  22759. /** defines the name of the target */
  22760. name: string;
  22761. /**
  22762. * Gets or sets the list of animations
  22763. */
  22764. animations: import("babylonjs/Animations/animation").Animation[];
  22765. private _scene;
  22766. private _positions;
  22767. private _normals;
  22768. private _tangents;
  22769. private _uvs;
  22770. private _influence;
  22771. private _uniqueId;
  22772. /**
  22773. * Observable raised when the influence changes
  22774. */
  22775. onInfluenceChanged: Observable<boolean>;
  22776. /** @hidden */
  22777. _onDataLayoutChanged: Observable<void>;
  22778. /**
  22779. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  22780. */
  22781. influence: number;
  22782. /**
  22783. * Gets or sets the id of the morph Target
  22784. */
  22785. id: string;
  22786. private _animationPropertiesOverride;
  22787. /**
  22788. * Gets or sets the animation properties override
  22789. */
  22790. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  22791. /**
  22792. * Creates a new MorphTarget
  22793. * @param name defines the name of the target
  22794. * @param influence defines the influence to use
  22795. * @param scene defines the scene the morphtarget belongs to
  22796. */
  22797. constructor(
  22798. /** defines the name of the target */
  22799. name: string, influence?: number, scene?: Nullable<Scene>);
  22800. /**
  22801. * Gets the unique ID of this manager
  22802. */
  22803. readonly uniqueId: number;
  22804. /**
  22805. * Gets a boolean defining if the target contains position data
  22806. */
  22807. readonly hasPositions: boolean;
  22808. /**
  22809. * Gets a boolean defining if the target contains normal data
  22810. */
  22811. readonly hasNormals: boolean;
  22812. /**
  22813. * Gets a boolean defining if the target contains tangent data
  22814. */
  22815. readonly hasTangents: boolean;
  22816. /**
  22817. * Gets a boolean defining if the target contains texture coordinates data
  22818. */
  22819. readonly hasUVs: boolean;
  22820. /**
  22821. * Affects position data to this target
  22822. * @param data defines the position data to use
  22823. */
  22824. setPositions(data: Nullable<FloatArray>): void;
  22825. /**
  22826. * Gets the position data stored in this target
  22827. * @returns a FloatArray containing the position data (or null if not present)
  22828. */
  22829. getPositions(): Nullable<FloatArray>;
  22830. /**
  22831. * Affects normal data to this target
  22832. * @param data defines the normal data to use
  22833. */
  22834. setNormals(data: Nullable<FloatArray>): void;
  22835. /**
  22836. * Gets the normal data stored in this target
  22837. * @returns a FloatArray containing the normal data (or null if not present)
  22838. */
  22839. getNormals(): Nullable<FloatArray>;
  22840. /**
  22841. * Affects tangent data to this target
  22842. * @param data defines the tangent data to use
  22843. */
  22844. setTangents(data: Nullable<FloatArray>): void;
  22845. /**
  22846. * Gets the tangent data stored in this target
  22847. * @returns a FloatArray containing the tangent data (or null if not present)
  22848. */
  22849. getTangents(): Nullable<FloatArray>;
  22850. /**
  22851. * Affects texture coordinates data to this target
  22852. * @param data defines the texture coordinates data to use
  22853. */
  22854. setUVs(data: Nullable<FloatArray>): void;
  22855. /**
  22856. * Gets the texture coordinates data stored in this target
  22857. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  22858. */
  22859. getUVs(): Nullable<FloatArray>;
  22860. /**
  22861. * Clone the current target
  22862. * @returns a new MorphTarget
  22863. */
  22864. clone(): MorphTarget;
  22865. /**
  22866. * Serializes the current target into a Serialization object
  22867. * @returns the serialized object
  22868. */
  22869. serialize(): any;
  22870. /**
  22871. * Returns the string "MorphTarget"
  22872. * @returns "MorphTarget"
  22873. */
  22874. getClassName(): string;
  22875. /**
  22876. * Creates a new target from serialized data
  22877. * @param serializationObject defines the serialized data to use
  22878. * @returns a new MorphTarget
  22879. */
  22880. static Parse(serializationObject: any): MorphTarget;
  22881. /**
  22882. * Creates a MorphTarget from mesh data
  22883. * @param mesh defines the source mesh
  22884. * @param name defines the name to use for the new target
  22885. * @param influence defines the influence to attach to the target
  22886. * @returns a new MorphTarget
  22887. */
  22888. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  22889. }
  22890. }
  22891. declare module "babylonjs/Morph/morphTargetManager" {
  22892. import { Nullable } from "babylonjs/types";
  22893. import { Scene } from "babylonjs/scene";
  22894. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  22895. /**
  22896. * This class is used to deform meshes using morphing between different targets
  22897. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  22898. */
  22899. export class MorphTargetManager {
  22900. private _targets;
  22901. private _targetInfluenceChangedObservers;
  22902. private _targetDataLayoutChangedObservers;
  22903. private _activeTargets;
  22904. private _scene;
  22905. private _influences;
  22906. private _supportsNormals;
  22907. private _supportsTangents;
  22908. private _supportsUVs;
  22909. private _vertexCount;
  22910. private _uniqueId;
  22911. private _tempInfluences;
  22912. /**
  22913. * Gets or sets a boolean indicating if normals must be morphed
  22914. */
  22915. enableNormalMorphing: boolean;
  22916. /**
  22917. * Gets or sets a boolean indicating if tangents must be morphed
  22918. */
  22919. enableTangentMorphing: boolean;
  22920. /**
  22921. * Gets or sets a boolean indicating if UV must be morphed
  22922. */
  22923. enableUVMorphing: boolean;
  22924. /**
  22925. * Creates a new MorphTargetManager
  22926. * @param scene defines the current scene
  22927. */
  22928. constructor(scene?: Nullable<Scene>);
  22929. /**
  22930. * Gets the unique ID of this manager
  22931. */
  22932. readonly uniqueId: number;
  22933. /**
  22934. * Gets the number of vertices handled by this manager
  22935. */
  22936. readonly vertexCount: number;
  22937. /**
  22938. * Gets a boolean indicating if this manager supports morphing of normals
  22939. */
  22940. readonly supportsNormals: boolean;
  22941. /**
  22942. * Gets a boolean indicating if this manager supports morphing of tangents
  22943. */
  22944. readonly supportsTangents: boolean;
  22945. /**
  22946. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  22947. */
  22948. readonly supportsUVs: boolean;
  22949. /**
  22950. * Gets the number of targets stored in this manager
  22951. */
  22952. readonly numTargets: number;
  22953. /**
  22954. * Gets the number of influencers (ie. the number of targets with influences > 0)
  22955. */
  22956. readonly numInfluencers: number;
  22957. /**
  22958. * Gets the list of influences (one per target)
  22959. */
  22960. readonly influences: Float32Array;
  22961. /**
  22962. * Gets the active target at specified index. An active target is a target with an influence > 0
  22963. * @param index defines the index to check
  22964. * @returns the requested target
  22965. */
  22966. getActiveTarget(index: number): MorphTarget;
  22967. /**
  22968. * Gets the target at specified index
  22969. * @param index defines the index to check
  22970. * @returns the requested target
  22971. */
  22972. getTarget(index: number): MorphTarget;
  22973. /**
  22974. * Add a new target to this manager
  22975. * @param target defines the target to add
  22976. */
  22977. addTarget(target: MorphTarget): void;
  22978. /**
  22979. * Removes a target from the manager
  22980. * @param target defines the target to remove
  22981. */
  22982. removeTarget(target: MorphTarget): void;
  22983. /**
  22984. * Clone the current manager
  22985. * @returns a new MorphTargetManager
  22986. */
  22987. clone(): MorphTargetManager;
  22988. /**
  22989. * Serializes the current manager into a Serialization object
  22990. * @returns the serialized object
  22991. */
  22992. serialize(): any;
  22993. private _syncActiveTargets;
  22994. /**
  22995. * Syncrhonize the targets with all the meshes using this morph target manager
  22996. */
  22997. synchronize(): void;
  22998. /**
  22999. * Creates a new MorphTargetManager from serialized data
  23000. * @param serializationObject defines the serialized data
  23001. * @param scene defines the hosting scene
  23002. * @returns the new MorphTargetManager
  23003. */
  23004. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  23005. }
  23006. }
  23007. declare module "babylonjs/Meshes/meshLODLevel" {
  23008. import { Mesh } from "babylonjs/Meshes/mesh";
  23009. import { Nullable } from "babylonjs/types";
  23010. /**
  23011. * Class used to represent a specific level of detail of a mesh
  23012. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  23013. */
  23014. export class MeshLODLevel {
  23015. /** Defines the distance where this level should start being displayed */
  23016. distance: number;
  23017. /** Defines the mesh to use to render this level */
  23018. mesh: Nullable<Mesh>;
  23019. /**
  23020. * Creates a new LOD level
  23021. * @param distance defines the distance where this level should star being displayed
  23022. * @param mesh defines the mesh to use to render this level
  23023. */
  23024. constructor(
  23025. /** Defines the distance where this level should start being displayed */
  23026. distance: number,
  23027. /** Defines the mesh to use to render this level */
  23028. mesh: Nullable<Mesh>);
  23029. }
  23030. }
  23031. declare module "babylonjs/Meshes/groundMesh" {
  23032. import { Scene } from "babylonjs/scene";
  23033. import { Vector3 } from "babylonjs/Maths/math.vector";
  23034. import { Mesh } from "babylonjs/Meshes/mesh";
  23035. /**
  23036. * Mesh representing the gorund
  23037. */
  23038. export class GroundMesh extends Mesh {
  23039. /** If octree should be generated */
  23040. generateOctree: boolean;
  23041. private _heightQuads;
  23042. /** @hidden */
  23043. _subdivisionsX: number;
  23044. /** @hidden */
  23045. _subdivisionsY: number;
  23046. /** @hidden */
  23047. _width: number;
  23048. /** @hidden */
  23049. _height: number;
  23050. /** @hidden */
  23051. _minX: number;
  23052. /** @hidden */
  23053. _maxX: number;
  23054. /** @hidden */
  23055. _minZ: number;
  23056. /** @hidden */
  23057. _maxZ: number;
  23058. constructor(name: string, scene: Scene);
  23059. /**
  23060. * "GroundMesh"
  23061. * @returns "GroundMesh"
  23062. */
  23063. getClassName(): string;
  23064. /**
  23065. * The minimum of x and y subdivisions
  23066. */
  23067. readonly subdivisions: number;
  23068. /**
  23069. * X subdivisions
  23070. */
  23071. readonly subdivisionsX: number;
  23072. /**
  23073. * Y subdivisions
  23074. */
  23075. readonly subdivisionsY: number;
  23076. /**
  23077. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  23078. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  23079. * @param chunksCount the number of subdivisions for x and y
  23080. * @param octreeBlocksSize (Default: 32)
  23081. */
  23082. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  23083. /**
  23084. * Returns a height (y) value in the Worl system :
  23085. * the ground altitude at the coordinates (x, z) expressed in the World system.
  23086. * @param x x coordinate
  23087. * @param z z coordinate
  23088. * @returns the ground y position if (x, z) are outside the ground surface.
  23089. */
  23090. getHeightAtCoordinates(x: number, z: number): number;
  23091. /**
  23092. * Returns a normalized vector (Vector3) orthogonal to the ground
  23093. * at the ground coordinates (x, z) expressed in the World system.
  23094. * @param x x coordinate
  23095. * @param z z coordinate
  23096. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  23097. */
  23098. getNormalAtCoordinates(x: number, z: number): Vector3;
  23099. /**
  23100. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  23101. * at the ground coordinates (x, z) expressed in the World system.
  23102. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  23103. * @param x x coordinate
  23104. * @param z z coordinate
  23105. * @param ref vector to store the result
  23106. * @returns the GroundMesh.
  23107. */
  23108. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  23109. /**
  23110. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  23111. * if the ground has been updated.
  23112. * This can be used in the render loop.
  23113. * @returns the GroundMesh.
  23114. */
  23115. updateCoordinateHeights(): GroundMesh;
  23116. private _getFacetAt;
  23117. private _initHeightQuads;
  23118. private _computeHeightQuads;
  23119. /**
  23120. * Serializes this ground mesh
  23121. * @param serializationObject object to write serialization to
  23122. */
  23123. serialize(serializationObject: any): void;
  23124. /**
  23125. * Parses a serialized ground mesh
  23126. * @param parsedMesh the serialized mesh
  23127. * @param scene the scene to create the ground mesh in
  23128. * @returns the created ground mesh
  23129. */
  23130. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  23131. }
  23132. }
  23133. declare module "babylonjs/Physics/physicsJoint" {
  23134. import { Vector3 } from "babylonjs/Maths/math.vector";
  23135. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  23136. /**
  23137. * Interface for Physics-Joint data
  23138. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23139. */
  23140. export interface PhysicsJointData {
  23141. /**
  23142. * The main pivot of the joint
  23143. */
  23144. mainPivot?: Vector3;
  23145. /**
  23146. * The connected pivot of the joint
  23147. */
  23148. connectedPivot?: Vector3;
  23149. /**
  23150. * The main axis of the joint
  23151. */
  23152. mainAxis?: Vector3;
  23153. /**
  23154. * The connected axis of the joint
  23155. */
  23156. connectedAxis?: Vector3;
  23157. /**
  23158. * The collision of the joint
  23159. */
  23160. collision?: boolean;
  23161. /**
  23162. * Native Oimo/Cannon/Energy data
  23163. */
  23164. nativeParams?: any;
  23165. }
  23166. /**
  23167. * This is a holder class for the physics joint created by the physics plugin
  23168. * It holds a set of functions to control the underlying joint
  23169. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23170. */
  23171. export class PhysicsJoint {
  23172. /**
  23173. * The type of the physics joint
  23174. */
  23175. type: number;
  23176. /**
  23177. * The data for the physics joint
  23178. */
  23179. jointData: PhysicsJointData;
  23180. private _physicsJoint;
  23181. protected _physicsPlugin: IPhysicsEnginePlugin;
  23182. /**
  23183. * Initializes the physics joint
  23184. * @param type The type of the physics joint
  23185. * @param jointData The data for the physics joint
  23186. */
  23187. constructor(
  23188. /**
  23189. * The type of the physics joint
  23190. */
  23191. type: number,
  23192. /**
  23193. * The data for the physics joint
  23194. */
  23195. jointData: PhysicsJointData);
  23196. /**
  23197. * Gets the physics joint
  23198. */
  23199. /**
  23200. * Sets the physics joint
  23201. */
  23202. physicsJoint: any;
  23203. /**
  23204. * Sets the physics plugin
  23205. */
  23206. physicsPlugin: IPhysicsEnginePlugin;
  23207. /**
  23208. * Execute a function that is physics-plugin specific.
  23209. * @param {Function} func the function that will be executed.
  23210. * It accepts two parameters: the physics world and the physics joint
  23211. */
  23212. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  23213. /**
  23214. * Distance-Joint type
  23215. */
  23216. static DistanceJoint: number;
  23217. /**
  23218. * Hinge-Joint type
  23219. */
  23220. static HingeJoint: number;
  23221. /**
  23222. * Ball-and-Socket joint type
  23223. */
  23224. static BallAndSocketJoint: number;
  23225. /**
  23226. * Wheel-Joint type
  23227. */
  23228. static WheelJoint: number;
  23229. /**
  23230. * Slider-Joint type
  23231. */
  23232. static SliderJoint: number;
  23233. /**
  23234. * Prismatic-Joint type
  23235. */
  23236. static PrismaticJoint: number;
  23237. /**
  23238. * Universal-Joint type
  23239. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  23240. */
  23241. static UniversalJoint: number;
  23242. /**
  23243. * Hinge-Joint 2 type
  23244. */
  23245. static Hinge2Joint: number;
  23246. /**
  23247. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  23248. */
  23249. static PointToPointJoint: number;
  23250. /**
  23251. * Spring-Joint type
  23252. */
  23253. static SpringJoint: number;
  23254. /**
  23255. * Lock-Joint type
  23256. */
  23257. static LockJoint: number;
  23258. }
  23259. /**
  23260. * A class representing a physics distance joint
  23261. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23262. */
  23263. export class DistanceJoint extends PhysicsJoint {
  23264. /**
  23265. *
  23266. * @param jointData The data for the Distance-Joint
  23267. */
  23268. constructor(jointData: DistanceJointData);
  23269. /**
  23270. * Update the predefined distance.
  23271. * @param maxDistance The maximum preferred distance
  23272. * @param minDistance The minimum preferred distance
  23273. */
  23274. updateDistance(maxDistance: number, minDistance?: number): void;
  23275. }
  23276. /**
  23277. * Represents a Motor-Enabled Joint
  23278. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23279. */
  23280. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  23281. /**
  23282. * Initializes the Motor-Enabled Joint
  23283. * @param type The type of the joint
  23284. * @param jointData The physica joint data for the joint
  23285. */
  23286. constructor(type: number, jointData: PhysicsJointData);
  23287. /**
  23288. * Set the motor values.
  23289. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23290. * @param force the force to apply
  23291. * @param maxForce max force for this motor.
  23292. */
  23293. setMotor(force?: number, maxForce?: number): void;
  23294. /**
  23295. * Set the motor's limits.
  23296. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23297. * @param upperLimit The upper limit of the motor
  23298. * @param lowerLimit The lower limit of the motor
  23299. */
  23300. setLimit(upperLimit: number, lowerLimit?: number): void;
  23301. }
  23302. /**
  23303. * This class represents a single physics Hinge-Joint
  23304. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23305. */
  23306. export class HingeJoint extends MotorEnabledJoint {
  23307. /**
  23308. * Initializes the Hinge-Joint
  23309. * @param jointData The joint data for the Hinge-Joint
  23310. */
  23311. constructor(jointData: PhysicsJointData);
  23312. /**
  23313. * Set the motor values.
  23314. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23315. * @param {number} force the force to apply
  23316. * @param {number} maxForce max force for this motor.
  23317. */
  23318. setMotor(force?: number, maxForce?: number): void;
  23319. /**
  23320. * Set the motor's limits.
  23321. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23322. * @param upperLimit The upper limit of the motor
  23323. * @param lowerLimit The lower limit of the motor
  23324. */
  23325. setLimit(upperLimit: number, lowerLimit?: number): void;
  23326. }
  23327. /**
  23328. * This class represents a dual hinge physics joint (same as wheel joint)
  23329. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23330. */
  23331. export class Hinge2Joint extends MotorEnabledJoint {
  23332. /**
  23333. * Initializes the Hinge2-Joint
  23334. * @param jointData The joint data for the Hinge2-Joint
  23335. */
  23336. constructor(jointData: PhysicsJointData);
  23337. /**
  23338. * Set the motor values.
  23339. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23340. * @param {number} targetSpeed the speed the motor is to reach
  23341. * @param {number} maxForce max force for this motor.
  23342. * @param {motorIndex} the motor's index, 0 or 1.
  23343. */
  23344. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  23345. /**
  23346. * Set the motor limits.
  23347. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23348. * @param {number} upperLimit the upper limit
  23349. * @param {number} lowerLimit lower limit
  23350. * @param {motorIndex} the motor's index, 0 or 1.
  23351. */
  23352. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23353. }
  23354. /**
  23355. * Interface for a motor enabled joint
  23356. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23357. */
  23358. export interface IMotorEnabledJoint {
  23359. /**
  23360. * Physics joint
  23361. */
  23362. physicsJoint: any;
  23363. /**
  23364. * Sets the motor of the motor-enabled joint
  23365. * @param force The force of the motor
  23366. * @param maxForce The maximum force of the motor
  23367. * @param motorIndex The index of the motor
  23368. */
  23369. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  23370. /**
  23371. * Sets the limit of the motor
  23372. * @param upperLimit The upper limit of the motor
  23373. * @param lowerLimit The lower limit of the motor
  23374. * @param motorIndex The index of the motor
  23375. */
  23376. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23377. }
  23378. /**
  23379. * Joint data for a Distance-Joint
  23380. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23381. */
  23382. export interface DistanceJointData extends PhysicsJointData {
  23383. /**
  23384. * Max distance the 2 joint objects can be apart
  23385. */
  23386. maxDistance: number;
  23387. }
  23388. /**
  23389. * Joint data from a spring joint
  23390. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23391. */
  23392. export interface SpringJointData extends PhysicsJointData {
  23393. /**
  23394. * Length of the spring
  23395. */
  23396. length: number;
  23397. /**
  23398. * Stiffness of the spring
  23399. */
  23400. stiffness: number;
  23401. /**
  23402. * Damping of the spring
  23403. */
  23404. damping: number;
  23405. /** this callback will be called when applying the force to the impostors. */
  23406. forceApplicationCallback: () => void;
  23407. }
  23408. }
  23409. declare module "babylonjs/Physics/physicsRaycastResult" {
  23410. import { Vector3 } from "babylonjs/Maths/math.vector";
  23411. /**
  23412. * Holds the data for the raycast result
  23413. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23414. */
  23415. export class PhysicsRaycastResult {
  23416. private _hasHit;
  23417. private _hitDistance;
  23418. private _hitNormalWorld;
  23419. private _hitPointWorld;
  23420. private _rayFromWorld;
  23421. private _rayToWorld;
  23422. /**
  23423. * Gets if there was a hit
  23424. */
  23425. readonly hasHit: boolean;
  23426. /**
  23427. * Gets the distance from the hit
  23428. */
  23429. readonly hitDistance: number;
  23430. /**
  23431. * Gets the hit normal/direction in the world
  23432. */
  23433. readonly hitNormalWorld: Vector3;
  23434. /**
  23435. * Gets the hit point in the world
  23436. */
  23437. readonly hitPointWorld: Vector3;
  23438. /**
  23439. * Gets the ray "start point" of the ray in the world
  23440. */
  23441. readonly rayFromWorld: Vector3;
  23442. /**
  23443. * Gets the ray "end point" of the ray in the world
  23444. */
  23445. readonly rayToWorld: Vector3;
  23446. /**
  23447. * Sets the hit data (normal & point in world space)
  23448. * @param hitNormalWorld defines the normal in world space
  23449. * @param hitPointWorld defines the point in world space
  23450. */
  23451. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  23452. /**
  23453. * Sets the distance from the start point to the hit point
  23454. * @param distance
  23455. */
  23456. setHitDistance(distance: number): void;
  23457. /**
  23458. * Calculates the distance manually
  23459. */
  23460. calculateHitDistance(): void;
  23461. /**
  23462. * Resets all the values to default
  23463. * @param from The from point on world space
  23464. * @param to The to point on world space
  23465. */
  23466. reset(from?: Vector3, to?: Vector3): void;
  23467. }
  23468. /**
  23469. * Interface for the size containing width and height
  23470. */
  23471. interface IXYZ {
  23472. /**
  23473. * X
  23474. */
  23475. x: number;
  23476. /**
  23477. * Y
  23478. */
  23479. y: number;
  23480. /**
  23481. * Z
  23482. */
  23483. z: number;
  23484. }
  23485. }
  23486. declare module "babylonjs/Physics/IPhysicsEngine" {
  23487. import { Nullable } from "babylonjs/types";
  23488. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  23489. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23490. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  23491. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  23492. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  23493. /**
  23494. * Interface used to describe a physics joint
  23495. */
  23496. export interface PhysicsImpostorJoint {
  23497. /** Defines the main impostor to which the joint is linked */
  23498. mainImpostor: PhysicsImpostor;
  23499. /** Defines the impostor that is connected to the main impostor using this joint */
  23500. connectedImpostor: PhysicsImpostor;
  23501. /** Defines the joint itself */
  23502. joint: PhysicsJoint;
  23503. }
  23504. /** @hidden */
  23505. export interface IPhysicsEnginePlugin {
  23506. world: any;
  23507. name: string;
  23508. setGravity(gravity: Vector3): void;
  23509. setTimeStep(timeStep: number): void;
  23510. getTimeStep(): number;
  23511. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  23512. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  23513. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  23514. generatePhysicsBody(impostor: PhysicsImpostor): void;
  23515. removePhysicsBody(impostor: PhysicsImpostor): void;
  23516. generateJoint(joint: PhysicsImpostorJoint): void;
  23517. removeJoint(joint: PhysicsImpostorJoint): void;
  23518. isSupported(): boolean;
  23519. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  23520. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  23521. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  23522. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  23523. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  23524. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  23525. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  23526. getBodyMass(impostor: PhysicsImpostor): number;
  23527. getBodyFriction(impostor: PhysicsImpostor): number;
  23528. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  23529. getBodyRestitution(impostor: PhysicsImpostor): number;
  23530. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  23531. getBodyPressure?(impostor: PhysicsImpostor): number;
  23532. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  23533. getBodyStiffness?(impostor: PhysicsImpostor): number;
  23534. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  23535. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  23536. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  23537. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  23538. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  23539. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  23540. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  23541. sleepBody(impostor: PhysicsImpostor): void;
  23542. wakeUpBody(impostor: PhysicsImpostor): void;
  23543. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  23544. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  23545. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  23546. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23547. getRadius(impostor: PhysicsImpostor): number;
  23548. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  23549. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  23550. dispose(): void;
  23551. }
  23552. /**
  23553. * Interface used to define a physics engine
  23554. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  23555. */
  23556. export interface IPhysicsEngine {
  23557. /**
  23558. * Gets the gravity vector used by the simulation
  23559. */
  23560. gravity: Vector3;
  23561. /**
  23562. * Sets the gravity vector used by the simulation
  23563. * @param gravity defines the gravity vector to use
  23564. */
  23565. setGravity(gravity: Vector3): void;
  23566. /**
  23567. * Set the time step of the physics engine.
  23568. * Default is 1/60.
  23569. * To slow it down, enter 1/600 for example.
  23570. * To speed it up, 1/30
  23571. * @param newTimeStep the new timestep to apply to this world.
  23572. */
  23573. setTimeStep(newTimeStep: number): void;
  23574. /**
  23575. * Get the time step of the physics engine.
  23576. * @returns the current time step
  23577. */
  23578. getTimeStep(): number;
  23579. /**
  23580. * Release all resources
  23581. */
  23582. dispose(): void;
  23583. /**
  23584. * Gets the name of the current physics plugin
  23585. * @returns the name of the plugin
  23586. */
  23587. getPhysicsPluginName(): string;
  23588. /**
  23589. * Adding a new impostor for the impostor tracking.
  23590. * This will be done by the impostor itself.
  23591. * @param impostor the impostor to add
  23592. */
  23593. addImpostor(impostor: PhysicsImpostor): void;
  23594. /**
  23595. * Remove an impostor from the engine.
  23596. * This impostor and its mesh will not longer be updated by the physics engine.
  23597. * @param impostor the impostor to remove
  23598. */
  23599. removeImpostor(impostor: PhysicsImpostor): void;
  23600. /**
  23601. * Add a joint to the physics engine
  23602. * @param mainImpostor defines the main impostor to which the joint is added.
  23603. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  23604. * @param joint defines the joint that will connect both impostors.
  23605. */
  23606. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  23607. /**
  23608. * Removes a joint from the simulation
  23609. * @param mainImpostor defines the impostor used with the joint
  23610. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  23611. * @param joint defines the joint to remove
  23612. */
  23613. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  23614. /**
  23615. * Gets the current plugin used to run the simulation
  23616. * @returns current plugin
  23617. */
  23618. getPhysicsPlugin(): IPhysicsEnginePlugin;
  23619. /**
  23620. * Gets the list of physic impostors
  23621. * @returns an array of PhysicsImpostor
  23622. */
  23623. getImpostors(): Array<PhysicsImpostor>;
  23624. /**
  23625. * Gets the impostor for a physics enabled object
  23626. * @param object defines the object impersonated by the impostor
  23627. * @returns the PhysicsImpostor or null if not found
  23628. */
  23629. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  23630. /**
  23631. * Gets the impostor for a physics body object
  23632. * @param body defines physics body used by the impostor
  23633. * @returns the PhysicsImpostor or null if not found
  23634. */
  23635. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  23636. /**
  23637. * Does a raycast in the physics world
  23638. * @param from when should the ray start?
  23639. * @param to when should the ray end?
  23640. * @returns PhysicsRaycastResult
  23641. */
  23642. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  23643. /**
  23644. * Called by the scene. No need to call it.
  23645. * @param delta defines the timespam between frames
  23646. */
  23647. _step(delta: number): void;
  23648. }
  23649. }
  23650. declare module "babylonjs/Physics/physicsImpostor" {
  23651. import { Nullable, IndicesArray } from "babylonjs/types";
  23652. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  23653. import { TransformNode } from "babylonjs/Meshes/transformNode";
  23654. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23655. import { Scene } from "babylonjs/scene";
  23656. import { Bone } from "babylonjs/Bones/bone";
  23657. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  23658. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  23659. import { Space } from "babylonjs/Maths/math.axis";
  23660. /**
  23661. * The interface for the physics imposter parameters
  23662. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23663. */
  23664. export interface PhysicsImpostorParameters {
  23665. /**
  23666. * The mass of the physics imposter
  23667. */
  23668. mass: number;
  23669. /**
  23670. * The friction of the physics imposter
  23671. */
  23672. friction?: number;
  23673. /**
  23674. * The coefficient of restitution of the physics imposter
  23675. */
  23676. restitution?: number;
  23677. /**
  23678. * The native options of the physics imposter
  23679. */
  23680. nativeOptions?: any;
  23681. /**
  23682. * Specifies if the parent should be ignored
  23683. */
  23684. ignoreParent?: boolean;
  23685. /**
  23686. * Specifies if bi-directional transformations should be disabled
  23687. */
  23688. disableBidirectionalTransformation?: boolean;
  23689. /**
  23690. * The pressure inside the physics imposter, soft object only
  23691. */
  23692. pressure?: number;
  23693. /**
  23694. * The stiffness the physics imposter, soft object only
  23695. */
  23696. stiffness?: number;
  23697. /**
  23698. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  23699. */
  23700. velocityIterations?: number;
  23701. /**
  23702. * The number of iterations used in maintaining consistent vertex positions, soft object only
  23703. */
  23704. positionIterations?: number;
  23705. /**
  23706. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  23707. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  23708. * Add to fix multiple points
  23709. */
  23710. fixedPoints?: number;
  23711. /**
  23712. * The collision margin around a soft object
  23713. */
  23714. margin?: number;
  23715. /**
  23716. * The collision margin around a soft object
  23717. */
  23718. damping?: number;
  23719. /**
  23720. * The path for a rope based on an extrusion
  23721. */
  23722. path?: any;
  23723. /**
  23724. * The shape of an extrusion used for a rope based on an extrusion
  23725. */
  23726. shape?: any;
  23727. }
  23728. /**
  23729. * Interface for a physics-enabled object
  23730. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23731. */
  23732. export interface IPhysicsEnabledObject {
  23733. /**
  23734. * The position of the physics-enabled object
  23735. */
  23736. position: Vector3;
  23737. /**
  23738. * The rotation of the physics-enabled object
  23739. */
  23740. rotationQuaternion: Nullable<Quaternion>;
  23741. /**
  23742. * The scale of the physics-enabled object
  23743. */
  23744. scaling: Vector3;
  23745. /**
  23746. * The rotation of the physics-enabled object
  23747. */
  23748. rotation?: Vector3;
  23749. /**
  23750. * The parent of the physics-enabled object
  23751. */
  23752. parent?: any;
  23753. /**
  23754. * The bounding info of the physics-enabled object
  23755. * @returns The bounding info of the physics-enabled object
  23756. */
  23757. getBoundingInfo(): BoundingInfo;
  23758. /**
  23759. * Computes the world matrix
  23760. * @param force Specifies if the world matrix should be computed by force
  23761. * @returns A world matrix
  23762. */
  23763. computeWorldMatrix(force: boolean): Matrix;
  23764. /**
  23765. * Gets the world matrix
  23766. * @returns A world matrix
  23767. */
  23768. getWorldMatrix?(): Matrix;
  23769. /**
  23770. * Gets the child meshes
  23771. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  23772. * @returns An array of abstract meshes
  23773. */
  23774. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  23775. /**
  23776. * Gets the vertex data
  23777. * @param kind The type of vertex data
  23778. * @returns A nullable array of numbers, or a float32 array
  23779. */
  23780. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  23781. /**
  23782. * Gets the indices from the mesh
  23783. * @returns A nullable array of index arrays
  23784. */
  23785. getIndices?(): Nullable<IndicesArray>;
  23786. /**
  23787. * Gets the scene from the mesh
  23788. * @returns the indices array or null
  23789. */
  23790. getScene?(): Scene;
  23791. /**
  23792. * Gets the absolute position from the mesh
  23793. * @returns the absolute position
  23794. */
  23795. getAbsolutePosition(): Vector3;
  23796. /**
  23797. * Gets the absolute pivot point from the mesh
  23798. * @returns the absolute pivot point
  23799. */
  23800. getAbsolutePivotPoint(): Vector3;
  23801. /**
  23802. * Rotates the mesh
  23803. * @param axis The axis of rotation
  23804. * @param amount The amount of rotation
  23805. * @param space The space of the rotation
  23806. * @returns The rotation transform node
  23807. */
  23808. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  23809. /**
  23810. * Translates the mesh
  23811. * @param axis The axis of translation
  23812. * @param distance The distance of translation
  23813. * @param space The space of the translation
  23814. * @returns The transform node
  23815. */
  23816. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  23817. /**
  23818. * Sets the absolute position of the mesh
  23819. * @param absolutePosition The absolute position of the mesh
  23820. * @returns The transform node
  23821. */
  23822. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  23823. /**
  23824. * Gets the class name of the mesh
  23825. * @returns The class name
  23826. */
  23827. getClassName(): string;
  23828. }
  23829. /**
  23830. * Represents a physics imposter
  23831. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23832. */
  23833. export class PhysicsImpostor {
  23834. /**
  23835. * The physics-enabled object used as the physics imposter
  23836. */
  23837. object: IPhysicsEnabledObject;
  23838. /**
  23839. * The type of the physics imposter
  23840. */
  23841. type: number;
  23842. private _options;
  23843. private _scene?;
  23844. /**
  23845. * The default object size of the imposter
  23846. */
  23847. static DEFAULT_OBJECT_SIZE: Vector3;
  23848. /**
  23849. * The identity quaternion of the imposter
  23850. */
  23851. static IDENTITY_QUATERNION: Quaternion;
  23852. /** @hidden */
  23853. _pluginData: any;
  23854. private _physicsEngine;
  23855. private _physicsBody;
  23856. private _bodyUpdateRequired;
  23857. private _onBeforePhysicsStepCallbacks;
  23858. private _onAfterPhysicsStepCallbacks;
  23859. /** @hidden */
  23860. _onPhysicsCollideCallbacks: Array<{
  23861. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  23862. otherImpostors: Array<PhysicsImpostor>;
  23863. }>;
  23864. private _deltaPosition;
  23865. private _deltaRotation;
  23866. private _deltaRotationConjugated;
  23867. /** @hidden */
  23868. _isFromLine: boolean;
  23869. private _parent;
  23870. private _isDisposed;
  23871. private static _tmpVecs;
  23872. private static _tmpQuat;
  23873. /**
  23874. * Specifies if the physics imposter is disposed
  23875. */
  23876. readonly isDisposed: boolean;
  23877. /**
  23878. * Gets the mass of the physics imposter
  23879. */
  23880. mass: number;
  23881. /**
  23882. * Gets the coefficient of friction
  23883. */
  23884. /**
  23885. * Sets the coefficient of friction
  23886. */
  23887. friction: number;
  23888. /**
  23889. * Gets the coefficient of restitution
  23890. */
  23891. /**
  23892. * Sets the coefficient of restitution
  23893. */
  23894. restitution: number;
  23895. /**
  23896. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  23897. */
  23898. /**
  23899. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  23900. */
  23901. pressure: number;
  23902. /**
  23903. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  23904. */
  23905. /**
  23906. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  23907. */
  23908. stiffness: number;
  23909. /**
  23910. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  23911. */
  23912. /**
  23913. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  23914. */
  23915. velocityIterations: number;
  23916. /**
  23917. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  23918. */
  23919. /**
  23920. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  23921. */
  23922. positionIterations: number;
  23923. /**
  23924. * The unique id of the physics imposter
  23925. * set by the physics engine when adding this impostor to the array
  23926. */
  23927. uniqueId: number;
  23928. /**
  23929. * @hidden
  23930. */
  23931. soft: boolean;
  23932. /**
  23933. * @hidden
  23934. */
  23935. segments: number;
  23936. private _joints;
  23937. /**
  23938. * Initializes the physics imposter
  23939. * @param object The physics-enabled object used as the physics imposter
  23940. * @param type The type of the physics imposter
  23941. * @param _options The options for the physics imposter
  23942. * @param _scene The Babylon scene
  23943. */
  23944. constructor(
  23945. /**
  23946. * The physics-enabled object used as the physics imposter
  23947. */
  23948. object: IPhysicsEnabledObject,
  23949. /**
  23950. * The type of the physics imposter
  23951. */
  23952. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  23953. /**
  23954. * This function will completly initialize this impostor.
  23955. * It will create a new body - but only if this mesh has no parent.
  23956. * If it has, this impostor will not be used other than to define the impostor
  23957. * of the child mesh.
  23958. * @hidden
  23959. */
  23960. _init(): void;
  23961. private _getPhysicsParent;
  23962. /**
  23963. * Should a new body be generated.
  23964. * @returns boolean specifying if body initialization is required
  23965. */
  23966. isBodyInitRequired(): boolean;
  23967. /**
  23968. * Sets the updated scaling
  23969. * @param updated Specifies if the scaling is updated
  23970. */
  23971. setScalingUpdated(): void;
  23972. /**
  23973. * Force a regeneration of this or the parent's impostor's body.
  23974. * Use under cautious - This will remove all joints already implemented.
  23975. */
  23976. forceUpdate(): void;
  23977. /**
  23978. * Gets the body that holds this impostor. Either its own, or its parent.
  23979. */
  23980. /**
  23981. * Set the physics body. Used mainly by the physics engine/plugin
  23982. */
  23983. physicsBody: any;
  23984. /**
  23985. * Get the parent of the physics imposter
  23986. * @returns Physics imposter or null
  23987. */
  23988. /**
  23989. * Sets the parent of the physics imposter
  23990. */
  23991. parent: Nullable<PhysicsImpostor>;
  23992. /**
  23993. * Resets the update flags
  23994. */
  23995. resetUpdateFlags(): void;
  23996. /**
  23997. * Gets the object extend size
  23998. * @returns the object extend size
  23999. */
  24000. getObjectExtendSize(): Vector3;
  24001. /**
  24002. * Gets the object center
  24003. * @returns The object center
  24004. */
  24005. getObjectCenter(): Vector3;
  24006. /**
  24007. * Get a specific parametes from the options parameter
  24008. * @param paramName The object parameter name
  24009. * @returns The object parameter
  24010. */
  24011. getParam(paramName: string): any;
  24012. /**
  24013. * Sets a specific parameter in the options given to the physics plugin
  24014. * @param paramName The parameter name
  24015. * @param value The value of the parameter
  24016. */
  24017. setParam(paramName: string, value: number): void;
  24018. /**
  24019. * Specifically change the body's mass option. Won't recreate the physics body object
  24020. * @param mass The mass of the physics imposter
  24021. */
  24022. setMass(mass: number): void;
  24023. /**
  24024. * Gets the linear velocity
  24025. * @returns linear velocity or null
  24026. */
  24027. getLinearVelocity(): Nullable<Vector3>;
  24028. /**
  24029. * Sets the linear velocity
  24030. * @param velocity linear velocity or null
  24031. */
  24032. setLinearVelocity(velocity: Nullable<Vector3>): void;
  24033. /**
  24034. * Gets the angular velocity
  24035. * @returns angular velocity or null
  24036. */
  24037. getAngularVelocity(): Nullable<Vector3>;
  24038. /**
  24039. * Sets the angular velocity
  24040. * @param velocity The velocity or null
  24041. */
  24042. setAngularVelocity(velocity: Nullable<Vector3>): void;
  24043. /**
  24044. * Execute a function with the physics plugin native code
  24045. * Provide a function the will have two variables - the world object and the physics body object
  24046. * @param func The function to execute with the physics plugin native code
  24047. */
  24048. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  24049. /**
  24050. * Register a function that will be executed before the physics world is stepping forward
  24051. * @param func The function to execute before the physics world is stepped forward
  24052. */
  24053. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24054. /**
  24055. * Unregister a function that will be executed before the physics world is stepping forward
  24056. * @param func The function to execute before the physics world is stepped forward
  24057. */
  24058. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24059. /**
  24060. * Register a function that will be executed after the physics step
  24061. * @param func The function to execute after physics step
  24062. */
  24063. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24064. /**
  24065. * Unregisters a function that will be executed after the physics step
  24066. * @param func The function to execute after physics step
  24067. */
  24068. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24069. /**
  24070. * register a function that will be executed when this impostor collides against a different body
  24071. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  24072. * @param func Callback that is executed on collision
  24073. */
  24074. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  24075. /**
  24076. * Unregisters the physics imposter on contact
  24077. * @param collideAgainst The physics object to collide against
  24078. * @param func Callback to execute on collision
  24079. */
  24080. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  24081. private _tmpQuat;
  24082. private _tmpQuat2;
  24083. /**
  24084. * Get the parent rotation
  24085. * @returns The parent rotation
  24086. */
  24087. getParentsRotation(): Quaternion;
  24088. /**
  24089. * this function is executed by the physics engine.
  24090. */
  24091. beforeStep: () => void;
  24092. /**
  24093. * this function is executed by the physics engine
  24094. */
  24095. afterStep: () => void;
  24096. /**
  24097. * Legacy collision detection event support
  24098. */
  24099. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  24100. /**
  24101. * event and body object due to cannon's event-based architecture.
  24102. */
  24103. onCollide: (e: {
  24104. body: any;
  24105. }) => void;
  24106. /**
  24107. * Apply a force
  24108. * @param force The force to apply
  24109. * @param contactPoint The contact point for the force
  24110. * @returns The physics imposter
  24111. */
  24112. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  24113. /**
  24114. * Apply an impulse
  24115. * @param force The impulse force
  24116. * @param contactPoint The contact point for the impulse force
  24117. * @returns The physics imposter
  24118. */
  24119. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  24120. /**
  24121. * A help function to create a joint
  24122. * @param otherImpostor A physics imposter used to create a joint
  24123. * @param jointType The type of joint
  24124. * @param jointData The data for the joint
  24125. * @returns The physics imposter
  24126. */
  24127. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  24128. /**
  24129. * Add a joint to this impostor with a different impostor
  24130. * @param otherImpostor A physics imposter used to add a joint
  24131. * @param joint The joint to add
  24132. * @returns The physics imposter
  24133. */
  24134. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  24135. /**
  24136. * Add an anchor to a cloth impostor
  24137. * @param otherImpostor rigid impostor to anchor to
  24138. * @param width ratio across width from 0 to 1
  24139. * @param height ratio up height from 0 to 1
  24140. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  24141. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  24142. * @returns impostor the soft imposter
  24143. */
  24144. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  24145. /**
  24146. * Add a hook to a rope impostor
  24147. * @param otherImpostor rigid impostor to anchor to
  24148. * @param length ratio across rope from 0 to 1
  24149. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  24150. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  24151. * @returns impostor the rope imposter
  24152. */
  24153. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  24154. /**
  24155. * Will keep this body still, in a sleep mode.
  24156. * @returns the physics imposter
  24157. */
  24158. sleep(): PhysicsImpostor;
  24159. /**
  24160. * Wake the body up.
  24161. * @returns The physics imposter
  24162. */
  24163. wakeUp(): PhysicsImpostor;
  24164. /**
  24165. * Clones the physics imposter
  24166. * @param newObject The physics imposter clones to this physics-enabled object
  24167. * @returns A nullable physics imposter
  24168. */
  24169. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  24170. /**
  24171. * Disposes the physics imposter
  24172. */
  24173. dispose(): void;
  24174. /**
  24175. * Sets the delta position
  24176. * @param position The delta position amount
  24177. */
  24178. setDeltaPosition(position: Vector3): void;
  24179. /**
  24180. * Sets the delta rotation
  24181. * @param rotation The delta rotation amount
  24182. */
  24183. setDeltaRotation(rotation: Quaternion): void;
  24184. /**
  24185. * Gets the box size of the physics imposter and stores the result in the input parameter
  24186. * @param result Stores the box size
  24187. * @returns The physics imposter
  24188. */
  24189. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  24190. /**
  24191. * Gets the radius of the physics imposter
  24192. * @returns Radius of the physics imposter
  24193. */
  24194. getRadius(): number;
  24195. /**
  24196. * Sync a bone with this impostor
  24197. * @param bone The bone to sync to the impostor.
  24198. * @param boneMesh The mesh that the bone is influencing.
  24199. * @param jointPivot The pivot of the joint / bone in local space.
  24200. * @param distToJoint Optional distance from the impostor to the joint.
  24201. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  24202. */
  24203. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  24204. /**
  24205. * Sync impostor to a bone
  24206. * @param bone The bone that the impostor will be synced to.
  24207. * @param boneMesh The mesh that the bone is influencing.
  24208. * @param jointPivot The pivot of the joint / bone in local space.
  24209. * @param distToJoint Optional distance from the impostor to the joint.
  24210. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  24211. * @param boneAxis Optional vector3 axis the bone is aligned with
  24212. */
  24213. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  24214. /**
  24215. * No-Imposter type
  24216. */
  24217. static NoImpostor: number;
  24218. /**
  24219. * Sphere-Imposter type
  24220. */
  24221. static SphereImpostor: number;
  24222. /**
  24223. * Box-Imposter type
  24224. */
  24225. static BoxImpostor: number;
  24226. /**
  24227. * Plane-Imposter type
  24228. */
  24229. static PlaneImpostor: number;
  24230. /**
  24231. * Mesh-imposter type
  24232. */
  24233. static MeshImpostor: number;
  24234. /**
  24235. * Capsule-Impostor type (Ammo.js plugin only)
  24236. */
  24237. static CapsuleImpostor: number;
  24238. /**
  24239. * Cylinder-Imposter type
  24240. */
  24241. static CylinderImpostor: number;
  24242. /**
  24243. * Particle-Imposter type
  24244. */
  24245. static ParticleImpostor: number;
  24246. /**
  24247. * Heightmap-Imposter type
  24248. */
  24249. static HeightmapImpostor: number;
  24250. /**
  24251. * ConvexHull-Impostor type (Ammo.js plugin only)
  24252. */
  24253. static ConvexHullImpostor: number;
  24254. /**
  24255. * Rope-Imposter type
  24256. */
  24257. static RopeImpostor: number;
  24258. /**
  24259. * Cloth-Imposter type
  24260. */
  24261. static ClothImpostor: number;
  24262. /**
  24263. * Softbody-Imposter type
  24264. */
  24265. static SoftbodyImpostor: number;
  24266. }
  24267. }
  24268. declare module "babylonjs/Meshes/mesh" {
  24269. import { Observable } from "babylonjs/Misc/observable";
  24270. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  24271. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  24272. import { Camera } from "babylonjs/Cameras/camera";
  24273. import { Scene } from "babylonjs/scene";
  24274. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  24275. import { Color4 } from "babylonjs/Maths/math.color";
  24276. import { Engine } from "babylonjs/Engines/engine";
  24277. import { Node } from "babylonjs/node";
  24278. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  24279. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  24280. import { Buffer } from "babylonjs/Meshes/buffer";
  24281. import { Geometry } from "babylonjs/Meshes/geometry";
  24282. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24283. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24284. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  24285. import { Effect } from "babylonjs/Materials/effect";
  24286. import { Material } from "babylonjs/Materials/material";
  24287. import { Skeleton } from "babylonjs/Bones/skeleton";
  24288. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  24289. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  24290. import { Path3D } from "babylonjs/Maths/math.path";
  24291. import { Plane } from "babylonjs/Maths/math.plane";
  24292. import { TransformNode } from "babylonjs/Meshes/transformNode";
  24293. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  24294. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  24295. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  24296. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  24297. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  24298. /**
  24299. * @hidden
  24300. **/
  24301. export class _CreationDataStorage {
  24302. closePath?: boolean;
  24303. closeArray?: boolean;
  24304. idx: number[];
  24305. dashSize: number;
  24306. gapSize: number;
  24307. path3D: Path3D;
  24308. pathArray: Vector3[][];
  24309. arc: number;
  24310. radius: number;
  24311. cap: number;
  24312. tessellation: number;
  24313. }
  24314. /**
  24315. * @hidden
  24316. **/
  24317. class _InstanceDataStorage {
  24318. visibleInstances: any;
  24319. batchCache: _InstancesBatch;
  24320. instancesBufferSize: number;
  24321. instancesBuffer: Nullable<Buffer>;
  24322. instancesData: Float32Array;
  24323. overridenInstanceCount: number;
  24324. isFrozen: boolean;
  24325. previousBatch: Nullable<_InstancesBatch>;
  24326. hardwareInstancedRendering: boolean;
  24327. sideOrientation: number;
  24328. }
  24329. /**
  24330. * @hidden
  24331. **/
  24332. export class _InstancesBatch {
  24333. mustReturn: boolean;
  24334. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  24335. renderSelf: boolean[];
  24336. hardwareInstancedRendering: boolean[];
  24337. }
  24338. /**
  24339. * Class used to represent renderable models
  24340. */
  24341. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  24342. /**
  24343. * Mesh side orientation : usually the external or front surface
  24344. */
  24345. static readonly FRONTSIDE: number;
  24346. /**
  24347. * Mesh side orientation : usually the internal or back surface
  24348. */
  24349. static readonly BACKSIDE: number;
  24350. /**
  24351. * Mesh side orientation : both internal and external or front and back surfaces
  24352. */
  24353. static readonly DOUBLESIDE: number;
  24354. /**
  24355. * Mesh side orientation : by default, `FRONTSIDE`
  24356. */
  24357. static readonly DEFAULTSIDE: number;
  24358. /**
  24359. * Mesh cap setting : no cap
  24360. */
  24361. static readonly NO_CAP: number;
  24362. /**
  24363. * Mesh cap setting : one cap at the beginning of the mesh
  24364. */
  24365. static readonly CAP_START: number;
  24366. /**
  24367. * Mesh cap setting : one cap at the end of the mesh
  24368. */
  24369. static readonly CAP_END: number;
  24370. /**
  24371. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  24372. */
  24373. static readonly CAP_ALL: number;
  24374. /**
  24375. * Mesh pattern setting : no flip or rotate
  24376. */
  24377. static readonly NO_FLIP: number;
  24378. /**
  24379. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  24380. */
  24381. static readonly FLIP_TILE: number;
  24382. /**
  24383. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  24384. */
  24385. static readonly ROTATE_TILE: number;
  24386. /**
  24387. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  24388. */
  24389. static readonly FLIP_ROW: number;
  24390. /**
  24391. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  24392. */
  24393. static readonly ROTATE_ROW: number;
  24394. /**
  24395. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  24396. */
  24397. static readonly FLIP_N_ROTATE_TILE: number;
  24398. /**
  24399. * Mesh pattern setting : rotate pattern and rotate
  24400. */
  24401. static readonly FLIP_N_ROTATE_ROW: number;
  24402. /**
  24403. * Mesh tile positioning : part tiles same on left/right or top/bottom
  24404. */
  24405. static readonly CENTER: number;
  24406. /**
  24407. * Mesh tile positioning : part tiles on left
  24408. */
  24409. static readonly LEFT: number;
  24410. /**
  24411. * Mesh tile positioning : part tiles on right
  24412. */
  24413. static readonly RIGHT: number;
  24414. /**
  24415. * Mesh tile positioning : part tiles on top
  24416. */
  24417. static readonly TOP: number;
  24418. /**
  24419. * Mesh tile positioning : part tiles on bottom
  24420. */
  24421. static readonly BOTTOM: number;
  24422. /**
  24423. * Gets the default side orientation.
  24424. * @param orientation the orientation to value to attempt to get
  24425. * @returns the default orientation
  24426. * @hidden
  24427. */
  24428. static _GetDefaultSideOrientation(orientation?: number): number;
  24429. private _internalMeshDataInfo;
  24430. /**
  24431. * An event triggered before rendering the mesh
  24432. */
  24433. readonly onBeforeRenderObservable: Observable<Mesh>;
  24434. /**
  24435. * An event triggered before binding the mesh
  24436. */
  24437. readonly onBeforeBindObservable: Observable<Mesh>;
  24438. /**
  24439. * An event triggered after rendering the mesh
  24440. */
  24441. readonly onAfterRenderObservable: Observable<Mesh>;
  24442. /**
  24443. * An event triggered before drawing the mesh
  24444. */
  24445. readonly onBeforeDrawObservable: Observable<Mesh>;
  24446. private _onBeforeDrawObserver;
  24447. /**
  24448. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  24449. */
  24450. onBeforeDraw: () => void;
  24451. readonly hasInstances: boolean;
  24452. /**
  24453. * Gets the delay loading state of the mesh (when delay loading is turned on)
  24454. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  24455. */
  24456. delayLoadState: number;
  24457. /**
  24458. * Gets the list of instances created from this mesh
  24459. * it is not supposed to be modified manually.
  24460. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  24461. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  24462. */
  24463. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  24464. /**
  24465. * Gets the file containing delay loading data for this mesh
  24466. */
  24467. delayLoadingFile: string;
  24468. /** @hidden */
  24469. _binaryInfo: any;
  24470. /**
  24471. * User defined function used to change how LOD level selection is done
  24472. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  24473. */
  24474. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  24475. /**
  24476. * Gets or sets the morph target manager
  24477. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  24478. */
  24479. morphTargetManager: Nullable<MorphTargetManager>;
  24480. /** @hidden */
  24481. _creationDataStorage: Nullable<_CreationDataStorage>;
  24482. /** @hidden */
  24483. _geometry: Nullable<Geometry>;
  24484. /** @hidden */
  24485. _delayInfo: Array<string>;
  24486. /** @hidden */
  24487. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  24488. /** @hidden */
  24489. _instanceDataStorage: _InstanceDataStorage;
  24490. private _effectiveMaterial;
  24491. /** @hidden */
  24492. _shouldGenerateFlatShading: boolean;
  24493. /** @hidden */
  24494. _originalBuilderSideOrientation: number;
  24495. /**
  24496. * Use this property to change the original side orientation defined at construction time
  24497. */
  24498. overrideMaterialSideOrientation: Nullable<number>;
  24499. /**
  24500. * Gets the source mesh (the one used to clone this one from)
  24501. */
  24502. readonly source: Nullable<Mesh>;
  24503. /**
  24504. * Gets or sets a boolean indicating that this mesh does not use index buffer
  24505. */
  24506. isUnIndexed: boolean;
  24507. /**
  24508. * @constructor
  24509. * @param name The value used by scene.getMeshByName() to do a lookup.
  24510. * @param scene The scene to add this mesh to.
  24511. * @param parent The parent of this mesh, if it has one
  24512. * @param source An optional Mesh from which geometry is shared, cloned.
  24513. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  24514. * When false, achieved by calling a clone(), also passing False.
  24515. * This will make creation of children, recursive.
  24516. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  24517. */
  24518. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  24519. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  24520. doNotInstantiate: boolean;
  24521. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  24522. /**
  24523. * Gets the class name
  24524. * @returns the string "Mesh".
  24525. */
  24526. getClassName(): string;
  24527. /** @hidden */
  24528. readonly _isMesh: boolean;
  24529. /**
  24530. * Returns a description of this mesh
  24531. * @param fullDetails define if full details about this mesh must be used
  24532. * @returns a descriptive string representing this mesh
  24533. */
  24534. toString(fullDetails?: boolean): string;
  24535. /** @hidden */
  24536. _unBindEffect(): void;
  24537. /**
  24538. * Gets a boolean indicating if this mesh has LOD
  24539. */
  24540. readonly hasLODLevels: boolean;
  24541. /**
  24542. * Gets the list of MeshLODLevel associated with the current mesh
  24543. * @returns an array of MeshLODLevel
  24544. */
  24545. getLODLevels(): MeshLODLevel[];
  24546. private _sortLODLevels;
  24547. /**
  24548. * Add a mesh as LOD level triggered at the given distance.
  24549. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24550. * @param distance The distance from the center of the object to show this level
  24551. * @param mesh The mesh to be added as LOD level (can be null)
  24552. * @return This mesh (for chaining)
  24553. */
  24554. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  24555. /**
  24556. * Returns the LOD level mesh at the passed distance or null if not found.
  24557. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24558. * @param distance The distance from the center of the object to show this level
  24559. * @returns a Mesh or `null`
  24560. */
  24561. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  24562. /**
  24563. * Remove a mesh from the LOD array
  24564. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24565. * @param mesh defines the mesh to be removed
  24566. * @return This mesh (for chaining)
  24567. */
  24568. removeLODLevel(mesh: Mesh): Mesh;
  24569. /**
  24570. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  24571. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24572. * @param camera defines the camera to use to compute distance
  24573. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  24574. * @return This mesh (for chaining)
  24575. */
  24576. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  24577. /**
  24578. * Gets the mesh internal Geometry object
  24579. */
  24580. readonly geometry: Nullable<Geometry>;
  24581. /**
  24582. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  24583. * @returns the total number of vertices
  24584. */
  24585. getTotalVertices(): number;
  24586. /**
  24587. * Returns the content of an associated vertex buffer
  24588. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24589. * - VertexBuffer.PositionKind
  24590. * - VertexBuffer.UVKind
  24591. * - VertexBuffer.UV2Kind
  24592. * - VertexBuffer.UV3Kind
  24593. * - VertexBuffer.UV4Kind
  24594. * - VertexBuffer.UV5Kind
  24595. * - VertexBuffer.UV6Kind
  24596. * - VertexBuffer.ColorKind
  24597. * - VertexBuffer.MatricesIndicesKind
  24598. * - VertexBuffer.MatricesIndicesExtraKind
  24599. * - VertexBuffer.MatricesWeightsKind
  24600. * - VertexBuffer.MatricesWeightsExtraKind
  24601. * @param copyWhenShared defines a boolean indicating that if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one
  24602. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  24603. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  24604. */
  24605. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  24606. /**
  24607. * Returns the mesh VertexBuffer object from the requested `kind`
  24608. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24609. * - VertexBuffer.PositionKind
  24610. * - VertexBuffer.NormalKind
  24611. * - VertexBuffer.UVKind
  24612. * - VertexBuffer.UV2Kind
  24613. * - VertexBuffer.UV3Kind
  24614. * - VertexBuffer.UV4Kind
  24615. * - VertexBuffer.UV5Kind
  24616. * - VertexBuffer.UV6Kind
  24617. * - VertexBuffer.ColorKind
  24618. * - VertexBuffer.MatricesIndicesKind
  24619. * - VertexBuffer.MatricesIndicesExtraKind
  24620. * - VertexBuffer.MatricesWeightsKind
  24621. * - VertexBuffer.MatricesWeightsExtraKind
  24622. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  24623. */
  24624. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  24625. /**
  24626. * Tests if a specific vertex buffer is associated with this mesh
  24627. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  24628. * - VertexBuffer.PositionKind
  24629. * - VertexBuffer.NormalKind
  24630. * - VertexBuffer.UVKind
  24631. * - VertexBuffer.UV2Kind
  24632. * - VertexBuffer.UV3Kind
  24633. * - VertexBuffer.UV4Kind
  24634. * - VertexBuffer.UV5Kind
  24635. * - VertexBuffer.UV6Kind
  24636. * - VertexBuffer.ColorKind
  24637. * - VertexBuffer.MatricesIndicesKind
  24638. * - VertexBuffer.MatricesIndicesExtraKind
  24639. * - VertexBuffer.MatricesWeightsKind
  24640. * - VertexBuffer.MatricesWeightsExtraKind
  24641. * @returns a boolean
  24642. */
  24643. isVerticesDataPresent(kind: string): boolean;
  24644. /**
  24645. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  24646. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  24647. * - VertexBuffer.PositionKind
  24648. * - VertexBuffer.UVKind
  24649. * - VertexBuffer.UV2Kind
  24650. * - VertexBuffer.UV3Kind
  24651. * - VertexBuffer.UV4Kind
  24652. * - VertexBuffer.UV5Kind
  24653. * - VertexBuffer.UV6Kind
  24654. * - VertexBuffer.ColorKind
  24655. * - VertexBuffer.MatricesIndicesKind
  24656. * - VertexBuffer.MatricesIndicesExtraKind
  24657. * - VertexBuffer.MatricesWeightsKind
  24658. * - VertexBuffer.MatricesWeightsExtraKind
  24659. * @returns a boolean
  24660. */
  24661. isVertexBufferUpdatable(kind: string): boolean;
  24662. /**
  24663. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  24664. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24665. * - VertexBuffer.PositionKind
  24666. * - VertexBuffer.NormalKind
  24667. * - VertexBuffer.UVKind
  24668. * - VertexBuffer.UV2Kind
  24669. * - VertexBuffer.UV3Kind
  24670. * - VertexBuffer.UV4Kind
  24671. * - VertexBuffer.UV5Kind
  24672. * - VertexBuffer.UV6Kind
  24673. * - VertexBuffer.ColorKind
  24674. * - VertexBuffer.MatricesIndicesKind
  24675. * - VertexBuffer.MatricesIndicesExtraKind
  24676. * - VertexBuffer.MatricesWeightsKind
  24677. * - VertexBuffer.MatricesWeightsExtraKind
  24678. * @returns an array of strings
  24679. */
  24680. getVerticesDataKinds(): string[];
  24681. /**
  24682. * Returns a positive integer : the total number of indices in this mesh geometry.
  24683. * @returns the numner of indices or zero if the mesh has no geometry.
  24684. */
  24685. getTotalIndices(): number;
  24686. /**
  24687. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  24688. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  24689. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  24690. * @returns the indices array or an empty array if the mesh has no geometry
  24691. */
  24692. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  24693. readonly isBlocked: boolean;
  24694. /**
  24695. * Determine if the current mesh is ready to be rendered
  24696. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  24697. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  24698. * @returns true if all associated assets are ready (material, textures, shaders)
  24699. */
  24700. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  24701. /**
  24702. * Gets a boolean indicating if the normals aren't to be recomputed on next mesh `positions` array update. This property is pertinent only for updatable parametric shapes.
  24703. */
  24704. readonly areNormalsFrozen: boolean;
  24705. /**
  24706. * This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It prevents the mesh normals from being recomputed on next `positions` array update.
  24707. * @returns the current mesh
  24708. */
  24709. freezeNormals(): Mesh;
  24710. /**
  24711. * This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It reactivates the mesh normals computation if it was previously frozen
  24712. * @returns the current mesh
  24713. */
  24714. unfreezeNormals(): Mesh;
  24715. /**
  24716. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  24717. */
  24718. overridenInstanceCount: number;
  24719. /** @hidden */
  24720. _preActivate(): Mesh;
  24721. /** @hidden */
  24722. _preActivateForIntermediateRendering(renderId: number): Mesh;
  24723. /** @hidden */
  24724. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  24725. /**
  24726. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  24727. * This means the mesh underlying bounding box and sphere are recomputed.
  24728. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  24729. * @returns the current mesh
  24730. */
  24731. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  24732. /** @hidden */
  24733. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  24734. /**
  24735. * This function will subdivide the mesh into multiple submeshes
  24736. * @param count defines the expected number of submeshes
  24737. */
  24738. subdivide(count: number): void;
  24739. /**
  24740. * Copy a FloatArray into a specific associated vertex buffer
  24741. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  24742. * - VertexBuffer.PositionKind
  24743. * - VertexBuffer.UVKind
  24744. * - VertexBuffer.UV2Kind
  24745. * - VertexBuffer.UV3Kind
  24746. * - VertexBuffer.UV4Kind
  24747. * - VertexBuffer.UV5Kind
  24748. * - VertexBuffer.UV6Kind
  24749. * - VertexBuffer.ColorKind
  24750. * - VertexBuffer.MatricesIndicesKind
  24751. * - VertexBuffer.MatricesIndicesExtraKind
  24752. * - VertexBuffer.MatricesWeightsKind
  24753. * - VertexBuffer.MatricesWeightsExtraKind
  24754. * @param data defines the data source
  24755. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  24756. * @param stride defines the data stride size (can be null)
  24757. * @returns the current mesh
  24758. */
  24759. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  24760. /**
  24761. * Delete a vertex buffer associated with this mesh
  24762. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  24763. * - VertexBuffer.PositionKind
  24764. * - VertexBuffer.UVKind
  24765. * - VertexBuffer.UV2Kind
  24766. * - VertexBuffer.UV3Kind
  24767. * - VertexBuffer.UV4Kind
  24768. * - VertexBuffer.UV5Kind
  24769. * - VertexBuffer.UV6Kind
  24770. * - VertexBuffer.ColorKind
  24771. * - VertexBuffer.MatricesIndicesKind
  24772. * - VertexBuffer.MatricesIndicesExtraKind
  24773. * - VertexBuffer.MatricesWeightsKind
  24774. * - VertexBuffer.MatricesWeightsExtraKind
  24775. */
  24776. removeVerticesData(kind: string): void;
  24777. /**
  24778. * Flags an associated vertex buffer as updatable
  24779. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  24780. * - VertexBuffer.PositionKind
  24781. * - VertexBuffer.UVKind
  24782. * - VertexBuffer.UV2Kind
  24783. * - VertexBuffer.UV3Kind
  24784. * - VertexBuffer.UV4Kind
  24785. * - VertexBuffer.UV5Kind
  24786. * - VertexBuffer.UV6Kind
  24787. * - VertexBuffer.ColorKind
  24788. * - VertexBuffer.MatricesIndicesKind
  24789. * - VertexBuffer.MatricesIndicesExtraKind
  24790. * - VertexBuffer.MatricesWeightsKind
  24791. * - VertexBuffer.MatricesWeightsExtraKind
  24792. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  24793. */
  24794. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  24795. /**
  24796. * Sets the mesh global Vertex Buffer
  24797. * @param buffer defines the buffer to use
  24798. * @returns the current mesh
  24799. */
  24800. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  24801. /**
  24802. * Update a specific associated vertex buffer
  24803. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  24804. * - VertexBuffer.PositionKind
  24805. * - VertexBuffer.UVKind
  24806. * - VertexBuffer.UV2Kind
  24807. * - VertexBuffer.UV3Kind
  24808. * - VertexBuffer.UV4Kind
  24809. * - VertexBuffer.UV5Kind
  24810. * - VertexBuffer.UV6Kind
  24811. * - VertexBuffer.ColorKind
  24812. * - VertexBuffer.MatricesIndicesKind
  24813. * - VertexBuffer.MatricesIndicesExtraKind
  24814. * - VertexBuffer.MatricesWeightsKind
  24815. * - VertexBuffer.MatricesWeightsExtraKind
  24816. * @param data defines the data source
  24817. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  24818. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  24819. * @returns the current mesh
  24820. */
  24821. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  24822. /**
  24823. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  24824. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  24825. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  24826. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  24827. * @returns the current mesh
  24828. */
  24829. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  24830. /**
  24831. * Creates a un-shared specific occurence of the geometry for the mesh.
  24832. * @returns the current mesh
  24833. */
  24834. makeGeometryUnique(): Mesh;
  24835. /**
  24836. * Set the index buffer of this mesh
  24837. * @param indices defines the source data
  24838. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  24839. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  24840. * @returns the current mesh
  24841. */
  24842. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  24843. /**
  24844. * Update the current index buffer
  24845. * @param indices defines the source data
  24846. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  24847. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  24848. * @returns the current mesh
  24849. */
  24850. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  24851. /**
  24852. * Invert the geometry to move from a right handed system to a left handed one.
  24853. * @returns the current mesh
  24854. */
  24855. toLeftHanded(): Mesh;
  24856. /** @hidden */
  24857. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  24858. /** @hidden */
  24859. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  24860. /**
  24861. * Registers for this mesh a javascript function called just before the rendering process
  24862. * @param func defines the function to call before rendering this mesh
  24863. * @returns the current mesh
  24864. */
  24865. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  24866. /**
  24867. * Disposes a previously registered javascript function called before the rendering
  24868. * @param func defines the function to remove
  24869. * @returns the current mesh
  24870. */
  24871. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  24872. /**
  24873. * Registers for this mesh a javascript function called just after the rendering is complete
  24874. * @param func defines the function to call after rendering this mesh
  24875. * @returns the current mesh
  24876. */
  24877. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  24878. /**
  24879. * Disposes a previously registered javascript function called after the rendering.
  24880. * @param func defines the function to remove
  24881. * @returns the current mesh
  24882. */
  24883. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  24884. /** @hidden */
  24885. _getInstancesRenderList(subMeshId: number): _InstancesBatch;
  24886. /** @hidden */
  24887. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  24888. /** @hidden */
  24889. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  24890. /** @hidden */
  24891. _processRendering(subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  24892. /** @hidden */
  24893. _rebuild(): void;
  24894. /** @hidden */
  24895. _freeze(): void;
  24896. /** @hidden */
  24897. _unFreeze(): void;
  24898. /**
  24899. * Triggers the draw call for the mesh. Usually, you don't need to call this method by your own because the mesh rendering is handled by the scene rendering manager
  24900. * @param subMesh defines the subMesh to render
  24901. * @param enableAlphaMode defines if alpha mode can be changed
  24902. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  24903. * @returns the current mesh
  24904. */
  24905. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  24906. private _onBeforeDraw;
  24907. /**
  24908. * Renormalize the mesh and patch it up if there are no weights
  24909. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  24910. * However in the case of zero weights then we set just a single influence to 1.
  24911. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  24912. */
  24913. cleanMatrixWeights(): void;
  24914. private normalizeSkinFourWeights;
  24915. private normalizeSkinWeightsAndExtra;
  24916. /**
  24917. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  24918. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  24919. * the user know there was an issue with importing the mesh
  24920. * @returns a validation object with skinned, valid and report string
  24921. */
  24922. validateSkinning(): {
  24923. skinned: boolean;
  24924. valid: boolean;
  24925. report: string;
  24926. };
  24927. /** @hidden */
  24928. _checkDelayState(): Mesh;
  24929. private _queueLoad;
  24930. /**
  24931. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  24932. * A mesh is in the frustum if its bounding box intersects the frustum
  24933. * @param frustumPlanes defines the frustum to test
  24934. * @returns true if the mesh is in the frustum planes
  24935. */
  24936. isInFrustum(frustumPlanes: Plane[]): boolean;
  24937. /**
  24938. * Sets the mesh material by the material or multiMaterial `id` property
  24939. * @param id is a string identifying the material or the multiMaterial
  24940. * @returns the current mesh
  24941. */
  24942. setMaterialByID(id: string): Mesh;
  24943. /**
  24944. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  24945. * @returns an array of IAnimatable
  24946. */
  24947. getAnimatables(): IAnimatable[];
  24948. /**
  24949. * Modifies the mesh geometry according to the passed transformation matrix.
  24950. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  24951. * The mesh normals are modified using the same transformation.
  24952. * Note that, under the hood, this method sets a new VertexBuffer each call.
  24953. * @param transform defines the transform matrix to use
  24954. * @see http://doc.babylonjs.com/resources/baking_transformations
  24955. * @returns the current mesh
  24956. */
  24957. bakeTransformIntoVertices(transform: Matrix): Mesh;
  24958. /**
  24959. * Modifies the mesh geometry according to its own current World Matrix.
  24960. * The mesh World Matrix is then reset.
  24961. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  24962. * Note that, under the hood, this method sets a new VertexBuffer each call.
  24963. * @see http://doc.babylonjs.com/resources/baking_transformations
  24964. * @returns the current mesh
  24965. */
  24966. bakeCurrentTransformIntoVertices(): Mesh;
  24967. /** @hidden */
  24968. readonly _positions: Nullable<Vector3[]>;
  24969. /** @hidden */
  24970. _resetPointsArrayCache(): Mesh;
  24971. /** @hidden */
  24972. _generatePointsArray(): boolean;
  24973. /**
  24974. * Returns a new Mesh object generated from the current mesh properties.
  24975. * This method must not get confused with createInstance()
  24976. * @param name is a string, the name given to the new mesh
  24977. * @param newParent can be any Node object (default `null`)
  24978. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  24979. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  24980. * @returns a new mesh
  24981. */
  24982. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Nullable<AbstractMesh>;
  24983. /**
  24984. * Releases resources associated with this mesh.
  24985. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  24986. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  24987. */
  24988. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  24989. /** @hidden */
  24990. _disposeInstanceSpecificData(): void;
  24991. /**
  24992. * Modifies the mesh geometry according to a displacement map.
  24993. * A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex.
  24994. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  24995. * @param url is a string, the URL from the image file is to be downloaded.
  24996. * @param minHeight is the lower limit of the displacement.
  24997. * @param maxHeight is the upper limit of the displacement.
  24998. * @param onSuccess is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
  24999. * @param uvOffset is an optional vector2 used to offset UV.
  25000. * @param uvScale is an optional vector2 used to scale UV.
  25001. * @param forceUpdate defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
  25002. * @returns the Mesh.
  25003. */
  25004. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  25005. /**
  25006. * Modifies the mesh geometry according to a displacementMap buffer.
  25007. * A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex.
  25008. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  25009. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  25010. * @param heightMapWidth is the width of the buffer image.
  25011. * @param heightMapHeight is the height of the buffer image.
  25012. * @param minHeight is the lower limit of the displacement.
  25013. * @param maxHeight is the upper limit of the displacement.
  25014. * @param onSuccess is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
  25015. * @param uvOffset is an optional vector2 used to offset UV.
  25016. * @param uvScale is an optional vector2 used to scale UV.
  25017. * @param forceUpdate defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
  25018. * @returns the Mesh.
  25019. */
  25020. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  25021. /**
  25022. * Modify the mesh to get a flat shading rendering.
  25023. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  25024. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  25025. * @returns current mesh
  25026. */
  25027. convertToFlatShadedMesh(): Mesh;
  25028. /**
  25029. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  25030. * In other words, more vertices, no more indices and a single bigger VBO.
  25031. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  25032. * @returns current mesh
  25033. */
  25034. convertToUnIndexedMesh(): Mesh;
  25035. /**
  25036. * Inverses facet orientations.
  25037. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25038. * @param flipNormals will also inverts the normals
  25039. * @returns current mesh
  25040. */
  25041. flipFaces(flipNormals?: boolean): Mesh;
  25042. /**
  25043. * Increase the number of facets and hence vertices in a mesh
  25044. * Vertex normals are interpolated from existing vertex normals
  25045. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25046. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  25047. */
  25048. increaseVertices(numberPerEdge: number): void;
  25049. /**
  25050. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  25051. * This will undo any application of covertToFlatShadedMesh
  25052. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25053. */
  25054. forceSharedVertices(): void;
  25055. /** @hidden */
  25056. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  25057. /** @hidden */
  25058. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  25059. /**
  25060. * Creates a new InstancedMesh object from the mesh model.
  25061. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  25062. * @param name defines the name of the new instance
  25063. * @returns a new InstancedMesh
  25064. */
  25065. createInstance(name: string): InstancedMesh;
  25066. /**
  25067. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  25068. * After this call, all the mesh instances have the same submeshes than the current mesh.
  25069. * @returns the current mesh
  25070. */
  25071. synchronizeInstances(): Mesh;
  25072. /**
  25073. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  25074. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  25075. * This should be used together with the simplification to avoid disappearing triangles.
  25076. * @param successCallback an optional success callback to be called after the optimization finished.
  25077. * @returns the current mesh
  25078. */
  25079. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  25080. /**
  25081. * Serialize current mesh
  25082. * @param serializationObject defines the object which will receive the serialization data
  25083. */
  25084. serialize(serializationObject: any): void;
  25085. /** @hidden */
  25086. _syncGeometryWithMorphTargetManager(): void;
  25087. /** @hidden */
  25088. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  25089. /**
  25090. * Returns a new Mesh object parsed from the source provided.
  25091. * @param parsedMesh is the source
  25092. * @param scene defines the hosting scene
  25093. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  25094. * @returns a new Mesh
  25095. */
  25096. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  25097. /**
  25098. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  25099. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25100. * @param name defines the name of the mesh to create
  25101. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  25102. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  25103. * @param closePath creates a seam between the first and the last points of each path of the path array
  25104. * @param offset is taken in account only if the `pathArray` is containing a single path
  25105. * @param scene defines the hosting scene
  25106. * @param updatable defines if the mesh must be flagged as updatable
  25107. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25108. * @param instance defines an instance of an existing Ribbon object to be updated with the passed `pathArray` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#ribbon)
  25109. * @returns a new Mesh
  25110. */
  25111. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25112. /**
  25113. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  25114. * @param name defines the name of the mesh to create
  25115. * @param radius sets the radius size (float) of the polygon (default 0.5)
  25116. * @param tessellation sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  25117. * @param scene defines the hosting scene
  25118. * @param updatable defines if the mesh must be flagged as updatable
  25119. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25120. * @returns a new Mesh
  25121. */
  25122. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  25123. /**
  25124. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  25125. * @param name defines the name of the mesh to create
  25126. * @param size sets the size (float) of each box side (default 1)
  25127. * @param scene defines the hosting scene
  25128. * @param updatable defines if the mesh must be flagged as updatable
  25129. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25130. * @returns a new Mesh
  25131. */
  25132. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  25133. /**
  25134. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  25135. * @param name defines the name of the mesh to create
  25136. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  25137. * @param diameter sets the diameter size (float) of the sphere (default 1)
  25138. * @param scene defines the hosting scene
  25139. * @param updatable defines if the mesh must be flagged as updatable
  25140. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25141. * @returns a new Mesh
  25142. */
  25143. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25144. /**
  25145. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  25146. * @param name defines the name of the mesh to create
  25147. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  25148. * @param diameter sets the diameter size (float) of the sphere (default 1)
  25149. * @param scene defines the hosting scene
  25150. * @returns a new Mesh
  25151. */
  25152. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  25153. /**
  25154. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  25155. * @param name defines the name of the mesh to create
  25156. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  25157. * @param diameterTop set the top cap diameter (floats, default 1)
  25158. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  25159. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  25160. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  25161. * @param scene defines the hosting scene
  25162. * @param updatable defines if the mesh must be flagged as updatable
  25163. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25164. * @returns a new Mesh
  25165. */
  25166. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  25167. /**
  25168. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  25169. * @param name defines the name of the mesh to create
  25170. * @param diameter sets the diameter size (float) of the torus (default 1)
  25171. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  25172. * @param tessellation sets the number of torus sides (postive integer, default 16)
  25173. * @param scene defines the hosting scene
  25174. * @param updatable defines if the mesh must be flagged as updatable
  25175. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25176. * @returns a new Mesh
  25177. */
  25178. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25179. /**
  25180. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  25181. * @param name defines the name of the mesh to create
  25182. * @param radius sets the global radius size (float) of the torus knot (default 2)
  25183. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  25184. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  25185. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  25186. * @param p the number of windings on X axis (positive integers, default 2)
  25187. * @param q the number of windings on Y axis (positive integers, default 3)
  25188. * @param scene defines the hosting scene
  25189. * @param updatable defines if the mesh must be flagged as updatable
  25190. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25191. * @returns a new Mesh
  25192. */
  25193. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25194. /**
  25195. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  25196. * @param name defines the name of the mesh to create
  25197. * @param points is an array successive Vector3
  25198. * @param scene defines the hosting scene
  25199. * @param updatable defines if the mesh must be flagged as updatable
  25200. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines).
  25201. * @returns a new Mesh
  25202. */
  25203. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  25204. /**
  25205. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  25206. * @param name defines the name of the mesh to create
  25207. * @param points is an array successive Vector3
  25208. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  25209. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  25210. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  25211. * @param scene defines the hosting scene
  25212. * @param updatable defines if the mesh must be flagged as updatable
  25213. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines)
  25214. * @returns a new Mesh
  25215. */
  25216. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  25217. /**
  25218. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  25219. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  25220. * The parameter `shape` is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors.
  25221. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25222. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  25223. * Remember you can only change the shape positions, not their number when updating a polygon.
  25224. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  25225. * @param name defines the name of the mesh to create
  25226. * @param shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  25227. * @param scene defines the hosting scene
  25228. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  25229. * @param updatable defines if the mesh must be flagged as updatable
  25230. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25231. * @param earcutInjection can be used to inject your own earcut reference
  25232. * @returns a new Mesh
  25233. */
  25234. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  25235. /**
  25236. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  25237. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  25238. * @param name defines the name of the mesh to create
  25239. * @param shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  25240. * @param depth defines the height of extrusion
  25241. * @param scene defines the hosting scene
  25242. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  25243. * @param updatable defines if the mesh must be flagged as updatable
  25244. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25245. * @param earcutInjection can be used to inject your own earcut reference
  25246. * @returns a new Mesh
  25247. */
  25248. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  25249. /**
  25250. * Creates an extruded shape mesh.
  25251. * The extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters. Please consider using the same method from the MeshBuilder class instead
  25252. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25253. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  25254. * @param name defines the name of the mesh to create
  25255. * @param shape is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
  25256. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  25257. * @param scale is the value to scale the shape
  25258. * @param rotation is the angle value to rotate the shape each step (each path point), from the former step (so rotation added each step) along the curve
  25259. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  25260. * @param scene defines the hosting scene
  25261. * @param updatable defines if the mesh must be flagged as updatable
  25262. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25263. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#extruded-shape)
  25264. * @returns a new Mesh
  25265. */
  25266. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25267. /**
  25268. * Creates an custom extruded shape mesh.
  25269. * The custom extrusion is a parametric shape.
  25270. * It has no predefined shape. Its final shape will depend on the input parameters.
  25271. * Please consider using the same method from the MeshBuilder class instead
  25272. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  25273. * @param name defines the name of the mesh to create
  25274. * @param shape is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
  25275. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  25276. * @param scaleFunction is a custom Javascript function called on each path point
  25277. * @param rotationFunction is a custom Javascript function called on each path point
  25278. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  25279. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  25280. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  25281. * @param scene defines the hosting scene
  25282. * @param updatable defines if the mesh must be flagged as updatable
  25283. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25284. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape)
  25285. * @returns a new Mesh
  25286. */
  25287. static ExtrudeShapeCustom(name: string, shape: Vector3[], path: Vector3[], scaleFunction: Function, rotationFunction: Function, ribbonCloseArray: boolean, ribbonClosePath: boolean, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25288. /**
  25289. * Creates lathe mesh.
  25290. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  25291. * Please consider using the same method from the MeshBuilder class instead
  25292. * @param name defines the name of the mesh to create
  25293. * @param shape is a required array of successive Vector3. This array depicts the shape to be rotated in its local space : the shape must be designed in the xOy plane and will be rotated around the Y axis. It's usually a 2D shape, so the Vector3 z coordinates are often set to zero
  25294. * @param radius is the radius value of the lathe
  25295. * @param tessellation is the side number of the lathe.
  25296. * @param scene defines the hosting scene
  25297. * @param updatable defines if the mesh must be flagged as updatable
  25298. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25299. * @returns a new Mesh
  25300. */
  25301. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25302. /**
  25303. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  25304. * @param name defines the name of the mesh to create
  25305. * @param size sets the size (float) of both sides of the plane at once (default 1)
  25306. * @param scene defines the hosting scene
  25307. * @param updatable defines if the mesh must be flagged as updatable
  25308. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25309. * @returns a new Mesh
  25310. */
  25311. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25312. /**
  25313. * Creates a ground mesh.
  25314. * Please consider using the same method from the MeshBuilder class instead
  25315. * @param name defines the name of the mesh to create
  25316. * @param width set the width of the ground
  25317. * @param height set the height of the ground
  25318. * @param subdivisions sets the number of subdivisions per side
  25319. * @param scene defines the hosting scene
  25320. * @param updatable defines if the mesh must be flagged as updatable
  25321. * @returns a new Mesh
  25322. */
  25323. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  25324. /**
  25325. * Creates a tiled ground mesh.
  25326. * Please consider using the same method from the MeshBuilder class instead
  25327. * @param name defines the name of the mesh to create
  25328. * @param xmin set the ground minimum X coordinate
  25329. * @param zmin set the ground minimum Y coordinate
  25330. * @param xmax set the ground maximum X coordinate
  25331. * @param zmax set the ground maximum Z coordinate
  25332. * @param subdivisions is an object `{w: positive integer, h: positive integer}` (default `{w: 6, h: 6}`). `w` and `h` are the numbers of subdivisions on the ground width and height. Each subdivision is called a tile
  25333. * @param precision is an object `{w: positive integer, h: positive integer}` (default `{w: 2, h: 2}`). `w` and `h` are the numbers of subdivisions on the ground width and height of each tile
  25334. * @param scene defines the hosting scene
  25335. * @param updatable defines if the mesh must be flagged as updatable
  25336. * @returns a new Mesh
  25337. */
  25338. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  25339. w: number;
  25340. h: number;
  25341. }, precision: {
  25342. w: number;
  25343. h: number;
  25344. }, scene: Scene, updatable?: boolean): Mesh;
  25345. /**
  25346. * Creates a ground mesh from a height map.
  25347. * Please consider using the same method from the MeshBuilder class instead
  25348. * @see http://doc.babylonjs.com/babylon101/height_map
  25349. * @param name defines the name of the mesh to create
  25350. * @param url sets the URL of the height map image resource
  25351. * @param width set the ground width size
  25352. * @param height set the ground height size
  25353. * @param subdivisions sets the number of subdivision per side
  25354. * @param minHeight is the minimum altitude on the ground
  25355. * @param maxHeight is the maximum altitude on the ground
  25356. * @param scene defines the hosting scene
  25357. * @param updatable defines if the mesh must be flagged as updatable
  25358. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  25359. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  25360. * @returns a new Mesh
  25361. */
  25362. static CreateGroundFromHeightMap(name: string, url: string, width: number, height: number, subdivisions: number, minHeight: number, maxHeight: number, scene: Scene, updatable?: boolean, onReady?: (mesh: GroundMesh) => void, alphaFilter?: number): GroundMesh;
  25363. /**
  25364. * Creates a tube mesh.
  25365. * The tube is a parametric shape.
  25366. * It has no predefined shape. Its final shape will depend on the input parameters.
  25367. * Please consider using the same method from the MeshBuilder class instead
  25368. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25369. * @param name defines the name of the mesh to create
  25370. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  25371. * @param radius sets the tube radius size
  25372. * @param tessellation is the number of sides on the tubular surface
  25373. * @param radiusFunction is a custom function. If it is not null, it overwrittes the parameter `radius`. This function is called on each point of the tube path and is passed the index `i` of the i-th point and the distance of this point from the first point of the path
  25374. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  25375. * @param scene defines the hosting scene
  25376. * @param updatable defines if the mesh must be flagged as updatable
  25377. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25378. * @param instance is an instance of an existing Tube object to be updated with the passed `pathArray` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#tube)
  25379. * @returns a new Mesh
  25380. */
  25381. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  25382. (i: number, distance: number): number;
  25383. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25384. /**
  25385. * Creates a polyhedron mesh.
  25386. * Please consider using the same method from the MeshBuilder class instead.
  25387. * * The parameter `type` (positive integer, max 14, default 0) sets the polyhedron type to build among the 15 embbeded types. Please refer to the type sheet in the tutorial to choose the wanted type
  25388. * * The parameter `size` (positive float, default 1) sets the polygon size
  25389. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  25390. * * You can build other polyhedron types than the 15 embbeded ones by setting the parameter `custom` (`polyhedronObject`, default null). If you set the parameter `custom`, this overwrittes the parameter `type`
  25391. * * A `polyhedronObject` is a formatted javascript object. You'll find a full file with pre-set polyhedra here : https://github.com/BabylonJS/Extensions/tree/master/Polyhedron
  25392. * * You can set the color and the UV of each side of the polyhedron with the parameters `faceColors` (Color4, default `(1, 1, 1, 1)`) and faceUV (Vector4, default `(0, 0, 1, 1)`)
  25393. * * To understand how to set `faceUV` or `faceColors`, please read this by considering the right number of faces of your polyhedron, instead of only 6 for the box : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  25394. * * The parameter `flat` (boolean, default true). If set to false, it gives the polyhedron a single global face, so less vertices and shared normals. In this case, `faceColors` and `faceUV` are ignored
  25395. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25396. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  25397. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  25398. * @param name defines the name of the mesh to create
  25399. * @param options defines the options used to create the mesh
  25400. * @param scene defines the hosting scene
  25401. * @returns a new Mesh
  25402. */
  25403. static CreatePolyhedron(name: string, options: {
  25404. type?: number;
  25405. size?: number;
  25406. sizeX?: number;
  25407. sizeY?: number;
  25408. sizeZ?: number;
  25409. custom?: any;
  25410. faceUV?: Vector4[];
  25411. faceColors?: Color4[];
  25412. updatable?: boolean;
  25413. sideOrientation?: number;
  25414. }, scene: Scene): Mesh;
  25415. /**
  25416. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  25417. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  25418. * * You can set some different icosphere dimensions, for instance to build an ellipsoid, by using the parameters `radiusX`, `radiusY` and `radiusZ` (all by default have the same value than `radius`)
  25419. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  25420. * * The parameter `flat` (boolean, default true) gives each side its own normals. Set it to false to get a smooth continuous light reflection on the surface
  25421. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25422. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  25423. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  25424. * @param name defines the name of the mesh
  25425. * @param options defines the options used to create the mesh
  25426. * @param scene defines the hosting scene
  25427. * @returns a new Mesh
  25428. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  25429. */
  25430. static CreateIcoSphere(name: string, options: {
  25431. radius?: number;
  25432. flat?: boolean;
  25433. subdivisions?: number;
  25434. sideOrientation?: number;
  25435. updatable?: boolean;
  25436. }, scene: Scene): Mesh;
  25437. /**
  25438. * Creates a decal mesh.
  25439. * Please consider using the same method from the MeshBuilder class instead.
  25440. * A decal is a mesh usually applied as a model onto the surface of another mesh
  25441. * @param name defines the name of the mesh
  25442. * @param sourceMesh defines the mesh receiving the decal
  25443. * @param position sets the position of the decal in world coordinates
  25444. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  25445. * @param size sets the decal scaling
  25446. * @param angle sets the angle to rotate the decal
  25447. * @returns a new Mesh
  25448. */
  25449. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  25450. /**
  25451. * Prepare internal position array for software CPU skinning
  25452. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  25453. */
  25454. setPositionsForCPUSkinning(): Float32Array;
  25455. /**
  25456. * Prepare internal normal array for software CPU skinning
  25457. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  25458. */
  25459. setNormalsForCPUSkinning(): Float32Array;
  25460. /**
  25461. * Updates the vertex buffer by applying transformation from the bones
  25462. * @param skeleton defines the skeleton to apply to current mesh
  25463. * @returns the current mesh
  25464. */
  25465. applySkeleton(skeleton: Skeleton): Mesh;
  25466. /**
  25467. * Returns an object containing a min and max Vector3 which are the minimum and maximum vectors of each mesh bounding box from the passed array, in the world coordinates
  25468. * @param meshes defines the list of meshes to scan
  25469. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  25470. */
  25471. static MinMax(meshes: AbstractMesh[]): {
  25472. min: Vector3;
  25473. max: Vector3;
  25474. };
  25475. /**
  25476. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  25477. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  25478. * @returns a vector3
  25479. */
  25480. static Center(meshesOrMinMaxVector: {
  25481. min: Vector3;
  25482. max: Vector3;
  25483. } | AbstractMesh[]): Vector3;
  25484. /**
  25485. * Merge the array of meshes into a single mesh for performance reasons.
  25486. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  25487. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  25488. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  25489. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  25490. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  25491. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  25492. * @returns a new mesh
  25493. */
  25494. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  25495. /** @hidden */
  25496. addInstance(instance: InstancedMesh): void;
  25497. /** @hidden */
  25498. removeInstance(instance: InstancedMesh): void;
  25499. }
  25500. }
  25501. declare module "babylonjs/Cameras/camera" {
  25502. import { SmartArray } from "babylonjs/Misc/smartArray";
  25503. import { Observable } from "babylonjs/Misc/observable";
  25504. import { Nullable } from "babylonjs/types";
  25505. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  25506. import { Scene } from "babylonjs/scene";
  25507. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  25508. import { Node } from "babylonjs/node";
  25509. import { Mesh } from "babylonjs/Meshes/mesh";
  25510. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25511. import { ICullable } from "babylonjs/Culling/boundingInfo";
  25512. import { Viewport } from "babylonjs/Maths/math.viewport";
  25513. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25514. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25515. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  25516. import { Ray } from "babylonjs/Culling/ray";
  25517. /**
  25518. * This is the base class of all the camera used in the application.
  25519. * @see http://doc.babylonjs.com/features/cameras
  25520. */
  25521. export class Camera extends Node {
  25522. /** @hidden */
  25523. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  25524. /**
  25525. * This is the default projection mode used by the cameras.
  25526. * It helps recreating a feeling of perspective and better appreciate depth.
  25527. * This is the best way to simulate real life cameras.
  25528. */
  25529. static readonly PERSPECTIVE_CAMERA: number;
  25530. /**
  25531. * This helps creating camera with an orthographic mode.
  25532. * Orthographic is commonly used in engineering as a means to produce object specifications that communicate dimensions unambiguously, each line of 1 unit length (cm, meter..whatever) will appear to have the same length everywhere on the drawing. This allows the drafter to dimension only a subset of lines and let the reader know that other lines of that length on the drawing are also that length in reality. Every parallel line in the drawing is also parallel in the object.
  25533. */
  25534. static readonly ORTHOGRAPHIC_CAMERA: number;
  25535. /**
  25536. * This is the default FOV mode for perspective cameras.
  25537. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  25538. */
  25539. static readonly FOVMODE_VERTICAL_FIXED: number;
  25540. /**
  25541. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  25542. */
  25543. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  25544. /**
  25545. * This specifies ther is no need for a camera rig.
  25546. * Basically only one eye is rendered corresponding to the camera.
  25547. */
  25548. static readonly RIG_MODE_NONE: number;
  25549. /**
  25550. * Simulates a camera Rig with one blue eye and one red eye.
  25551. * This can be use with 3d blue and red glasses.
  25552. */
  25553. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  25554. /**
  25555. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  25556. */
  25557. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  25558. /**
  25559. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  25560. */
  25561. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  25562. /**
  25563. * Defines that both eyes of the camera will be rendered over under each other.
  25564. */
  25565. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  25566. /**
  25567. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  25568. */
  25569. static readonly RIG_MODE_VR: number;
  25570. /**
  25571. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  25572. */
  25573. static readonly RIG_MODE_WEBVR: number;
  25574. /**
  25575. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  25576. */
  25577. static readonly RIG_MODE_CUSTOM: number;
  25578. /**
  25579. * Defines if by default attaching controls should prevent the default javascript event to continue.
  25580. */
  25581. static ForceAttachControlToAlwaysPreventDefault: boolean;
  25582. /**
  25583. * Define the input manager associated with the camera.
  25584. */
  25585. inputs: CameraInputsManager<Camera>;
  25586. /** @hidden */
  25587. _position: Vector3;
  25588. /**
  25589. * Define the current local position of the camera in the scene
  25590. */
  25591. position: Vector3;
  25592. /**
  25593. * The vector the camera should consider as up.
  25594. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  25595. */
  25596. upVector: Vector3;
  25597. /**
  25598. * Define the current limit on the left side for an orthographic camera
  25599. * In scene unit
  25600. */
  25601. orthoLeft: Nullable<number>;
  25602. /**
  25603. * Define the current limit on the right side for an orthographic camera
  25604. * In scene unit
  25605. */
  25606. orthoRight: Nullable<number>;
  25607. /**
  25608. * Define the current limit on the bottom side for an orthographic camera
  25609. * In scene unit
  25610. */
  25611. orthoBottom: Nullable<number>;
  25612. /**
  25613. * Define the current limit on the top side for an orthographic camera
  25614. * In scene unit
  25615. */
  25616. orthoTop: Nullable<number>;
  25617. /**
  25618. * Field Of View is set in Radians. (default is 0.8)
  25619. */
  25620. fov: number;
  25621. /**
  25622. * Define the minimum distance the camera can see from.
  25623. * This is important to note that the depth buffer are not infinite and the closer it starts
  25624. * the more your scene might encounter depth fighting issue.
  25625. */
  25626. minZ: number;
  25627. /**
  25628. * Define the maximum distance the camera can see to.
  25629. * This is important to note that the depth buffer are not infinite and the further it end
  25630. * the more your scene might encounter depth fighting issue.
  25631. */
  25632. maxZ: number;
  25633. /**
  25634. * Define the default inertia of the camera.
  25635. * This helps giving a smooth feeling to the camera movement.
  25636. */
  25637. inertia: number;
  25638. /**
  25639. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  25640. */
  25641. mode: number;
  25642. /**
  25643. * Define wether the camera is intermediate.
  25644. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  25645. */
  25646. isIntermediate: boolean;
  25647. /**
  25648. * Define the viewport of the camera.
  25649. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  25650. */
  25651. viewport: Viewport;
  25652. /**
  25653. * Restricts the camera to viewing objects with the same layerMask.
  25654. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  25655. */
  25656. layerMask: number;
  25657. /**
  25658. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  25659. */
  25660. fovMode: number;
  25661. /**
  25662. * Rig mode of the camera.
  25663. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  25664. * This is normally controlled byt the camera themselves as internal use.
  25665. */
  25666. cameraRigMode: number;
  25667. /**
  25668. * Defines the distance between both "eyes" in case of a RIG
  25669. */
  25670. interaxialDistance: number;
  25671. /**
  25672. * Defines if stereoscopic rendering is done side by side or over under.
  25673. */
  25674. isStereoscopicSideBySide: boolean;
  25675. /**
  25676. * Defines the list of custom render target which are rendered to and then used as the input to this camera's render. Eg. display another camera view on a TV in the main scene
  25677. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  25678. * else in the scene. (Eg. security camera)
  25679. *
  25680. * To change the final output target of the camera, camera.outputRenderTarget should be used instead (eg. webXR renders to a render target corrisponding to an HMD)
  25681. */
  25682. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  25683. /**
  25684. * When set, the camera will render to this render target instead of the default canvas
  25685. *
  25686. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  25687. */
  25688. outputRenderTarget: Nullable<RenderTargetTexture>;
  25689. /**
  25690. * Observable triggered when the camera view matrix has changed.
  25691. */
  25692. onViewMatrixChangedObservable: Observable<Camera>;
  25693. /**
  25694. * Observable triggered when the camera Projection matrix has changed.
  25695. */
  25696. onProjectionMatrixChangedObservable: Observable<Camera>;
  25697. /**
  25698. * Observable triggered when the inputs have been processed.
  25699. */
  25700. onAfterCheckInputsObservable: Observable<Camera>;
  25701. /**
  25702. * Observable triggered when reset has been called and applied to the camera.
  25703. */
  25704. onRestoreStateObservable: Observable<Camera>;
  25705. /** @hidden */
  25706. _cameraRigParams: any;
  25707. /** @hidden */
  25708. _rigCameras: Camera[];
  25709. /** @hidden */
  25710. _rigPostProcess: Nullable<PostProcess>;
  25711. protected _webvrViewMatrix: Matrix;
  25712. /** @hidden */
  25713. _skipRendering: boolean;
  25714. /** @hidden */
  25715. _projectionMatrix: Matrix;
  25716. /** @hidden */
  25717. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  25718. /** @hidden */
  25719. _activeMeshes: SmartArray<AbstractMesh>;
  25720. protected _globalPosition: Vector3;
  25721. /** @hidden */
  25722. _computedViewMatrix: Matrix;
  25723. private _doNotComputeProjectionMatrix;
  25724. private _transformMatrix;
  25725. private _frustumPlanes;
  25726. private _refreshFrustumPlanes;
  25727. private _storedFov;
  25728. private _stateStored;
  25729. /**
  25730. * Instantiates a new camera object.
  25731. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  25732. * @see http://doc.babylonjs.com/features/cameras
  25733. * @param name Defines the name of the camera in the scene
  25734. * @param position Defines the position of the camera
  25735. * @param scene Defines the scene the camera belongs too
  25736. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  25737. */
  25738. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  25739. /**
  25740. * Store current camera state (fov, position, etc..)
  25741. * @returns the camera
  25742. */
  25743. storeState(): Camera;
  25744. /**
  25745. * Restores the camera state values if it has been stored. You must call storeState() first
  25746. */
  25747. protected _restoreStateValues(): boolean;
  25748. /**
  25749. * Restored camera state. You must call storeState() first.
  25750. * @returns true if restored and false otherwise
  25751. */
  25752. restoreState(): boolean;
  25753. /**
  25754. * Gets the class name of the camera.
  25755. * @returns the class name
  25756. */
  25757. getClassName(): string;
  25758. /** @hidden */
  25759. readonly _isCamera: boolean;
  25760. /**
  25761. * Gets a string representation of the camera useful for debug purpose.
  25762. * @param fullDetails Defines that a more verboe level of logging is required
  25763. * @returns the string representation
  25764. */
  25765. toString(fullDetails?: boolean): string;
  25766. /**
  25767. * Gets the current world space position of the camera.
  25768. */
  25769. readonly globalPosition: Vector3;
  25770. /**
  25771. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  25772. * @returns the active meshe list
  25773. */
  25774. getActiveMeshes(): SmartArray<AbstractMesh>;
  25775. /**
  25776. * Check wether a mesh is part of the current active mesh list of the camera
  25777. * @param mesh Defines the mesh to check
  25778. * @returns true if active, false otherwise
  25779. */
  25780. isActiveMesh(mesh: Mesh): boolean;
  25781. /**
  25782. * Is this camera ready to be used/rendered
  25783. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  25784. * @return true if the camera is ready
  25785. */
  25786. isReady(completeCheck?: boolean): boolean;
  25787. /** @hidden */
  25788. _initCache(): void;
  25789. /** @hidden */
  25790. _updateCache(ignoreParentClass?: boolean): void;
  25791. /** @hidden */
  25792. _isSynchronized(): boolean;
  25793. /** @hidden */
  25794. _isSynchronizedViewMatrix(): boolean;
  25795. /** @hidden */
  25796. _isSynchronizedProjectionMatrix(): boolean;
  25797. /**
  25798. * Attach the input controls to a specific dom element to get the input from.
  25799. * @param element Defines the element the controls should be listened from
  25800. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  25801. */
  25802. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  25803. /**
  25804. * Detach the current controls from the specified dom element.
  25805. * @param element Defines the element to stop listening the inputs from
  25806. */
  25807. detachControl(element: HTMLElement): void;
  25808. /**
  25809. * Update the camera state according to the different inputs gathered during the frame.
  25810. */
  25811. update(): void;
  25812. /** @hidden */
  25813. _checkInputs(): void;
  25814. /** @hidden */
  25815. readonly rigCameras: Camera[];
  25816. /**
  25817. * Gets the post process used by the rig cameras
  25818. */
  25819. readonly rigPostProcess: Nullable<PostProcess>;
  25820. /**
  25821. * Internal, gets the first post proces.
  25822. * @returns the first post process to be run on this camera.
  25823. */
  25824. _getFirstPostProcess(): Nullable<PostProcess>;
  25825. private _cascadePostProcessesToRigCams;
  25826. /**
  25827. * Attach a post process to the camera.
  25828. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  25829. * @param postProcess The post process to attach to the camera
  25830. * @param insertAt The position of the post process in case several of them are in use in the scene
  25831. * @returns the position the post process has been inserted at
  25832. */
  25833. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  25834. /**
  25835. * Detach a post process to the camera.
  25836. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  25837. * @param postProcess The post process to detach from the camera
  25838. */
  25839. detachPostProcess(postProcess: PostProcess): void;
  25840. /**
  25841. * Gets the current world matrix of the camera
  25842. */
  25843. getWorldMatrix(): Matrix;
  25844. /** @hidden */
  25845. _getViewMatrix(): Matrix;
  25846. /**
  25847. * Gets the current view matrix of the camera.
  25848. * @param force forces the camera to recompute the matrix without looking at the cached state
  25849. * @returns the view matrix
  25850. */
  25851. getViewMatrix(force?: boolean): Matrix;
  25852. /**
  25853. * Freeze the projection matrix.
  25854. * It will prevent the cache check of the camera projection compute and can speed up perf
  25855. * if no parameter of the camera are meant to change
  25856. * @param projection Defines manually a projection if necessary
  25857. */
  25858. freezeProjectionMatrix(projection?: Matrix): void;
  25859. /**
  25860. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  25861. */
  25862. unfreezeProjectionMatrix(): void;
  25863. /**
  25864. * Gets the current projection matrix of the camera.
  25865. * @param force forces the camera to recompute the matrix without looking at the cached state
  25866. * @returns the projection matrix
  25867. */
  25868. getProjectionMatrix(force?: boolean): Matrix;
  25869. /**
  25870. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  25871. * @returns a Matrix
  25872. */
  25873. getTransformationMatrix(): Matrix;
  25874. private _updateFrustumPlanes;
  25875. /**
  25876. * Checks if a cullable object (mesh...) is in the camera frustum
  25877. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  25878. * @param target The object to check
  25879. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  25880. * @returns true if the object is in frustum otherwise false
  25881. */
  25882. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  25883. /**
  25884. * Checks if a cullable object (mesh...) is in the camera frustum
  25885. * Unlike isInFrustum this cheks the full bounding box
  25886. * @param target The object to check
  25887. * @returns true if the object is in frustum otherwise false
  25888. */
  25889. isCompletelyInFrustum(target: ICullable): boolean;
  25890. /**
  25891. * Gets a ray in the forward direction from the camera.
  25892. * @param length Defines the length of the ray to create
  25893. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  25894. * @param origin Defines the start point of the ray which defaults to the camera position
  25895. * @returns the forward ray
  25896. */
  25897. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  25898. /**
  25899. * Releases resources associated with this node.
  25900. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  25901. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  25902. */
  25903. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  25904. /** @hidden */
  25905. _isLeftCamera: boolean;
  25906. /**
  25907. * Gets the left camera of a rig setup in case of Rigged Camera
  25908. */
  25909. readonly isLeftCamera: boolean;
  25910. /** @hidden */
  25911. _isRightCamera: boolean;
  25912. /**
  25913. * Gets the right camera of a rig setup in case of Rigged Camera
  25914. */
  25915. readonly isRightCamera: boolean;
  25916. /**
  25917. * Gets the left camera of a rig setup in case of Rigged Camera
  25918. */
  25919. readonly leftCamera: Nullable<FreeCamera>;
  25920. /**
  25921. * Gets the right camera of a rig setup in case of Rigged Camera
  25922. */
  25923. readonly rightCamera: Nullable<FreeCamera>;
  25924. /**
  25925. * Gets the left camera target of a rig setup in case of Rigged Camera
  25926. * @returns the target position
  25927. */
  25928. getLeftTarget(): Nullable<Vector3>;
  25929. /**
  25930. * Gets the right camera target of a rig setup in case of Rigged Camera
  25931. * @returns the target position
  25932. */
  25933. getRightTarget(): Nullable<Vector3>;
  25934. /**
  25935. * @hidden
  25936. */
  25937. setCameraRigMode(mode: number, rigParams: any): void;
  25938. /** @hidden */
  25939. static _setStereoscopicRigMode(camera: Camera): void;
  25940. /** @hidden */
  25941. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  25942. /** @hidden */
  25943. static _setVRRigMode(camera: Camera, rigParams: any): void;
  25944. /** @hidden */
  25945. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  25946. /** @hidden */
  25947. _getVRProjectionMatrix(): Matrix;
  25948. protected _updateCameraRotationMatrix(): void;
  25949. protected _updateWebVRCameraRotationMatrix(): void;
  25950. /**
  25951. * This function MUST be overwritten by the different WebVR cameras available.
  25952. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  25953. * @hidden
  25954. */
  25955. _getWebVRProjectionMatrix(): Matrix;
  25956. /**
  25957. * This function MUST be overwritten by the different WebVR cameras available.
  25958. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  25959. * @hidden
  25960. */
  25961. _getWebVRViewMatrix(): Matrix;
  25962. /** @hidden */
  25963. setCameraRigParameter(name: string, value: any): void;
  25964. /**
  25965. * needs to be overridden by children so sub has required properties to be copied
  25966. * @hidden
  25967. */
  25968. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  25969. /**
  25970. * May need to be overridden by children
  25971. * @hidden
  25972. */
  25973. _updateRigCameras(): void;
  25974. /** @hidden */
  25975. _setupInputs(): void;
  25976. /**
  25977. * Serialiaze the camera setup to a json represention
  25978. * @returns the JSON representation
  25979. */
  25980. serialize(): any;
  25981. /**
  25982. * Clones the current camera.
  25983. * @param name The cloned camera name
  25984. * @returns the cloned camera
  25985. */
  25986. clone(name: string): Camera;
  25987. /**
  25988. * Gets the direction of the camera relative to a given local axis.
  25989. * @param localAxis Defines the reference axis to provide a relative direction.
  25990. * @return the direction
  25991. */
  25992. getDirection(localAxis: Vector3): Vector3;
  25993. /**
  25994. * Returns the current camera absolute rotation
  25995. */
  25996. readonly absoluteRotation: Quaternion;
  25997. /**
  25998. * Gets the direction of the camera relative to a given local axis into a passed vector.
  25999. * @param localAxis Defines the reference axis to provide a relative direction.
  26000. * @param result Defines the vector to store the result in
  26001. */
  26002. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  26003. /**
  26004. * Gets a camera constructor for a given camera type
  26005. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  26006. * @param name The name of the camera the result will be able to instantiate
  26007. * @param scene The scene the result will construct the camera in
  26008. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  26009. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  26010. * @returns a factory method to construc the camera
  26011. */
  26012. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  26013. /**
  26014. * Compute the world matrix of the camera.
  26015. * @returns the camera world matrix
  26016. */
  26017. computeWorldMatrix(): Matrix;
  26018. /**
  26019. * Parse a JSON and creates the camera from the parsed information
  26020. * @param parsedCamera The JSON to parse
  26021. * @param scene The scene to instantiate the camera in
  26022. * @returns the newly constructed camera
  26023. */
  26024. static Parse(parsedCamera: any, scene: Scene): Camera;
  26025. }
  26026. }
  26027. declare module "babylonjs/Meshes/Builders/discBuilder" {
  26028. import { Nullable } from "babylonjs/types";
  26029. import { Scene } from "babylonjs/scene";
  26030. import { Vector4 } from "babylonjs/Maths/math.vector";
  26031. import { Mesh } from "babylonjs/Meshes/mesh";
  26032. /**
  26033. * Class containing static functions to help procedurally build meshes
  26034. */
  26035. export class DiscBuilder {
  26036. /**
  26037. * Creates a plane polygonal mesh. By default, this is a disc
  26038. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  26039. * * The parameter `tessellation` sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  26040. * * You can create an unclosed polygon with the parameter `arc` (positive float, default 1), valued between 0 and 1, what is the ratio of the circumference : 2 x PI x ratio
  26041. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  26042. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  26043. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  26044. * @param name defines the name of the mesh
  26045. * @param options defines the options used to create the mesh
  26046. * @param scene defines the hosting scene
  26047. * @returns the plane polygonal mesh
  26048. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  26049. */
  26050. static CreateDisc(name: string, options: {
  26051. radius?: number;
  26052. tessellation?: number;
  26053. arc?: number;
  26054. updatable?: boolean;
  26055. sideOrientation?: number;
  26056. frontUVs?: Vector4;
  26057. backUVs?: Vector4;
  26058. }, scene?: Nullable<Scene>): Mesh;
  26059. }
  26060. }
  26061. declare module "babylonjs/Particles/solidParticleSystem" {
  26062. import { Vector3 } from "babylonjs/Maths/math.vector";
  26063. import { Mesh } from "babylonjs/Meshes/mesh";
  26064. import { Scene, IDisposable } from "babylonjs/scene";
  26065. import { DepthSortedParticle, SolidParticle } from "babylonjs/Particles/solidParticle";
  26066. /**
  26067. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  26068. *As it is just a mesh, the SPS has all the same properties than any other BJS mesh : not more, not less. It can be scaled, rotated, translated, enlighted, textured, moved, etc.
  26069. * The SPS is also a particle system. It provides some methods to manage the particles.
  26070. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  26071. *
  26072. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  26073. */
  26074. export class SolidParticleSystem implements IDisposable {
  26075. /**
  26076. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  26077. * Example : var p = SPS.particles[i];
  26078. */
  26079. particles: SolidParticle[];
  26080. /**
  26081. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  26082. */
  26083. nbParticles: number;
  26084. /**
  26085. * If the particles must ever face the camera (default false). Useful for planar particles.
  26086. */
  26087. billboard: boolean;
  26088. /**
  26089. * Recompute normals when adding a shape
  26090. */
  26091. recomputeNormals: boolean;
  26092. /**
  26093. * This a counter ofr your own usage. It's not set by any SPS functions.
  26094. */
  26095. counter: number;
  26096. /**
  26097. * The SPS name. This name is also given to the underlying mesh.
  26098. */
  26099. name: string;
  26100. /**
  26101. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  26102. */
  26103. mesh: Mesh;
  26104. /**
  26105. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  26106. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  26107. */
  26108. vars: any;
  26109. /**
  26110. * This array is populated when the SPS is set as 'pickable'.
  26111. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  26112. * Each element of this array is an object `{idx: int, faceId: int}`.
  26113. * `idx` is the picked particle index in the `SPS.particles` array
  26114. * `faceId` is the picked face index counted within this particle.
  26115. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  26116. */
  26117. pickedParticles: {
  26118. idx: number;
  26119. faceId: number;
  26120. }[];
  26121. /**
  26122. * This array is populated when `enableDepthSort` is set to true.
  26123. * Each element of this array is an instance of the class DepthSortedParticle.
  26124. */
  26125. depthSortedParticles: DepthSortedParticle[];
  26126. /**
  26127. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  26128. * @hidden
  26129. */
  26130. _bSphereOnly: boolean;
  26131. /**
  26132. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  26133. * @hidden
  26134. */
  26135. _bSphereRadiusFactor: number;
  26136. private _scene;
  26137. private _positions;
  26138. private _indices;
  26139. private _normals;
  26140. private _colors;
  26141. private _uvs;
  26142. private _indices32;
  26143. private _positions32;
  26144. private _normals32;
  26145. private _fixedNormal32;
  26146. private _colors32;
  26147. private _uvs32;
  26148. private _index;
  26149. private _updatable;
  26150. private _pickable;
  26151. private _isVisibilityBoxLocked;
  26152. private _alwaysVisible;
  26153. private _depthSort;
  26154. private _expandable;
  26155. private _shapeCounter;
  26156. private _copy;
  26157. private _color;
  26158. private _computeParticleColor;
  26159. private _computeParticleTexture;
  26160. private _computeParticleRotation;
  26161. private _computeParticleVertex;
  26162. private _computeBoundingBox;
  26163. private _depthSortParticles;
  26164. private _camera;
  26165. private _mustUnrotateFixedNormals;
  26166. private _particlesIntersect;
  26167. private _needs32Bits;
  26168. private _isNotBuilt;
  26169. /**
  26170. * Creates a SPS (Solid Particle System) object.
  26171. * @param name (String) is the SPS name, this will be the underlying mesh name.
  26172. * @param scene (Scene) is the scene in which the SPS is added.
  26173. * @param options defines the options of the sps e.g.
  26174. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  26175. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  26176. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  26177. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  26178. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  26179. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  26180. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  26181. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  26182. */
  26183. constructor(name: string, scene: Scene, options?: {
  26184. updatable?: boolean;
  26185. isPickable?: boolean;
  26186. enableDepthSort?: boolean;
  26187. particleIntersection?: boolean;
  26188. boundingSphereOnly?: boolean;
  26189. bSphereRadiusFactor?: number;
  26190. expandable?: boolean;
  26191. });
  26192. /**
  26193. * Builds the SPS underlying mesh. Returns a standard Mesh.
  26194. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  26195. * @returns the created mesh
  26196. */
  26197. buildMesh(): Mesh;
  26198. /**
  26199. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  26200. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  26201. * Thus the particles generated from `digest()` have their property `position` set yet.
  26202. * @param mesh ( Mesh ) is the mesh to be digested
  26203. * @param options {facetNb} (optional integer, default 1) is the number of mesh facets per particle, this parameter is overriden by the parameter `number` if any
  26204. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  26205. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  26206. * @returns the current SPS
  26207. */
  26208. digest(mesh: Mesh, options?: {
  26209. facetNb?: number;
  26210. number?: number;
  26211. delta?: number;
  26212. }): SolidParticleSystem;
  26213. private _unrotateFixedNormals;
  26214. private _resetCopy;
  26215. private _meshBuilder;
  26216. private _posToShape;
  26217. private _uvsToShapeUV;
  26218. private _addParticle;
  26219. /**
  26220. * Adds some particles to the SPS from the model shape. Returns the shape id.
  26221. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  26222. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  26223. * @param nb (positive integer) the number of particles to be created from this model
  26224. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  26225. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  26226. * @returns the number of shapes in the system
  26227. */
  26228. addShape(mesh: Mesh, nb: number, options?: {
  26229. positionFunction?: any;
  26230. vertexFunction?: any;
  26231. }): number;
  26232. private _rebuildParticle;
  26233. /**
  26234. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  26235. * @param reset boolean, default false : if the particles must be reset at position and rotation zero, scaling 1, color white, initial UVs and not parented.
  26236. * @returns the SPS.
  26237. */
  26238. rebuildMesh(reset?: boolean): SolidParticleSystem;
  26239. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  26240. * Returns an array with the removed particles.
  26241. * If the number of particles to remove is lower than zero or greater than the global remaining particle number, then an empty array is returned.
  26242. * The SPS can't be empty so at least one particle needs to remain in place.
  26243. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  26244. * @param start index of the first particle to remove
  26245. * @param end index of the last particle to remove (included)
  26246. * @returns an array populated with the removed particles
  26247. */
  26248. removeParticles(start: number, end: number): SolidParticle[];
  26249. /**
  26250. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  26251. * This method calls `updateParticle()` for each particle of the SPS.
  26252. * For an animated SPS, it is usually called within the render loop.
  26253. * This methods does nothing if called on a non updatable or not yet built SPS. Example : buildMesh() not called after having added or removed particles from an expandable SPS.
  26254. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  26255. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  26256. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  26257. * @returns the SPS.
  26258. */
  26259. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  26260. /**
  26261. * Disposes the SPS.
  26262. */
  26263. dispose(): void;
  26264. /**
  26265. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  26266. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26267. * @returns the SPS.
  26268. */
  26269. refreshVisibleSize(): SolidParticleSystem;
  26270. /**
  26271. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  26272. * @param size the size (float) of the visibility box
  26273. * note : this doesn't lock the SPS mesh bounding box.
  26274. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26275. */
  26276. setVisibilityBox(size: number): void;
  26277. /**
  26278. * Gets whether the SPS as always visible or not
  26279. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26280. */
  26281. /**
  26282. * Sets the SPS as always visible or not
  26283. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26284. */
  26285. isAlwaysVisible: boolean;
  26286. /**
  26287. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  26288. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26289. */
  26290. /**
  26291. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  26292. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26293. */
  26294. isVisibilityBoxLocked: boolean;
  26295. /**
  26296. * Tells to `setParticles()` to compute the particle rotations or not.
  26297. * Default value : true. The SPS is faster when it's set to false.
  26298. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  26299. */
  26300. /**
  26301. * Gets if `setParticles()` computes the particle rotations or not.
  26302. * Default value : true. The SPS is faster when it's set to false.
  26303. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  26304. */
  26305. computeParticleRotation: boolean;
  26306. /**
  26307. * Tells to `setParticles()` to compute the particle colors or not.
  26308. * Default value : true. The SPS is faster when it's set to false.
  26309. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  26310. */
  26311. /**
  26312. * Gets if `setParticles()` computes the particle colors or not.
  26313. * Default value : true. The SPS is faster when it's set to false.
  26314. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  26315. */
  26316. computeParticleColor: boolean;
  26317. /**
  26318. * Gets if `setParticles()` computes the particle textures or not.
  26319. * Default value : true. The SPS is faster when it's set to false.
  26320. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  26321. */
  26322. computeParticleTexture: boolean;
  26323. /**
  26324. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  26325. * Default value : false. The SPS is faster when it's set to false.
  26326. * Note : the particle custom vertex positions aren't stored values.
  26327. */
  26328. /**
  26329. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  26330. * Default value : false. The SPS is faster when it's set to false.
  26331. * Note : the particle custom vertex positions aren't stored values.
  26332. */
  26333. computeParticleVertex: boolean;
  26334. /**
  26335. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  26336. */
  26337. /**
  26338. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  26339. */
  26340. computeBoundingBox: boolean;
  26341. /**
  26342. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  26343. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  26344. * Default : `true`
  26345. */
  26346. /**
  26347. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  26348. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  26349. * Default : `true`
  26350. */
  26351. depthSortParticles: boolean;
  26352. /**
  26353. * Gets if the SPS is created as expandable at construction time.
  26354. * Default : `false`
  26355. */
  26356. readonly expandable: boolean;
  26357. /**
  26358. * This function does nothing. It may be overwritten to set all the particle first values.
  26359. * The SPS doesn't call this function, you may have to call it by your own.
  26360. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26361. */
  26362. initParticles(): void;
  26363. /**
  26364. * This function does nothing. It may be overwritten to recycle a particle.
  26365. * The SPS doesn't call this function, you may have to call it by your own.
  26366. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26367. * @param particle The particle to recycle
  26368. * @returns the recycled particle
  26369. */
  26370. recycleParticle(particle: SolidParticle): SolidParticle;
  26371. /**
  26372. * Updates a particle : this function should be overwritten by the user.
  26373. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  26374. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26375. * @example : just set a particle position or velocity and recycle conditions
  26376. * @param particle The particle to update
  26377. * @returns the updated particle
  26378. */
  26379. updateParticle(particle: SolidParticle): SolidParticle;
  26380. /**
  26381. * Updates a vertex of a particle : it can be overwritten by the user.
  26382. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  26383. * @param particle the current particle
  26384. * @param vertex the current index of the current particle
  26385. * @param pt the index of the current vertex in the particle shape
  26386. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  26387. * @example : just set a vertex particle position
  26388. * @returns the updated vertex
  26389. */
  26390. updateParticleVertex(particle: SolidParticle, vertex: Vector3, pt: number): Vector3;
  26391. /**
  26392. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  26393. * This does nothing and may be overwritten by the user.
  26394. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26395. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26396. * @param update the boolean update value actually passed to setParticles()
  26397. */
  26398. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  26399. /**
  26400. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  26401. * This will be passed three parameters.
  26402. * This does nothing and may be overwritten by the user.
  26403. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26404. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26405. * @param update the boolean update value actually passed to setParticles()
  26406. */
  26407. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  26408. }
  26409. }
  26410. declare module "babylonjs/Particles/solidParticle" {
  26411. import { Nullable } from "babylonjs/types";
  26412. import { Vector3, Matrix, Quaternion, Vector4 } from "babylonjs/Maths/math.vector";
  26413. import { Color4 } from "babylonjs/Maths/math.color";
  26414. import { Mesh } from "babylonjs/Meshes/mesh";
  26415. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26416. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  26417. import { Plane } from "babylonjs/Maths/math.plane";
  26418. /**
  26419. * Represents one particle of a solid particle system.
  26420. */
  26421. export class SolidParticle {
  26422. /**
  26423. * particle global index
  26424. */
  26425. idx: number;
  26426. /**
  26427. * The color of the particle
  26428. */
  26429. color: Nullable<Color4>;
  26430. /**
  26431. * The world space position of the particle.
  26432. */
  26433. position: Vector3;
  26434. /**
  26435. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  26436. */
  26437. rotation: Vector3;
  26438. /**
  26439. * The world space rotation quaternion of the particle.
  26440. */
  26441. rotationQuaternion: Nullable<Quaternion>;
  26442. /**
  26443. * The scaling of the particle.
  26444. */
  26445. scaling: Vector3;
  26446. /**
  26447. * The uvs of the particle.
  26448. */
  26449. uvs: Vector4;
  26450. /**
  26451. * The current speed of the particle.
  26452. */
  26453. velocity: Vector3;
  26454. /**
  26455. * The pivot point in the particle local space.
  26456. */
  26457. pivot: Vector3;
  26458. /**
  26459. * Must the particle be translated from its pivot point in its local space ?
  26460. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  26461. * Default : false
  26462. */
  26463. translateFromPivot: boolean;
  26464. /**
  26465. * Is the particle active or not ?
  26466. */
  26467. alive: boolean;
  26468. /**
  26469. * Is the particle visible or not ?
  26470. */
  26471. isVisible: boolean;
  26472. /**
  26473. * Index of this particle in the global "positions" array (Internal use)
  26474. * @hidden
  26475. */
  26476. _pos: number;
  26477. /**
  26478. * @hidden Index of this particle in the global "indices" array (Internal use)
  26479. */
  26480. _ind: number;
  26481. /**
  26482. * @hidden ModelShape of this particle (Internal use)
  26483. */
  26484. _model: ModelShape;
  26485. /**
  26486. * ModelShape id of this particle
  26487. */
  26488. shapeId: number;
  26489. /**
  26490. * Index of the particle in its shape id
  26491. */
  26492. idxInShape: number;
  26493. /**
  26494. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  26495. */
  26496. _modelBoundingInfo: BoundingInfo;
  26497. /**
  26498. * @hidden Particle BoundingInfo object (Internal use)
  26499. */
  26500. _boundingInfo: BoundingInfo;
  26501. /**
  26502. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  26503. */
  26504. _sps: SolidParticleSystem;
  26505. /**
  26506. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  26507. */
  26508. _stillInvisible: boolean;
  26509. /**
  26510. * @hidden Last computed particle rotation matrix
  26511. */
  26512. _rotationMatrix: number[];
  26513. /**
  26514. * Parent particle Id, if any.
  26515. * Default null.
  26516. */
  26517. parentId: Nullable<number>;
  26518. /**
  26519. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  26520. * The possible values are :
  26521. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  26522. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26523. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  26524. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  26525. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26526. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  26527. * */
  26528. cullingStrategy: number;
  26529. /**
  26530. * @hidden Internal global position in the SPS.
  26531. */
  26532. _globalPosition: Vector3;
  26533. /**
  26534. * Creates a Solid Particle object.
  26535. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  26536. * @param particleIndex (integer) is the particle index in the Solid Particle System pool. It's also the particle identifier.
  26537. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  26538. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  26539. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  26540. * @param shapeId (integer) is the model shape identifier in the SPS.
  26541. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  26542. * @param sps defines the sps it is associated to
  26543. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  26544. */
  26545. constructor(particleIndex: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>);
  26546. /**
  26547. * Legacy support, changed scale to scaling
  26548. */
  26549. /**
  26550. * Legacy support, changed scale to scaling
  26551. */
  26552. scale: Vector3;
  26553. /**
  26554. * Legacy support, changed quaternion to rotationQuaternion
  26555. */
  26556. /**
  26557. * Legacy support, changed quaternion to rotationQuaternion
  26558. */
  26559. quaternion: Nullable<Quaternion>;
  26560. /**
  26561. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  26562. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  26563. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  26564. * @returns true if it intersects
  26565. */
  26566. intersectsMesh(target: Mesh | SolidParticle): boolean;
  26567. /**
  26568. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  26569. * A particle is in the frustum if its bounding box intersects the frustum
  26570. * @param frustumPlanes defines the frustum to test
  26571. * @returns true if the particle is in the frustum planes
  26572. */
  26573. isInFrustum(frustumPlanes: Plane[]): boolean;
  26574. /**
  26575. * get the rotation matrix of the particle
  26576. * @hidden
  26577. */
  26578. getRotationMatrix(m: Matrix): void;
  26579. }
  26580. /**
  26581. * Represents the shape of the model used by one particle of a solid particle system.
  26582. * SPS internal tool, don't use it manually.
  26583. */
  26584. export class ModelShape {
  26585. /**
  26586. * The shape id
  26587. * @hidden
  26588. */
  26589. shapeID: number;
  26590. /**
  26591. * flat array of model positions (internal use)
  26592. * @hidden
  26593. */
  26594. _shape: Vector3[];
  26595. /**
  26596. * flat array of model UVs (internal use)
  26597. * @hidden
  26598. */
  26599. _shapeUV: number[];
  26600. /**
  26601. * color array of the model
  26602. * @hidden
  26603. */
  26604. _shapeColors: number[];
  26605. /**
  26606. * indices array of the model
  26607. * @hidden
  26608. */
  26609. _indices: number[];
  26610. /**
  26611. * normals array of the model
  26612. * @hidden
  26613. */
  26614. _normals: number[];
  26615. /**
  26616. * length of the shape in the model indices array (internal use)
  26617. * @hidden
  26618. */
  26619. _indicesLength: number;
  26620. /**
  26621. * Custom position function (internal use)
  26622. * @hidden
  26623. */
  26624. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  26625. /**
  26626. * Custom vertex function (internal use)
  26627. * @hidden
  26628. */
  26629. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  26630. /**
  26631. * Creates a ModelShape object. This is an internal simplified reference to a mesh used as for a model to replicate particles from by the SPS.
  26632. * SPS internal tool, don't use it manually.
  26633. * @hidden
  26634. */
  26635. constructor(id: number, shape: Vector3[], indices: number[], normals: number[], colors: number[], shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>);
  26636. }
  26637. /**
  26638. * Represents a Depth Sorted Particle in the solid particle system.
  26639. */
  26640. export class DepthSortedParticle {
  26641. /**
  26642. * Index of the particle in the "indices" array
  26643. */
  26644. ind: number;
  26645. /**
  26646. * Length of the particle shape in the "indices" array
  26647. */
  26648. indicesLength: number;
  26649. /**
  26650. * Squared distance from the particle to the camera
  26651. */
  26652. sqDistance: number;
  26653. }
  26654. }
  26655. declare module "babylonjs/Collisions/meshCollisionData" {
  26656. import { Collider } from "babylonjs/Collisions/collider";
  26657. import { Vector3 } from "babylonjs/Maths/math.vector";
  26658. import { Nullable } from "babylonjs/types";
  26659. import { Observer } from "babylonjs/Misc/observable";
  26660. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26661. /**
  26662. * @hidden
  26663. */
  26664. export class _MeshCollisionData {
  26665. _checkCollisions: boolean;
  26666. _collisionMask: number;
  26667. _collisionGroup: number;
  26668. _collider: Nullable<Collider>;
  26669. _oldPositionForCollisions: Vector3;
  26670. _diffPositionForCollisions: Vector3;
  26671. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  26672. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  26673. }
  26674. }
  26675. declare module "babylonjs/Meshes/abstractMesh" {
  26676. import { Observable } from "babylonjs/Misc/observable";
  26677. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  26678. import { Camera } from "babylonjs/Cameras/camera";
  26679. import { Scene, IDisposable } from "babylonjs/scene";
  26680. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26681. import { Node } from "babylonjs/node";
  26682. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  26683. import { TransformNode } from "babylonjs/Meshes/transformNode";
  26684. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26685. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  26686. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26687. import { Material } from "babylonjs/Materials/material";
  26688. import { Light } from "babylonjs/Lights/light";
  26689. import { Skeleton } from "babylonjs/Bones/skeleton";
  26690. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  26691. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  26692. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  26693. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  26694. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  26695. import { Plane } from "babylonjs/Maths/math.plane";
  26696. import { Ray } from "babylonjs/Culling/ray";
  26697. import { Collider } from "babylonjs/Collisions/collider";
  26698. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26699. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  26700. /** @hidden */
  26701. class _FacetDataStorage {
  26702. facetPositions: Vector3[];
  26703. facetNormals: Vector3[];
  26704. facetPartitioning: number[][];
  26705. facetNb: number;
  26706. partitioningSubdivisions: number;
  26707. partitioningBBoxRatio: number;
  26708. facetDataEnabled: boolean;
  26709. facetParameters: any;
  26710. bbSize: Vector3;
  26711. subDiv: {
  26712. max: number;
  26713. X: number;
  26714. Y: number;
  26715. Z: number;
  26716. };
  26717. facetDepthSort: boolean;
  26718. facetDepthSortEnabled: boolean;
  26719. depthSortedIndices: IndicesArray;
  26720. depthSortedFacets: {
  26721. ind: number;
  26722. sqDistance: number;
  26723. }[];
  26724. facetDepthSortFunction: (f1: {
  26725. ind: number;
  26726. sqDistance: number;
  26727. }, f2: {
  26728. ind: number;
  26729. sqDistance: number;
  26730. }) => number;
  26731. facetDepthSortFrom: Vector3;
  26732. facetDepthSortOrigin: Vector3;
  26733. invertedMatrix: Matrix;
  26734. }
  26735. /**
  26736. * @hidden
  26737. **/
  26738. class _InternalAbstractMeshDataInfo {
  26739. _hasVertexAlpha: boolean;
  26740. _useVertexColors: boolean;
  26741. _numBoneInfluencers: number;
  26742. _applyFog: boolean;
  26743. _receiveShadows: boolean;
  26744. _facetData: _FacetDataStorage;
  26745. _visibility: number;
  26746. _skeleton: Nullable<Skeleton>;
  26747. _layerMask: number;
  26748. _computeBonesUsingShaders: boolean;
  26749. _isActive: boolean;
  26750. _onlyForInstances: boolean;
  26751. _isActiveIntermediate: boolean;
  26752. _onlyForInstancesIntermediate: boolean;
  26753. _actAsRegularMesh: boolean;
  26754. }
  26755. /**
  26756. * Class used to store all common mesh properties
  26757. */
  26758. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  26759. /** No occlusion */
  26760. static OCCLUSION_TYPE_NONE: number;
  26761. /** Occlusion set to optimisitic */
  26762. static OCCLUSION_TYPE_OPTIMISTIC: number;
  26763. /** Occlusion set to strict */
  26764. static OCCLUSION_TYPE_STRICT: number;
  26765. /** Use an accurante occlusion algorithm */
  26766. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  26767. /** Use a conservative occlusion algorithm */
  26768. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  26769. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  26770. * Test order :
  26771. * Is the bounding sphere outside the frustum ?
  26772. * If not, are the bounding box vertices outside the frustum ?
  26773. * It not, then the cullable object is in the frustum.
  26774. */
  26775. static readonly CULLINGSTRATEGY_STANDARD: number;
  26776. /** Culling strategy : Bounding Sphere Only.
  26777. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  26778. * It's also less accurate than the standard because some not visible objects can still be selected.
  26779. * Test : is the bounding sphere outside the frustum ?
  26780. * If not, then the cullable object is in the frustum.
  26781. */
  26782. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  26783. /** Culling strategy : Optimistic Inclusion.
  26784. * This in an inclusion test first, then the standard exclusion test.
  26785. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  26786. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  26787. * Anyway, it's as accurate as the standard strategy.
  26788. * Test :
  26789. * Is the cullable object bounding sphere center in the frustum ?
  26790. * If not, apply the default culling strategy.
  26791. */
  26792. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  26793. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  26794. * This in an inclusion test first, then the bounding sphere only exclusion test.
  26795. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  26796. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  26797. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  26798. * Test :
  26799. * Is the cullable object bounding sphere center in the frustum ?
  26800. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  26801. */
  26802. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  26803. /**
  26804. * No billboard
  26805. */
  26806. static readonly BILLBOARDMODE_NONE: number;
  26807. /** Billboard on X axis */
  26808. static readonly BILLBOARDMODE_X: number;
  26809. /** Billboard on Y axis */
  26810. static readonly BILLBOARDMODE_Y: number;
  26811. /** Billboard on Z axis */
  26812. static readonly BILLBOARDMODE_Z: number;
  26813. /** Billboard on all axes */
  26814. static readonly BILLBOARDMODE_ALL: number;
  26815. /** Billboard on using position instead of orientation */
  26816. static readonly BILLBOARDMODE_USE_POSITION: number;
  26817. /** @hidden */
  26818. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  26819. /**
  26820. * The culling strategy to use to check whether the mesh must be rendered or not.
  26821. * This value can be changed at any time and will be used on the next render mesh selection.
  26822. * The possible values are :
  26823. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  26824. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26825. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  26826. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  26827. * Please read each static variable documentation to get details about the culling process.
  26828. * */
  26829. cullingStrategy: number;
  26830. /**
  26831. * Gets the number of facets in the mesh
  26832. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  26833. */
  26834. readonly facetNb: number;
  26835. /**
  26836. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  26837. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  26838. */
  26839. partitioningSubdivisions: number;
  26840. /**
  26841. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  26842. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  26843. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  26844. */
  26845. partitioningBBoxRatio: number;
  26846. /**
  26847. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  26848. * Works only for updatable meshes.
  26849. * Doesn't work with multi-materials
  26850. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  26851. */
  26852. mustDepthSortFacets: boolean;
  26853. /**
  26854. * The location (Vector3) where the facet depth sort must be computed from.
  26855. * By default, the active camera position.
  26856. * Used only when facet depth sort is enabled
  26857. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  26858. */
  26859. facetDepthSortFrom: Vector3;
  26860. /**
  26861. * gets a boolean indicating if facetData is enabled
  26862. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  26863. */
  26864. readonly isFacetDataEnabled: boolean;
  26865. /** @hidden */
  26866. _updateNonUniformScalingState(value: boolean): boolean;
  26867. /**
  26868. * An event triggered when this mesh collides with another one
  26869. */
  26870. onCollideObservable: Observable<AbstractMesh>;
  26871. /** Set a function to call when this mesh collides with another one */
  26872. onCollide: () => void;
  26873. /**
  26874. * An event triggered when the collision's position changes
  26875. */
  26876. onCollisionPositionChangeObservable: Observable<Vector3>;
  26877. /** Set a function to call when the collision's position changes */
  26878. onCollisionPositionChange: () => void;
  26879. /**
  26880. * An event triggered when material is changed
  26881. */
  26882. onMaterialChangedObservable: Observable<AbstractMesh>;
  26883. /**
  26884. * Gets or sets the orientation for POV movement & rotation
  26885. */
  26886. definedFacingForward: boolean;
  26887. /** @hidden */
  26888. _occlusionQuery: Nullable<WebGLQuery>;
  26889. /** @hidden */
  26890. _renderingGroup: Nullable<RenderingGroup>;
  26891. /**
  26892. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  26893. */
  26894. /**
  26895. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  26896. */
  26897. visibility: number;
  26898. /** Gets or sets the alpha index used to sort transparent meshes
  26899. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  26900. */
  26901. alphaIndex: number;
  26902. /**
  26903. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  26904. */
  26905. isVisible: boolean;
  26906. /**
  26907. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  26908. */
  26909. isPickable: boolean;
  26910. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  26911. showSubMeshesBoundingBox: boolean;
  26912. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  26913. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  26914. */
  26915. isBlocker: boolean;
  26916. /**
  26917. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  26918. */
  26919. enablePointerMoveEvents: boolean;
  26920. /**
  26921. * Specifies the rendering group id for this mesh (0 by default)
  26922. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  26923. */
  26924. renderingGroupId: number;
  26925. private _material;
  26926. /** Gets or sets current material */
  26927. material: Nullable<Material>;
  26928. /**
  26929. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  26930. * @see http://doc.babylonjs.com/babylon101/shadows
  26931. */
  26932. receiveShadows: boolean;
  26933. /** Defines color to use when rendering outline */
  26934. outlineColor: Color3;
  26935. /** Define width to use when rendering outline */
  26936. outlineWidth: number;
  26937. /** Defines color to use when rendering overlay */
  26938. overlayColor: Color3;
  26939. /** Defines alpha to use when rendering overlay */
  26940. overlayAlpha: number;
  26941. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  26942. hasVertexAlpha: boolean;
  26943. /** Gets or sets a boolean indicating that this mesh needs to use vertex color data to render (if this kind of vertex data is available in the geometry) */
  26944. useVertexColors: boolean;
  26945. /**
  26946. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  26947. */
  26948. computeBonesUsingShaders: boolean;
  26949. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  26950. numBoneInfluencers: number;
  26951. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  26952. applyFog: boolean;
  26953. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  26954. useOctreeForRenderingSelection: boolean;
  26955. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  26956. useOctreeForPicking: boolean;
  26957. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  26958. useOctreeForCollisions: boolean;
  26959. /**
  26960. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  26961. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  26962. */
  26963. layerMask: number;
  26964. /**
  26965. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  26966. */
  26967. alwaysSelectAsActiveMesh: boolean;
  26968. /**
  26969. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  26970. */
  26971. doNotSyncBoundingInfo: boolean;
  26972. /**
  26973. * Gets or sets the current action manager
  26974. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  26975. */
  26976. actionManager: Nullable<AbstractActionManager>;
  26977. private _meshCollisionData;
  26978. /**
  26979. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  26980. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  26981. */
  26982. ellipsoid: Vector3;
  26983. /**
  26984. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  26985. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  26986. */
  26987. ellipsoidOffset: Vector3;
  26988. /**
  26989. * Gets or sets a collision mask used to mask collisions (default is -1).
  26990. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  26991. */
  26992. collisionMask: number;
  26993. /**
  26994. * Gets or sets the current collision group mask (-1 by default).
  26995. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  26996. */
  26997. collisionGroup: number;
  26998. /**
  26999. * Defines edge width used when edgesRenderer is enabled
  27000. * @see https://www.babylonjs-playground.com/#10OJSG#13
  27001. */
  27002. edgesWidth: number;
  27003. /**
  27004. * Defines edge color used when edgesRenderer is enabled
  27005. * @see https://www.babylonjs-playground.com/#10OJSG#13
  27006. */
  27007. edgesColor: Color4;
  27008. /** @hidden */
  27009. _edgesRenderer: Nullable<IEdgesRenderer>;
  27010. /** @hidden */
  27011. _masterMesh: Nullable<AbstractMesh>;
  27012. /** @hidden */
  27013. _boundingInfo: Nullable<BoundingInfo>;
  27014. /** @hidden */
  27015. _renderId: number;
  27016. /**
  27017. * Gets or sets the list of subMeshes
  27018. * @see http://doc.babylonjs.com/how_to/multi_materials
  27019. */
  27020. subMeshes: SubMesh[];
  27021. /** @hidden */
  27022. _intersectionsInProgress: AbstractMesh[];
  27023. /** @hidden */
  27024. _unIndexed: boolean;
  27025. /** @hidden */
  27026. _lightSources: Light[];
  27027. /** Gets the list of lights affecting that mesh */
  27028. readonly lightSources: Light[];
  27029. /** @hidden */
  27030. readonly _positions: Nullable<Vector3[]>;
  27031. /** @hidden */
  27032. _waitingData: {
  27033. lods: Nullable<any>;
  27034. actions: Nullable<any>;
  27035. freezeWorldMatrix: Nullable<boolean>;
  27036. };
  27037. /** @hidden */
  27038. _bonesTransformMatrices: Nullable<Float32Array>;
  27039. /** @hidden */
  27040. _transformMatrixTexture: Nullable<RawTexture>;
  27041. /**
  27042. * Gets or sets a skeleton to apply skining transformations
  27043. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  27044. */
  27045. skeleton: Nullable<Skeleton>;
  27046. /**
  27047. * An event triggered when the mesh is rebuilt.
  27048. */
  27049. onRebuildObservable: Observable<AbstractMesh>;
  27050. /**
  27051. * Creates a new AbstractMesh
  27052. * @param name defines the name of the mesh
  27053. * @param scene defines the hosting scene
  27054. */
  27055. constructor(name: string, scene?: Nullable<Scene>);
  27056. /**
  27057. * Returns the string "AbstractMesh"
  27058. * @returns "AbstractMesh"
  27059. */
  27060. getClassName(): string;
  27061. /**
  27062. * Gets a string representation of the current mesh
  27063. * @param fullDetails defines a boolean indicating if full details must be included
  27064. * @returns a string representation of the current mesh
  27065. */
  27066. toString(fullDetails?: boolean): string;
  27067. /**
  27068. * @hidden
  27069. */
  27070. protected _getEffectiveParent(): Nullable<Node>;
  27071. /** @hidden */
  27072. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  27073. /** @hidden */
  27074. _rebuild(): void;
  27075. /** @hidden */
  27076. _resyncLightSources(): void;
  27077. /** @hidden */
  27078. _resyncLighSource(light: Light): void;
  27079. /** @hidden */
  27080. _unBindEffect(): void;
  27081. /** @hidden */
  27082. _removeLightSource(light: Light, dispose: boolean): void;
  27083. private _markSubMeshesAsDirty;
  27084. /** @hidden */
  27085. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  27086. /** @hidden */
  27087. _markSubMeshesAsAttributesDirty(): void;
  27088. /** @hidden */
  27089. _markSubMeshesAsMiscDirty(): void;
  27090. /**
  27091. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  27092. */
  27093. scaling: Vector3;
  27094. /**
  27095. * Returns true if the mesh is blocked. Implemented by child classes
  27096. */
  27097. readonly isBlocked: boolean;
  27098. /**
  27099. * Returns the mesh itself by default. Implemented by child classes
  27100. * @param camera defines the camera to use to pick the right LOD level
  27101. * @returns the currentAbstractMesh
  27102. */
  27103. getLOD(camera: Camera): Nullable<AbstractMesh>;
  27104. /**
  27105. * Returns 0 by default. Implemented by child classes
  27106. * @returns an integer
  27107. */
  27108. getTotalVertices(): number;
  27109. /**
  27110. * Returns a positive integer : the total number of indices in this mesh geometry.
  27111. * @returns the numner of indices or zero if the mesh has no geometry.
  27112. */
  27113. getTotalIndices(): number;
  27114. /**
  27115. * Returns null by default. Implemented by child classes
  27116. * @returns null
  27117. */
  27118. getIndices(): Nullable<IndicesArray>;
  27119. /**
  27120. * Returns the array of the requested vertex data kind. Implemented by child classes
  27121. * @param kind defines the vertex data kind to use
  27122. * @returns null
  27123. */
  27124. getVerticesData(kind: string): Nullable<FloatArray>;
  27125. /**
  27126. * Sets the vertex data of the mesh geometry for the requested `kind`.
  27127. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  27128. * Note that a new underlying VertexBuffer object is created each call.
  27129. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  27130. * @param kind defines vertex data kind:
  27131. * * VertexBuffer.PositionKind
  27132. * * VertexBuffer.UVKind
  27133. * * VertexBuffer.UV2Kind
  27134. * * VertexBuffer.UV3Kind
  27135. * * VertexBuffer.UV4Kind
  27136. * * VertexBuffer.UV5Kind
  27137. * * VertexBuffer.UV6Kind
  27138. * * VertexBuffer.ColorKind
  27139. * * VertexBuffer.MatricesIndicesKind
  27140. * * VertexBuffer.MatricesIndicesExtraKind
  27141. * * VertexBuffer.MatricesWeightsKind
  27142. * * VertexBuffer.MatricesWeightsExtraKind
  27143. * @param data defines the data source
  27144. * @param updatable defines if the data must be flagged as updatable (or static)
  27145. * @param stride defines the vertex stride (size of an entire vertex). Can be null and in this case will be deduced from vertex data kind
  27146. * @returns the current mesh
  27147. */
  27148. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  27149. /**
  27150. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  27151. * If the mesh has no geometry, it is simply returned as it is.
  27152. * @param kind defines vertex data kind:
  27153. * * VertexBuffer.PositionKind
  27154. * * VertexBuffer.UVKind
  27155. * * VertexBuffer.UV2Kind
  27156. * * VertexBuffer.UV3Kind
  27157. * * VertexBuffer.UV4Kind
  27158. * * VertexBuffer.UV5Kind
  27159. * * VertexBuffer.UV6Kind
  27160. * * VertexBuffer.ColorKind
  27161. * * VertexBuffer.MatricesIndicesKind
  27162. * * VertexBuffer.MatricesIndicesExtraKind
  27163. * * VertexBuffer.MatricesWeightsKind
  27164. * * VertexBuffer.MatricesWeightsExtraKind
  27165. * @param data defines the data source
  27166. * @param updateExtends If `kind` is `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed
  27167. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  27168. * @returns the current mesh
  27169. */
  27170. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  27171. /**
  27172. * Sets the mesh indices,
  27173. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  27174. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  27175. * @param totalVertices Defines the total number of vertices
  27176. * @returns the current mesh
  27177. */
  27178. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  27179. /**
  27180. * Gets a boolean indicating if specific vertex data is present
  27181. * @param kind defines the vertex data kind to use
  27182. * @returns true is data kind is present
  27183. */
  27184. isVerticesDataPresent(kind: string): boolean;
  27185. /**
  27186. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  27187. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  27188. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  27189. * @returns a BoundingInfo
  27190. */
  27191. getBoundingInfo(): BoundingInfo;
  27192. /**
  27193. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  27194. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  27195. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  27196. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  27197. * @returns the current mesh
  27198. */
  27199. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  27200. /**
  27201. * Overwrite the current bounding info
  27202. * @param boundingInfo defines the new bounding info
  27203. * @returns the current mesh
  27204. */
  27205. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  27206. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  27207. readonly useBones: boolean;
  27208. /** @hidden */
  27209. _preActivate(): void;
  27210. /** @hidden */
  27211. _preActivateForIntermediateRendering(renderId: number): void;
  27212. /** @hidden */
  27213. _activate(renderId: number, intermediateRendering: boolean): boolean;
  27214. /** @hidden */
  27215. _postActivate(): void;
  27216. /** @hidden */
  27217. _freeze(): void;
  27218. /** @hidden */
  27219. _unFreeze(): void;
  27220. /**
  27221. * Gets the current world matrix
  27222. * @returns a Matrix
  27223. */
  27224. getWorldMatrix(): Matrix;
  27225. /** @hidden */
  27226. _getWorldMatrixDeterminant(): number;
  27227. /**
  27228. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  27229. */
  27230. readonly isAnInstance: boolean;
  27231. /**
  27232. * Gets a boolean indicating if this mesh has instances
  27233. */
  27234. readonly hasInstances: boolean;
  27235. /**
  27236. * Perform relative position change from the point of view of behind the front of the mesh.
  27237. * This is performed taking into account the meshes current rotation, so you do not have to care.
  27238. * Supports definition of mesh facing forward or backward
  27239. * @param amountRight defines the distance on the right axis
  27240. * @param amountUp defines the distance on the up axis
  27241. * @param amountForward defines the distance on the forward axis
  27242. * @returns the current mesh
  27243. */
  27244. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  27245. /**
  27246. * Calculate relative position change from the point of view of behind the front of the mesh.
  27247. * This is performed taking into account the meshes current rotation, so you do not have to care.
  27248. * Supports definition of mesh facing forward or backward
  27249. * @param amountRight defines the distance on the right axis
  27250. * @param amountUp defines the distance on the up axis
  27251. * @param amountForward defines the distance on the forward axis
  27252. * @returns the new displacement vector
  27253. */
  27254. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  27255. /**
  27256. * Perform relative rotation change from the point of view of behind the front of the mesh.
  27257. * Supports definition of mesh facing forward or backward
  27258. * @param flipBack defines the flip
  27259. * @param twirlClockwise defines the twirl
  27260. * @param tiltRight defines the tilt
  27261. * @returns the current mesh
  27262. */
  27263. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  27264. /**
  27265. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  27266. * Supports definition of mesh facing forward or backward.
  27267. * @param flipBack defines the flip
  27268. * @param twirlClockwise defines the twirl
  27269. * @param tiltRight defines the tilt
  27270. * @returns the new rotation vector
  27271. */
  27272. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  27273. /**
  27274. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  27275. * This means the mesh underlying bounding box and sphere are recomputed.
  27276. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  27277. * @returns the current mesh
  27278. */
  27279. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  27280. /** @hidden */
  27281. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  27282. /** @hidden */
  27283. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  27284. /** @hidden */
  27285. _updateBoundingInfo(): AbstractMesh;
  27286. /** @hidden */
  27287. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  27288. /** @hidden */
  27289. protected _afterComputeWorldMatrix(): void;
  27290. /** @hidden */
  27291. readonly _effectiveMesh: AbstractMesh;
  27292. /**
  27293. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  27294. * A mesh is in the frustum if its bounding box intersects the frustum
  27295. * @param frustumPlanes defines the frustum to test
  27296. * @returns true if the mesh is in the frustum planes
  27297. */
  27298. isInFrustum(frustumPlanes: Plane[]): boolean;
  27299. /**
  27300. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  27301. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  27302. * @param frustumPlanes defines the frustum to test
  27303. * @returns true if the mesh is completely in the frustum planes
  27304. */
  27305. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  27306. /**
  27307. * True if the mesh intersects another mesh or a SolidParticle object
  27308. * @param mesh defines a target mesh or SolidParticle to test
  27309. * @param precise Unless the parameter `precise` is set to `true` the intersection is computed according to Axis Aligned Bounding Boxes (AABB), else according to OBB (Oriented BBoxes)
  27310. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  27311. * @returns true if there is an intersection
  27312. */
  27313. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  27314. /**
  27315. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  27316. * @param point defines the point to test
  27317. * @returns true if there is an intersection
  27318. */
  27319. intersectsPoint(point: Vector3): boolean;
  27320. /**
  27321. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  27322. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27323. */
  27324. checkCollisions: boolean;
  27325. /**
  27326. * Gets Collider object used to compute collisions (not physics)
  27327. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27328. */
  27329. readonly collider: Nullable<Collider>;
  27330. /**
  27331. * Move the mesh using collision engine
  27332. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27333. * @param displacement defines the requested displacement vector
  27334. * @returns the current mesh
  27335. */
  27336. moveWithCollisions(displacement: Vector3): AbstractMesh;
  27337. private _onCollisionPositionChange;
  27338. /** @hidden */
  27339. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  27340. /** @hidden */
  27341. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  27342. /** @hidden */
  27343. _checkCollision(collider: Collider): AbstractMesh;
  27344. /** @hidden */
  27345. _generatePointsArray(): boolean;
  27346. /**
  27347. * Checks if the passed Ray intersects with the mesh
  27348. * @param ray defines the ray to use
  27349. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  27350. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  27351. * @returns the picking info
  27352. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  27353. */
  27354. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): PickingInfo;
  27355. /**
  27356. * Clones the current mesh
  27357. * @param name defines the mesh name
  27358. * @param newParent defines the new mesh parent
  27359. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  27360. * @returns the new mesh
  27361. */
  27362. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  27363. /**
  27364. * Disposes all the submeshes of the current meshnp
  27365. * @returns the current mesh
  27366. */
  27367. releaseSubMeshes(): AbstractMesh;
  27368. /**
  27369. * Releases resources associated with this abstract mesh.
  27370. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  27371. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  27372. */
  27373. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  27374. /**
  27375. * Adds the passed mesh as a child to the current mesh
  27376. * @param mesh defines the child mesh
  27377. * @returns the current mesh
  27378. */
  27379. addChild(mesh: AbstractMesh): AbstractMesh;
  27380. /**
  27381. * Removes the passed mesh from the current mesh children list
  27382. * @param mesh defines the child mesh
  27383. * @returns the current mesh
  27384. */
  27385. removeChild(mesh: AbstractMesh): AbstractMesh;
  27386. /** @hidden */
  27387. private _initFacetData;
  27388. /**
  27389. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  27390. * This method can be called within the render loop.
  27391. * You don't need to call this method by yourself in the render loop when you update/morph a mesh with the methods CreateXXX() as they automatically manage this computation
  27392. * @returns the current mesh
  27393. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27394. */
  27395. updateFacetData(): AbstractMesh;
  27396. /**
  27397. * Returns the facetLocalNormals array.
  27398. * The normals are expressed in the mesh local spac
  27399. * @returns an array of Vector3
  27400. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27401. */
  27402. getFacetLocalNormals(): Vector3[];
  27403. /**
  27404. * Returns the facetLocalPositions array.
  27405. * The facet positions are expressed in the mesh local space
  27406. * @returns an array of Vector3
  27407. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27408. */
  27409. getFacetLocalPositions(): Vector3[];
  27410. /**
  27411. * Returns the facetLocalPartioning array
  27412. * @returns an array of array of numbers
  27413. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27414. */
  27415. getFacetLocalPartitioning(): number[][];
  27416. /**
  27417. * Returns the i-th facet position in the world system.
  27418. * This method allocates a new Vector3 per call
  27419. * @param i defines the facet index
  27420. * @returns a new Vector3
  27421. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27422. */
  27423. getFacetPosition(i: number): Vector3;
  27424. /**
  27425. * Sets the reference Vector3 with the i-th facet position in the world system
  27426. * @param i defines the facet index
  27427. * @param ref defines the target vector
  27428. * @returns the current mesh
  27429. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27430. */
  27431. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  27432. /**
  27433. * Returns the i-th facet normal in the world system.
  27434. * This method allocates a new Vector3 per call
  27435. * @param i defines the facet index
  27436. * @returns a new Vector3
  27437. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27438. */
  27439. getFacetNormal(i: number): Vector3;
  27440. /**
  27441. * Sets the reference Vector3 with the i-th facet normal in the world system
  27442. * @param i defines the facet index
  27443. * @param ref defines the target vector
  27444. * @returns the current mesh
  27445. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27446. */
  27447. getFacetNormalToRef(i: number, ref: Vector3): this;
  27448. /**
  27449. * Returns the facets (in an array) in the same partitioning block than the one the passed coordinates are located (expressed in the mesh local system)
  27450. * @param x defines x coordinate
  27451. * @param y defines y coordinate
  27452. * @param z defines z coordinate
  27453. * @returns the array of facet indexes
  27454. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27455. */
  27456. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  27457. /**
  27458. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  27459. * @param projected sets as the (x,y,z) world projection on the facet
  27460. * @param checkFace if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
  27461. * @param facing if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
  27462. * @param x defines x coordinate
  27463. * @param y defines y coordinate
  27464. * @param z defines z coordinate
  27465. * @returns the face index if found (or null instead)
  27466. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27467. */
  27468. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  27469. /**
  27470. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  27471. * @param projected sets as the (x,y,z) local projection on the facet
  27472. * @param checkFace if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
  27473. * @param facing if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
  27474. * @param x defines x coordinate
  27475. * @param y defines y coordinate
  27476. * @param z defines z coordinate
  27477. * @returns the face index if found (or null instead)
  27478. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27479. */
  27480. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  27481. /**
  27482. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  27483. * @returns the parameters
  27484. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27485. */
  27486. getFacetDataParameters(): any;
  27487. /**
  27488. * Disables the feature FacetData and frees the related memory
  27489. * @returns the current mesh
  27490. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27491. */
  27492. disableFacetData(): AbstractMesh;
  27493. /**
  27494. * Updates the AbstractMesh indices array
  27495. * @param indices defines the data source
  27496. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  27497. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  27498. * @returns the current mesh
  27499. */
  27500. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  27501. /**
  27502. * Creates new normals data for the mesh
  27503. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  27504. * @returns the current mesh
  27505. */
  27506. createNormals(updatable: boolean): AbstractMesh;
  27507. /**
  27508. * Align the mesh with a normal
  27509. * @param normal defines the normal to use
  27510. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  27511. * @returns the current mesh
  27512. */
  27513. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  27514. /** @hidden */
  27515. _checkOcclusionQuery(): boolean;
  27516. /**
  27517. * Disables the mesh edge rendering mode
  27518. * @returns the currentAbstractMesh
  27519. */
  27520. disableEdgesRendering(): AbstractMesh;
  27521. /**
  27522. * Enables the edge rendering mode on the mesh.
  27523. * This mode makes the mesh edges visible
  27524. * @param epsilon defines the maximal distance between two angles to detect a face
  27525. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  27526. * @returns the currentAbstractMesh
  27527. * @see https://www.babylonjs-playground.com/#19O9TU#0
  27528. */
  27529. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  27530. }
  27531. }
  27532. declare module "babylonjs/Actions/actionEvent" {
  27533. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27534. import { Nullable } from "babylonjs/types";
  27535. import { Sprite } from "babylonjs/Sprites/sprite";
  27536. import { Scene } from "babylonjs/scene";
  27537. import { Vector2 } from "babylonjs/Maths/math.vector";
  27538. /**
  27539. * Interface used to define ActionEvent
  27540. */
  27541. export interface IActionEvent {
  27542. /** The mesh or sprite that triggered the action */
  27543. source: any;
  27544. /** The X mouse cursor position at the time of the event */
  27545. pointerX: number;
  27546. /** The Y mouse cursor position at the time of the event */
  27547. pointerY: number;
  27548. /** The mesh that is currently pointed at (can be null) */
  27549. meshUnderPointer: Nullable<AbstractMesh>;
  27550. /** the original (browser) event that triggered the ActionEvent */
  27551. sourceEvent?: any;
  27552. /** additional data for the event */
  27553. additionalData?: any;
  27554. }
  27555. /**
  27556. * ActionEvent is the event being sent when an action is triggered.
  27557. */
  27558. export class ActionEvent implements IActionEvent {
  27559. /** The mesh or sprite that triggered the action */
  27560. source: any;
  27561. /** The X mouse cursor position at the time of the event */
  27562. pointerX: number;
  27563. /** The Y mouse cursor position at the time of the event */
  27564. pointerY: number;
  27565. /** The mesh that is currently pointed at (can be null) */
  27566. meshUnderPointer: Nullable<AbstractMesh>;
  27567. /** the original (browser) event that triggered the ActionEvent */
  27568. sourceEvent?: any;
  27569. /** additional data for the event */
  27570. additionalData?: any;
  27571. /**
  27572. * Creates a new ActionEvent
  27573. * @param source The mesh or sprite that triggered the action
  27574. * @param pointerX The X mouse cursor position at the time of the event
  27575. * @param pointerY The Y mouse cursor position at the time of the event
  27576. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  27577. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  27578. * @param additionalData additional data for the event
  27579. */
  27580. constructor(
  27581. /** The mesh or sprite that triggered the action */
  27582. source: any,
  27583. /** The X mouse cursor position at the time of the event */
  27584. pointerX: number,
  27585. /** The Y mouse cursor position at the time of the event */
  27586. pointerY: number,
  27587. /** The mesh that is currently pointed at (can be null) */
  27588. meshUnderPointer: Nullable<AbstractMesh>,
  27589. /** the original (browser) event that triggered the ActionEvent */
  27590. sourceEvent?: any,
  27591. /** additional data for the event */
  27592. additionalData?: any);
  27593. /**
  27594. * Helper function to auto-create an ActionEvent from a source mesh.
  27595. * @param source The source mesh that triggered the event
  27596. * @param evt The original (browser) event
  27597. * @param additionalData additional data for the event
  27598. * @returns the new ActionEvent
  27599. */
  27600. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  27601. /**
  27602. * Helper function to auto-create an ActionEvent from a source sprite
  27603. * @param source The source sprite that triggered the event
  27604. * @param scene Scene associated with the sprite
  27605. * @param evt The original (browser) event
  27606. * @param additionalData additional data for the event
  27607. * @returns the new ActionEvent
  27608. */
  27609. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  27610. /**
  27611. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  27612. * @param scene the scene where the event occurred
  27613. * @param evt The original (browser) event
  27614. * @returns the new ActionEvent
  27615. */
  27616. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  27617. /**
  27618. * Helper function to auto-create an ActionEvent from a primitive
  27619. * @param prim defines the target primitive
  27620. * @param pointerPos defines the pointer position
  27621. * @param evt The original (browser) event
  27622. * @param additionalData additional data for the event
  27623. * @returns the new ActionEvent
  27624. */
  27625. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  27626. }
  27627. }
  27628. declare module "babylonjs/Actions/abstractActionManager" {
  27629. import { IDisposable } from "babylonjs/scene";
  27630. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  27631. import { IAction } from "babylonjs/Actions/action";
  27632. import { Nullable } from "babylonjs/types";
  27633. /**
  27634. * Abstract class used to decouple action Manager from scene and meshes.
  27635. * Do not instantiate.
  27636. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  27637. */
  27638. export abstract class AbstractActionManager implements IDisposable {
  27639. /** Gets the list of active triggers */
  27640. static Triggers: {
  27641. [key: string]: number;
  27642. };
  27643. /** Gets the cursor to use when hovering items */
  27644. hoverCursor: string;
  27645. /** Gets the list of actions */
  27646. actions: IAction[];
  27647. /**
  27648. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  27649. */
  27650. isRecursive: boolean;
  27651. /**
  27652. * Releases all associated resources
  27653. */
  27654. abstract dispose(): void;
  27655. /**
  27656. * Does this action manager has pointer triggers
  27657. */
  27658. abstract readonly hasPointerTriggers: boolean;
  27659. /**
  27660. * Does this action manager has pick triggers
  27661. */
  27662. abstract readonly hasPickTriggers: boolean;
  27663. /**
  27664. * Process a specific trigger
  27665. * @param trigger defines the trigger to process
  27666. * @param evt defines the event details to be processed
  27667. */
  27668. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  27669. /**
  27670. * Does this action manager handles actions of any of the given triggers
  27671. * @param triggers defines the triggers to be tested
  27672. * @return a boolean indicating whether one (or more) of the triggers is handled
  27673. */
  27674. abstract hasSpecificTriggers(triggers: number[]): boolean;
  27675. /**
  27676. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  27677. * speed.
  27678. * @param triggerA defines the trigger to be tested
  27679. * @param triggerB defines the trigger to be tested
  27680. * @return a boolean indicating whether one (or more) of the triggers is handled
  27681. */
  27682. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  27683. /**
  27684. * Does this action manager handles actions of a given trigger
  27685. * @param trigger defines the trigger to be tested
  27686. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  27687. * @return whether the trigger is handled
  27688. */
  27689. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  27690. /**
  27691. * Serialize this manager to a JSON object
  27692. * @param name defines the property name to store this manager
  27693. * @returns a JSON representation of this manager
  27694. */
  27695. abstract serialize(name: string): any;
  27696. /**
  27697. * Registers an action to this action manager
  27698. * @param action defines the action to be registered
  27699. * @return the action amended (prepared) after registration
  27700. */
  27701. abstract registerAction(action: IAction): Nullable<IAction>;
  27702. /**
  27703. * Unregisters an action to this action manager
  27704. * @param action defines the action to be unregistered
  27705. * @return a boolean indicating whether the action has been unregistered
  27706. */
  27707. abstract unregisterAction(action: IAction): Boolean;
  27708. /**
  27709. * Does exist one action manager with at least one trigger
  27710. **/
  27711. static readonly HasTriggers: boolean;
  27712. /**
  27713. * Does exist one action manager with at least one pick trigger
  27714. **/
  27715. static readonly HasPickTriggers: boolean;
  27716. /**
  27717. * Does exist one action manager that handles actions of a given trigger
  27718. * @param trigger defines the trigger to be tested
  27719. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  27720. **/
  27721. static HasSpecificTrigger(trigger: number): boolean;
  27722. }
  27723. }
  27724. declare module "babylonjs/node" {
  27725. import { Scene } from "babylonjs/scene";
  27726. import { Nullable } from "babylonjs/types";
  27727. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  27728. import { Engine } from "babylonjs/Engines/engine";
  27729. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  27730. import { Observable } from "babylonjs/Misc/observable";
  27731. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  27732. import { IInspectable } from "babylonjs/Misc/iInspectable";
  27733. import { Animatable } from "babylonjs/Animations/animatable";
  27734. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27735. import { Animation } from "babylonjs/Animations/animation";
  27736. import { AnimationRange } from "babylonjs/Animations/animationRange";
  27737. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27738. /**
  27739. * Defines how a node can be built from a string name.
  27740. */
  27741. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  27742. /**
  27743. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  27744. */
  27745. export class Node implements IBehaviorAware<Node> {
  27746. /** @hidden */
  27747. static _AnimationRangeFactory: (name: string, from: number, to: number) => import("babylonjs/Animations/animationRange").AnimationRange;
  27748. private static _NodeConstructors;
  27749. /**
  27750. * Add a new node constructor
  27751. * @param type defines the type name of the node to construct
  27752. * @param constructorFunc defines the constructor function
  27753. */
  27754. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  27755. /**
  27756. * Returns a node constructor based on type name
  27757. * @param type defines the type name
  27758. * @param name defines the new node name
  27759. * @param scene defines the hosting scene
  27760. * @param options defines optional options to transmit to constructors
  27761. * @returns the new constructor or null
  27762. */
  27763. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  27764. /**
  27765. * Gets or sets the name of the node
  27766. */
  27767. name: string;
  27768. /**
  27769. * Gets or sets the id of the node
  27770. */
  27771. id: string;
  27772. /**
  27773. * Gets or sets the unique id of the node
  27774. */
  27775. uniqueId: number;
  27776. /**
  27777. * Gets or sets a string used to store user defined state for the node
  27778. */
  27779. state: string;
  27780. /**
  27781. * Gets or sets an object used to store user defined information for the node
  27782. */
  27783. metadata: any;
  27784. /**
  27785. * For internal use only. Please do not use.
  27786. */
  27787. reservedDataStore: any;
  27788. /**
  27789. * List of inspectable custom properties (used by the Inspector)
  27790. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  27791. */
  27792. inspectableCustomProperties: IInspectable[];
  27793. private _doNotSerialize;
  27794. /**
  27795. * Gets or sets a boolean used to define if the node must be serialized
  27796. */
  27797. doNotSerialize: boolean;
  27798. /** @hidden */
  27799. _isDisposed: boolean;
  27800. /**
  27801. * Gets a list of Animations associated with the node
  27802. */
  27803. animations: import("babylonjs/Animations/animation").Animation[];
  27804. protected _ranges: {
  27805. [name: string]: Nullable<AnimationRange>;
  27806. };
  27807. /**
  27808. * Callback raised when the node is ready to be used
  27809. */
  27810. onReady: Nullable<(node: Node) => void>;
  27811. private _isEnabled;
  27812. private _isParentEnabled;
  27813. private _isReady;
  27814. /** @hidden */
  27815. _currentRenderId: number;
  27816. private _parentUpdateId;
  27817. /** @hidden */
  27818. _childUpdateId: number;
  27819. /** @hidden */
  27820. _waitingParentId: Nullable<string>;
  27821. /** @hidden */
  27822. _scene: Scene;
  27823. /** @hidden */
  27824. _cache: any;
  27825. private _parentNode;
  27826. private _children;
  27827. /** @hidden */
  27828. _worldMatrix: Matrix;
  27829. /** @hidden */
  27830. _worldMatrixDeterminant: number;
  27831. /** @hidden */
  27832. _worldMatrixDeterminantIsDirty: boolean;
  27833. /** @hidden */
  27834. private _sceneRootNodesIndex;
  27835. /**
  27836. * Gets a boolean indicating if the node has been disposed
  27837. * @returns true if the node was disposed
  27838. */
  27839. isDisposed(): boolean;
  27840. /**
  27841. * Gets or sets the parent of the node (without keeping the current position in the scene)
  27842. * @see https://doc.babylonjs.com/how_to/parenting
  27843. */
  27844. parent: Nullable<Node>;
  27845. /** @hidden */
  27846. _addToSceneRootNodes(): void;
  27847. /** @hidden */
  27848. _removeFromSceneRootNodes(): void;
  27849. private _animationPropertiesOverride;
  27850. /**
  27851. * Gets or sets the animation properties override
  27852. */
  27853. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  27854. /**
  27855. * Gets a string idenfifying the name of the class
  27856. * @returns "Node" string
  27857. */
  27858. getClassName(): string;
  27859. /** @hidden */
  27860. readonly _isNode: boolean;
  27861. /**
  27862. * An event triggered when the mesh is disposed
  27863. */
  27864. onDisposeObservable: Observable<Node>;
  27865. private _onDisposeObserver;
  27866. /**
  27867. * Sets a callback that will be raised when the node will be disposed
  27868. */
  27869. onDispose: () => void;
  27870. /**
  27871. * Creates a new Node
  27872. * @param name the name and id to be given to this node
  27873. * @param scene the scene this node will be added to
  27874. */
  27875. constructor(name: string, scene?: Nullable<Scene>);
  27876. /**
  27877. * Gets the scene of the node
  27878. * @returns a scene
  27879. */
  27880. getScene(): Scene;
  27881. /**
  27882. * Gets the engine of the node
  27883. * @returns a Engine
  27884. */
  27885. getEngine(): Engine;
  27886. private _behaviors;
  27887. /**
  27888. * Attach a behavior to the node
  27889. * @see http://doc.babylonjs.com/features/behaviour
  27890. * @param behavior defines the behavior to attach
  27891. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  27892. * @returns the current Node
  27893. */
  27894. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  27895. /**
  27896. * Remove an attached behavior
  27897. * @see http://doc.babylonjs.com/features/behaviour
  27898. * @param behavior defines the behavior to attach
  27899. * @returns the current Node
  27900. */
  27901. removeBehavior(behavior: Behavior<Node>): Node;
  27902. /**
  27903. * Gets the list of attached behaviors
  27904. * @see http://doc.babylonjs.com/features/behaviour
  27905. */
  27906. readonly behaviors: Behavior<Node>[];
  27907. /**
  27908. * Gets an attached behavior by name
  27909. * @param name defines the name of the behavior to look for
  27910. * @see http://doc.babylonjs.com/features/behaviour
  27911. * @returns null if behavior was not found else the requested behavior
  27912. */
  27913. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  27914. /**
  27915. * Returns the latest update of the World matrix
  27916. * @returns a Matrix
  27917. */
  27918. getWorldMatrix(): Matrix;
  27919. /** @hidden */
  27920. _getWorldMatrixDeterminant(): number;
  27921. /**
  27922. * Returns directly the latest state of the mesh World matrix.
  27923. * A Matrix is returned.
  27924. */
  27925. readonly worldMatrixFromCache: Matrix;
  27926. /** @hidden */
  27927. _initCache(): void;
  27928. /** @hidden */
  27929. updateCache(force?: boolean): void;
  27930. /** @hidden */
  27931. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  27932. /** @hidden */
  27933. _updateCache(ignoreParentClass?: boolean): void;
  27934. /** @hidden */
  27935. _isSynchronized(): boolean;
  27936. /** @hidden */
  27937. _markSyncedWithParent(): void;
  27938. /** @hidden */
  27939. isSynchronizedWithParent(): boolean;
  27940. /** @hidden */
  27941. isSynchronized(): boolean;
  27942. /**
  27943. * Is this node ready to be used/rendered
  27944. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  27945. * @return true if the node is ready
  27946. */
  27947. isReady(completeCheck?: boolean): boolean;
  27948. /**
  27949. * Is this node enabled?
  27950. * If the node has a parent, all ancestors will be checked and false will be returned if any are false (not enabled), otherwise will return true
  27951. * @param checkAncestors indicates if this method should check the ancestors. The default is to check the ancestors. If set to false, the method will return the value of this node without checking ancestors
  27952. * @return whether this node (and its parent) is enabled
  27953. */
  27954. isEnabled(checkAncestors?: boolean): boolean;
  27955. /** @hidden */
  27956. protected _syncParentEnabledState(): void;
  27957. /**
  27958. * Set the enabled state of this node
  27959. * @param value defines the new enabled state
  27960. */
  27961. setEnabled(value: boolean): void;
  27962. /**
  27963. * Is this node a descendant of the given node?
  27964. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  27965. * @param ancestor defines the parent node to inspect
  27966. * @returns a boolean indicating if this node is a descendant of the given node
  27967. */
  27968. isDescendantOf(ancestor: Node): boolean;
  27969. /** @hidden */
  27970. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  27971. /**
  27972. * Will return all nodes that have this node as ascendant
  27973. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  27974. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  27975. * @return all children nodes of all types
  27976. */
  27977. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  27978. /**
  27979. * Get all child-meshes of this node
  27980. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: false)
  27981. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  27982. * @returns an array of AbstractMesh
  27983. */
  27984. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  27985. /**
  27986. * Get all direct children of this node
  27987. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  27988. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: true)
  27989. * @returns an array of Node
  27990. */
  27991. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  27992. /** @hidden */
  27993. _setReady(state: boolean): void;
  27994. /**
  27995. * Get an animation by name
  27996. * @param name defines the name of the animation to look for
  27997. * @returns null if not found else the requested animation
  27998. */
  27999. getAnimationByName(name: string): Nullable<Animation>;
  28000. /**
  28001. * Creates an animation range for this node
  28002. * @param name defines the name of the range
  28003. * @param from defines the starting key
  28004. * @param to defines the end key
  28005. */
  28006. createAnimationRange(name: string, from: number, to: number): void;
  28007. /**
  28008. * Delete a specific animation range
  28009. * @param name defines the name of the range to delete
  28010. * @param deleteFrames defines if animation frames from the range must be deleted as well
  28011. */
  28012. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  28013. /**
  28014. * Get an animation range by name
  28015. * @param name defines the name of the animation range to look for
  28016. * @returns null if not found else the requested animation range
  28017. */
  28018. getAnimationRange(name: string): Nullable<AnimationRange>;
  28019. /**
  28020. * Gets the list of all animation ranges defined on this node
  28021. * @returns an array
  28022. */
  28023. getAnimationRanges(): Nullable<AnimationRange>[];
  28024. /**
  28025. * Will start the animation sequence
  28026. * @param name defines the range frames for animation sequence
  28027. * @param loop defines if the animation should loop (false by default)
  28028. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  28029. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  28030. * @returns the object created for this animation. If range does not exist, it will return null
  28031. */
  28032. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  28033. /**
  28034. * Serialize animation ranges into a JSON compatible object
  28035. * @returns serialization object
  28036. */
  28037. serializeAnimationRanges(): any;
  28038. /**
  28039. * Computes the world matrix of the node
  28040. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  28041. * @returns the world matrix
  28042. */
  28043. computeWorldMatrix(force?: boolean): Matrix;
  28044. /**
  28045. * Releases resources associated with this node.
  28046. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  28047. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  28048. */
  28049. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  28050. /**
  28051. * Parse animation range data from a serialization object and store them into a given node
  28052. * @param node defines where to store the animation ranges
  28053. * @param parsedNode defines the serialization object to read data from
  28054. * @param scene defines the hosting scene
  28055. */
  28056. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  28057. /**
  28058. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  28059. * @param includeDescendants Include bounding info from descendants as well (true by default)
  28060. * @param predicate defines a callback function that can be customize to filter what meshes should be included in the list used to compute the bounding vectors
  28061. * @returns the new bounding vectors
  28062. */
  28063. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  28064. min: Vector3;
  28065. max: Vector3;
  28066. };
  28067. }
  28068. }
  28069. declare module "babylonjs/Animations/animation" {
  28070. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  28071. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  28072. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  28073. import { Nullable } from "babylonjs/types";
  28074. import { Scene } from "babylonjs/scene";
  28075. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  28076. import { AnimationRange } from "babylonjs/Animations/animationRange";
  28077. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  28078. import { Node } from "babylonjs/node";
  28079. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28080. import { Size } from "babylonjs/Maths/math.size";
  28081. import { Animatable } from "babylonjs/Animations/animatable";
  28082. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  28083. /**
  28084. * @hidden
  28085. */
  28086. export class _IAnimationState {
  28087. key: number;
  28088. repeatCount: number;
  28089. workValue?: any;
  28090. loopMode?: number;
  28091. offsetValue?: any;
  28092. highLimitValue?: any;
  28093. }
  28094. /**
  28095. * Class used to store any kind of animation
  28096. */
  28097. export class Animation {
  28098. /**Name of the animation */
  28099. name: string;
  28100. /**Property to animate */
  28101. targetProperty: string;
  28102. /**The frames per second of the animation */
  28103. framePerSecond: number;
  28104. /**The data type of the animation */
  28105. dataType: number;
  28106. /**The loop mode of the animation */
  28107. loopMode?: number | undefined;
  28108. /**Specifies if blending should be enabled */
  28109. enableBlending?: boolean | undefined;
  28110. /**
  28111. * Use matrix interpolation instead of using direct key value when animating matrices
  28112. */
  28113. static AllowMatricesInterpolation: boolean;
  28114. /**
  28115. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  28116. */
  28117. static AllowMatrixDecomposeForInterpolation: boolean;
  28118. /**
  28119. * Stores the key frames of the animation
  28120. */
  28121. private _keys;
  28122. /**
  28123. * Stores the easing function of the animation
  28124. */
  28125. private _easingFunction;
  28126. /**
  28127. * @hidden Internal use only
  28128. */
  28129. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  28130. /**
  28131. * The set of event that will be linked to this animation
  28132. */
  28133. private _events;
  28134. /**
  28135. * Stores an array of target property paths
  28136. */
  28137. targetPropertyPath: string[];
  28138. /**
  28139. * Stores the blending speed of the animation
  28140. */
  28141. blendingSpeed: number;
  28142. /**
  28143. * Stores the animation ranges for the animation
  28144. */
  28145. private _ranges;
  28146. /**
  28147. * @hidden Internal use
  28148. */
  28149. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  28150. /**
  28151. * Sets up an animation
  28152. * @param property The property to animate
  28153. * @param animationType The animation type to apply
  28154. * @param framePerSecond The frames per second of the animation
  28155. * @param easingFunction The easing function used in the animation
  28156. * @returns The created animation
  28157. */
  28158. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  28159. /**
  28160. * Create and start an animation on a node
  28161. * @param name defines the name of the global animation that will be run on all nodes
  28162. * @param node defines the root node where the animation will take place
  28163. * @param targetProperty defines property to animate
  28164. * @param framePerSecond defines the number of frame per second yo use
  28165. * @param totalFrame defines the number of frames in total
  28166. * @param from defines the initial value
  28167. * @param to defines the final value
  28168. * @param loopMode defines which loop mode you want to use (off by default)
  28169. * @param easingFunction defines the easing function to use (linear by default)
  28170. * @param onAnimationEnd defines the callback to call when animation end
  28171. * @returns the animatable created for this animation
  28172. */
  28173. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  28174. /**
  28175. * Create and start an animation on a node and its descendants
  28176. * @param name defines the name of the global animation that will be run on all nodes
  28177. * @param node defines the root node where the animation will take place
  28178. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used
  28179. * @param targetProperty defines property to animate
  28180. * @param framePerSecond defines the number of frame per second to use
  28181. * @param totalFrame defines the number of frames in total
  28182. * @param from defines the initial value
  28183. * @param to defines the final value
  28184. * @param loopMode defines which loop mode you want to use (off by default)
  28185. * @param easingFunction defines the easing function to use (linear by default)
  28186. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  28187. * @returns the list of animatables created for all nodes
  28188. * @example https://www.babylonjs-playground.com/#MH0VLI
  28189. */
  28190. static CreateAndStartHierarchyAnimation(name: string, node: Node, directDescendantsOnly: boolean, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable[]>;
  28191. /**
  28192. * Creates a new animation, merges it with the existing animations and starts it
  28193. * @param name Name of the animation
  28194. * @param node Node which contains the scene that begins the animations
  28195. * @param targetProperty Specifies which property to animate
  28196. * @param framePerSecond The frames per second of the animation
  28197. * @param totalFrame The total number of frames
  28198. * @param from The frame at the beginning of the animation
  28199. * @param to The frame at the end of the animation
  28200. * @param loopMode Specifies the loop mode of the animation
  28201. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  28202. * @param onAnimationEnd Callback to run once the animation is complete
  28203. * @returns Nullable animation
  28204. */
  28205. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  28206. /**
  28207. * Transition property of an host to the target Value
  28208. * @param property The property to transition
  28209. * @param targetValue The target Value of the property
  28210. * @param host The object where the property to animate belongs
  28211. * @param scene Scene used to run the animation
  28212. * @param frameRate Framerate (in frame/s) to use
  28213. * @param transition The transition type we want to use
  28214. * @param duration The duration of the animation, in milliseconds
  28215. * @param onAnimationEnd Callback trigger at the end of the animation
  28216. * @returns Nullable animation
  28217. */
  28218. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  28219. /**
  28220. * Return the array of runtime animations currently using this animation
  28221. */
  28222. readonly runtimeAnimations: RuntimeAnimation[];
  28223. /**
  28224. * Specifies if any of the runtime animations are currently running
  28225. */
  28226. readonly hasRunningRuntimeAnimations: boolean;
  28227. /**
  28228. * Initializes the animation
  28229. * @param name Name of the animation
  28230. * @param targetProperty Property to animate
  28231. * @param framePerSecond The frames per second of the animation
  28232. * @param dataType The data type of the animation
  28233. * @param loopMode The loop mode of the animation
  28234. * @param enableBlending Specifies if blending should be enabled
  28235. */
  28236. constructor(
  28237. /**Name of the animation */
  28238. name: string,
  28239. /**Property to animate */
  28240. targetProperty: string,
  28241. /**The frames per second of the animation */
  28242. framePerSecond: number,
  28243. /**The data type of the animation */
  28244. dataType: number,
  28245. /**The loop mode of the animation */
  28246. loopMode?: number | undefined,
  28247. /**Specifies if blending should be enabled */
  28248. enableBlending?: boolean | undefined);
  28249. /**
  28250. * Converts the animation to a string
  28251. * @param fullDetails support for multiple levels of logging within scene loading
  28252. * @returns String form of the animation
  28253. */
  28254. toString(fullDetails?: boolean): string;
  28255. /**
  28256. * Add an event to this animation
  28257. * @param event Event to add
  28258. */
  28259. addEvent(event: AnimationEvent): void;
  28260. /**
  28261. * Remove all events found at the given frame
  28262. * @param frame The frame to remove events from
  28263. */
  28264. removeEvents(frame: number): void;
  28265. /**
  28266. * Retrieves all the events from the animation
  28267. * @returns Events from the animation
  28268. */
  28269. getEvents(): AnimationEvent[];
  28270. /**
  28271. * Creates an animation range
  28272. * @param name Name of the animation range
  28273. * @param from Starting frame of the animation range
  28274. * @param to Ending frame of the animation
  28275. */
  28276. createRange(name: string, from: number, to: number): void;
  28277. /**
  28278. * Deletes an animation range by name
  28279. * @param name Name of the animation range to delete
  28280. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  28281. */
  28282. deleteRange(name: string, deleteFrames?: boolean): void;
  28283. /**
  28284. * Gets the animation range by name, or null if not defined
  28285. * @param name Name of the animation range
  28286. * @returns Nullable animation range
  28287. */
  28288. getRange(name: string): Nullable<AnimationRange>;
  28289. /**
  28290. * Gets the key frames from the animation
  28291. * @returns The key frames of the animation
  28292. */
  28293. getKeys(): Array<IAnimationKey>;
  28294. /**
  28295. * Gets the highest frame rate of the animation
  28296. * @returns Highest frame rate of the animation
  28297. */
  28298. getHighestFrame(): number;
  28299. /**
  28300. * Gets the easing function of the animation
  28301. * @returns Easing function of the animation
  28302. */
  28303. getEasingFunction(): IEasingFunction;
  28304. /**
  28305. * Sets the easing function of the animation
  28306. * @param easingFunction A custom mathematical formula for animation
  28307. */
  28308. setEasingFunction(easingFunction: EasingFunction): void;
  28309. /**
  28310. * Interpolates a scalar linearly
  28311. * @param startValue Start value of the animation curve
  28312. * @param endValue End value of the animation curve
  28313. * @param gradient Scalar amount to interpolate
  28314. * @returns Interpolated scalar value
  28315. */
  28316. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  28317. /**
  28318. * Interpolates a scalar cubically
  28319. * @param startValue Start value of the animation curve
  28320. * @param outTangent End tangent of the animation
  28321. * @param endValue End value of the animation curve
  28322. * @param inTangent Start tangent of the animation curve
  28323. * @param gradient Scalar amount to interpolate
  28324. * @returns Interpolated scalar value
  28325. */
  28326. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  28327. /**
  28328. * Interpolates a quaternion using a spherical linear interpolation
  28329. * @param startValue Start value of the animation curve
  28330. * @param endValue End value of the animation curve
  28331. * @param gradient Scalar amount to interpolate
  28332. * @returns Interpolated quaternion value
  28333. */
  28334. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  28335. /**
  28336. * Interpolates a quaternion cubically
  28337. * @param startValue Start value of the animation curve
  28338. * @param outTangent End tangent of the animation curve
  28339. * @param endValue End value of the animation curve
  28340. * @param inTangent Start tangent of the animation curve
  28341. * @param gradient Scalar amount to interpolate
  28342. * @returns Interpolated quaternion value
  28343. */
  28344. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  28345. /**
  28346. * Interpolates a Vector3 linearl
  28347. * @param startValue Start value of the animation curve
  28348. * @param endValue End value of the animation curve
  28349. * @param gradient Scalar amount to interpolate
  28350. * @returns Interpolated scalar value
  28351. */
  28352. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  28353. /**
  28354. * Interpolates a Vector3 cubically
  28355. * @param startValue Start value of the animation curve
  28356. * @param outTangent End tangent of the animation
  28357. * @param endValue End value of the animation curve
  28358. * @param inTangent Start tangent of the animation curve
  28359. * @param gradient Scalar amount to interpolate
  28360. * @returns InterpolatedVector3 value
  28361. */
  28362. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  28363. /**
  28364. * Interpolates a Vector2 linearly
  28365. * @param startValue Start value of the animation curve
  28366. * @param endValue End value of the animation curve
  28367. * @param gradient Scalar amount to interpolate
  28368. * @returns Interpolated Vector2 value
  28369. */
  28370. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  28371. /**
  28372. * Interpolates a Vector2 cubically
  28373. * @param startValue Start value of the animation curve
  28374. * @param outTangent End tangent of the animation
  28375. * @param endValue End value of the animation curve
  28376. * @param inTangent Start tangent of the animation curve
  28377. * @param gradient Scalar amount to interpolate
  28378. * @returns Interpolated Vector2 value
  28379. */
  28380. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  28381. /**
  28382. * Interpolates a size linearly
  28383. * @param startValue Start value of the animation curve
  28384. * @param endValue End value of the animation curve
  28385. * @param gradient Scalar amount to interpolate
  28386. * @returns Interpolated Size value
  28387. */
  28388. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  28389. /**
  28390. * Interpolates a Color3 linearly
  28391. * @param startValue Start value of the animation curve
  28392. * @param endValue End value of the animation curve
  28393. * @param gradient Scalar amount to interpolate
  28394. * @returns Interpolated Color3 value
  28395. */
  28396. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  28397. /**
  28398. * Interpolates a Color4 linearly
  28399. * @param startValue Start value of the animation curve
  28400. * @param endValue End value of the animation curve
  28401. * @param gradient Scalar amount to interpolate
  28402. * @returns Interpolated Color3 value
  28403. */
  28404. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  28405. /**
  28406. * @hidden Internal use only
  28407. */
  28408. _getKeyValue(value: any): any;
  28409. /**
  28410. * @hidden Internal use only
  28411. */
  28412. _interpolate(currentFrame: number, state: _IAnimationState): any;
  28413. /**
  28414. * Defines the function to use to interpolate matrices
  28415. * @param startValue defines the start matrix
  28416. * @param endValue defines the end matrix
  28417. * @param gradient defines the gradient between both matrices
  28418. * @param result defines an optional target matrix where to store the interpolation
  28419. * @returns the interpolated matrix
  28420. */
  28421. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  28422. /**
  28423. * Makes a copy of the animation
  28424. * @returns Cloned animation
  28425. */
  28426. clone(): Animation;
  28427. /**
  28428. * Sets the key frames of the animation
  28429. * @param values The animation key frames to set
  28430. */
  28431. setKeys(values: Array<IAnimationKey>): void;
  28432. /**
  28433. * Serializes the animation to an object
  28434. * @returns Serialized object
  28435. */
  28436. serialize(): any;
  28437. /**
  28438. * Float animation type
  28439. */
  28440. static readonly ANIMATIONTYPE_FLOAT: number;
  28441. /**
  28442. * Vector3 animation type
  28443. */
  28444. static readonly ANIMATIONTYPE_VECTOR3: number;
  28445. /**
  28446. * Quaternion animation type
  28447. */
  28448. static readonly ANIMATIONTYPE_QUATERNION: number;
  28449. /**
  28450. * Matrix animation type
  28451. */
  28452. static readonly ANIMATIONTYPE_MATRIX: number;
  28453. /**
  28454. * Color3 animation type
  28455. */
  28456. static readonly ANIMATIONTYPE_COLOR3: number;
  28457. /**
  28458. * Color3 animation type
  28459. */
  28460. static readonly ANIMATIONTYPE_COLOR4: number;
  28461. /**
  28462. * Vector2 animation type
  28463. */
  28464. static readonly ANIMATIONTYPE_VECTOR2: number;
  28465. /**
  28466. * Size animation type
  28467. */
  28468. static readonly ANIMATIONTYPE_SIZE: number;
  28469. /**
  28470. * Relative Loop Mode
  28471. */
  28472. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  28473. /**
  28474. * Cycle Loop Mode
  28475. */
  28476. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  28477. /**
  28478. * Constant Loop Mode
  28479. */
  28480. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  28481. /** @hidden */
  28482. static _UniversalLerp(left: any, right: any, amount: number): any;
  28483. /**
  28484. * Parses an animation object and creates an animation
  28485. * @param parsedAnimation Parsed animation object
  28486. * @returns Animation object
  28487. */
  28488. static Parse(parsedAnimation: any): Animation;
  28489. /**
  28490. * Appends the serialized animations from the source animations
  28491. * @param source Source containing the animations
  28492. * @param destination Target to store the animations
  28493. */
  28494. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  28495. }
  28496. }
  28497. declare module "babylonjs/Animations/animatable.interface" {
  28498. import { Nullable } from "babylonjs/types";
  28499. import { Animation } from "babylonjs/Animations/animation";
  28500. /**
  28501. * Interface containing an array of animations
  28502. */
  28503. export interface IAnimatable {
  28504. /**
  28505. * Array of animations
  28506. */
  28507. animations: Nullable<Array<Animation>>;
  28508. }
  28509. }
  28510. declare module "babylonjs/Materials/fresnelParameters" {
  28511. import { Color3 } from "babylonjs/Maths/math.color";
  28512. /**
  28513. * This represents all the required information to add a fresnel effect on a material:
  28514. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  28515. */
  28516. export class FresnelParameters {
  28517. private _isEnabled;
  28518. /**
  28519. * Define if the fresnel effect is enable or not.
  28520. */
  28521. isEnabled: boolean;
  28522. /**
  28523. * Define the color used on edges (grazing angle)
  28524. */
  28525. leftColor: Color3;
  28526. /**
  28527. * Define the color used on center
  28528. */
  28529. rightColor: Color3;
  28530. /**
  28531. * Define bias applied to computed fresnel term
  28532. */
  28533. bias: number;
  28534. /**
  28535. * Defined the power exponent applied to fresnel term
  28536. */
  28537. power: number;
  28538. /**
  28539. * Clones the current fresnel and its valuues
  28540. * @returns a clone fresnel configuration
  28541. */
  28542. clone(): FresnelParameters;
  28543. /**
  28544. * Serializes the current fresnel parameters to a JSON representation.
  28545. * @return the JSON serialization
  28546. */
  28547. serialize(): any;
  28548. /**
  28549. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  28550. * @param parsedFresnelParameters Define the JSON representation
  28551. * @returns the parsed parameters
  28552. */
  28553. static Parse(parsedFresnelParameters: any): FresnelParameters;
  28554. }
  28555. }
  28556. declare module "babylonjs/Misc/decorators" {
  28557. import { Nullable } from "babylonjs/types";
  28558. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28559. import { Scene } from "babylonjs/scene";
  28560. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  28561. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28562. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28563. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28564. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28565. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28566. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28567. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28568. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28569. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28570. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28571. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28572. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28573. /**
  28574. * Decorator used to define property that can be serialized as reference to a camera
  28575. * @param sourceName defines the name of the property to decorate
  28576. */
  28577. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28578. /**
  28579. * Class used to help serialization objects
  28580. */
  28581. export class SerializationHelper {
  28582. /** @hidden */
  28583. static _ImageProcessingConfigurationParser: (sourceProperty: any) => import("babylonjs/Materials/imageProcessingConfiguration").ImageProcessingConfiguration;
  28584. /** @hidden */
  28585. static _FresnelParametersParser: (sourceProperty: any) => import("babylonjs/Materials/fresnelParameters").FresnelParameters;
  28586. /** @hidden */
  28587. static _ColorCurvesParser: (sourceProperty: any) => import("babylonjs/Materials/colorCurves").ColorCurves;
  28588. /** @hidden */
  28589. static _TextureParser: (sourceProperty: any, scene: import("babylonjs/scene").Scene, rootUrl: string) => Nullable<import("babylonjs/Materials/Textures/baseTexture").BaseTexture>;
  28590. /**
  28591. * Appends the serialized animations from the source animations
  28592. * @param source Source containing the animations
  28593. * @param destination Target to store the animations
  28594. */
  28595. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  28596. /**
  28597. * Static function used to serialized a specific entity
  28598. * @param entity defines the entity to serialize
  28599. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  28600. * @returns a JSON compatible object representing the serialization of the entity
  28601. */
  28602. static Serialize<T>(entity: T, serializationObject?: any): any;
  28603. /**
  28604. * Creates a new entity from a serialization data object
  28605. * @param creationFunction defines a function used to instanciated the new entity
  28606. * @param source defines the source serialization data
  28607. * @param scene defines the hosting scene
  28608. * @param rootUrl defines the root url for resources
  28609. * @returns a new entity
  28610. */
  28611. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  28612. /**
  28613. * Clones an object
  28614. * @param creationFunction defines the function used to instanciate the new object
  28615. * @param source defines the source object
  28616. * @returns the cloned object
  28617. */
  28618. static Clone<T>(creationFunction: () => T, source: T): T;
  28619. /**
  28620. * Instanciates a new object based on a source one (some data will be shared between both object)
  28621. * @param creationFunction defines the function used to instanciate the new object
  28622. * @param source defines the source object
  28623. * @returns the new object
  28624. */
  28625. static Instanciate<T>(creationFunction: () => T, source: T): T;
  28626. }
  28627. }
  28628. declare module "babylonjs/Misc/guid" {
  28629. /**
  28630. * Class used to manipulate GUIDs
  28631. */
  28632. export class GUID {
  28633. /**
  28634. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  28635. * Be aware Math.random() could cause collisions, but:
  28636. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  28637. * @returns a pseudo random id
  28638. */
  28639. static RandomId(): string;
  28640. }
  28641. }
  28642. declare module "babylonjs/Materials/Textures/baseTexture" {
  28643. import { Observable } from "babylonjs/Misc/observable";
  28644. import { Nullable } from "babylonjs/types";
  28645. import { Scene } from "babylonjs/scene";
  28646. import { Matrix } from "babylonjs/Maths/math.vector";
  28647. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  28648. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28649. import { ISize } from "babylonjs/Maths/math.size";
  28650. /**
  28651. * Base class of all the textures in babylon.
  28652. * It groups all the common properties the materials, post process, lights... might need
  28653. * in order to make a correct use of the texture.
  28654. */
  28655. export class BaseTexture implements IAnimatable {
  28656. /**
  28657. * Default anisotropic filtering level for the application.
  28658. * It is set to 4 as a good tradeoff between perf and quality.
  28659. */
  28660. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  28661. /**
  28662. * Gets or sets the unique id of the texture
  28663. */
  28664. uniqueId: number;
  28665. /**
  28666. * Define the name of the texture.
  28667. */
  28668. name: string;
  28669. /**
  28670. * Gets or sets an object used to store user defined information.
  28671. */
  28672. metadata: any;
  28673. /**
  28674. * For internal use only. Please do not use.
  28675. */
  28676. reservedDataStore: any;
  28677. private _hasAlpha;
  28678. /**
  28679. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  28680. */
  28681. hasAlpha: boolean;
  28682. /**
  28683. * Defines if the alpha value should be determined via the rgb values.
  28684. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  28685. */
  28686. getAlphaFromRGB: boolean;
  28687. /**
  28688. * Intensity or strength of the texture.
  28689. * It is commonly used by materials to fine tune the intensity of the texture
  28690. */
  28691. level: number;
  28692. /**
  28693. * Define the UV chanel to use starting from 0 and defaulting to 0.
  28694. * This is part of the texture as textures usually maps to one uv set.
  28695. */
  28696. coordinatesIndex: number;
  28697. private _coordinatesMode;
  28698. /**
  28699. * How a texture is mapped.
  28700. *
  28701. * | Value | Type | Description |
  28702. * | ----- | ----------------------------------- | ----------- |
  28703. * | 0 | EXPLICIT_MODE | |
  28704. * | 1 | SPHERICAL_MODE | |
  28705. * | 2 | PLANAR_MODE | |
  28706. * | 3 | CUBIC_MODE | |
  28707. * | 4 | PROJECTION_MODE | |
  28708. * | 5 | SKYBOX_MODE | |
  28709. * | 6 | INVCUBIC_MODE | |
  28710. * | 7 | EQUIRECTANGULAR_MODE | |
  28711. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  28712. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  28713. */
  28714. coordinatesMode: number;
  28715. /**
  28716. * | Value | Type | Description |
  28717. * | ----- | ------------------ | ----------- |
  28718. * | 0 | CLAMP_ADDRESSMODE | |
  28719. * | 1 | WRAP_ADDRESSMODE | |
  28720. * | 2 | MIRROR_ADDRESSMODE | |
  28721. */
  28722. wrapU: number;
  28723. /**
  28724. * | Value | Type | Description |
  28725. * | ----- | ------------------ | ----------- |
  28726. * | 0 | CLAMP_ADDRESSMODE | |
  28727. * | 1 | WRAP_ADDRESSMODE | |
  28728. * | 2 | MIRROR_ADDRESSMODE | |
  28729. */
  28730. wrapV: number;
  28731. /**
  28732. * | Value | Type | Description |
  28733. * | ----- | ------------------ | ----------- |
  28734. * | 0 | CLAMP_ADDRESSMODE | |
  28735. * | 1 | WRAP_ADDRESSMODE | |
  28736. * | 2 | MIRROR_ADDRESSMODE | |
  28737. */
  28738. wrapR: number;
  28739. /**
  28740. * With compliant hardware and browser (supporting anisotropic filtering)
  28741. * this defines the level of anisotropic filtering in the texture.
  28742. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  28743. */
  28744. anisotropicFilteringLevel: number;
  28745. /**
  28746. * Define if the texture is a cube texture or if false a 2d texture.
  28747. */
  28748. isCube: boolean;
  28749. /**
  28750. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  28751. */
  28752. is3D: boolean;
  28753. /**
  28754. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  28755. * HDR texture are usually stored in linear space.
  28756. * This only impacts the PBR and Background materials
  28757. */
  28758. gammaSpace: boolean;
  28759. /**
  28760. * Gets or sets whether or not the texture contains RGBD data.
  28761. */
  28762. isRGBD: boolean;
  28763. /**
  28764. * Is Z inverted in the texture (useful in a cube texture).
  28765. */
  28766. invertZ: boolean;
  28767. /**
  28768. * Are mip maps generated for this texture or not.
  28769. */
  28770. readonly noMipmap: boolean;
  28771. /**
  28772. * @hidden
  28773. */
  28774. lodLevelInAlpha: boolean;
  28775. /**
  28776. * With prefiltered texture, defined the offset used during the prefiltering steps.
  28777. */
  28778. lodGenerationOffset: number;
  28779. /**
  28780. * With prefiltered texture, defined the scale used during the prefiltering steps.
  28781. */
  28782. lodGenerationScale: number;
  28783. /**
  28784. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  28785. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  28786. * average roughness values.
  28787. */
  28788. linearSpecularLOD: boolean;
  28789. /**
  28790. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  28791. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  28792. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  28793. */
  28794. irradianceTexture: Nullable<BaseTexture>;
  28795. /**
  28796. * Define if the texture is a render target.
  28797. */
  28798. isRenderTarget: boolean;
  28799. /**
  28800. * Define the unique id of the texture in the scene.
  28801. */
  28802. readonly uid: string;
  28803. /**
  28804. * Return a string representation of the texture.
  28805. * @returns the texture as a string
  28806. */
  28807. toString(): string;
  28808. /**
  28809. * Get the class name of the texture.
  28810. * @returns "BaseTexture"
  28811. */
  28812. getClassName(): string;
  28813. /**
  28814. * Define the list of animation attached to the texture.
  28815. */
  28816. animations: import("babylonjs/Animations/animation").Animation[];
  28817. /**
  28818. * An event triggered when the texture is disposed.
  28819. */
  28820. onDisposeObservable: Observable<BaseTexture>;
  28821. private _onDisposeObserver;
  28822. /**
  28823. * Callback triggered when the texture has been disposed.
  28824. * Kept for back compatibility, you can use the onDisposeObservable instead.
  28825. */
  28826. onDispose: () => void;
  28827. /**
  28828. * Define the current state of the loading sequence when in delayed load mode.
  28829. */
  28830. delayLoadState: number;
  28831. private _scene;
  28832. /** @hidden */
  28833. _texture: Nullable<InternalTexture>;
  28834. private _uid;
  28835. /**
  28836. * Define if the texture is preventinga material to render or not.
  28837. * If not and the texture is not ready, the engine will use a default black texture instead.
  28838. */
  28839. readonly isBlocking: boolean;
  28840. /**
  28841. * Instantiates a new BaseTexture.
  28842. * Base class of all the textures in babylon.
  28843. * It groups all the common properties the materials, post process, lights... might need
  28844. * in order to make a correct use of the texture.
  28845. * @param scene Define the scene the texture blongs to
  28846. */
  28847. constructor(scene: Nullable<Scene>);
  28848. /**
  28849. * Get the scene the texture belongs to.
  28850. * @returns the scene or null if undefined
  28851. */
  28852. getScene(): Nullable<Scene>;
  28853. /**
  28854. * Get the texture transform matrix used to offset tile the texture for istance.
  28855. * @returns the transformation matrix
  28856. */
  28857. getTextureMatrix(): Matrix;
  28858. /**
  28859. * Get the texture reflection matrix used to rotate/transform the reflection.
  28860. * @returns the reflection matrix
  28861. */
  28862. getReflectionTextureMatrix(): Matrix;
  28863. /**
  28864. * Get the underlying lower level texture from Babylon.
  28865. * @returns the insternal texture
  28866. */
  28867. getInternalTexture(): Nullable<InternalTexture>;
  28868. /**
  28869. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  28870. * @returns true if ready or not blocking
  28871. */
  28872. isReadyOrNotBlocking(): boolean;
  28873. /**
  28874. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  28875. * @returns true if fully ready
  28876. */
  28877. isReady(): boolean;
  28878. private _cachedSize;
  28879. /**
  28880. * Get the size of the texture.
  28881. * @returns the texture size.
  28882. */
  28883. getSize(): ISize;
  28884. /**
  28885. * Get the base size of the texture.
  28886. * It can be different from the size if the texture has been resized for POT for instance
  28887. * @returns the base size
  28888. */
  28889. getBaseSize(): ISize;
  28890. /**
  28891. * Update the sampling mode of the texture.
  28892. * Default is Trilinear mode.
  28893. *
  28894. * | Value | Type | Description |
  28895. * | ----- | ------------------ | ----------- |
  28896. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  28897. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  28898. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  28899. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  28900. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  28901. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  28902. * | 7 | NEAREST_LINEAR | |
  28903. * | 8 | NEAREST_NEAREST | |
  28904. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  28905. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  28906. * | 11 | LINEAR_LINEAR | |
  28907. * | 12 | LINEAR_NEAREST | |
  28908. *
  28909. * > _mag_: magnification filter (close to the viewer)
  28910. * > _min_: minification filter (far from the viewer)
  28911. * > _mip_: filter used between mip map levels
  28912. *@param samplingMode Define the new sampling mode of the texture
  28913. */
  28914. updateSamplingMode(samplingMode: number): void;
  28915. /**
  28916. * Scales the texture if is `canRescale()`
  28917. * @param ratio the resize factor we want to use to rescale
  28918. */
  28919. scale(ratio: number): void;
  28920. /**
  28921. * Get if the texture can rescale.
  28922. */
  28923. readonly canRescale: boolean;
  28924. /** @hidden */
  28925. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  28926. /** @hidden */
  28927. _rebuild(): void;
  28928. /**
  28929. * Triggers the load sequence in delayed load mode.
  28930. */
  28931. delayLoad(): void;
  28932. /**
  28933. * Clones the texture.
  28934. * @returns the cloned texture
  28935. */
  28936. clone(): Nullable<BaseTexture>;
  28937. /**
  28938. * Get the texture underlying type (INT, FLOAT...)
  28939. */
  28940. readonly textureType: number;
  28941. /**
  28942. * Get the texture underlying format (RGB, RGBA...)
  28943. */
  28944. readonly textureFormat: number;
  28945. /**
  28946. * Indicates that textures need to be re-calculated for all materials
  28947. */
  28948. protected _markAllSubMeshesAsTexturesDirty(): void;
  28949. /**
  28950. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  28951. * This will returns an RGBA array buffer containing either in values (0-255) or
  28952. * float values (0-1) depending of the underlying buffer type.
  28953. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  28954. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  28955. * @param buffer defines a user defined buffer to fill with data (can be null)
  28956. * @returns The Array buffer containing the pixels data.
  28957. */
  28958. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  28959. /**
  28960. * Release and destroy the underlying lower level texture aka internalTexture.
  28961. */
  28962. releaseInternalTexture(): void;
  28963. /** @hidden */
  28964. readonly _lodTextureHigh: Nullable<BaseTexture>;
  28965. /** @hidden */
  28966. readonly _lodTextureMid: Nullable<BaseTexture>;
  28967. /** @hidden */
  28968. readonly _lodTextureLow: Nullable<BaseTexture>;
  28969. /**
  28970. * Dispose the texture and release its associated resources.
  28971. */
  28972. dispose(): void;
  28973. /**
  28974. * Serialize the texture into a JSON representation that can be parsed later on.
  28975. * @returns the JSON representation of the texture
  28976. */
  28977. serialize(): any;
  28978. /**
  28979. * Helper function to be called back once a list of texture contains only ready textures.
  28980. * @param textures Define the list of textures to wait for
  28981. * @param callback Define the callback triggered once the entire list will be ready
  28982. */
  28983. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  28984. }
  28985. }
  28986. declare module "babylonjs/Materials/effect" {
  28987. import { Observable } from "babylonjs/Misc/observable";
  28988. import { Nullable } from "babylonjs/types";
  28989. import { IDisposable } from "babylonjs/scene";
  28990. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  28991. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  28992. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  28993. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  28994. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  28995. import { Engine } from "babylonjs/Engines/engine";
  28996. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  28997. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  28998. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  28999. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  29000. /**
  29001. * Options to be used when creating an effect.
  29002. */
  29003. export interface IEffectCreationOptions {
  29004. /**
  29005. * Atrributes that will be used in the shader.
  29006. */
  29007. attributes: string[];
  29008. /**
  29009. * Uniform varible names that will be set in the shader.
  29010. */
  29011. uniformsNames: string[];
  29012. /**
  29013. * Uniform buffer varible names that will be set in the shader.
  29014. */
  29015. uniformBuffersNames: string[];
  29016. /**
  29017. * Sampler texture variable names that will be set in the shader.
  29018. */
  29019. samplers: string[];
  29020. /**
  29021. * Define statements that will be set in the shader.
  29022. */
  29023. defines: any;
  29024. /**
  29025. * Possible fallbacks for this effect to improve performance when needed.
  29026. */
  29027. fallbacks: Nullable<IEffectFallbacks>;
  29028. /**
  29029. * Callback that will be called when the shader is compiled.
  29030. */
  29031. onCompiled: Nullable<(effect: Effect) => void>;
  29032. /**
  29033. * Callback that will be called if an error occurs during shader compilation.
  29034. */
  29035. onError: Nullable<(effect: Effect, errors: string) => void>;
  29036. /**
  29037. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  29038. */
  29039. indexParameters?: any;
  29040. /**
  29041. * Max number of lights that can be used in the shader.
  29042. */
  29043. maxSimultaneousLights?: number;
  29044. /**
  29045. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  29046. */
  29047. transformFeedbackVaryings?: Nullable<string[]>;
  29048. }
  29049. /**
  29050. * Effect containing vertex and fragment shader that can be executed on an object.
  29051. */
  29052. export class Effect implements IDisposable {
  29053. /**
  29054. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  29055. */
  29056. static ShadersRepository: string;
  29057. /**
  29058. * Name of the effect.
  29059. */
  29060. name: any;
  29061. /**
  29062. * String container all the define statements that should be set on the shader.
  29063. */
  29064. defines: string;
  29065. /**
  29066. * Callback that will be called when the shader is compiled.
  29067. */
  29068. onCompiled: Nullable<(effect: Effect) => void>;
  29069. /**
  29070. * Callback that will be called if an error occurs during shader compilation.
  29071. */
  29072. onError: Nullable<(effect: Effect, errors: string) => void>;
  29073. /**
  29074. * Callback that will be called when effect is bound.
  29075. */
  29076. onBind: Nullable<(effect: Effect) => void>;
  29077. /**
  29078. * Unique ID of the effect.
  29079. */
  29080. uniqueId: number;
  29081. /**
  29082. * Observable that will be called when the shader is compiled.
  29083. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  29084. */
  29085. onCompileObservable: Observable<Effect>;
  29086. /**
  29087. * Observable that will be called if an error occurs during shader compilation.
  29088. */
  29089. onErrorObservable: Observable<Effect>;
  29090. /** @hidden */
  29091. _onBindObservable: Nullable<Observable<Effect>>;
  29092. /**
  29093. * Observable that will be called when effect is bound.
  29094. */
  29095. readonly onBindObservable: Observable<Effect>;
  29096. /** @hidden */
  29097. _bonesComputationForcedToCPU: boolean;
  29098. private static _uniqueIdSeed;
  29099. private _engine;
  29100. private _uniformBuffersNames;
  29101. private _uniformsNames;
  29102. private _samplerList;
  29103. private _samplers;
  29104. private _isReady;
  29105. private _compilationError;
  29106. private _allFallbacksProcessed;
  29107. private _attributesNames;
  29108. private _attributes;
  29109. private _uniforms;
  29110. /**
  29111. * Key for the effect.
  29112. * @hidden
  29113. */
  29114. _key: string;
  29115. private _indexParameters;
  29116. private _fallbacks;
  29117. private _vertexSourceCode;
  29118. private _fragmentSourceCode;
  29119. private _vertexSourceCodeOverride;
  29120. private _fragmentSourceCodeOverride;
  29121. private _transformFeedbackVaryings;
  29122. /**
  29123. * Compiled shader to webGL program.
  29124. * @hidden
  29125. */
  29126. _pipelineContext: Nullable<IPipelineContext>;
  29127. private _valueCache;
  29128. private static _baseCache;
  29129. /**
  29130. * Instantiates an effect.
  29131. * An effect can be used to create/manage/execute vertex and fragment shaders.
  29132. * @param baseName Name of the effect.
  29133. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  29134. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  29135. * @param samplers List of sampler variables that will be passed to the shader.
  29136. * @param engine Engine to be used to render the effect
  29137. * @param defines Define statements to be added to the shader.
  29138. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  29139. * @param onCompiled Callback that will be called when the shader is compiled.
  29140. * @param onError Callback that will be called if an error occurs during shader compilation.
  29141. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  29142. */
  29143. constructor(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: Nullable<string[]>, engine?: ThinEngine, defines?: Nullable<string>, fallbacks?: Nullable<IEffectFallbacks>, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any);
  29144. private _useFinalCode;
  29145. /**
  29146. * Unique key for this effect
  29147. */
  29148. readonly key: string;
  29149. /**
  29150. * If the effect has been compiled and prepared.
  29151. * @returns if the effect is compiled and prepared.
  29152. */
  29153. isReady(): boolean;
  29154. private _isReadyInternal;
  29155. /**
  29156. * The engine the effect was initialized with.
  29157. * @returns the engine.
  29158. */
  29159. getEngine(): Engine;
  29160. /**
  29161. * The pipeline context for this effect
  29162. * @returns the associated pipeline context
  29163. */
  29164. getPipelineContext(): Nullable<IPipelineContext>;
  29165. /**
  29166. * The set of names of attribute variables for the shader.
  29167. * @returns An array of attribute names.
  29168. */
  29169. getAttributesNames(): string[];
  29170. /**
  29171. * Returns the attribute at the given index.
  29172. * @param index The index of the attribute.
  29173. * @returns The location of the attribute.
  29174. */
  29175. getAttributeLocation(index: number): number;
  29176. /**
  29177. * Returns the attribute based on the name of the variable.
  29178. * @param name of the attribute to look up.
  29179. * @returns the attribute location.
  29180. */
  29181. getAttributeLocationByName(name: string): number;
  29182. /**
  29183. * The number of attributes.
  29184. * @returns the numnber of attributes.
  29185. */
  29186. getAttributesCount(): number;
  29187. /**
  29188. * Gets the index of a uniform variable.
  29189. * @param uniformName of the uniform to look up.
  29190. * @returns the index.
  29191. */
  29192. getUniformIndex(uniformName: string): number;
  29193. /**
  29194. * Returns the attribute based on the name of the variable.
  29195. * @param uniformName of the uniform to look up.
  29196. * @returns the location of the uniform.
  29197. */
  29198. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  29199. /**
  29200. * Returns an array of sampler variable names
  29201. * @returns The array of sampler variable neames.
  29202. */
  29203. getSamplers(): string[];
  29204. /**
  29205. * The error from the last compilation.
  29206. * @returns the error string.
  29207. */
  29208. getCompilationError(): string;
  29209. /**
  29210. * Gets a boolean indicating that all fallbacks were used during compilation
  29211. * @returns true if all fallbacks were used
  29212. */
  29213. allFallbacksProcessed(): boolean;
  29214. /**
  29215. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  29216. * @param func The callback to be used.
  29217. */
  29218. executeWhenCompiled(func: (effect: Effect) => void): void;
  29219. private _checkIsReady;
  29220. private _loadShader;
  29221. /**
  29222. * Recompiles the webGL program
  29223. * @param vertexSourceCode The source code for the vertex shader.
  29224. * @param fragmentSourceCode The source code for the fragment shader.
  29225. * @param onCompiled Callback called when completed.
  29226. * @param onError Callback called on error.
  29227. * @hidden
  29228. */
  29229. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  29230. /**
  29231. * Prepares the effect
  29232. * @hidden
  29233. */
  29234. _prepareEffect(): void;
  29235. private _processCompilationErrors;
  29236. /**
  29237. * Checks if the effect is supported. (Must be called after compilation)
  29238. */
  29239. readonly isSupported: boolean;
  29240. /**
  29241. * Binds a texture to the engine to be used as output of the shader.
  29242. * @param channel Name of the output variable.
  29243. * @param texture Texture to bind.
  29244. * @hidden
  29245. */
  29246. _bindTexture(channel: string, texture: InternalTexture): void;
  29247. /**
  29248. * Sets a texture on the engine to be used in the shader.
  29249. * @param channel Name of the sampler variable.
  29250. * @param texture Texture to set.
  29251. */
  29252. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  29253. /**
  29254. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  29255. * @param channel Name of the sampler variable.
  29256. * @param texture Texture to set.
  29257. */
  29258. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  29259. /**
  29260. * Sets an array of textures on the engine to be used in the shader.
  29261. * @param channel Name of the variable.
  29262. * @param textures Textures to set.
  29263. */
  29264. setTextureArray(channel: string, textures: BaseTexture[]): void;
  29265. /**
  29266. * Sets a texture to be the input of the specified post process. (To use the output, pass in the next post process in the pipeline)
  29267. * @param channel Name of the sampler variable.
  29268. * @param postProcess Post process to get the input texture from.
  29269. */
  29270. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  29271. /**
  29272. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  29273. * Sets the input texture of the passed in post process to be input of this effect. (To use the output of the passed in post process use setTextureFromPostProcessOutput)
  29274. * @param channel Name of the sampler variable.
  29275. * @param postProcess Post process to get the output texture from.
  29276. */
  29277. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  29278. /** @hidden */
  29279. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  29280. /** @hidden */
  29281. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  29282. /** @hidden */
  29283. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  29284. /** @hidden */
  29285. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  29286. /**
  29287. * Binds a buffer to a uniform.
  29288. * @param buffer Buffer to bind.
  29289. * @param name Name of the uniform variable to bind to.
  29290. */
  29291. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  29292. /**
  29293. * Binds block to a uniform.
  29294. * @param blockName Name of the block to bind.
  29295. * @param index Index to bind.
  29296. */
  29297. bindUniformBlock(blockName: string, index: number): void;
  29298. /**
  29299. * Sets an interger value on a uniform variable.
  29300. * @param uniformName Name of the variable.
  29301. * @param value Value to be set.
  29302. * @returns this effect.
  29303. */
  29304. setInt(uniformName: string, value: number): Effect;
  29305. /**
  29306. * Sets an int array on a uniform variable.
  29307. * @param uniformName Name of the variable.
  29308. * @param array array to be set.
  29309. * @returns this effect.
  29310. */
  29311. setIntArray(uniformName: string, array: Int32Array): Effect;
  29312. /**
  29313. * Sets an int array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  29314. * @param uniformName Name of the variable.
  29315. * @param array array to be set.
  29316. * @returns this effect.
  29317. */
  29318. setIntArray2(uniformName: string, array: Int32Array): Effect;
  29319. /**
  29320. * Sets an int array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  29321. * @param uniformName Name of the variable.
  29322. * @param array array to be set.
  29323. * @returns this effect.
  29324. */
  29325. setIntArray3(uniformName: string, array: Int32Array): Effect;
  29326. /**
  29327. * Sets an int array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  29328. * @param uniformName Name of the variable.
  29329. * @param array array to be set.
  29330. * @returns this effect.
  29331. */
  29332. setIntArray4(uniformName: string, array: Int32Array): Effect;
  29333. /**
  29334. * Sets an float array on a uniform variable.
  29335. * @param uniformName Name of the variable.
  29336. * @param array array to be set.
  29337. * @returns this effect.
  29338. */
  29339. setFloatArray(uniformName: string, array: Float32Array): Effect;
  29340. /**
  29341. * Sets an float array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  29342. * @param uniformName Name of the variable.
  29343. * @param array array to be set.
  29344. * @returns this effect.
  29345. */
  29346. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  29347. /**
  29348. * Sets an float array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  29349. * @param uniformName Name of the variable.
  29350. * @param array array to be set.
  29351. * @returns this effect.
  29352. */
  29353. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  29354. /**
  29355. * Sets an float array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  29356. * @param uniformName Name of the variable.
  29357. * @param array array to be set.
  29358. * @returns this effect.
  29359. */
  29360. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  29361. /**
  29362. * Sets an array on a uniform variable.
  29363. * @param uniformName Name of the variable.
  29364. * @param array array to be set.
  29365. * @returns this effect.
  29366. */
  29367. setArray(uniformName: string, array: number[]): Effect;
  29368. /**
  29369. * Sets an array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  29370. * @param uniformName Name of the variable.
  29371. * @param array array to be set.
  29372. * @returns this effect.
  29373. */
  29374. setArray2(uniformName: string, array: number[]): Effect;
  29375. /**
  29376. * Sets an array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  29377. * @param uniformName Name of the variable.
  29378. * @param array array to be set.
  29379. * @returns this effect.
  29380. */
  29381. setArray3(uniformName: string, array: number[]): Effect;
  29382. /**
  29383. * Sets an array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  29384. * @param uniformName Name of the variable.
  29385. * @param array array to be set.
  29386. * @returns this effect.
  29387. */
  29388. setArray4(uniformName: string, array: number[]): Effect;
  29389. /**
  29390. * Sets matrices on a uniform variable.
  29391. * @param uniformName Name of the variable.
  29392. * @param matrices matrices to be set.
  29393. * @returns this effect.
  29394. */
  29395. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  29396. /**
  29397. * Sets matrix on a uniform variable.
  29398. * @param uniformName Name of the variable.
  29399. * @param matrix matrix to be set.
  29400. * @returns this effect.
  29401. */
  29402. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  29403. /**
  29404. * Sets a 3x3 matrix on a uniform variable. (Speicified as [1,2,3,4,5,6,7,8,9] will result in [1,2,3][4,5,6][7,8,9] matrix)
  29405. * @param uniformName Name of the variable.
  29406. * @param matrix matrix to be set.
  29407. * @returns this effect.
  29408. */
  29409. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  29410. /**
  29411. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  29412. * @param uniformName Name of the variable.
  29413. * @param matrix matrix to be set.
  29414. * @returns this effect.
  29415. */
  29416. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  29417. /**
  29418. * Sets a float on a uniform variable.
  29419. * @param uniformName Name of the variable.
  29420. * @param value value to be set.
  29421. * @returns this effect.
  29422. */
  29423. setFloat(uniformName: string, value: number): Effect;
  29424. /**
  29425. * Sets a boolean on a uniform variable.
  29426. * @param uniformName Name of the variable.
  29427. * @param bool value to be set.
  29428. * @returns this effect.
  29429. */
  29430. setBool(uniformName: string, bool: boolean): Effect;
  29431. /**
  29432. * Sets a Vector2 on a uniform variable.
  29433. * @param uniformName Name of the variable.
  29434. * @param vector2 vector2 to be set.
  29435. * @returns this effect.
  29436. */
  29437. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  29438. /**
  29439. * Sets a float2 on a uniform variable.
  29440. * @param uniformName Name of the variable.
  29441. * @param x First float in float2.
  29442. * @param y Second float in float2.
  29443. * @returns this effect.
  29444. */
  29445. setFloat2(uniformName: string, x: number, y: number): Effect;
  29446. /**
  29447. * Sets a Vector3 on a uniform variable.
  29448. * @param uniformName Name of the variable.
  29449. * @param vector3 Value to be set.
  29450. * @returns this effect.
  29451. */
  29452. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  29453. /**
  29454. * Sets a float3 on a uniform variable.
  29455. * @param uniformName Name of the variable.
  29456. * @param x First float in float3.
  29457. * @param y Second float in float3.
  29458. * @param z Third float in float3.
  29459. * @returns this effect.
  29460. */
  29461. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  29462. /**
  29463. * Sets a Vector4 on a uniform variable.
  29464. * @param uniformName Name of the variable.
  29465. * @param vector4 Value to be set.
  29466. * @returns this effect.
  29467. */
  29468. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  29469. /**
  29470. * Sets a float4 on a uniform variable.
  29471. * @param uniformName Name of the variable.
  29472. * @param x First float in float4.
  29473. * @param y Second float in float4.
  29474. * @param z Third float in float4.
  29475. * @param w Fourth float in float4.
  29476. * @returns this effect.
  29477. */
  29478. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  29479. /**
  29480. * Sets a Color3 on a uniform variable.
  29481. * @param uniformName Name of the variable.
  29482. * @param color3 Value to be set.
  29483. * @returns this effect.
  29484. */
  29485. setColor3(uniformName: string, color3: IColor3Like): Effect;
  29486. /**
  29487. * Sets a Color4 on a uniform variable.
  29488. * @param uniformName Name of the variable.
  29489. * @param color3 Value to be set.
  29490. * @param alpha Alpha value to be set.
  29491. * @returns this effect.
  29492. */
  29493. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  29494. /**
  29495. * Sets a Color4 on a uniform variable
  29496. * @param uniformName defines the name of the variable
  29497. * @param color4 defines the value to be set
  29498. * @returns this effect.
  29499. */
  29500. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  29501. /** Release all associated resources */
  29502. dispose(): void;
  29503. /**
  29504. * This function will add a new shader to the shader store
  29505. * @param name the name of the shader
  29506. * @param pixelShader optional pixel shader content
  29507. * @param vertexShader optional vertex shader content
  29508. */
  29509. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  29510. /**
  29511. * Store of each shader (The can be looked up using effect.key)
  29512. */
  29513. static ShadersStore: {
  29514. [key: string]: string;
  29515. };
  29516. /**
  29517. * Store of each included file for a shader (The can be looked up using effect.key)
  29518. */
  29519. static IncludesShadersStore: {
  29520. [key: string]: string;
  29521. };
  29522. /**
  29523. * Resets the cache of effects.
  29524. */
  29525. static ResetCache(): void;
  29526. }
  29527. }
  29528. declare module "babylonjs/Engines/engineCapabilities" {
  29529. /**
  29530. * Interface used to describe the capabilities of the engine relatively to the current browser
  29531. */
  29532. export interface EngineCapabilities {
  29533. /** Maximum textures units per fragment shader */
  29534. maxTexturesImageUnits: number;
  29535. /** Maximum texture units per vertex shader */
  29536. maxVertexTextureImageUnits: number;
  29537. /** Maximum textures units in the entire pipeline */
  29538. maxCombinedTexturesImageUnits: number;
  29539. /** Maximum texture size */
  29540. maxTextureSize: number;
  29541. /** Maximum cube texture size */
  29542. maxCubemapTextureSize: number;
  29543. /** Maximum render texture size */
  29544. maxRenderTextureSize: number;
  29545. /** Maximum number of vertex attributes */
  29546. maxVertexAttribs: number;
  29547. /** Maximum number of varyings */
  29548. maxVaryingVectors: number;
  29549. /** Maximum number of uniforms per vertex shader */
  29550. maxVertexUniformVectors: number;
  29551. /** Maximum number of uniforms per fragment shader */
  29552. maxFragmentUniformVectors: number;
  29553. /** Defines if standard derivates (dx/dy) are supported */
  29554. standardDerivatives: boolean;
  29555. /** Defines if s3tc texture compression is supported */
  29556. s3tc?: WEBGL_compressed_texture_s3tc;
  29557. /** Defines if pvrtc texture compression is supported */
  29558. pvrtc: any;
  29559. /** Defines if etc1 texture compression is supported */
  29560. etc1: any;
  29561. /** Defines if etc2 texture compression is supported */
  29562. etc2: any;
  29563. /** Defines if astc texture compression is supported */
  29564. astc: any;
  29565. /** Defines if float textures are supported */
  29566. textureFloat: boolean;
  29567. /** Defines if vertex array objects are supported */
  29568. vertexArrayObject: boolean;
  29569. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  29570. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  29571. /** Gets the maximum level of anisotropy supported */
  29572. maxAnisotropy: number;
  29573. /** Defines if instancing is supported */
  29574. instancedArrays: boolean;
  29575. /** Defines if 32 bits indices are supported */
  29576. uintIndices: boolean;
  29577. /** Defines if high precision shaders are supported */
  29578. highPrecisionShaderSupported: boolean;
  29579. /** Defines if depth reading in the fragment shader is supported */
  29580. fragmentDepthSupported: boolean;
  29581. /** Defines if float texture linear filtering is supported*/
  29582. textureFloatLinearFiltering: boolean;
  29583. /** Defines if rendering to float textures is supported */
  29584. textureFloatRender: boolean;
  29585. /** Defines if half float textures are supported*/
  29586. textureHalfFloat: boolean;
  29587. /** Defines if half float texture linear filtering is supported*/
  29588. textureHalfFloatLinearFiltering: boolean;
  29589. /** Defines if rendering to half float textures is supported */
  29590. textureHalfFloatRender: boolean;
  29591. /** Defines if textureLOD shader command is supported */
  29592. textureLOD: boolean;
  29593. /** Defines if draw buffers extension is supported */
  29594. drawBuffersExtension: boolean;
  29595. /** Defines if depth textures are supported */
  29596. depthTextureExtension: boolean;
  29597. /** Defines if float color buffer are supported */
  29598. colorBufferFloat: boolean;
  29599. /** Gets disjoint timer query extension (null if not supported) */
  29600. timerQuery?: EXT_disjoint_timer_query;
  29601. /** Defines if timestamp can be used with timer query */
  29602. canUseTimestampForTimerQuery: boolean;
  29603. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  29604. multiview?: any;
  29605. /** Function used to let the system compiles shaders in background */
  29606. parallelShaderCompile?: {
  29607. COMPLETION_STATUS_KHR: number;
  29608. };
  29609. /** Max number of texture samples for MSAA */
  29610. maxMSAASamples: number;
  29611. /** Defines if the blend min max extension is supported */
  29612. blendMinMax: boolean;
  29613. }
  29614. }
  29615. declare module "babylonjs/States/depthCullingState" {
  29616. import { Nullable } from "babylonjs/types";
  29617. /**
  29618. * @hidden
  29619. **/
  29620. export class DepthCullingState {
  29621. private _isDepthTestDirty;
  29622. private _isDepthMaskDirty;
  29623. private _isDepthFuncDirty;
  29624. private _isCullFaceDirty;
  29625. private _isCullDirty;
  29626. private _isZOffsetDirty;
  29627. private _isFrontFaceDirty;
  29628. private _depthTest;
  29629. private _depthMask;
  29630. private _depthFunc;
  29631. private _cull;
  29632. private _cullFace;
  29633. private _zOffset;
  29634. private _frontFace;
  29635. /**
  29636. * Initializes the state.
  29637. */
  29638. constructor();
  29639. readonly isDirty: boolean;
  29640. zOffset: number;
  29641. cullFace: Nullable<number>;
  29642. cull: Nullable<boolean>;
  29643. depthFunc: Nullable<number>;
  29644. depthMask: boolean;
  29645. depthTest: boolean;
  29646. frontFace: Nullable<number>;
  29647. reset(): void;
  29648. apply(gl: WebGLRenderingContext): void;
  29649. }
  29650. }
  29651. declare module "babylonjs/States/stencilState" {
  29652. /**
  29653. * @hidden
  29654. **/
  29655. export class StencilState {
  29656. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  29657. static readonly ALWAYS: number;
  29658. /** Passed to stencilOperation to specify that stencil value must be kept */
  29659. static readonly KEEP: number;
  29660. /** Passed to stencilOperation to specify that stencil value must be replaced */
  29661. static readonly REPLACE: number;
  29662. private _isStencilTestDirty;
  29663. private _isStencilMaskDirty;
  29664. private _isStencilFuncDirty;
  29665. private _isStencilOpDirty;
  29666. private _stencilTest;
  29667. private _stencilMask;
  29668. private _stencilFunc;
  29669. private _stencilFuncRef;
  29670. private _stencilFuncMask;
  29671. private _stencilOpStencilFail;
  29672. private _stencilOpDepthFail;
  29673. private _stencilOpStencilDepthPass;
  29674. readonly isDirty: boolean;
  29675. stencilFunc: number;
  29676. stencilFuncRef: number;
  29677. stencilFuncMask: number;
  29678. stencilOpStencilFail: number;
  29679. stencilOpDepthFail: number;
  29680. stencilOpStencilDepthPass: number;
  29681. stencilMask: number;
  29682. stencilTest: boolean;
  29683. constructor();
  29684. reset(): void;
  29685. apply(gl: WebGLRenderingContext): void;
  29686. }
  29687. }
  29688. declare module "babylonjs/States/alphaCullingState" {
  29689. /**
  29690. * @hidden
  29691. **/
  29692. export class AlphaState {
  29693. private _isAlphaBlendDirty;
  29694. private _isBlendFunctionParametersDirty;
  29695. private _isBlendEquationParametersDirty;
  29696. private _isBlendConstantsDirty;
  29697. private _alphaBlend;
  29698. private _blendFunctionParameters;
  29699. private _blendEquationParameters;
  29700. private _blendConstants;
  29701. /**
  29702. * Initializes the state.
  29703. */
  29704. constructor();
  29705. readonly isDirty: boolean;
  29706. alphaBlend: boolean;
  29707. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  29708. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  29709. setAlphaEquationParameters(rgb: number, alpha: number): void;
  29710. reset(): void;
  29711. apply(gl: WebGLRenderingContext): void;
  29712. }
  29713. }
  29714. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  29715. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  29716. /** @hidden */
  29717. export class WebGL2ShaderProcessor implements IShaderProcessor {
  29718. attributeProcessor(attribute: string): string;
  29719. varyingProcessor(varying: string, isFragment: boolean): string;
  29720. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  29721. }
  29722. }
  29723. declare module "babylonjs/Engines/instancingAttributeInfo" {
  29724. /**
  29725. * Interface for attribute information associated with buffer instanciation
  29726. */
  29727. export interface InstancingAttributeInfo {
  29728. /**
  29729. * Index/offset of the attribute in the vertex shader
  29730. */
  29731. index: number;
  29732. /**
  29733. * size of the attribute, 1, 2, 3 or 4
  29734. */
  29735. attributeSize: number;
  29736. /**
  29737. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  29738. * default is FLOAT
  29739. */
  29740. attributeType: number;
  29741. /**
  29742. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  29743. */
  29744. normalized: boolean;
  29745. /**
  29746. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  29747. */
  29748. offset: number;
  29749. /**
  29750. * Name of the GLSL attribute, for debugging purpose only
  29751. */
  29752. attributeName: string;
  29753. }
  29754. }
  29755. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  29756. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  29757. import { Nullable } from "babylonjs/types";
  29758. module "babylonjs/Engines/thinEngine" {
  29759. interface ThinEngine {
  29760. /**
  29761. * Update a video texture
  29762. * @param texture defines the texture to update
  29763. * @param video defines the video element to use
  29764. * @param invertY defines if data must be stored with Y axis inverted
  29765. */
  29766. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  29767. }
  29768. }
  29769. }
  29770. declare module "babylonjs/Materials/Textures/videoTexture" {
  29771. import { Observable } from "babylonjs/Misc/observable";
  29772. import { Nullable } from "babylonjs/types";
  29773. import { Scene } from "babylonjs/scene";
  29774. import { Texture } from "babylonjs/Materials/Textures/texture";
  29775. import "babylonjs/Engines/Extensions/engine.videoTexture";
  29776. /**
  29777. * Settings for finer control over video usage
  29778. */
  29779. export interface VideoTextureSettings {
  29780. /**
  29781. * Applies `autoplay` to video, if specified
  29782. */
  29783. autoPlay?: boolean;
  29784. /**
  29785. * Applies `loop` to video, if specified
  29786. */
  29787. loop?: boolean;
  29788. /**
  29789. * Automatically updates internal texture from video at every frame in the render loop
  29790. */
  29791. autoUpdateTexture: boolean;
  29792. /**
  29793. * Image src displayed during the video loading or until the user interacts with the video.
  29794. */
  29795. poster?: string;
  29796. }
  29797. /**
  29798. * If you want to display a video in your scene, this is the special texture for that.
  29799. * This special texture works similar to other textures, with the exception of a few parameters.
  29800. * @see https://doc.babylonjs.com/how_to/video_texture
  29801. */
  29802. export class VideoTexture extends Texture {
  29803. /**
  29804. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  29805. */
  29806. readonly autoUpdateTexture: boolean;
  29807. /**
  29808. * The video instance used by the texture internally
  29809. */
  29810. readonly video: HTMLVideoElement;
  29811. private _onUserActionRequestedObservable;
  29812. /**
  29813. * Event triggerd when a dom action is required by the user to play the video.
  29814. * This happens due to recent changes in browser policies preventing video to auto start.
  29815. */
  29816. readonly onUserActionRequestedObservable: Observable<Texture>;
  29817. private _generateMipMaps;
  29818. private _engine;
  29819. private _stillImageCaptured;
  29820. private _displayingPosterTexture;
  29821. private _settings;
  29822. private _createInternalTextureOnEvent;
  29823. private _frameId;
  29824. /**
  29825. * Creates a video texture.
  29826. * If you want to display a video in your scene, this is the special texture for that.
  29827. * This special texture works similar to other textures, with the exception of a few parameters.
  29828. * @see https://doc.babylonjs.com/how_to/video_texture
  29829. * @param name optional name, will detect from video source, if not defined
  29830. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  29831. * @param scene is obviously the current scene.
  29832. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  29833. * @param invertY is false by default but can be used to invert video on Y axis
  29834. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  29835. * @param settings allows finer control over video usage
  29836. */
  29837. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  29838. private _getName;
  29839. private _getVideo;
  29840. private _createInternalTexture;
  29841. private reset;
  29842. /**
  29843. * @hidden Internal method to initiate `update`.
  29844. */
  29845. _rebuild(): void;
  29846. /**
  29847. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  29848. */
  29849. update(): void;
  29850. /**
  29851. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  29852. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  29853. */
  29854. updateTexture(isVisible: boolean): void;
  29855. protected _updateInternalTexture: () => void;
  29856. /**
  29857. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  29858. * @param url New url.
  29859. */
  29860. updateURL(url: string): void;
  29861. /**
  29862. * Dispose the texture and release its associated resources.
  29863. */
  29864. dispose(): void;
  29865. /**
  29866. * Creates a video texture straight from a stream.
  29867. * @param scene Define the scene the texture should be created in
  29868. * @param stream Define the stream the texture should be created from
  29869. * @returns The created video texture as a promise
  29870. */
  29871. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  29872. /**
  29873. * Creates a video texture straight from your WebCam video feed.
  29874. * @param scene Define the scene the texture should be created in
  29875. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  29876. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  29877. * @returns The created video texture as a promise
  29878. */
  29879. static CreateFromWebCamAsync(scene: Scene, constraints: {
  29880. minWidth: number;
  29881. maxWidth: number;
  29882. minHeight: number;
  29883. maxHeight: number;
  29884. deviceId: string;
  29885. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  29886. /**
  29887. * Creates a video texture straight from your WebCam video feed.
  29888. * @param scene Define the scene the texture should be created in
  29889. * @param onReady Define a callback to triggered once the texture will be ready
  29890. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  29891. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  29892. */
  29893. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  29894. minWidth: number;
  29895. maxWidth: number;
  29896. minHeight: number;
  29897. maxHeight: number;
  29898. deviceId: string;
  29899. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  29900. }
  29901. }
  29902. declare module "babylonjs/Engines/thinEngine" {
  29903. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  29904. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  29905. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  29906. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  29907. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  29908. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  29909. import { Observable } from "babylonjs/Misc/observable";
  29910. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  29911. import { StencilState } from "babylonjs/States/stencilState";
  29912. import { AlphaState } from "babylonjs/States/alphaCullingState";
  29913. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  29914. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  29915. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  29916. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  29917. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  29918. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  29919. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  29920. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  29921. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  29922. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  29923. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  29924. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  29925. /**
  29926. * Defines the interface used by objects working like Scene
  29927. * @hidden
  29928. */
  29929. interface ISceneLike {
  29930. _addPendingData(data: any): void;
  29931. _removePendingData(data: any): void;
  29932. offlineProvider: IOfflineProvider;
  29933. }
  29934. /** Interface defining initialization parameters for Engine class */
  29935. export interface EngineOptions extends WebGLContextAttributes {
  29936. /**
  29937. * Defines if the engine should no exceed a specified device ratio
  29938. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  29939. */
  29940. limitDeviceRatio?: number;
  29941. /**
  29942. * Defines if webvr should be enabled automatically
  29943. * @see http://doc.babylonjs.com/how_to/webvr_camera
  29944. */
  29945. autoEnableWebVR?: boolean;
  29946. /**
  29947. * Defines if webgl2 should be turned off even if supported
  29948. * @see http://doc.babylonjs.com/features/webgl2
  29949. */
  29950. disableWebGL2Support?: boolean;
  29951. /**
  29952. * Defines if webaudio should be initialized as well
  29953. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  29954. */
  29955. audioEngine?: boolean;
  29956. /**
  29957. * Defines if animations should run using a deterministic lock step
  29958. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  29959. */
  29960. deterministicLockstep?: boolean;
  29961. /** Defines the maximum steps to use with deterministic lock step mode */
  29962. lockstepMaxSteps?: number;
  29963. /**
  29964. * Defines that engine should ignore context lost events
  29965. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  29966. */
  29967. doNotHandleContextLost?: boolean;
  29968. /**
  29969. * Defines that engine should ignore modifying touch action attribute and style
  29970. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  29971. */
  29972. doNotHandleTouchAction?: boolean;
  29973. /**
  29974. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  29975. */
  29976. useHighPrecisionFloats?: boolean;
  29977. }
  29978. /**
  29979. * The base engine class (root of all engines)
  29980. */
  29981. export class ThinEngine {
  29982. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  29983. static ExceptionList: ({
  29984. key: string;
  29985. capture: string;
  29986. captureConstraint: number;
  29987. targets: string[];
  29988. } | {
  29989. key: string;
  29990. capture: null;
  29991. captureConstraint: null;
  29992. targets: string[];
  29993. })[];
  29994. /** @hidden */
  29995. static _TextureLoaders: IInternalTextureLoader[];
  29996. /**
  29997. * Returns the current npm package of the sdk
  29998. */
  29999. static readonly NpmPackage: string;
  30000. /**
  30001. * Returns the current version of the framework
  30002. */
  30003. static readonly Version: string;
  30004. /**
  30005. * Returns a string describing the current engine
  30006. */
  30007. readonly description: string;
  30008. /**
  30009. * Gets or sets the epsilon value used by collision engine
  30010. */
  30011. static CollisionsEpsilon: number;
  30012. /**
  30013. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  30014. */
  30015. static ShadersRepository: string;
  30016. /** @hidden */
  30017. _shaderProcessor: IShaderProcessor;
  30018. /**
  30019. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  30020. */
  30021. forcePOTTextures: boolean;
  30022. /**
  30023. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  30024. */
  30025. isFullscreen: boolean;
  30026. /**
  30027. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  30028. */
  30029. cullBackFaces: boolean;
  30030. /**
  30031. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  30032. */
  30033. renderEvenInBackground: boolean;
  30034. /**
  30035. * Gets or sets a boolean indicating that cache can be kept between frames
  30036. */
  30037. preventCacheWipeBetweenFrames: boolean;
  30038. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  30039. validateShaderPrograms: boolean;
  30040. /**
  30041. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  30042. */
  30043. disableUniformBuffers: boolean;
  30044. /** @hidden */
  30045. _uniformBuffers: UniformBuffer[];
  30046. /**
  30047. * Gets a boolean indicating that the engine supports uniform buffers
  30048. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  30049. */
  30050. readonly supportsUniformBuffers: boolean;
  30051. /** @hidden */
  30052. _gl: WebGLRenderingContext;
  30053. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  30054. protected _windowIsBackground: boolean;
  30055. protected _webGLVersion: number;
  30056. protected _creationOptions: EngineOptions;
  30057. protected _highPrecisionShadersAllowed: boolean;
  30058. /** @hidden */
  30059. readonly _shouldUseHighPrecisionShader: boolean;
  30060. /**
  30061. * Gets a boolean indicating that only power of 2 textures are supported
  30062. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  30063. */
  30064. readonly needPOTTextures: boolean;
  30065. /** @hidden */
  30066. _badOS: boolean;
  30067. /** @hidden */
  30068. _badDesktopOS: boolean;
  30069. private _hardwareScalingLevel;
  30070. /** @hidden */
  30071. _caps: EngineCapabilities;
  30072. private _isStencilEnable;
  30073. protected _colorWrite: boolean;
  30074. private _glVersion;
  30075. private _glRenderer;
  30076. private _glVendor;
  30077. /** @hidden */
  30078. _videoTextureSupported: boolean;
  30079. protected _renderingQueueLaunched: boolean;
  30080. protected _activeRenderLoops: (() => void)[];
  30081. /**
  30082. * Observable signaled when a context lost event is raised
  30083. */
  30084. onContextLostObservable: Observable<ThinEngine>;
  30085. /**
  30086. * Observable signaled when a context restored event is raised
  30087. */
  30088. onContextRestoredObservable: Observable<ThinEngine>;
  30089. private _onContextLost;
  30090. private _onContextRestored;
  30091. protected _contextWasLost: boolean;
  30092. /** @hidden */
  30093. _doNotHandleContextLost: boolean;
  30094. /**
  30095. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  30096. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  30097. */
  30098. doNotHandleContextLost: boolean;
  30099. /**
  30100. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  30101. */
  30102. disableVertexArrayObjects: boolean;
  30103. /** @hidden */
  30104. protected _depthCullingState: DepthCullingState;
  30105. /** @hidden */
  30106. protected _stencilState: StencilState;
  30107. /** @hidden */
  30108. protected _alphaState: AlphaState;
  30109. /** @hidden */
  30110. _internalTexturesCache: InternalTexture[];
  30111. /** @hidden */
  30112. protected _activeChannel: number;
  30113. private _currentTextureChannel;
  30114. /** @hidden */
  30115. protected _boundTexturesCache: {
  30116. [key: string]: Nullable<InternalTexture>;
  30117. };
  30118. /** @hidden */
  30119. protected _currentEffect: Nullable<Effect>;
  30120. /** @hidden */
  30121. protected _currentProgram: Nullable<WebGLProgram>;
  30122. private _compiledEffects;
  30123. private _vertexAttribArraysEnabled;
  30124. /** @hidden */
  30125. protected _cachedViewport: Nullable<IViewportLike>;
  30126. private _cachedVertexArrayObject;
  30127. /** @hidden */
  30128. protected _cachedVertexBuffers: any;
  30129. /** @hidden */
  30130. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  30131. /** @hidden */
  30132. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  30133. /** @hidden */
  30134. _currentRenderTarget: Nullable<InternalTexture>;
  30135. private _uintIndicesCurrentlySet;
  30136. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  30137. /** @hidden */
  30138. protected _currentFramebuffer: Nullable<WebGLFramebuffer>;
  30139. private _currentBufferPointers;
  30140. private _currentInstanceLocations;
  30141. private _currentInstanceBuffers;
  30142. private _textureUnits;
  30143. /** @hidden */
  30144. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  30145. /** @hidden */
  30146. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  30147. /** @hidden */
  30148. _bindedRenderFunction: any;
  30149. private _vaoRecordInProgress;
  30150. private _mustWipeVertexAttributes;
  30151. private _emptyTexture;
  30152. private _emptyCubeTexture;
  30153. private _emptyTexture3D;
  30154. /** @hidden */
  30155. _frameHandler: number;
  30156. private _nextFreeTextureSlots;
  30157. private _maxSimultaneousTextures;
  30158. private _activeRequests;
  30159. protected _texturesSupported: string[];
  30160. /** @hidden */
  30161. _textureFormatInUse: Nullable<string>;
  30162. protected readonly _supportsHardwareTextureRescaling: boolean;
  30163. /**
  30164. * Gets the list of texture formats supported
  30165. */
  30166. readonly texturesSupported: Array<string>;
  30167. /**
  30168. * Gets the list of texture formats in use
  30169. */
  30170. readonly textureFormatInUse: Nullable<string>;
  30171. /**
  30172. * Gets the current viewport
  30173. */
  30174. readonly currentViewport: Nullable<IViewportLike>;
  30175. /**
  30176. * Gets the default empty texture
  30177. */
  30178. readonly emptyTexture: InternalTexture;
  30179. /**
  30180. * Gets the default empty 3D texture
  30181. */
  30182. readonly emptyTexture3D: InternalTexture;
  30183. /**
  30184. * Gets the default empty cube texture
  30185. */
  30186. readonly emptyCubeTexture: InternalTexture;
  30187. /**
  30188. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  30189. */
  30190. readonly premultipliedAlpha: boolean;
  30191. /**
  30192. * Observable event triggered before each texture is initialized
  30193. */
  30194. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  30195. /**
  30196. * Creates a new engine
  30197. * @param canvasOrContext defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which alreay used the WebGL context
  30198. * @param antialias defines enable antialiasing (default: false)
  30199. * @param options defines further options to be sent to the getContext() function
  30200. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  30201. */
  30202. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  30203. private _rebuildInternalTextures;
  30204. private _rebuildEffects;
  30205. /**
  30206. * Gets a boolean indicating if all created effects are ready
  30207. * @returns true if all effects are ready
  30208. */
  30209. areAllEffectsReady(): boolean;
  30210. protected _rebuildBuffers(): void;
  30211. private _initGLContext;
  30212. /**
  30213. * Gets version of the current webGL context
  30214. */
  30215. readonly webGLVersion: number;
  30216. /**
  30217. * Gets a string idenfifying the name of the class
  30218. * @returns "Engine" string
  30219. */
  30220. getClassName(): string;
  30221. /**
  30222. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  30223. */
  30224. readonly isStencilEnable: boolean;
  30225. /** @hidden */
  30226. _prepareWorkingCanvas(): void;
  30227. /**
  30228. * Reset the texture cache to empty state
  30229. */
  30230. resetTextureCache(): void;
  30231. /**
  30232. * Gets an object containing information about the current webGL context
  30233. * @returns an object containing the vender, the renderer and the version of the current webGL context
  30234. */
  30235. getGlInfo(): {
  30236. vendor: string;
  30237. renderer: string;
  30238. version: string;
  30239. };
  30240. /**
  30241. * Defines the hardware scaling level.
  30242. * By default the hardware scaling level is computed from the window device ratio.
  30243. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  30244. * @param level defines the level to use
  30245. */
  30246. setHardwareScalingLevel(level: number): void;
  30247. /**
  30248. * Gets the current hardware scaling level.
  30249. * By default the hardware scaling level is computed from the window device ratio.
  30250. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  30251. * @returns a number indicating the current hardware scaling level
  30252. */
  30253. getHardwareScalingLevel(): number;
  30254. /**
  30255. * Gets the list of loaded textures
  30256. * @returns an array containing all loaded textures
  30257. */
  30258. getLoadedTexturesCache(): InternalTexture[];
  30259. /**
  30260. * Gets the object containing all engine capabilities
  30261. * @returns the EngineCapabilities object
  30262. */
  30263. getCaps(): EngineCapabilities;
  30264. /**
  30265. * stop executing a render loop function and remove it from the execution array
  30266. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  30267. */
  30268. stopRenderLoop(renderFunction?: () => void): void;
  30269. /** @hidden */
  30270. _renderLoop(): void;
  30271. /**
  30272. * Gets the HTML canvas attached with the current webGL context
  30273. * @returns a HTML canvas
  30274. */
  30275. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  30276. /**
  30277. * Gets host window
  30278. * @returns the host window object
  30279. */
  30280. getHostWindow(): Nullable<Window>;
  30281. /**
  30282. * Gets the current render width
  30283. * @param useScreen defines if screen size must be used (or the current render target if any)
  30284. * @returns a number defining the current render width
  30285. */
  30286. getRenderWidth(useScreen?: boolean): number;
  30287. /**
  30288. * Gets the current render height
  30289. * @param useScreen defines if screen size must be used (or the current render target if any)
  30290. * @returns a number defining the current render height
  30291. */
  30292. getRenderHeight(useScreen?: boolean): number;
  30293. /**
  30294. * Can be used to override the current requestAnimationFrame requester.
  30295. * @hidden
  30296. */
  30297. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  30298. /**
  30299. * Register and execute a render loop. The engine can have more than one render function
  30300. * @param renderFunction defines the function to continuously execute
  30301. */
  30302. runRenderLoop(renderFunction: () => void): void;
  30303. /**
  30304. * Clear the current render buffer or the current render target (if any is set up)
  30305. * @param color defines the color to use
  30306. * @param backBuffer defines if the back buffer must be cleared
  30307. * @param depth defines if the depth buffer must be cleared
  30308. * @param stencil defines if the stencil buffer must be cleared
  30309. */
  30310. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  30311. private _viewportCached;
  30312. /** @hidden */
  30313. _viewport(x: number, y: number, width: number, height: number): void;
  30314. /**
  30315. * Set the WebGL's viewport
  30316. * @param viewport defines the viewport element to be used
  30317. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  30318. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  30319. */
  30320. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  30321. /**
  30322. * Begin a new frame
  30323. */
  30324. beginFrame(): void;
  30325. /**
  30326. * Enf the current frame
  30327. */
  30328. endFrame(): void;
  30329. /**
  30330. * Resize the view according to the canvas' size
  30331. */
  30332. resize(): void;
  30333. /**
  30334. * Force a specific size of the canvas
  30335. * @param width defines the new canvas' width
  30336. * @param height defines the new canvas' height
  30337. */
  30338. setSize(width: number, height: number): void;
  30339. /**
  30340. * Binds the frame buffer to the specified texture.
  30341. * @param texture The texture to render to or null for the default canvas
  30342. * @param faceIndex The face of the texture to render to in case of cube texture
  30343. * @param requiredWidth The width of the target to render to
  30344. * @param requiredHeight The height of the target to render to
  30345. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  30346. * @param depthStencilTexture The depth stencil texture to use to render
  30347. * @param lodLevel defines le lod level to bind to the frame buffer
  30348. */
  30349. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel?: number): void;
  30350. /** @hidden */
  30351. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  30352. /**
  30353. * Unbind the current render target texture from the webGL context
  30354. * @param texture defines the render target texture to unbind
  30355. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  30356. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  30357. */
  30358. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  30359. /**
  30360. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  30361. */
  30362. flushFramebuffer(): void;
  30363. /**
  30364. * Unbind the current render target and bind the default framebuffer
  30365. */
  30366. restoreDefaultFramebuffer(): void;
  30367. /** @hidden */
  30368. protected _resetVertexBufferBinding(): void;
  30369. /**
  30370. * Creates a vertex buffer
  30371. * @param data the data for the vertex buffer
  30372. * @returns the new WebGL static buffer
  30373. */
  30374. createVertexBuffer(data: DataArray): DataBuffer;
  30375. private _createVertexBuffer;
  30376. /**
  30377. * Creates a dynamic vertex buffer
  30378. * @param data the data for the dynamic vertex buffer
  30379. * @returns the new WebGL dynamic buffer
  30380. */
  30381. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  30382. protected _resetIndexBufferBinding(): void;
  30383. /**
  30384. * Creates a new index buffer
  30385. * @param indices defines the content of the index buffer
  30386. * @param updatable defines if the index buffer must be updatable
  30387. * @returns a new webGL buffer
  30388. */
  30389. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  30390. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  30391. /**
  30392. * Bind a webGL buffer to the webGL context
  30393. * @param buffer defines the buffer to bind
  30394. */
  30395. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  30396. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  30397. private bindBuffer;
  30398. /**
  30399. * update the bound buffer with the given data
  30400. * @param data defines the data to update
  30401. */
  30402. updateArrayBuffer(data: Float32Array): void;
  30403. private _vertexAttribPointer;
  30404. private _bindIndexBufferWithCache;
  30405. private _bindVertexBuffersAttributes;
  30406. /**
  30407. * Records a vertex array object
  30408. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  30409. * @param vertexBuffers defines the list of vertex buffers to store
  30410. * @param indexBuffer defines the index buffer to store
  30411. * @param effect defines the effect to store
  30412. * @returns the new vertex array object
  30413. */
  30414. recordVertexArrayObject(vertexBuffers: {
  30415. [key: string]: VertexBuffer;
  30416. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  30417. /**
  30418. * Bind a specific vertex array object
  30419. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  30420. * @param vertexArrayObject defines the vertex array object to bind
  30421. * @param indexBuffer defines the index buffer to bind
  30422. */
  30423. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  30424. /**
  30425. * Bind webGl buffers directly to the webGL context
  30426. * @param vertexBuffer defines the vertex buffer to bind
  30427. * @param indexBuffer defines the index buffer to bind
  30428. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  30429. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  30430. * @param effect defines the effect associated with the vertex buffer
  30431. */
  30432. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  30433. private _unbindVertexArrayObject;
  30434. /**
  30435. * Bind a list of vertex buffers to the webGL context
  30436. * @param vertexBuffers defines the list of vertex buffers to bind
  30437. * @param indexBuffer defines the index buffer to bind
  30438. * @param effect defines the effect associated with the vertex buffers
  30439. */
  30440. bindBuffers(vertexBuffers: {
  30441. [key: string]: Nullable<VertexBuffer>;
  30442. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  30443. /**
  30444. * Unbind all instance attributes
  30445. */
  30446. unbindInstanceAttributes(): void;
  30447. /**
  30448. * Release and free the memory of a vertex array object
  30449. * @param vao defines the vertex array object to delete
  30450. */
  30451. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  30452. /** @hidden */
  30453. _releaseBuffer(buffer: DataBuffer): boolean;
  30454. protected _deleteBuffer(buffer: DataBuffer): void;
  30455. /**
  30456. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  30457. * @param instancesBuffer defines the webGL buffer to update and bind
  30458. * @param data defines the data to store in the buffer
  30459. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  30460. */
  30461. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  30462. /**
  30463. * Apply all cached states (depth, culling, stencil and alpha)
  30464. */
  30465. applyStates(): void;
  30466. /**
  30467. * Send a draw order
  30468. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  30469. * @param indexStart defines the starting index
  30470. * @param indexCount defines the number of index to draw
  30471. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30472. */
  30473. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  30474. /**
  30475. * Draw a list of points
  30476. * @param verticesStart defines the index of first vertex to draw
  30477. * @param verticesCount defines the count of vertices to draw
  30478. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30479. */
  30480. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30481. /**
  30482. * Draw a list of unindexed primitives
  30483. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  30484. * @param verticesStart defines the index of first vertex to draw
  30485. * @param verticesCount defines the count of vertices to draw
  30486. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30487. */
  30488. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30489. /**
  30490. * Draw a list of indexed primitives
  30491. * @param fillMode defines the primitive to use
  30492. * @param indexStart defines the starting index
  30493. * @param indexCount defines the number of index to draw
  30494. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30495. */
  30496. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  30497. /**
  30498. * Draw a list of unindexed primitives
  30499. * @param fillMode defines the primitive to use
  30500. * @param verticesStart defines the index of first vertex to draw
  30501. * @param verticesCount defines the count of vertices to draw
  30502. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30503. */
  30504. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30505. private _drawMode;
  30506. /** @hidden */
  30507. protected _reportDrawCall(): void;
  30508. /** @hidden */
  30509. _releaseEffect(effect: Effect): void;
  30510. /** @hidden */
  30511. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  30512. /**
  30513. * Create a new effect (used to store vertex/fragment shaders)
  30514. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  30515. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  30516. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  30517. * @param samplers defines an array of string used to represent textures
  30518. * @param defines defines the string containing the defines to use to compile the shaders
  30519. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  30520. * @param onCompiled defines a function to call when the effect creation is successful
  30521. * @param onError defines a function to call when the effect creation has failed
  30522. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  30523. * @returns the new Effect
  30524. */
  30525. createEffect(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: string[], defines?: string, fallbacks?: IEffectFallbacks, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any): Effect;
  30526. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  30527. private _compileShader;
  30528. private _compileRawShader;
  30529. /**
  30530. * Directly creates a webGL program
  30531. * @param pipelineContext defines the pipeline context to attach to
  30532. * @param vertexCode defines the vertex shader code to use
  30533. * @param fragmentCode defines the fragment shader code to use
  30534. * @param context defines the webGL context to use (if not set, the current one will be used)
  30535. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  30536. * @returns the new webGL program
  30537. */
  30538. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30539. /**
  30540. * Creates a webGL program
  30541. * @param pipelineContext defines the pipeline context to attach to
  30542. * @param vertexCode defines the vertex shader code to use
  30543. * @param fragmentCode defines the fragment shader code to use
  30544. * @param defines defines the string containing the defines to use to compile the shaders
  30545. * @param context defines the webGL context to use (if not set, the current one will be used)
  30546. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  30547. * @returns the new webGL program
  30548. */
  30549. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30550. /**
  30551. * Creates a new pipeline context
  30552. * @returns the new pipeline
  30553. */
  30554. createPipelineContext(): IPipelineContext;
  30555. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30556. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  30557. /** @hidden */
  30558. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  30559. /** @hidden */
  30560. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  30561. /** @hidden */
  30562. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  30563. /**
  30564. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  30565. * @param pipelineContext defines the pipeline context to use
  30566. * @param uniformsNames defines the list of uniform names
  30567. * @returns an array of webGL uniform locations
  30568. */
  30569. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  30570. /**
  30571. * Gets the lsit of active attributes for a given webGL program
  30572. * @param pipelineContext defines the pipeline context to use
  30573. * @param attributesNames defines the list of attribute names to get
  30574. * @returns an array of indices indicating the offset of each attribute
  30575. */
  30576. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  30577. /**
  30578. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  30579. * @param effect defines the effect to activate
  30580. */
  30581. enableEffect(effect: Nullable<Effect>): void;
  30582. /**
  30583. * Set the value of an uniform to a number (int)
  30584. * @param uniform defines the webGL uniform location where to store the value
  30585. * @param value defines the int number to store
  30586. */
  30587. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  30588. /**
  30589. * Set the value of an uniform to an array of int32
  30590. * @param uniform defines the webGL uniform location where to store the value
  30591. * @param array defines the array of int32 to store
  30592. */
  30593. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30594. /**
  30595. * Set the value of an uniform to an array of int32 (stored as vec2)
  30596. * @param uniform defines the webGL uniform location where to store the value
  30597. * @param array defines the array of int32 to store
  30598. */
  30599. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30600. /**
  30601. * Set the value of an uniform to an array of int32 (stored as vec3)
  30602. * @param uniform defines the webGL uniform location where to store the value
  30603. * @param array defines the array of int32 to store
  30604. */
  30605. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30606. /**
  30607. * Set the value of an uniform to an array of int32 (stored as vec4)
  30608. * @param uniform defines the webGL uniform location where to store the value
  30609. * @param array defines the array of int32 to store
  30610. */
  30611. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30612. /**
  30613. * Set the value of an uniform to an array of number
  30614. * @param uniform defines the webGL uniform location where to store the value
  30615. * @param array defines the array of number to store
  30616. */
  30617. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30618. /**
  30619. * Set the value of an uniform to an array of number (stored as vec2)
  30620. * @param uniform defines the webGL uniform location where to store the value
  30621. * @param array defines the array of number to store
  30622. */
  30623. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30624. /**
  30625. * Set the value of an uniform to an array of number (stored as vec3)
  30626. * @param uniform defines the webGL uniform location where to store the value
  30627. * @param array defines the array of number to store
  30628. */
  30629. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30630. /**
  30631. * Set the value of an uniform to an array of number (stored as vec4)
  30632. * @param uniform defines the webGL uniform location where to store the value
  30633. * @param array defines the array of number to store
  30634. */
  30635. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30636. /**
  30637. * Set the value of an uniform to an array of float32 (stored as matrices)
  30638. * @param uniform defines the webGL uniform location where to store the value
  30639. * @param matrices defines the array of float32 to store
  30640. */
  30641. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  30642. /**
  30643. * Set the value of an uniform to a matrix (3x3)
  30644. * @param uniform defines the webGL uniform location where to store the value
  30645. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  30646. */
  30647. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  30648. /**
  30649. * Set the value of an uniform to a matrix (2x2)
  30650. * @param uniform defines the webGL uniform location where to store the value
  30651. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  30652. */
  30653. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  30654. /**
  30655. * Set the value of an uniform to a number (float)
  30656. * @param uniform defines the webGL uniform location where to store the value
  30657. * @param value defines the float number to store
  30658. */
  30659. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  30660. /**
  30661. * Set the value of an uniform to a vec2
  30662. * @param uniform defines the webGL uniform location where to store the value
  30663. * @param x defines the 1st component of the value
  30664. * @param y defines the 2nd component of the value
  30665. */
  30666. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  30667. /**
  30668. * Set the value of an uniform to a vec3
  30669. * @param uniform defines the webGL uniform location where to store the value
  30670. * @param x defines the 1st component of the value
  30671. * @param y defines the 2nd component of the value
  30672. * @param z defines the 3rd component of the value
  30673. */
  30674. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  30675. /**
  30676. * Set the value of an uniform to a vec4
  30677. * @param uniform defines the webGL uniform location where to store the value
  30678. * @param x defines the 1st component of the value
  30679. * @param y defines the 2nd component of the value
  30680. * @param z defines the 3rd component of the value
  30681. * @param w defines the 4th component of the value
  30682. */
  30683. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  30684. /**
  30685. * Gets the depth culling state manager
  30686. */
  30687. readonly depthCullingState: DepthCullingState;
  30688. /**
  30689. * Gets the alpha state manager
  30690. */
  30691. readonly alphaState: AlphaState;
  30692. /**
  30693. * Gets the stencil state manager
  30694. */
  30695. readonly stencilState: StencilState;
  30696. /**
  30697. * Clears the list of texture accessible through engine.
  30698. * This can help preventing texture load conflict due to name collision.
  30699. */
  30700. clearInternalTexturesCache(): void;
  30701. /**
  30702. * Force the entire cache to be cleared
  30703. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  30704. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  30705. */
  30706. wipeCaches(bruteForce?: boolean): void;
  30707. /** @hidden */
  30708. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  30709. min: number;
  30710. mag: number;
  30711. };
  30712. /** @hidden */
  30713. _createTexture(): WebGLTexture;
  30714. /**
  30715. * Usually called from Texture.ts.
  30716. * Passed information to create a WebGLTexture
  30717. * @param urlArg defines a value which contains one of the following:
  30718. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  30719. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  30720. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  30721. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  30722. * @param invertY when true, image is flipped when loaded. You probably want true. Certain compressed textures may invert this if their default is inverted (eg. ktx)
  30723. * @param scene needed for loading to the correct scene
  30724. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  30725. * @param onLoad optional callback to be called upon successful completion
  30726. * @param onError optional callback to be called upon failure
  30727. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), HTMLImageElement (image format), or a Blob
  30728. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  30729. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  30730. * @param forcedExtension defines the extension to use to pick the right loader
  30731. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  30732. * @param mimeType defines an optional mime type
  30733. * @returns a InternalTexture for assignment back into BABYLON.Texture
  30734. */
  30735. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, excludeLoaders?: Array<IInternalTextureLoader>, mimeType?: string): InternalTexture;
  30736. /**
  30737. * @hidden
  30738. */
  30739. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  30740. /**
  30741. * Creates a raw texture
  30742. * @param data defines the data to store in the texture
  30743. * @param width defines the width of the texture
  30744. * @param height defines the height of the texture
  30745. * @param format defines the format of the data
  30746. * @param generateMipMaps defines if the engine should generate the mip levels
  30747. * @param invertY defines if data must be stored with Y axis inverted
  30748. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  30749. * @param compression defines the compression used (null by default)
  30750. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  30751. * @returns the raw texture inside an InternalTexture
  30752. */
  30753. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, type?: number): InternalTexture;
  30754. /**
  30755. * Creates a new raw cube texture
  30756. * @param data defines the array of data to use to create each face
  30757. * @param size defines the size of the textures
  30758. * @param format defines the format of the data
  30759. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  30760. * @param generateMipMaps defines if the engine should generate the mip levels
  30761. * @param invertY defines if data must be stored with Y axis inverted
  30762. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  30763. * @param compression defines the compression used (null by default)
  30764. * @returns the cube texture as an InternalTexture
  30765. */
  30766. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>): InternalTexture;
  30767. /**
  30768. * Creates a new raw 3D texture
  30769. * @param data defines the data used to create the texture
  30770. * @param width defines the width of the texture
  30771. * @param height defines the height of the texture
  30772. * @param depth defines the depth of the texture
  30773. * @param format defines the format of the texture
  30774. * @param generateMipMaps defines if the engine must generate mip levels
  30775. * @param invertY defines if data must be stored with Y axis inverted
  30776. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  30777. * @param compression defines the compressed used (can be null)
  30778. * @param textureType defines the compressed used (can be null)
  30779. * @returns a new raw 3D texture (stored in an InternalTexture)
  30780. */
  30781. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  30782. private _unpackFlipYCached;
  30783. /**
  30784. * In case you are sharing the context with other applications, it might
  30785. * be interested to not cache the unpack flip y state to ensure a consistent
  30786. * value would be set.
  30787. */
  30788. enableUnpackFlipYCached: boolean;
  30789. /** @hidden */
  30790. _unpackFlipY(value: boolean): void;
  30791. /** @hidden */
  30792. _getUnpackAlignement(): number;
  30793. /**
  30794. * Update the sampling mode of a given texture
  30795. * @param samplingMode defines the required sampling mode
  30796. * @param texture defines the texture to update
  30797. */
  30798. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  30799. /** @hidden */
  30800. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  30801. width: number;
  30802. height: number;
  30803. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  30804. /** @hidden */
  30805. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  30806. /** @hidden */
  30807. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  30808. /** @hidden */
  30809. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  30810. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  30811. private _prepareWebGLTexture;
  30812. /** @hidden */
  30813. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  30814. /** @hidden */
  30815. _releaseFramebufferObjects(texture: InternalTexture): void;
  30816. /** @hidden */
  30817. _releaseTexture(texture: InternalTexture): void;
  30818. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  30819. protected _setProgram(program: WebGLProgram): void;
  30820. protected _boundUniforms: {
  30821. [key: number]: WebGLUniformLocation;
  30822. };
  30823. /**
  30824. * Binds an effect to the webGL context
  30825. * @param effect defines the effect to bind
  30826. */
  30827. bindSamplers(effect: Effect): void;
  30828. private _activateCurrentTexture;
  30829. /** @hidden */
  30830. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  30831. /** @hidden */
  30832. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  30833. /**
  30834. * Unbind all textures from the webGL context
  30835. */
  30836. unbindAllTextures(): void;
  30837. /**
  30838. * Sets a texture to the according uniform.
  30839. * @param channel The texture channel
  30840. * @param uniform The uniform to set
  30841. * @param texture The texture to apply
  30842. */
  30843. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  30844. private _bindSamplerUniformToChannel;
  30845. private _getTextureWrapMode;
  30846. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  30847. /**
  30848. * Sets an array of texture to the webGL context
  30849. * @param channel defines the channel where the texture array must be set
  30850. * @param uniform defines the associated uniform location
  30851. * @param textures defines the array of textures to bind
  30852. */
  30853. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  30854. /** @hidden */
  30855. _setAnisotropicLevel(target: number, texture: BaseTexture): void;
  30856. private _setTextureParameterFloat;
  30857. private _setTextureParameterInteger;
  30858. /**
  30859. * Unbind all vertex attributes from the webGL context
  30860. */
  30861. unbindAllAttributes(): void;
  30862. /**
  30863. * Force the engine to release all cached effects. This means that next effect compilation will have to be done completely even if a similar effect was already compiled
  30864. */
  30865. releaseEffects(): void;
  30866. /**
  30867. * Dispose and release all associated resources
  30868. */
  30869. dispose(): void;
  30870. /**
  30871. * Attach a new callback raised when context lost event is fired
  30872. * @param callback defines the callback to call
  30873. */
  30874. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  30875. /**
  30876. * Attach a new callback raised when context restored event is fired
  30877. * @param callback defines the callback to call
  30878. */
  30879. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  30880. /**
  30881. * Get the current error code of the webGL context
  30882. * @returns the error code
  30883. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  30884. */
  30885. getError(): number;
  30886. private _canRenderToFloatFramebuffer;
  30887. private _canRenderToHalfFloatFramebuffer;
  30888. private _canRenderToFramebuffer;
  30889. /** @hidden */
  30890. _getWebGLTextureType(type: number): number;
  30891. /** @hidden */
  30892. _getInternalFormat(format: number): number;
  30893. /** @hidden */
  30894. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  30895. /** @hidden */
  30896. _getRGBAMultiSampleBufferFormat(type: number): number;
  30897. /** @hidden */
  30898. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: IWebRequest, exception?: any) => void): IFileRequest;
  30899. /**
  30900. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  30901. * @returns true if the engine can be created
  30902. * @ignorenaming
  30903. */
  30904. static isSupported(): boolean;
  30905. /**
  30906. * Find the next highest power of two.
  30907. * @param x Number to start search from.
  30908. * @return Next highest power of two.
  30909. */
  30910. static CeilingPOT(x: number): number;
  30911. /**
  30912. * Find the next lowest power of two.
  30913. * @param x Number to start search from.
  30914. * @return Next lowest power of two.
  30915. */
  30916. static FloorPOT(x: number): number;
  30917. /**
  30918. * Find the nearest power of two.
  30919. * @param x Number to start search from.
  30920. * @return Next nearest power of two.
  30921. */
  30922. static NearestPOT(x: number): number;
  30923. /**
  30924. * Get the closest exponent of two
  30925. * @param value defines the value to approximate
  30926. * @param max defines the maximum value to return
  30927. * @param mode defines how to define the closest value
  30928. * @returns closest exponent of two of the given value
  30929. */
  30930. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  30931. /**
  30932. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  30933. * @param func - the function to be called
  30934. * @param requester - the object that will request the next frame. Falls back to window.
  30935. * @returns frame number
  30936. */
  30937. static QueueNewFrame(func: () => void, requester?: any): number;
  30938. }
  30939. }
  30940. declare module "babylonjs/Maths/sphericalPolynomial" {
  30941. import { Vector3 } from "babylonjs/Maths/math.vector";
  30942. import { Color3 } from "babylonjs/Maths/math.color";
  30943. /**
  30944. * Class representing spherical harmonics coefficients to the 3rd degree
  30945. */
  30946. export class SphericalHarmonics {
  30947. /**
  30948. * Defines whether or not the harmonics have been prescaled for rendering.
  30949. */
  30950. preScaled: boolean;
  30951. /**
  30952. * The l0,0 coefficients of the spherical harmonics
  30953. */
  30954. l00: Vector3;
  30955. /**
  30956. * The l1,-1 coefficients of the spherical harmonics
  30957. */
  30958. l1_1: Vector3;
  30959. /**
  30960. * The l1,0 coefficients of the spherical harmonics
  30961. */
  30962. l10: Vector3;
  30963. /**
  30964. * The l1,1 coefficients of the spherical harmonics
  30965. */
  30966. l11: Vector3;
  30967. /**
  30968. * The l2,-2 coefficients of the spherical harmonics
  30969. */
  30970. l2_2: Vector3;
  30971. /**
  30972. * The l2,-1 coefficients of the spherical harmonics
  30973. */
  30974. l2_1: Vector3;
  30975. /**
  30976. * The l2,0 coefficients of the spherical harmonics
  30977. */
  30978. l20: Vector3;
  30979. /**
  30980. * The l2,1 coefficients of the spherical harmonics
  30981. */
  30982. l21: Vector3;
  30983. /**
  30984. * The l2,2 coefficients of the spherical harmonics
  30985. */
  30986. l22: Vector3;
  30987. /**
  30988. * Adds a light to the spherical harmonics
  30989. * @param direction the direction of the light
  30990. * @param color the color of the light
  30991. * @param deltaSolidAngle the delta solid angle of the light
  30992. */
  30993. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  30994. /**
  30995. * Scales the spherical harmonics by the given amount
  30996. * @param scale the amount to scale
  30997. */
  30998. scaleInPlace(scale: number): void;
  30999. /**
  31000. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  31001. *
  31002. * ```
  31003. * E_lm = A_l * L_lm
  31004. * ```
  31005. *
  31006. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  31007. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  31008. * the scaling factors are given in equation 9.
  31009. */
  31010. convertIncidentRadianceToIrradiance(): void;
  31011. /**
  31012. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  31013. *
  31014. * ```
  31015. * L = (1/pi) * E * rho
  31016. * ```
  31017. *
  31018. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  31019. */
  31020. convertIrradianceToLambertianRadiance(): void;
  31021. /**
  31022. * Integrates the reconstruction coefficients directly in to the SH preventing further
  31023. * required operations at run time.
  31024. *
  31025. * This is simply done by scaling back the SH with Ylm constants parameter.
  31026. * The trigonometric part being applied by the shader at run time.
  31027. */
  31028. preScaleForRendering(): void;
  31029. /**
  31030. * Constructs a spherical harmonics from an array.
  31031. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  31032. * @returns the spherical harmonics
  31033. */
  31034. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  31035. /**
  31036. * Gets the spherical harmonics from polynomial
  31037. * @param polynomial the spherical polynomial
  31038. * @returns the spherical harmonics
  31039. */
  31040. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  31041. }
  31042. /**
  31043. * Class representing spherical polynomial coefficients to the 3rd degree
  31044. */
  31045. export class SphericalPolynomial {
  31046. private _harmonics;
  31047. /**
  31048. * The spherical harmonics used to create the polynomials.
  31049. */
  31050. readonly preScaledHarmonics: SphericalHarmonics;
  31051. /**
  31052. * The x coefficients of the spherical polynomial
  31053. */
  31054. x: Vector3;
  31055. /**
  31056. * The y coefficients of the spherical polynomial
  31057. */
  31058. y: Vector3;
  31059. /**
  31060. * The z coefficients of the spherical polynomial
  31061. */
  31062. z: Vector3;
  31063. /**
  31064. * The xx coefficients of the spherical polynomial
  31065. */
  31066. xx: Vector3;
  31067. /**
  31068. * The yy coefficients of the spherical polynomial
  31069. */
  31070. yy: Vector3;
  31071. /**
  31072. * The zz coefficients of the spherical polynomial
  31073. */
  31074. zz: Vector3;
  31075. /**
  31076. * The xy coefficients of the spherical polynomial
  31077. */
  31078. xy: Vector3;
  31079. /**
  31080. * The yz coefficients of the spherical polynomial
  31081. */
  31082. yz: Vector3;
  31083. /**
  31084. * The zx coefficients of the spherical polynomial
  31085. */
  31086. zx: Vector3;
  31087. /**
  31088. * Adds an ambient color to the spherical polynomial
  31089. * @param color the color to add
  31090. */
  31091. addAmbient(color: Color3): void;
  31092. /**
  31093. * Scales the spherical polynomial by the given amount
  31094. * @param scale the amount to scale
  31095. */
  31096. scaleInPlace(scale: number): void;
  31097. /**
  31098. * Gets the spherical polynomial from harmonics
  31099. * @param harmonics the spherical harmonics
  31100. * @returns the spherical polynomial
  31101. */
  31102. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  31103. /**
  31104. * Constructs a spherical polynomial from an array.
  31105. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  31106. * @returns the spherical polynomial
  31107. */
  31108. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  31109. }
  31110. }
  31111. declare module "babylonjs/Materials/Textures/internalTexture" {
  31112. import { Observable } from "babylonjs/Misc/observable";
  31113. import { Nullable, int } from "babylonjs/types";
  31114. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  31115. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31116. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  31117. /**
  31118. * Defines the source of the internal texture
  31119. */
  31120. export enum InternalTextureSource {
  31121. /**
  31122. * The source of the texture data is unknown
  31123. */
  31124. Unknown = 0,
  31125. /**
  31126. * Texture data comes from an URL
  31127. */
  31128. Url = 1,
  31129. /**
  31130. * Texture data is only used for temporary storage
  31131. */
  31132. Temp = 2,
  31133. /**
  31134. * Texture data comes from raw data (ArrayBuffer)
  31135. */
  31136. Raw = 3,
  31137. /**
  31138. * Texture content is dynamic (video or dynamic texture)
  31139. */
  31140. Dynamic = 4,
  31141. /**
  31142. * Texture content is generated by rendering to it
  31143. */
  31144. RenderTarget = 5,
  31145. /**
  31146. * Texture content is part of a multi render target process
  31147. */
  31148. MultiRenderTarget = 6,
  31149. /**
  31150. * Texture data comes from a cube data file
  31151. */
  31152. Cube = 7,
  31153. /**
  31154. * Texture data comes from a raw cube data
  31155. */
  31156. CubeRaw = 8,
  31157. /**
  31158. * Texture data come from a prefiltered cube data file
  31159. */
  31160. CubePrefiltered = 9,
  31161. /**
  31162. * Texture content is raw 3D data
  31163. */
  31164. Raw3D = 10,
  31165. /**
  31166. * Texture content is a depth texture
  31167. */
  31168. Depth = 11,
  31169. /**
  31170. * Texture data comes from a raw cube data encoded with RGBD
  31171. */
  31172. CubeRawRGBD = 12
  31173. }
  31174. /**
  31175. * Class used to store data associated with WebGL texture data for the engine
  31176. * This class should not be used directly
  31177. */
  31178. export class InternalTexture {
  31179. /** @hidden */
  31180. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<import("babylonjs/Maths/sphericalPolynomial").SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  31181. /**
  31182. * Defines if the texture is ready
  31183. */
  31184. isReady: boolean;
  31185. /**
  31186. * Defines if the texture is a cube texture
  31187. */
  31188. isCube: boolean;
  31189. /**
  31190. * Defines if the texture contains 3D data
  31191. */
  31192. is3D: boolean;
  31193. /**
  31194. * Defines if the texture contains multiview data
  31195. */
  31196. isMultiview: boolean;
  31197. /**
  31198. * Gets the URL used to load this texture
  31199. */
  31200. url: string;
  31201. /**
  31202. * Gets the sampling mode of the texture
  31203. */
  31204. samplingMode: number;
  31205. /**
  31206. * Gets a boolean indicating if the texture needs mipmaps generation
  31207. */
  31208. generateMipMaps: boolean;
  31209. /**
  31210. * Gets the number of samples used by the texture (WebGL2+ only)
  31211. */
  31212. samples: number;
  31213. /**
  31214. * Gets the type of the texture (int, float...)
  31215. */
  31216. type: number;
  31217. /**
  31218. * Gets the format of the texture (RGB, RGBA...)
  31219. */
  31220. format: number;
  31221. /**
  31222. * Observable called when the texture is loaded
  31223. */
  31224. onLoadedObservable: Observable<InternalTexture>;
  31225. /**
  31226. * Gets the width of the texture
  31227. */
  31228. width: number;
  31229. /**
  31230. * Gets the height of the texture
  31231. */
  31232. height: number;
  31233. /**
  31234. * Gets the depth of the texture
  31235. */
  31236. depth: number;
  31237. /**
  31238. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  31239. */
  31240. baseWidth: number;
  31241. /**
  31242. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  31243. */
  31244. baseHeight: number;
  31245. /**
  31246. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  31247. */
  31248. baseDepth: number;
  31249. /**
  31250. * Gets a boolean indicating if the texture is inverted on Y axis
  31251. */
  31252. invertY: boolean;
  31253. /** @hidden */
  31254. _invertVScale: boolean;
  31255. /** @hidden */
  31256. _associatedChannel: number;
  31257. /** @hidden */
  31258. _source: InternalTextureSource;
  31259. /** @hidden */
  31260. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  31261. /** @hidden */
  31262. _bufferView: Nullable<ArrayBufferView>;
  31263. /** @hidden */
  31264. _bufferViewArray: Nullable<ArrayBufferView[]>;
  31265. /** @hidden */
  31266. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  31267. /** @hidden */
  31268. _size: number;
  31269. /** @hidden */
  31270. _extension: string;
  31271. /** @hidden */
  31272. _files: Nullable<string[]>;
  31273. /** @hidden */
  31274. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  31275. /** @hidden */
  31276. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  31277. /** @hidden */
  31278. _framebuffer: Nullable<WebGLFramebuffer>;
  31279. /** @hidden */
  31280. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  31281. /** @hidden */
  31282. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  31283. /** @hidden */
  31284. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  31285. /** @hidden */
  31286. _attachments: Nullable<number[]>;
  31287. /** @hidden */
  31288. _cachedCoordinatesMode: Nullable<number>;
  31289. /** @hidden */
  31290. _cachedWrapU: Nullable<number>;
  31291. /** @hidden */
  31292. _cachedWrapV: Nullable<number>;
  31293. /** @hidden */
  31294. _cachedWrapR: Nullable<number>;
  31295. /** @hidden */
  31296. _cachedAnisotropicFilteringLevel: Nullable<number>;
  31297. /** @hidden */
  31298. _isDisabled: boolean;
  31299. /** @hidden */
  31300. _compression: Nullable<string>;
  31301. /** @hidden */
  31302. _generateStencilBuffer: boolean;
  31303. /** @hidden */
  31304. _generateDepthBuffer: boolean;
  31305. /** @hidden */
  31306. _comparisonFunction: number;
  31307. /** @hidden */
  31308. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  31309. /** @hidden */
  31310. _lodGenerationScale: number;
  31311. /** @hidden */
  31312. _lodGenerationOffset: number;
  31313. /** @hidden */
  31314. _colorTextureArray: Nullable<WebGLTexture>;
  31315. /** @hidden */
  31316. _depthStencilTextureArray: Nullable<WebGLTexture>;
  31317. /** @hidden */
  31318. _lodTextureHigh: Nullable<BaseTexture>;
  31319. /** @hidden */
  31320. _lodTextureMid: Nullable<BaseTexture>;
  31321. /** @hidden */
  31322. _lodTextureLow: Nullable<BaseTexture>;
  31323. /** @hidden */
  31324. _isRGBD: boolean;
  31325. /** @hidden */
  31326. _linearSpecularLOD: boolean;
  31327. /** @hidden */
  31328. _irradianceTexture: Nullable<BaseTexture>;
  31329. /** @hidden */
  31330. _webGLTexture: Nullable<WebGLTexture>;
  31331. /** @hidden */
  31332. _references: number;
  31333. private _engine;
  31334. /**
  31335. * Gets the Engine the texture belongs to.
  31336. * @returns The babylon engine
  31337. */
  31338. getEngine(): ThinEngine;
  31339. /**
  31340. * Gets the data source type of the texture
  31341. */
  31342. readonly source: InternalTextureSource;
  31343. /**
  31344. * Creates a new InternalTexture
  31345. * @param engine defines the engine to use
  31346. * @param source defines the type of data that will be used
  31347. * @param delayAllocation if the texture allocation should be delayed (default: false)
  31348. */
  31349. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  31350. /**
  31351. * Increments the number of references (ie. the number of Texture that point to it)
  31352. */
  31353. incrementReferences(): void;
  31354. /**
  31355. * Change the size of the texture (not the size of the content)
  31356. * @param width defines the new width
  31357. * @param height defines the new height
  31358. * @param depth defines the new depth (1 by default)
  31359. */
  31360. updateSize(width: int, height: int, depth?: int): void;
  31361. /** @hidden */
  31362. _rebuild(): void;
  31363. /** @hidden */
  31364. _swapAndDie(target: InternalTexture): void;
  31365. /**
  31366. * Dispose the current allocated resources
  31367. */
  31368. dispose(): void;
  31369. }
  31370. }
  31371. declare module "babylonjs/Audio/analyser" {
  31372. import { Scene } from "babylonjs/scene";
  31373. /**
  31374. * Class used to work with sound analyzer using fast fourier transform (FFT)
  31375. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31376. */
  31377. export class Analyser {
  31378. /**
  31379. * Gets or sets the smoothing
  31380. * @ignorenaming
  31381. */
  31382. SMOOTHING: number;
  31383. /**
  31384. * Gets or sets the FFT table size
  31385. * @ignorenaming
  31386. */
  31387. FFT_SIZE: number;
  31388. /**
  31389. * Gets or sets the bar graph amplitude
  31390. * @ignorenaming
  31391. */
  31392. BARGRAPHAMPLITUDE: number;
  31393. /**
  31394. * Gets or sets the position of the debug canvas
  31395. * @ignorenaming
  31396. */
  31397. DEBUGCANVASPOS: {
  31398. x: number;
  31399. y: number;
  31400. };
  31401. /**
  31402. * Gets or sets the debug canvas size
  31403. * @ignorenaming
  31404. */
  31405. DEBUGCANVASSIZE: {
  31406. width: number;
  31407. height: number;
  31408. };
  31409. private _byteFreqs;
  31410. private _byteTime;
  31411. private _floatFreqs;
  31412. private _webAudioAnalyser;
  31413. private _debugCanvas;
  31414. private _debugCanvasContext;
  31415. private _scene;
  31416. private _registerFunc;
  31417. private _audioEngine;
  31418. /**
  31419. * Creates a new analyser
  31420. * @param scene defines hosting scene
  31421. */
  31422. constructor(scene: Scene);
  31423. /**
  31424. * Get the number of data values you will have to play with for the visualization
  31425. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  31426. * @returns a number
  31427. */
  31428. getFrequencyBinCount(): number;
  31429. /**
  31430. * Gets the current frequency data as a byte array
  31431. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  31432. * @returns a Uint8Array
  31433. */
  31434. getByteFrequencyData(): Uint8Array;
  31435. /**
  31436. * Gets the current waveform as a byte array
  31437. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  31438. * @returns a Uint8Array
  31439. */
  31440. getByteTimeDomainData(): Uint8Array;
  31441. /**
  31442. * Gets the current frequency data as a float array
  31443. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  31444. * @returns a Float32Array
  31445. */
  31446. getFloatFrequencyData(): Float32Array;
  31447. /**
  31448. * Renders the debug canvas
  31449. */
  31450. drawDebugCanvas(): void;
  31451. /**
  31452. * Stops rendering the debug canvas and removes it
  31453. */
  31454. stopDebugCanvas(): void;
  31455. /**
  31456. * Connects two audio nodes
  31457. * @param inputAudioNode defines first node to connect
  31458. * @param outputAudioNode defines second node to connect
  31459. */
  31460. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  31461. /**
  31462. * Releases all associated resources
  31463. */
  31464. dispose(): void;
  31465. }
  31466. }
  31467. declare module "babylonjs/Audio/audioEngine" {
  31468. import { IDisposable } from "babylonjs/scene";
  31469. import { Analyser } from "babylonjs/Audio/analyser";
  31470. import { Nullable } from "babylonjs/types";
  31471. import { Observable } from "babylonjs/Misc/observable";
  31472. /**
  31473. * This represents an audio engine and it is responsible
  31474. * to play, synchronize and analyse sounds throughout the application.
  31475. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31476. */
  31477. export interface IAudioEngine extends IDisposable {
  31478. /**
  31479. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  31480. */
  31481. readonly canUseWebAudio: boolean;
  31482. /**
  31483. * Gets the current AudioContext if available.
  31484. */
  31485. readonly audioContext: Nullable<AudioContext>;
  31486. /**
  31487. * The master gain node defines the global audio volume of your audio engine.
  31488. */
  31489. readonly masterGain: GainNode;
  31490. /**
  31491. * Gets whether or not mp3 are supported by your browser.
  31492. */
  31493. readonly isMP3supported: boolean;
  31494. /**
  31495. * Gets whether or not ogg are supported by your browser.
  31496. */
  31497. readonly isOGGsupported: boolean;
  31498. /**
  31499. * Defines if Babylon should emit a warning if WebAudio is not supported.
  31500. * @ignoreNaming
  31501. */
  31502. WarnedWebAudioUnsupported: boolean;
  31503. /**
  31504. * Defines if the audio engine relies on a custom unlocked button.
  31505. * In this case, the embedded button will not be displayed.
  31506. */
  31507. useCustomUnlockedButton: boolean;
  31508. /**
  31509. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  31510. */
  31511. readonly unlocked: boolean;
  31512. /**
  31513. * Event raised when audio has been unlocked on the browser.
  31514. */
  31515. onAudioUnlockedObservable: Observable<AudioEngine>;
  31516. /**
  31517. * Event raised when audio has been locked on the browser.
  31518. */
  31519. onAudioLockedObservable: Observable<AudioEngine>;
  31520. /**
  31521. * Flags the audio engine in Locked state.
  31522. * This happens due to new browser policies preventing audio to autoplay.
  31523. */
  31524. lock(): void;
  31525. /**
  31526. * Unlocks the audio engine once a user action has been done on the dom.
  31527. * This is helpful to resume play once browser policies have been satisfied.
  31528. */
  31529. unlock(): void;
  31530. }
  31531. /**
  31532. * This represents the default audio engine used in babylon.
  31533. * It is responsible to play, synchronize and analyse sounds throughout the application.
  31534. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31535. */
  31536. export class AudioEngine implements IAudioEngine {
  31537. private _audioContext;
  31538. private _audioContextInitialized;
  31539. private _muteButton;
  31540. private _hostElement;
  31541. /**
  31542. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  31543. */
  31544. canUseWebAudio: boolean;
  31545. /**
  31546. * The master gain node defines the global audio volume of your audio engine.
  31547. */
  31548. masterGain: GainNode;
  31549. /**
  31550. * Defines if Babylon should emit a warning if WebAudio is not supported.
  31551. * @ignoreNaming
  31552. */
  31553. WarnedWebAudioUnsupported: boolean;
  31554. /**
  31555. * Gets whether or not mp3 are supported by your browser.
  31556. */
  31557. isMP3supported: boolean;
  31558. /**
  31559. * Gets whether or not ogg are supported by your browser.
  31560. */
  31561. isOGGsupported: boolean;
  31562. /**
  31563. * Gets whether audio has been unlocked on the device.
  31564. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  31565. * a user interaction has happened.
  31566. */
  31567. unlocked: boolean;
  31568. /**
  31569. * Defines if the audio engine relies on a custom unlocked button.
  31570. * In this case, the embedded button will not be displayed.
  31571. */
  31572. useCustomUnlockedButton: boolean;
  31573. /**
  31574. * Event raised when audio has been unlocked on the browser.
  31575. */
  31576. onAudioUnlockedObservable: Observable<AudioEngine>;
  31577. /**
  31578. * Event raised when audio has been locked on the browser.
  31579. */
  31580. onAudioLockedObservable: Observable<AudioEngine>;
  31581. /**
  31582. * Gets the current AudioContext if available.
  31583. */
  31584. readonly audioContext: Nullable<AudioContext>;
  31585. private _connectedAnalyser;
  31586. /**
  31587. * Instantiates a new audio engine.
  31588. *
  31589. * There should be only one per page as some browsers restrict the number
  31590. * of audio contexts you can create.
  31591. * @param hostElement defines the host element where to display the mute icon if necessary
  31592. */
  31593. constructor(hostElement?: Nullable<HTMLElement>);
  31594. /**
  31595. * Flags the audio engine in Locked state.
  31596. * This happens due to new browser policies preventing audio to autoplay.
  31597. */
  31598. lock(): void;
  31599. /**
  31600. * Unlocks the audio engine once a user action has been done on the dom.
  31601. * This is helpful to resume play once browser policies have been satisfied.
  31602. */
  31603. unlock(): void;
  31604. private _resumeAudioContext;
  31605. private _initializeAudioContext;
  31606. private _tryToRun;
  31607. private _triggerRunningState;
  31608. private _triggerSuspendedState;
  31609. private _displayMuteButton;
  31610. private _moveButtonToTopLeft;
  31611. private _onResize;
  31612. private _hideMuteButton;
  31613. /**
  31614. * Destroy and release the resources associated with the audio ccontext.
  31615. */
  31616. dispose(): void;
  31617. /**
  31618. * Gets the global volume sets on the master gain.
  31619. * @returns the global volume if set or -1 otherwise
  31620. */
  31621. getGlobalVolume(): number;
  31622. /**
  31623. * Sets the global volume of your experience (sets on the master gain).
  31624. * @param newVolume Defines the new global volume of the application
  31625. */
  31626. setGlobalVolume(newVolume: number): void;
  31627. /**
  31628. * Connect the audio engine to an audio analyser allowing some amazing
  31629. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  31630. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  31631. * @param analyser The analyser to connect to the engine
  31632. */
  31633. connectToAnalyser(analyser: Analyser): void;
  31634. }
  31635. }
  31636. declare module "babylonjs/Loading/loadingScreen" {
  31637. /**
  31638. * Interface used to present a loading screen while loading a scene
  31639. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  31640. */
  31641. export interface ILoadingScreen {
  31642. /**
  31643. * Function called to display the loading screen
  31644. */
  31645. displayLoadingUI: () => void;
  31646. /**
  31647. * Function called to hide the loading screen
  31648. */
  31649. hideLoadingUI: () => void;
  31650. /**
  31651. * Gets or sets the color to use for the background
  31652. */
  31653. loadingUIBackgroundColor: string;
  31654. /**
  31655. * Gets or sets the text to display while loading
  31656. */
  31657. loadingUIText: string;
  31658. }
  31659. /**
  31660. * Class used for the default loading screen
  31661. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  31662. */
  31663. export class DefaultLoadingScreen implements ILoadingScreen {
  31664. private _renderingCanvas;
  31665. private _loadingText;
  31666. private _loadingDivBackgroundColor;
  31667. private _loadingDiv;
  31668. private _loadingTextDiv;
  31669. /** Gets or sets the logo url to use for the default loading screen */
  31670. static DefaultLogoUrl: string;
  31671. /** Gets or sets the spinner url to use for the default loading screen */
  31672. static DefaultSpinnerUrl: string;
  31673. /**
  31674. * Creates a new default loading screen
  31675. * @param _renderingCanvas defines the canvas used to render the scene
  31676. * @param _loadingText defines the default text to display
  31677. * @param _loadingDivBackgroundColor defines the default background color
  31678. */
  31679. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  31680. /**
  31681. * Function called to display the loading screen
  31682. */
  31683. displayLoadingUI(): void;
  31684. /**
  31685. * Function called to hide the loading screen
  31686. */
  31687. hideLoadingUI(): void;
  31688. /**
  31689. * Gets or sets the text to display while loading
  31690. */
  31691. loadingUIText: string;
  31692. /**
  31693. * Gets or sets the color to use for the background
  31694. */
  31695. loadingUIBackgroundColor: string;
  31696. private _resizeLoadingUI;
  31697. }
  31698. }
  31699. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  31700. /**
  31701. * Interface for any object that can request an animation frame
  31702. */
  31703. export interface ICustomAnimationFrameRequester {
  31704. /**
  31705. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  31706. */
  31707. renderFunction?: Function;
  31708. /**
  31709. * Called to request the next frame to render to
  31710. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  31711. */
  31712. requestAnimationFrame: Function;
  31713. /**
  31714. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  31715. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  31716. */
  31717. requestID?: number;
  31718. }
  31719. }
  31720. declare module "babylonjs/Misc/performanceMonitor" {
  31721. /**
  31722. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  31723. */
  31724. export class PerformanceMonitor {
  31725. private _enabled;
  31726. private _rollingFrameTime;
  31727. private _lastFrameTimeMs;
  31728. /**
  31729. * constructor
  31730. * @param frameSampleSize The number of samples required to saturate the sliding window
  31731. */
  31732. constructor(frameSampleSize?: number);
  31733. /**
  31734. * Samples current frame
  31735. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  31736. */
  31737. sampleFrame(timeMs?: number): void;
  31738. /**
  31739. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  31740. */
  31741. readonly averageFrameTime: number;
  31742. /**
  31743. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  31744. */
  31745. readonly averageFrameTimeVariance: number;
  31746. /**
  31747. * Returns the frame time of the most recent frame
  31748. */
  31749. readonly instantaneousFrameTime: number;
  31750. /**
  31751. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  31752. */
  31753. readonly averageFPS: number;
  31754. /**
  31755. * Returns the average framerate in frames per second using the most recent frame time
  31756. */
  31757. readonly instantaneousFPS: number;
  31758. /**
  31759. * Returns true if enough samples have been taken to completely fill the sliding window
  31760. */
  31761. readonly isSaturated: boolean;
  31762. /**
  31763. * Enables contributions to the sliding window sample set
  31764. */
  31765. enable(): void;
  31766. /**
  31767. * Disables contributions to the sliding window sample set
  31768. * Samples will not be interpolated over the disabled period
  31769. */
  31770. disable(): void;
  31771. /**
  31772. * Returns true if sampling is enabled
  31773. */
  31774. readonly isEnabled: boolean;
  31775. /**
  31776. * Resets performance monitor
  31777. */
  31778. reset(): void;
  31779. }
  31780. /**
  31781. * RollingAverage
  31782. *
  31783. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  31784. */
  31785. export class RollingAverage {
  31786. /**
  31787. * Current average
  31788. */
  31789. average: number;
  31790. /**
  31791. * Current variance
  31792. */
  31793. variance: number;
  31794. protected _samples: Array<number>;
  31795. protected _sampleCount: number;
  31796. protected _pos: number;
  31797. protected _m2: number;
  31798. /**
  31799. * constructor
  31800. * @param length The number of samples required to saturate the sliding window
  31801. */
  31802. constructor(length: number);
  31803. /**
  31804. * Adds a sample to the sample set
  31805. * @param v The sample value
  31806. */
  31807. add(v: number): void;
  31808. /**
  31809. * Returns previously added values or null if outside of history or outside the sliding window domain
  31810. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  31811. * @return Value previously recorded with add() or null if outside of range
  31812. */
  31813. history(i: number): number;
  31814. /**
  31815. * Returns true if enough samples have been taken to completely fill the sliding window
  31816. * @return true if sample-set saturated
  31817. */
  31818. isSaturated(): boolean;
  31819. /**
  31820. * Resets the rolling average (equivalent to 0 samples taken so far)
  31821. */
  31822. reset(): void;
  31823. /**
  31824. * Wraps a value around the sample range boundaries
  31825. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  31826. * @return Wrapped position in sample range
  31827. */
  31828. protected _wrapPosition(i: number): number;
  31829. }
  31830. }
  31831. declare module "babylonjs/Misc/perfCounter" {
  31832. /**
  31833. * This class is used to track a performance counter which is number based.
  31834. * The user has access to many properties which give statistics of different nature.
  31835. *
  31836. * The implementer can track two kinds of Performance Counter: time and count.
  31837. * For time you can optionally call fetchNewFrame() to notify the start of a new frame to monitor, then call beginMonitoring() to start and endMonitoring() to record the lapsed time. endMonitoring takes a newFrame parameter for you to specify if the monitored time should be set for a new frame or accumulated to the current frame being monitored.
  31838. * For count you first have to call fetchNewFrame() to notify the start of a new frame to monitor, then call addCount() how many time required to increment the count value you monitor.
  31839. */
  31840. export class PerfCounter {
  31841. /**
  31842. * Gets or sets a global boolean to turn on and off all the counters
  31843. */
  31844. static Enabled: boolean;
  31845. /**
  31846. * Returns the smallest value ever
  31847. */
  31848. readonly min: number;
  31849. /**
  31850. * Returns the biggest value ever
  31851. */
  31852. readonly max: number;
  31853. /**
  31854. * Returns the average value since the performance counter is running
  31855. */
  31856. readonly average: number;
  31857. /**
  31858. * Returns the average value of the last second the counter was monitored
  31859. */
  31860. readonly lastSecAverage: number;
  31861. /**
  31862. * Returns the current value
  31863. */
  31864. readonly current: number;
  31865. /**
  31866. * Gets the accumulated total
  31867. */
  31868. readonly total: number;
  31869. /**
  31870. * Gets the total value count
  31871. */
  31872. readonly count: number;
  31873. /**
  31874. * Creates a new counter
  31875. */
  31876. constructor();
  31877. /**
  31878. * Call this method to start monitoring a new frame.
  31879. * This scenario is typically used when you accumulate monitoring time many times for a single frame, you call this method at the start of the frame, then beginMonitoring to start recording and endMonitoring(false) to accumulated the recorded time to the PerfCounter or addCount() to accumulate a monitored count.
  31880. */
  31881. fetchNewFrame(): void;
  31882. /**
  31883. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  31884. * @param newCount the count value to add to the monitored count
  31885. * @param fetchResult true when it's the last time in the frame you add to the counter and you wish to update the statistics properties (min/max/average), false if you only want to update statistics.
  31886. */
  31887. addCount(newCount: number, fetchResult: boolean): void;
  31888. /**
  31889. * Start monitoring this performance counter
  31890. */
  31891. beginMonitoring(): void;
  31892. /**
  31893. * Compute the time lapsed since the previous beginMonitoring() call.
  31894. * @param newFrame true by default to fetch the result and monitor a new frame, if false the time monitored will be added to the current frame counter
  31895. */
  31896. endMonitoring(newFrame?: boolean): void;
  31897. private _fetchResult;
  31898. private _startMonitoringTime;
  31899. private _min;
  31900. private _max;
  31901. private _average;
  31902. private _current;
  31903. private _totalValueCount;
  31904. private _totalAccumulated;
  31905. private _lastSecAverage;
  31906. private _lastSecAccumulated;
  31907. private _lastSecTime;
  31908. private _lastSecValueCount;
  31909. }
  31910. }
  31911. declare module "babylonjs/Engines/engine" {
  31912. import { Observable } from "babylonjs/Misc/observable";
  31913. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  31914. import { Scene } from "babylonjs/scene";
  31915. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  31916. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  31917. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  31918. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  31919. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  31920. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  31921. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  31922. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  31923. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  31924. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31925. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  31926. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  31927. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  31928. import { Material } from "babylonjs/Materials/material";
  31929. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  31930. /**
  31931. * Defines the interface used by display changed events
  31932. */
  31933. export interface IDisplayChangedEventArgs {
  31934. /** Gets the vrDisplay object (if any) */
  31935. vrDisplay: Nullable<any>;
  31936. /** Gets a boolean indicating if webVR is supported */
  31937. vrSupported: boolean;
  31938. }
  31939. /**
  31940. * Defines the interface used by objects containing a viewport (like a camera)
  31941. */
  31942. interface IViewportOwnerLike {
  31943. /**
  31944. * Gets or sets the viewport
  31945. */
  31946. viewport: IViewportLike;
  31947. }
  31948. /**
  31949. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  31950. */
  31951. export class Engine extends ThinEngine {
  31952. /** Defines that alpha blending is disabled */
  31953. static readonly ALPHA_DISABLE: number;
  31954. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  31955. static readonly ALPHA_ADD: number;
  31956. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  31957. static readonly ALPHA_COMBINE: number;
  31958. /** Defines that alpha blending to DEST - SRC * DEST */
  31959. static readonly ALPHA_SUBTRACT: number;
  31960. /** Defines that alpha blending to SRC * DEST */
  31961. static readonly ALPHA_MULTIPLY: number;
  31962. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  31963. static readonly ALPHA_MAXIMIZED: number;
  31964. /** Defines that alpha blending to SRC + DEST */
  31965. static readonly ALPHA_ONEONE: number;
  31966. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  31967. static readonly ALPHA_PREMULTIPLIED: number;
  31968. /**
  31969. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  31970. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  31971. */
  31972. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  31973. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  31974. static readonly ALPHA_INTERPOLATE: number;
  31975. /**
  31976. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  31977. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  31978. */
  31979. static readonly ALPHA_SCREENMODE: number;
  31980. /** Defines that the ressource is not delayed*/
  31981. static readonly DELAYLOADSTATE_NONE: number;
  31982. /** Defines that the ressource was successfully delay loaded */
  31983. static readonly DELAYLOADSTATE_LOADED: number;
  31984. /** Defines that the ressource is currently delay loading */
  31985. static readonly DELAYLOADSTATE_LOADING: number;
  31986. /** Defines that the ressource is delayed and has not started loading */
  31987. static readonly DELAYLOADSTATE_NOTLOADED: number;
  31988. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  31989. static readonly NEVER: number;
  31990. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  31991. static readonly ALWAYS: number;
  31992. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  31993. static readonly LESS: number;
  31994. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  31995. static readonly EQUAL: number;
  31996. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  31997. static readonly LEQUAL: number;
  31998. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  31999. static readonly GREATER: number;
  32000. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  32001. static readonly GEQUAL: number;
  32002. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  32003. static readonly NOTEQUAL: number;
  32004. /** Passed to stencilOperation to specify that stencil value must be kept */
  32005. static readonly KEEP: number;
  32006. /** Passed to stencilOperation to specify that stencil value must be replaced */
  32007. static readonly REPLACE: number;
  32008. /** Passed to stencilOperation to specify that stencil value must be incremented */
  32009. static readonly INCR: number;
  32010. /** Passed to stencilOperation to specify that stencil value must be decremented */
  32011. static readonly DECR: number;
  32012. /** Passed to stencilOperation to specify that stencil value must be inverted */
  32013. static readonly INVERT: number;
  32014. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  32015. static readonly INCR_WRAP: number;
  32016. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  32017. static readonly DECR_WRAP: number;
  32018. /** Texture is not repeating outside of 0..1 UVs */
  32019. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  32020. /** Texture is repeating outside of 0..1 UVs */
  32021. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  32022. /** Texture is repeating and mirrored */
  32023. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  32024. /** ALPHA */
  32025. static readonly TEXTUREFORMAT_ALPHA: number;
  32026. /** LUMINANCE */
  32027. static readonly TEXTUREFORMAT_LUMINANCE: number;
  32028. /** LUMINANCE_ALPHA */
  32029. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  32030. /** RGB */
  32031. static readonly TEXTUREFORMAT_RGB: number;
  32032. /** RGBA */
  32033. static readonly TEXTUREFORMAT_RGBA: number;
  32034. /** RED */
  32035. static readonly TEXTUREFORMAT_RED: number;
  32036. /** RED (2nd reference) */
  32037. static readonly TEXTUREFORMAT_R: number;
  32038. /** RG */
  32039. static readonly TEXTUREFORMAT_RG: number;
  32040. /** RED_INTEGER */
  32041. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  32042. /** RED_INTEGER (2nd reference) */
  32043. static readonly TEXTUREFORMAT_R_INTEGER: number;
  32044. /** RG_INTEGER */
  32045. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  32046. /** RGB_INTEGER */
  32047. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  32048. /** RGBA_INTEGER */
  32049. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  32050. /** UNSIGNED_BYTE */
  32051. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  32052. /** UNSIGNED_BYTE (2nd reference) */
  32053. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  32054. /** FLOAT */
  32055. static readonly TEXTURETYPE_FLOAT: number;
  32056. /** HALF_FLOAT */
  32057. static readonly TEXTURETYPE_HALF_FLOAT: number;
  32058. /** BYTE */
  32059. static readonly TEXTURETYPE_BYTE: number;
  32060. /** SHORT */
  32061. static readonly TEXTURETYPE_SHORT: number;
  32062. /** UNSIGNED_SHORT */
  32063. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  32064. /** INT */
  32065. static readonly TEXTURETYPE_INT: number;
  32066. /** UNSIGNED_INT */
  32067. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  32068. /** UNSIGNED_SHORT_4_4_4_4 */
  32069. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  32070. /** UNSIGNED_SHORT_5_5_5_1 */
  32071. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  32072. /** UNSIGNED_SHORT_5_6_5 */
  32073. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  32074. /** UNSIGNED_INT_2_10_10_10_REV */
  32075. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  32076. /** UNSIGNED_INT_24_8 */
  32077. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  32078. /** UNSIGNED_INT_10F_11F_11F_REV */
  32079. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  32080. /** UNSIGNED_INT_5_9_9_9_REV */
  32081. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  32082. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  32083. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  32084. /** nearest is mag = nearest and min = nearest and mip = linear */
  32085. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  32086. /** Bilinear is mag = linear and min = linear and mip = nearest */
  32087. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  32088. /** Trilinear is mag = linear and min = linear and mip = linear */
  32089. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  32090. /** nearest is mag = nearest and min = nearest and mip = linear */
  32091. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  32092. /** Bilinear is mag = linear and min = linear and mip = nearest */
  32093. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  32094. /** Trilinear is mag = linear and min = linear and mip = linear */
  32095. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  32096. /** mag = nearest and min = nearest and mip = nearest */
  32097. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  32098. /** mag = nearest and min = linear and mip = nearest */
  32099. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  32100. /** mag = nearest and min = linear and mip = linear */
  32101. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  32102. /** mag = nearest and min = linear and mip = none */
  32103. static readonly TEXTURE_NEAREST_LINEAR: number;
  32104. /** mag = nearest and min = nearest and mip = none */
  32105. static readonly TEXTURE_NEAREST_NEAREST: number;
  32106. /** mag = linear and min = nearest and mip = nearest */
  32107. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  32108. /** mag = linear and min = nearest and mip = linear */
  32109. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  32110. /** mag = linear and min = linear and mip = none */
  32111. static readonly TEXTURE_LINEAR_LINEAR: number;
  32112. /** mag = linear and min = nearest and mip = none */
  32113. static readonly TEXTURE_LINEAR_NEAREST: number;
  32114. /** Explicit coordinates mode */
  32115. static readonly TEXTURE_EXPLICIT_MODE: number;
  32116. /** Spherical coordinates mode */
  32117. static readonly TEXTURE_SPHERICAL_MODE: number;
  32118. /** Planar coordinates mode */
  32119. static readonly TEXTURE_PLANAR_MODE: number;
  32120. /** Cubic coordinates mode */
  32121. static readonly TEXTURE_CUBIC_MODE: number;
  32122. /** Projection coordinates mode */
  32123. static readonly TEXTURE_PROJECTION_MODE: number;
  32124. /** Skybox coordinates mode */
  32125. static readonly TEXTURE_SKYBOX_MODE: number;
  32126. /** Inverse Cubic coordinates mode */
  32127. static readonly TEXTURE_INVCUBIC_MODE: number;
  32128. /** Equirectangular coordinates mode */
  32129. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  32130. /** Equirectangular Fixed coordinates mode */
  32131. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  32132. /** Equirectangular Fixed Mirrored coordinates mode */
  32133. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  32134. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  32135. static readonly SCALEMODE_FLOOR: number;
  32136. /** Defines that texture rescaling will look for the nearest power of 2 size */
  32137. static readonly SCALEMODE_NEAREST: number;
  32138. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  32139. static readonly SCALEMODE_CEILING: number;
  32140. /**
  32141. * Returns the current npm package of the sdk
  32142. */
  32143. static readonly NpmPackage: string;
  32144. /**
  32145. * Returns the current version of the framework
  32146. */
  32147. static readonly Version: string;
  32148. /** Gets the list of created engines */
  32149. static readonly Instances: Engine[];
  32150. /**
  32151. * Gets the latest created engine
  32152. */
  32153. static readonly LastCreatedEngine: Nullable<Engine>;
  32154. /**
  32155. * Gets the latest created scene
  32156. */
  32157. static readonly LastCreatedScene: Nullable<Scene>;
  32158. /**
  32159. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  32160. * @param flag defines which part of the materials must be marked as dirty
  32161. * @param predicate defines a predicate used to filter which materials should be affected
  32162. */
  32163. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  32164. /**
  32165. * Method called to create the default loading screen.
  32166. * This can be overriden in your own app.
  32167. * @param canvas The rendering canvas element
  32168. * @returns The loading screen
  32169. */
  32170. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  32171. /**
  32172. * Method called to create the default rescale post process on each engine.
  32173. */
  32174. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  32175. /**
  32176. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  32177. **/
  32178. enableOfflineSupport: boolean;
  32179. /**
  32180. * Gets or sets a boolean to enable/disable checking manifest if IndexedDB support is enabled (js will always consider the database is up to date)
  32181. **/
  32182. disableManifestCheck: boolean;
  32183. /**
  32184. * Gets the list of created scenes
  32185. */
  32186. scenes: Scene[];
  32187. /**
  32188. * Event raised when a new scene is created
  32189. */
  32190. onNewSceneAddedObservable: Observable<Scene>;
  32191. /**
  32192. * Gets the list of created postprocesses
  32193. */
  32194. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  32195. /**
  32196. * Gets a boolean indicating if the pointer is currently locked
  32197. */
  32198. isPointerLock: boolean;
  32199. /**
  32200. * Observable event triggered each time the rendering canvas is resized
  32201. */
  32202. onResizeObservable: Observable<Engine>;
  32203. /**
  32204. * Observable event triggered each time the canvas loses focus
  32205. */
  32206. onCanvasBlurObservable: Observable<Engine>;
  32207. /**
  32208. * Observable event triggered each time the canvas gains focus
  32209. */
  32210. onCanvasFocusObservable: Observable<Engine>;
  32211. /**
  32212. * Observable event triggered each time the canvas receives pointerout event
  32213. */
  32214. onCanvasPointerOutObservable: Observable<PointerEvent>;
  32215. /**
  32216. * Observable raised when the engine begins a new frame
  32217. */
  32218. onBeginFrameObservable: Observable<Engine>;
  32219. /**
  32220. * If set, will be used to request the next animation frame for the render loop
  32221. */
  32222. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  32223. /**
  32224. * Observable raised when the engine ends the current frame
  32225. */
  32226. onEndFrameObservable: Observable<Engine>;
  32227. /**
  32228. * Observable raised when the engine is about to compile a shader
  32229. */
  32230. onBeforeShaderCompilationObservable: Observable<Engine>;
  32231. /**
  32232. * Observable raised when the engine has jsut compiled a shader
  32233. */
  32234. onAfterShaderCompilationObservable: Observable<Engine>;
  32235. /**
  32236. * Gets the audio engine
  32237. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  32238. * @ignorenaming
  32239. */
  32240. static audioEngine: IAudioEngine;
  32241. /**
  32242. * Default AudioEngine factory responsible of creating the Audio Engine.
  32243. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  32244. */
  32245. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  32246. /**
  32247. * Default offline support factory responsible of creating a tool used to store data locally.
  32248. * By default, this will create a Database object if the workload has been embedded.
  32249. */
  32250. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  32251. private _loadingScreen;
  32252. private _pointerLockRequested;
  32253. private _dummyFramebuffer;
  32254. private _rescalePostProcess;
  32255. /** @hidden */
  32256. protected _alphaMode: number;
  32257. /** @hidden */
  32258. protected _alphaEquation: number;
  32259. private _deterministicLockstep;
  32260. private _lockstepMaxSteps;
  32261. protected readonly _supportsHardwareTextureRescaling: boolean;
  32262. private _fps;
  32263. private _deltaTime;
  32264. /** @hidden */
  32265. _drawCalls: PerfCounter;
  32266. /**
  32267. * Turn this value on if you want to pause FPS computation when in background
  32268. */
  32269. disablePerformanceMonitorInBackground: boolean;
  32270. private _performanceMonitor;
  32271. /**
  32272. * Gets the performance monitor attached to this engine
  32273. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  32274. */
  32275. readonly performanceMonitor: PerformanceMonitor;
  32276. private _onFocus;
  32277. private _onBlur;
  32278. private _onCanvasPointerOut;
  32279. private _onCanvasBlur;
  32280. private _onCanvasFocus;
  32281. private _onFullscreenChange;
  32282. private _onPointerLockChange;
  32283. /**
  32284. * Creates a new engine
  32285. * @param canvasOrContext defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which alreay used the WebGL context
  32286. * @param antialias defines enable antialiasing (default: false)
  32287. * @param options defines further options to be sent to the getContext() function
  32288. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  32289. */
  32290. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  32291. /**
  32292. * Gets current aspect ratio
  32293. * @param viewportOwner defines the camera to use to get the aspect ratio
  32294. * @param useScreen defines if screen size must be used (or the current render target if any)
  32295. * @returns a number defining the aspect ratio
  32296. */
  32297. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  32298. /**
  32299. * Gets current screen aspect ratio
  32300. * @returns a number defining the aspect ratio
  32301. */
  32302. getScreenAspectRatio(): number;
  32303. /**
  32304. * Gets host document
  32305. * @returns the host document object
  32306. */
  32307. getHostDocument(): Document;
  32308. /**
  32309. * Gets the client rect of the HTML canvas attached with the current webGL context
  32310. * @returns a client rectanglee
  32311. */
  32312. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  32313. /**
  32314. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  32315. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  32316. * @returns true if engine is in deterministic lock step mode
  32317. */
  32318. isDeterministicLockStep(): boolean;
  32319. /**
  32320. * Gets the max steps when engine is running in deterministic lock step
  32321. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  32322. * @returns the max steps
  32323. */
  32324. getLockstepMaxSteps(): number;
  32325. /**
  32326. * Force the mipmap generation for the given render target texture
  32327. * @param texture defines the render target texture to use
  32328. */
  32329. generateMipMapsForCubemap(texture: InternalTexture): void;
  32330. /** States */
  32331. /**
  32332. * Set various states to the webGL context
  32333. * @param culling defines backface culling state
  32334. * @param zOffset defines the value to apply to zOffset (0 by default)
  32335. * @param force defines if states must be applied even if cache is up to date
  32336. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  32337. */
  32338. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  32339. /**
  32340. * Set the z offset to apply to current rendering
  32341. * @param value defines the offset to apply
  32342. */
  32343. setZOffset(value: number): void;
  32344. /**
  32345. * Gets the current value of the zOffset
  32346. * @returns the current zOffset state
  32347. */
  32348. getZOffset(): number;
  32349. /**
  32350. * Enable or disable depth buffering
  32351. * @param enable defines the state to set
  32352. */
  32353. setDepthBuffer(enable: boolean): void;
  32354. /**
  32355. * Gets a boolean indicating if depth writing is enabled
  32356. * @returns the current depth writing state
  32357. */
  32358. getDepthWrite(): boolean;
  32359. /**
  32360. * Enable or disable depth writing
  32361. * @param enable defines the state to set
  32362. */
  32363. setDepthWrite(enable: boolean): void;
  32364. /**
  32365. * Enable or disable color writing
  32366. * @param enable defines the state to set
  32367. */
  32368. setColorWrite(enable: boolean): void;
  32369. /**
  32370. * Gets a boolean indicating if color writing is enabled
  32371. * @returns the current color writing state
  32372. */
  32373. getColorWrite(): boolean;
  32374. /**
  32375. * Sets alpha constants used by some alpha blending modes
  32376. * @param r defines the red component
  32377. * @param g defines the green component
  32378. * @param b defines the blue component
  32379. * @param a defines the alpha component
  32380. */
  32381. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  32382. /**
  32383. * Sets the current alpha mode
  32384. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  32385. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  32386. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  32387. */
  32388. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  32389. /**
  32390. * Gets the current alpha mode
  32391. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  32392. * @returns the current alpha mode
  32393. */
  32394. getAlphaMode(): number;
  32395. /**
  32396. * Sets the current alpha equation
  32397. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  32398. */
  32399. setAlphaEquation(equation: number): void;
  32400. /**
  32401. * Gets the current alpha equation.
  32402. * @returns the current alpha equation
  32403. */
  32404. getAlphaEquation(): number;
  32405. /**
  32406. * Gets a boolean indicating if stencil buffer is enabled
  32407. * @returns the current stencil buffer state
  32408. */
  32409. getStencilBuffer(): boolean;
  32410. /**
  32411. * Enable or disable the stencil buffer
  32412. * @param enable defines if the stencil buffer must be enabled or disabled
  32413. */
  32414. setStencilBuffer(enable: boolean): void;
  32415. /**
  32416. * Gets the current stencil mask
  32417. * @returns a number defining the new stencil mask to use
  32418. */
  32419. getStencilMask(): number;
  32420. /**
  32421. * Sets the current stencil mask
  32422. * @param mask defines the new stencil mask to use
  32423. */
  32424. setStencilMask(mask: number): void;
  32425. /**
  32426. * Gets the current stencil function
  32427. * @returns a number defining the stencil function to use
  32428. */
  32429. getStencilFunction(): number;
  32430. /**
  32431. * Gets the current stencil reference value
  32432. * @returns a number defining the stencil reference value to use
  32433. */
  32434. getStencilFunctionReference(): number;
  32435. /**
  32436. * Gets the current stencil mask
  32437. * @returns a number defining the stencil mask to use
  32438. */
  32439. getStencilFunctionMask(): number;
  32440. /**
  32441. * Sets the current stencil function
  32442. * @param stencilFunc defines the new stencil function to use
  32443. */
  32444. setStencilFunction(stencilFunc: number): void;
  32445. /**
  32446. * Sets the current stencil reference
  32447. * @param reference defines the new stencil reference to use
  32448. */
  32449. setStencilFunctionReference(reference: number): void;
  32450. /**
  32451. * Sets the current stencil mask
  32452. * @param mask defines the new stencil mask to use
  32453. */
  32454. setStencilFunctionMask(mask: number): void;
  32455. /**
  32456. * Gets the current stencil operation when stencil fails
  32457. * @returns a number defining stencil operation to use when stencil fails
  32458. */
  32459. getStencilOperationFail(): number;
  32460. /**
  32461. * Gets the current stencil operation when depth fails
  32462. * @returns a number defining stencil operation to use when depth fails
  32463. */
  32464. getStencilOperationDepthFail(): number;
  32465. /**
  32466. * Gets the current stencil operation when stencil passes
  32467. * @returns a number defining stencil operation to use when stencil passes
  32468. */
  32469. getStencilOperationPass(): number;
  32470. /**
  32471. * Sets the stencil operation to use when stencil fails
  32472. * @param operation defines the stencil operation to use when stencil fails
  32473. */
  32474. setStencilOperationFail(operation: number): void;
  32475. /**
  32476. * Sets the stencil operation to use when depth fails
  32477. * @param operation defines the stencil operation to use when depth fails
  32478. */
  32479. setStencilOperationDepthFail(operation: number): void;
  32480. /**
  32481. * Sets the stencil operation to use when stencil passes
  32482. * @param operation defines the stencil operation to use when stencil passes
  32483. */
  32484. setStencilOperationPass(operation: number): void;
  32485. /**
  32486. * Sets a boolean indicating if the dithering state is enabled or disabled
  32487. * @param value defines the dithering state
  32488. */
  32489. setDitheringState(value: boolean): void;
  32490. /**
  32491. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  32492. * @param value defines the rasterizer state
  32493. */
  32494. setRasterizerState(value: boolean): void;
  32495. /**
  32496. * Gets the current depth function
  32497. * @returns a number defining the depth function
  32498. */
  32499. getDepthFunction(): Nullable<number>;
  32500. /**
  32501. * Sets the current depth function
  32502. * @param depthFunc defines the function to use
  32503. */
  32504. setDepthFunction(depthFunc: number): void;
  32505. /**
  32506. * Sets the current depth function to GREATER
  32507. */
  32508. setDepthFunctionToGreater(): void;
  32509. /**
  32510. * Sets the current depth function to GEQUAL
  32511. */
  32512. setDepthFunctionToGreaterOrEqual(): void;
  32513. /**
  32514. * Sets the current depth function to LESS
  32515. */
  32516. setDepthFunctionToLess(): void;
  32517. /**
  32518. * Sets the current depth function to LEQUAL
  32519. */
  32520. setDepthFunctionToLessOrEqual(): void;
  32521. private _cachedStencilBuffer;
  32522. private _cachedStencilFunction;
  32523. private _cachedStencilMask;
  32524. private _cachedStencilOperationPass;
  32525. private _cachedStencilOperationFail;
  32526. private _cachedStencilOperationDepthFail;
  32527. private _cachedStencilReference;
  32528. /**
  32529. * Caches the the state of the stencil buffer
  32530. */
  32531. cacheStencilState(): void;
  32532. /**
  32533. * Restores the state of the stencil buffer
  32534. */
  32535. restoreStencilState(): void;
  32536. /**
  32537. * Directly set the WebGL Viewport
  32538. * @param x defines the x coordinate of the viewport (in screen space)
  32539. * @param y defines the y coordinate of the viewport (in screen space)
  32540. * @param width defines the width of the viewport (in screen space)
  32541. * @param height defines the height of the viewport (in screen space)
  32542. * @return the current viewport Object (if any) that is being replaced by this call. You can restore this viewport later on to go back to the original state
  32543. */
  32544. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  32545. /**
  32546. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  32547. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  32548. * @param y defines the y-coordinate of the corner of the clear rectangle
  32549. * @param width defines the width of the clear rectangle
  32550. * @param height defines the height of the clear rectangle
  32551. * @param clearColor defines the clear color
  32552. */
  32553. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  32554. /**
  32555. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  32556. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  32557. * @param y defines the y-coordinate of the corner of the clear rectangle
  32558. * @param width defines the width of the clear rectangle
  32559. * @param height defines the height of the clear rectangle
  32560. */
  32561. enableScissor(x: number, y: number, width: number, height: number): void;
  32562. /**
  32563. * Disable previously set scissor test rectangle
  32564. */
  32565. disableScissor(): void;
  32566. protected _reportDrawCall(): void;
  32567. /**
  32568. * Initializes a webVR display and starts listening to display change events
  32569. * The onVRDisplayChangedObservable will be notified upon these changes
  32570. * @returns The onVRDisplayChangedObservable
  32571. */
  32572. initWebVR(): Observable<IDisplayChangedEventArgs>;
  32573. /** @hidden */
  32574. _prepareVRComponent(): void;
  32575. /** @hidden */
  32576. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  32577. /** @hidden */
  32578. _submitVRFrame(): void;
  32579. /**
  32580. * Call this function to leave webVR mode
  32581. * Will do nothing if webVR is not supported or if there is no webVR device
  32582. * @see http://doc.babylonjs.com/how_to/webvr_camera
  32583. */
  32584. disableVR(): void;
  32585. /**
  32586. * Gets a boolean indicating that the system is in VR mode and is presenting
  32587. * @returns true if VR mode is engaged
  32588. */
  32589. isVRPresenting(): boolean;
  32590. /** @hidden */
  32591. _requestVRFrame(): void;
  32592. /** @hidden */
  32593. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  32594. /**
  32595. * Gets the source code of the vertex shader associated with a specific webGL program
  32596. * @param program defines the program to use
  32597. * @returns a string containing the source code of the vertex shader associated with the program
  32598. */
  32599. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  32600. /**
  32601. * Gets the source code of the fragment shader associated with a specific webGL program
  32602. * @param program defines the program to use
  32603. * @returns a string containing the source code of the fragment shader associated with the program
  32604. */
  32605. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  32606. /**
  32607. * Reads pixels from the current frame buffer. Please note that this function can be slow
  32608. * @param x defines the x coordinate of the rectangle where pixels must be read
  32609. * @param y defines the y coordinate of the rectangle where pixels must be read
  32610. * @param width defines the width of the rectangle where pixels must be read
  32611. * @param height defines the height of the rectangle where pixels must be read
  32612. * @returns a Uint8Array containing RGBA colors
  32613. */
  32614. readPixels(x: number, y: number, width: number, height: number): Uint8Array;
  32615. /**
  32616. * Sets a depth stencil texture from a render target to the according uniform.
  32617. * @param channel The texture channel
  32618. * @param uniform The uniform to set
  32619. * @param texture The render target texture containing the depth stencil texture to apply
  32620. */
  32621. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  32622. /**
  32623. * Sets a texture to the webGL context from a postprocess
  32624. * @param channel defines the channel to use
  32625. * @param postProcess defines the source postprocess
  32626. */
  32627. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  32628. /**
  32629. * Binds the output of the passed in post process to the texture channel specified
  32630. * @param channel The channel the texture should be bound to
  32631. * @param postProcess The post process which's output should be bound
  32632. */
  32633. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  32634. /** @hidden */
  32635. _convertRGBtoRGBATextureData(rgbData: any, width: number, height: number, textureType: number): ArrayBufferView;
  32636. protected _rebuildBuffers(): void;
  32637. _renderLoop(): void;
  32638. /**
  32639. * Toggle full screen mode
  32640. * @param requestPointerLock defines if a pointer lock should be requested from the user
  32641. */
  32642. switchFullscreen(requestPointerLock: boolean): void;
  32643. /**
  32644. * Enters full screen mode
  32645. * @param requestPointerLock defines if a pointer lock should be requested from the user
  32646. */
  32647. enterFullscreen(requestPointerLock: boolean): void;
  32648. /**
  32649. * Exits full screen mode
  32650. */
  32651. exitFullscreen(): void;
  32652. /**
  32653. * Enters Pointerlock mode
  32654. */
  32655. enterPointerlock(): void;
  32656. /**
  32657. * Exits Pointerlock mode
  32658. */
  32659. exitPointerlock(): void;
  32660. /**
  32661. * Begin a new frame
  32662. */
  32663. beginFrame(): void;
  32664. /**
  32665. * Enf the current frame
  32666. */
  32667. endFrame(): void;
  32668. resize(): void;
  32669. /**
  32670. * Set the compressed texture format to use, based on the formats you have, and the formats
  32671. * supported by the hardware / browser.
  32672. *
  32673. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  32674. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  32675. * to API arguments needed to compressed textures. This puts the burden on the container
  32676. * generator to house the arcane code for determining these for current & future formats.
  32677. *
  32678. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  32679. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  32680. *
  32681. * Note: The result of this call is not taken into account when a texture is base64.
  32682. *
  32683. * @param formatsAvailable defines the list of those format families you have created
  32684. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  32685. *
  32686. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  32687. * @returns The extension selected.
  32688. */
  32689. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  32690. /**
  32691. * Force a specific size of the canvas
  32692. * @param width defines the new canvas' width
  32693. * @param height defines the new canvas' height
  32694. */
  32695. setSize(width: number, height: number): void;
  32696. /**
  32697. * Updates a dynamic vertex buffer.
  32698. * @param vertexBuffer the vertex buffer to update
  32699. * @param data the data used to update the vertex buffer
  32700. * @param byteOffset the byte offset of the data
  32701. * @param byteLength the byte length of the data
  32702. */
  32703. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  32704. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  32705. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  32706. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  32707. _releaseTexture(texture: InternalTexture): void;
  32708. /**
  32709. * @hidden
  32710. * Rescales a texture
  32711. * @param source input texutre
  32712. * @param destination destination texture
  32713. * @param scene scene to use to render the resize
  32714. * @param internalFormat format to use when resizing
  32715. * @param onComplete callback to be called when resize has completed
  32716. */
  32717. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  32718. /**
  32719. * Gets the current framerate
  32720. * @returns a number representing the framerate
  32721. */
  32722. getFps(): number;
  32723. /**
  32724. * Gets the time spent between current and previous frame
  32725. * @returns a number representing the delta time in ms
  32726. */
  32727. getDeltaTime(): number;
  32728. private _measureFps;
  32729. /** @hidden */
  32730. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  32731. /**
  32732. * Sets the frame buffer Depth / Stencil attachement of the render target to the defined depth stencil texture.
  32733. * @param renderTarget The render target to set the frame buffer for
  32734. */
  32735. setFrameBufferDepthStencilTexture(renderTarget: RenderTargetTexture): void;
  32736. /**
  32737. * Update a dynamic index buffer
  32738. * @param indexBuffer defines the target index buffer
  32739. * @param indices defines the data to update
  32740. * @param offset defines the offset in the target index buffer where update should start
  32741. */
  32742. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  32743. /**
  32744. * Updates the sample count of a render target texture
  32745. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  32746. * @param texture defines the texture to update
  32747. * @param samples defines the sample count to set
  32748. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  32749. */
  32750. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  32751. /**
  32752. * Updates a depth texture Comparison Mode and Function.
  32753. * If the comparison Function is equal to 0, the mode will be set to none.
  32754. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  32755. * @param texture The texture to set the comparison function for
  32756. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  32757. */
  32758. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  32759. /**
  32760. * Creates a webGL buffer to use with instanciation
  32761. * @param capacity defines the size of the buffer
  32762. * @returns the webGL buffer
  32763. */
  32764. createInstancesBuffer(capacity: number): DataBuffer;
  32765. /**
  32766. * Delete a webGL buffer used with instanciation
  32767. * @param buffer defines the webGL buffer to delete
  32768. */
  32769. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  32770. /** @hidden */
  32771. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  32772. dispose(): void;
  32773. private _disableTouchAction;
  32774. /**
  32775. * Display the loading screen
  32776. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32777. */
  32778. displayLoadingUI(): void;
  32779. /**
  32780. * Hide the loading screen
  32781. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32782. */
  32783. hideLoadingUI(): void;
  32784. /**
  32785. * Gets the current loading screen object
  32786. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32787. */
  32788. /**
  32789. * Sets the current loading screen object
  32790. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32791. */
  32792. loadingScreen: ILoadingScreen;
  32793. /**
  32794. * Sets the current loading screen text
  32795. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32796. */
  32797. loadingUIText: string;
  32798. /**
  32799. * Sets the current loading screen background color
  32800. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32801. */
  32802. loadingUIBackgroundColor: string;
  32803. /** Pointerlock and fullscreen */
  32804. /**
  32805. * Ask the browser to promote the current element to pointerlock mode
  32806. * @param element defines the DOM element to promote
  32807. */
  32808. static _RequestPointerlock(element: HTMLElement): void;
  32809. /**
  32810. * Asks the browser to exit pointerlock mode
  32811. */
  32812. static _ExitPointerlock(): void;
  32813. /**
  32814. * Ask the browser to promote the current element to fullscreen rendering mode
  32815. * @param element defines the DOM element to promote
  32816. */
  32817. static _RequestFullscreen(element: HTMLElement): void;
  32818. /**
  32819. * Asks the browser to exit fullscreen mode
  32820. */
  32821. static _ExitFullscreen(): void;
  32822. }
  32823. }
  32824. declare module "babylonjs/Engines/engineStore" {
  32825. import { Nullable } from "babylonjs/types";
  32826. import { Engine } from "babylonjs/Engines/engine";
  32827. import { Scene } from "babylonjs/scene";
  32828. /**
  32829. * The engine store class is responsible to hold all the instances of Engine and Scene created
  32830. * during the life time of the application.
  32831. */
  32832. export class EngineStore {
  32833. /** Gets the list of created engines */
  32834. static Instances: import("babylonjs/Engines/engine").Engine[];
  32835. /** @hidden */
  32836. static _LastCreatedScene: Nullable<Scene>;
  32837. /**
  32838. * Gets the latest created engine
  32839. */
  32840. static readonly LastCreatedEngine: Nullable<Engine>;
  32841. /**
  32842. * Gets the latest created scene
  32843. */
  32844. static readonly LastCreatedScene: Nullable<Scene>;
  32845. /**
  32846. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  32847. * @ignorenaming
  32848. */
  32849. static UseFallbackTexture: boolean;
  32850. /**
  32851. * Texture content used if a texture cannot loaded
  32852. * @ignorenaming
  32853. */
  32854. static FallbackTexture: string;
  32855. }
  32856. }
  32857. declare module "babylonjs/Misc/promise" {
  32858. /**
  32859. * Helper class that provides a small promise polyfill
  32860. */
  32861. export class PromisePolyfill {
  32862. /**
  32863. * Static function used to check if the polyfill is required
  32864. * If this is the case then the function will inject the polyfill to window.Promise
  32865. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  32866. */
  32867. static Apply(force?: boolean): void;
  32868. }
  32869. }
  32870. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  32871. /**
  32872. * Interface for screenshot methods with describe argument called `size` as object with options
  32873. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  32874. */
  32875. export interface IScreenshotSize {
  32876. /**
  32877. * number in pixels for canvas height
  32878. */
  32879. height?: number;
  32880. /**
  32881. * multiplier allowing render at a higher or lower resolution
  32882. * If value is defined then height and width will be ignored and taken from camera
  32883. */
  32884. precision?: number;
  32885. /**
  32886. * number in pixels for canvas width
  32887. */
  32888. width?: number;
  32889. }
  32890. }
  32891. declare module "babylonjs/Misc/tools" {
  32892. import { Nullable, float } from "babylonjs/types";
  32893. import { DomManagement } from "babylonjs/Misc/domManagement";
  32894. import { WebRequest } from "babylonjs/Misc/webRequest";
  32895. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  32896. import { ReadFileError } from "babylonjs/Misc/fileTools";
  32897. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  32898. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  32899. import { Camera } from "babylonjs/Cameras/camera";
  32900. import { Engine } from "babylonjs/Engines/engine";
  32901. interface IColor4Like {
  32902. r: float;
  32903. g: float;
  32904. b: float;
  32905. a: float;
  32906. }
  32907. /**
  32908. * Class containing a set of static utilities functions
  32909. */
  32910. export class Tools {
  32911. /**
  32912. * Gets or sets the base URL to use to load assets
  32913. */
  32914. static BaseUrl: string;
  32915. /**
  32916. * Enable/Disable Custom HTTP Request Headers globally.
  32917. * default = false
  32918. * @see CustomRequestHeaders
  32919. */
  32920. static UseCustomRequestHeaders: boolean;
  32921. /**
  32922. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  32923. * i.e. when loading files, where the server/service expects an Authorization header
  32924. */
  32925. static CustomRequestHeaders: {
  32926. [key: string]: string;
  32927. };
  32928. /**
  32929. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  32930. */
  32931. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  32932. /**
  32933. * Default behaviour for cors in the application.
  32934. * It can be a string if the expected behavior is identical in the entire app.
  32935. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  32936. */
  32937. static CorsBehavior: string | ((url: string | string[]) => string);
  32938. /**
  32939. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  32940. * @ignorenaming
  32941. */
  32942. static UseFallbackTexture: boolean;
  32943. /**
  32944. * Use this object to register external classes like custom textures or material
  32945. * to allow the laoders to instantiate them
  32946. */
  32947. static RegisteredExternalClasses: {
  32948. [key: string]: Object;
  32949. };
  32950. /**
  32951. * Texture content used if a texture cannot loaded
  32952. * @ignorenaming
  32953. */
  32954. static fallbackTexture: string;
  32955. /**
  32956. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  32957. * @param u defines the coordinate on X axis
  32958. * @param v defines the coordinate on Y axis
  32959. * @param width defines the width of the source data
  32960. * @param height defines the height of the source data
  32961. * @param pixels defines the source byte array
  32962. * @param color defines the output color
  32963. */
  32964. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  32965. /**
  32966. * Interpolates between a and b via alpha
  32967. * @param a The lower value (returned when alpha = 0)
  32968. * @param b The upper value (returned when alpha = 1)
  32969. * @param alpha The interpolation-factor
  32970. * @return The mixed value
  32971. */
  32972. static Mix(a: number, b: number, alpha: number): number;
  32973. /**
  32974. * Tries to instantiate a new object from a given class name
  32975. * @param className defines the class name to instantiate
  32976. * @returns the new object or null if the system was not able to do the instantiation
  32977. */
  32978. static Instantiate(className: string): any;
  32979. /**
  32980. * Provides a slice function that will work even on IE
  32981. * @param data defines the array to slice
  32982. * @param start defines the start of the data (optional)
  32983. * @param end defines the end of the data (optional)
  32984. * @returns the new sliced array
  32985. */
  32986. static Slice<T>(data: T, start?: number, end?: number): T;
  32987. /**
  32988. * Polyfill for setImmediate
  32989. * @param action defines the action to execute after the current execution block
  32990. */
  32991. static SetImmediate(action: () => void): void;
  32992. /**
  32993. * Function indicating if a number is an exponent of 2
  32994. * @param value defines the value to test
  32995. * @returns true if the value is an exponent of 2
  32996. */
  32997. static IsExponentOfTwo(value: number): boolean;
  32998. private static _tmpFloatArray;
  32999. /**
  33000. * Returns the nearest 32-bit single precision float representation of a Number
  33001. * @param value A Number. If the parameter is of a different type, it will get converted
  33002. * to a number or to NaN if it cannot be converted
  33003. * @returns number
  33004. */
  33005. static FloatRound(value: number): number;
  33006. /**
  33007. * Extracts the filename from a path
  33008. * @param path defines the path to use
  33009. * @returns the filename
  33010. */
  33011. static GetFilename(path: string): string;
  33012. /**
  33013. * Extracts the "folder" part of a path (everything before the filename).
  33014. * @param uri The URI to extract the info from
  33015. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  33016. * @returns The "folder" part of the path
  33017. */
  33018. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  33019. /**
  33020. * Extracts text content from a DOM element hierarchy
  33021. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  33022. */
  33023. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  33024. /**
  33025. * Convert an angle in radians to degrees
  33026. * @param angle defines the angle to convert
  33027. * @returns the angle in degrees
  33028. */
  33029. static ToDegrees(angle: number): number;
  33030. /**
  33031. * Convert an angle in degrees to radians
  33032. * @param angle defines the angle to convert
  33033. * @returns the angle in radians
  33034. */
  33035. static ToRadians(angle: number): number;
  33036. /**
  33037. * Returns an array if obj is not an array
  33038. * @param obj defines the object to evaluate as an array
  33039. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  33040. * @returns either obj directly if obj is an array or a new array containing obj
  33041. */
  33042. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  33043. /**
  33044. * Gets the pointer prefix to use
  33045. * @returns "pointer" if touch is enabled. Else returns "mouse"
  33046. */
  33047. static GetPointerPrefix(): string;
  33048. /**
  33049. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  33050. * @param url define the url we are trying
  33051. * @param element define the dom element where to configure the cors policy
  33052. */
  33053. static SetCorsBehavior(url: string | string[], element: {
  33054. crossOrigin: string | null;
  33055. }): void;
  33056. /**
  33057. * Removes unwanted characters from an url
  33058. * @param url defines the url to clean
  33059. * @returns the cleaned url
  33060. */
  33061. static CleanUrl(url: string): string;
  33062. /**
  33063. * Gets or sets a function used to pre-process url before using them to load assets
  33064. */
  33065. static PreprocessUrl: (url: string) => string;
  33066. /**
  33067. * Loads an image as an HTMLImageElement.
  33068. * @param input url string, ArrayBuffer, or Blob to load
  33069. * @param onLoad callback called when the image successfully loads
  33070. * @param onError callback called when the image fails to load
  33071. * @param offlineProvider offline provider for caching
  33072. * @param mimeType optional mime type
  33073. * @returns the HTMLImageElement of the loaded image
  33074. */
  33075. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  33076. /**
  33077. * Loads a file from a url
  33078. * @param url url string, ArrayBuffer, or Blob to load
  33079. * @param onSuccess callback called when the file successfully loads
  33080. * @param onProgress callback called while file is loading (if the server supports this mode)
  33081. * @param offlineProvider defines the offline provider for caching
  33082. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  33083. * @param onError callback called when the file fails to load
  33084. * @returns a file request object
  33085. */
  33086. 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;
  33087. /**
  33088. * Loads a file from a url
  33089. * @param url the file url to load
  33090. * @returns a promise containing an ArrayBuffer corrisponding to the loaded file
  33091. */
  33092. static LoadFileAsync(url: string): Promise<ArrayBuffer>;
  33093. /**
  33094. * Load a script (identified by an url). When the url returns, the
  33095. * content of this file is added into a new script element, attached to the DOM (body element)
  33096. * @param scriptUrl defines the url of the script to laod
  33097. * @param onSuccess defines the callback called when the script is loaded
  33098. * @param onError defines the callback to call if an error occurs
  33099. * @param scriptId defines the id of the script element
  33100. */
  33101. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  33102. /**
  33103. * Load an asynchronous script (identified by an url). When the url returns, the
  33104. * content of this file is added into a new script element, attached to the DOM (body element)
  33105. * @param scriptUrl defines the url of the script to laod
  33106. * @param scriptId defines the id of the script element
  33107. * @returns a promise request object
  33108. */
  33109. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<boolean>;
  33110. /**
  33111. * Loads a file from a blob
  33112. * @param fileToLoad defines the blob to use
  33113. * @param callback defines the callback to call when data is loaded
  33114. * @param progressCallback defines the callback to call during loading process
  33115. * @returns a file request object
  33116. */
  33117. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  33118. /**
  33119. * Reads a file from a File object
  33120. * @param file defines the file to load
  33121. * @param onSuccess defines the callback to call when data is loaded
  33122. * @param onProgress defines the callback to call during loading process
  33123. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  33124. * @param onError defines the callback to call when an error occurs
  33125. * @returns a file request object
  33126. */
  33127. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  33128. /**
  33129. * Creates a data url from a given string content
  33130. * @param content defines the content to convert
  33131. * @returns the new data url link
  33132. */
  33133. static FileAsURL(content: string): string;
  33134. /**
  33135. * Format the given number to a specific decimal format
  33136. * @param value defines the number to format
  33137. * @param decimals defines the number of decimals to use
  33138. * @returns the formatted string
  33139. */
  33140. static Format(value: number, decimals?: number): string;
  33141. /**
  33142. * Tries to copy an object by duplicating every property
  33143. * @param source defines the source object
  33144. * @param destination defines the target object
  33145. * @param doNotCopyList defines a list of properties to avoid
  33146. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  33147. */
  33148. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  33149. /**
  33150. * Gets a boolean indicating if the given object has no own property
  33151. * @param obj defines the object to test
  33152. * @returns true if object has no own property
  33153. */
  33154. static IsEmpty(obj: any): boolean;
  33155. /**
  33156. * Function used to register events at window level
  33157. * @param windowElement defines the Window object to use
  33158. * @param events defines the events to register
  33159. */
  33160. static RegisterTopRootEvents(windowElement: Window, events: {
  33161. name: string;
  33162. handler: Nullable<(e: FocusEvent) => any>;
  33163. }[]): void;
  33164. /**
  33165. * Function used to unregister events from window level
  33166. * @param windowElement defines the Window object to use
  33167. * @param events defines the events to unregister
  33168. */
  33169. static UnregisterTopRootEvents(windowElement: Window, events: {
  33170. name: string;
  33171. handler: Nullable<(e: FocusEvent) => any>;
  33172. }[]): void;
  33173. /**
  33174. * @ignore
  33175. */
  33176. static _ScreenshotCanvas: HTMLCanvasElement;
  33177. /**
  33178. * Dumps the current bound framebuffer
  33179. * @param width defines the rendering width
  33180. * @param height defines the rendering height
  33181. * @param engine defines the hosting engine
  33182. * @param successCallback defines the callback triggered once the data are available
  33183. * @param mimeType defines the mime type of the result
  33184. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  33185. */
  33186. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  33187. /**
  33188. * Converts the canvas data to blob.
  33189. * This acts as a polyfill for browsers not supporting the to blob function.
  33190. * @param canvas Defines the canvas to extract the data from
  33191. * @param successCallback Defines the callback triggered once the data are available
  33192. * @param mimeType Defines the mime type of the result
  33193. */
  33194. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  33195. /**
  33196. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  33197. * @param successCallback defines the callback triggered once the data are available
  33198. * @param mimeType defines the mime type of the result
  33199. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  33200. */
  33201. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  33202. /**
  33203. * Downloads a blob in the browser
  33204. * @param blob defines the blob to download
  33205. * @param fileName defines the name of the downloaded file
  33206. */
  33207. static Download(blob: Blob, fileName: string): void;
  33208. /**
  33209. * Captures a screenshot of the current rendering
  33210. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33211. * @param engine defines the rendering engine
  33212. * @param camera defines the source camera
  33213. * @param size This parameter can be set to a single number or to an object with the
  33214. * following (optional) properties: precision, width, height. If a single number is passed,
  33215. * it will be used for both width and height. If an object is passed, the screenshot size
  33216. * will be derived from the parameters. The precision property is a multiplier allowing
  33217. * rendering at a higher or lower resolution
  33218. * @param successCallback defines the callback receives a single parameter which contains the
  33219. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  33220. * src parameter of an <img> to display it
  33221. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  33222. * Check your browser for supported MIME types
  33223. */
  33224. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  33225. /**
  33226. * Captures a screenshot of the current rendering
  33227. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33228. * @param engine defines the rendering engine
  33229. * @param camera defines the source camera
  33230. * @param size This parameter can be set to a single number or to an object with the
  33231. * following (optional) properties: precision, width, height. If a single number is passed,
  33232. * it will be used for both width and height. If an object is passed, the screenshot size
  33233. * will be derived from the parameters. The precision property is a multiplier allowing
  33234. * rendering at a higher or lower resolution
  33235. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  33236. * Check your browser for supported MIME types
  33237. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  33238. * to the src parameter of an <img> to display it
  33239. */
  33240. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  33241. /**
  33242. * Generates an image screenshot from the specified camera.
  33243. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33244. * @param engine The engine to use for rendering
  33245. * @param camera The camera to use for rendering
  33246. * @param size This parameter can be set to a single number or to an object with the
  33247. * following (optional) properties: precision, width, height. If a single number is passed,
  33248. * it will be used for both width and height. If an object is passed, the screenshot size
  33249. * will be derived from the parameters. The precision property is a multiplier allowing
  33250. * rendering at a higher or lower resolution
  33251. * @param successCallback The callback receives a single parameter which contains the
  33252. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  33253. * src parameter of an <img> to display it
  33254. * @param mimeType The MIME type of the screenshot image (default: image/png).
  33255. * Check your browser for supported MIME types
  33256. * @param samples Texture samples (default: 1)
  33257. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  33258. * @param fileName A name for for the downloaded file.
  33259. */
  33260. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  33261. /**
  33262. * Generates an image screenshot from the specified camera.
  33263. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33264. * @param engine The engine to use for rendering
  33265. * @param camera The camera to use for rendering
  33266. * @param size This parameter can be set to a single number or to an object with the
  33267. * following (optional) properties: precision, width, height. If a single number is passed,
  33268. * it will be used for both width and height. If an object is passed, the screenshot size
  33269. * will be derived from the parameters. The precision property is a multiplier allowing
  33270. * rendering at a higher or lower resolution
  33271. * @param mimeType The MIME type of the screenshot image (default: image/png).
  33272. * Check your browser for supported MIME types
  33273. * @param samples Texture samples (default: 1)
  33274. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  33275. * @param fileName A name for for the downloaded file.
  33276. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  33277. * to the src parameter of an <img> to display it
  33278. */
  33279. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  33280. /**
  33281. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  33282. * Be aware Math.random() could cause collisions, but:
  33283. * "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"
  33284. * @returns a pseudo random id
  33285. */
  33286. static RandomId(): string;
  33287. /**
  33288. * Test if the given uri is a base64 string
  33289. * @param uri The uri to test
  33290. * @return True if the uri is a base64 string or false otherwise
  33291. */
  33292. static IsBase64(uri: string): boolean;
  33293. /**
  33294. * Decode the given base64 uri.
  33295. * @param uri The uri to decode
  33296. * @return The decoded base64 data.
  33297. */
  33298. static DecodeBase64(uri: string): ArrayBuffer;
  33299. /**
  33300. * Gets the absolute url.
  33301. * @param url the input url
  33302. * @return the absolute url
  33303. */
  33304. static GetAbsoluteUrl(url: string): string;
  33305. /**
  33306. * No log
  33307. */
  33308. static readonly NoneLogLevel: number;
  33309. /**
  33310. * Only message logs
  33311. */
  33312. static readonly MessageLogLevel: number;
  33313. /**
  33314. * Only warning logs
  33315. */
  33316. static readonly WarningLogLevel: number;
  33317. /**
  33318. * Only error logs
  33319. */
  33320. static readonly ErrorLogLevel: number;
  33321. /**
  33322. * All logs
  33323. */
  33324. static readonly AllLogLevel: number;
  33325. /**
  33326. * Gets a value indicating the number of loading errors
  33327. * @ignorenaming
  33328. */
  33329. static readonly errorsCount: number;
  33330. /**
  33331. * Callback called when a new log is added
  33332. */
  33333. static OnNewCacheEntry: (entry: string) => void;
  33334. /**
  33335. * Log a message to the console
  33336. * @param message defines the message to log
  33337. */
  33338. static Log(message: string): void;
  33339. /**
  33340. * Write a warning message to the console
  33341. * @param message defines the message to log
  33342. */
  33343. static Warn(message: string): void;
  33344. /**
  33345. * Write an error message to the console
  33346. * @param message defines the message to log
  33347. */
  33348. static Error(message: string): void;
  33349. /**
  33350. * Gets current log cache (list of logs)
  33351. */
  33352. static readonly LogCache: string;
  33353. /**
  33354. * Clears the log cache
  33355. */
  33356. static ClearLogCache(): void;
  33357. /**
  33358. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  33359. */
  33360. static LogLevels: number;
  33361. /**
  33362. * Checks if the window object exists
  33363. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  33364. */
  33365. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  33366. /**
  33367. * No performance log
  33368. */
  33369. static readonly PerformanceNoneLogLevel: number;
  33370. /**
  33371. * Use user marks to log performance
  33372. */
  33373. static readonly PerformanceUserMarkLogLevel: number;
  33374. /**
  33375. * Log performance to the console
  33376. */
  33377. static readonly PerformanceConsoleLogLevel: number;
  33378. private static _performance;
  33379. /**
  33380. * Sets the current performance log level
  33381. */
  33382. static PerformanceLogLevel: number;
  33383. private static _StartPerformanceCounterDisabled;
  33384. private static _EndPerformanceCounterDisabled;
  33385. private static _StartUserMark;
  33386. private static _EndUserMark;
  33387. private static _StartPerformanceConsole;
  33388. private static _EndPerformanceConsole;
  33389. /**
  33390. * Starts a performance counter
  33391. */
  33392. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  33393. /**
  33394. * Ends a specific performance coutner
  33395. */
  33396. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  33397. /**
  33398. * Gets either window.performance.now() if supported or Date.now() else
  33399. */
  33400. static readonly Now: number;
  33401. /**
  33402. * This method will return the name of the class used to create the instance of the given object.
  33403. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  33404. * @param object the object to get the class name from
  33405. * @param isType defines if the object is actually a type
  33406. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  33407. */
  33408. static GetClassName(object: any, isType?: boolean): string;
  33409. /**
  33410. * Gets the first element of an array satisfying a given predicate
  33411. * @param array defines the array to browse
  33412. * @param predicate defines the predicate to use
  33413. * @returns null if not found or the element
  33414. */
  33415. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  33416. /**
  33417. * This method will return the name of the full name of the class, including its owning module (if any).
  33418. * 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).
  33419. * @param object the object to get the class name from
  33420. * @param isType defines if the object is actually a type
  33421. * @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.
  33422. * @ignorenaming
  33423. */
  33424. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  33425. /**
  33426. * Returns a promise that resolves after the given amount of time.
  33427. * @param delay Number of milliseconds to delay
  33428. * @returns Promise that resolves after the given amount of time
  33429. */
  33430. static DelayAsync(delay: number): Promise<void>;
  33431. }
  33432. /**
  33433. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  33434. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  33435. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  33436. * @param name The name of the class, case should be preserved
  33437. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  33438. */
  33439. export function className(name: string, module?: string): (target: Object) => void;
  33440. /**
  33441. * An implementation of a loop for asynchronous functions.
  33442. */
  33443. export class AsyncLoop {
  33444. /**
  33445. * Defines the number of iterations for the loop
  33446. */
  33447. iterations: number;
  33448. /**
  33449. * Defines the current index of the loop.
  33450. */
  33451. index: number;
  33452. private _done;
  33453. private _fn;
  33454. private _successCallback;
  33455. /**
  33456. * Constructor.
  33457. * @param iterations the number of iterations.
  33458. * @param func the function to run each iteration
  33459. * @param successCallback the callback that will be called upon succesful execution
  33460. * @param offset starting offset.
  33461. */
  33462. constructor(
  33463. /**
  33464. * Defines the number of iterations for the loop
  33465. */
  33466. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  33467. /**
  33468. * Execute the next iteration. Must be called after the last iteration was finished.
  33469. */
  33470. executeNext(): void;
  33471. /**
  33472. * Break the loop and run the success callback.
  33473. */
  33474. breakLoop(): void;
  33475. /**
  33476. * Create and run an async loop.
  33477. * @param iterations the number of iterations.
  33478. * @param fn the function to run each iteration
  33479. * @param successCallback the callback that will be called upon succesful execution
  33480. * @param offset starting offset.
  33481. * @returns the created async loop object
  33482. */
  33483. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  33484. /**
  33485. * A for-loop that will run a given number of iterations synchronous and the rest async.
  33486. * @param iterations total number of iterations
  33487. * @param syncedIterations number of synchronous iterations in each async iteration.
  33488. * @param fn the function to call each iteration.
  33489. * @param callback a success call back that will be called when iterating stops.
  33490. * @param breakFunction a break condition (optional)
  33491. * @param timeout timeout settings for the setTimeout function. default - 0.
  33492. * @returns the created async loop object
  33493. */
  33494. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  33495. }
  33496. }
  33497. declare module "babylonjs/Misc/stringDictionary" {
  33498. import { Nullable } from "babylonjs/types";
  33499. /**
  33500. * This class implement a typical dictionary using a string as key and the generic type T as value.
  33501. * The underlying implementation relies on an associative array to ensure the best performances.
  33502. * The value can be anything including 'null' but except 'undefined'
  33503. */
  33504. export class StringDictionary<T> {
  33505. /**
  33506. * This will clear this dictionary and copy the content from the 'source' one.
  33507. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  33508. * @param source the dictionary to take the content from and copy to this dictionary
  33509. */
  33510. copyFrom(source: StringDictionary<T>): void;
  33511. /**
  33512. * Get a value based from its key
  33513. * @param key the given key to get the matching value from
  33514. * @return the value if found, otherwise undefined is returned
  33515. */
  33516. get(key: string): T | undefined;
  33517. /**
  33518. * Get a value from its key or add it if it doesn't exist.
  33519. * This method will ensure you that a given key/data will be present in the dictionary.
  33520. * @param key the given key to get the matching value from
  33521. * @param factory the factory that will create the value if the key is not present in the dictionary.
  33522. * The factory will only be invoked if there's no data for the given key.
  33523. * @return the value corresponding to the key.
  33524. */
  33525. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  33526. /**
  33527. * Get a value from its key if present in the dictionary otherwise add it
  33528. * @param key the key to get the value from
  33529. * @param val if there's no such key/value pair in the dictionary add it with this value
  33530. * @return the value corresponding to the key
  33531. */
  33532. getOrAdd(key: string, val: T): T;
  33533. /**
  33534. * Check if there's a given key in the dictionary
  33535. * @param key the key to check for
  33536. * @return true if the key is present, false otherwise
  33537. */
  33538. contains(key: string): boolean;
  33539. /**
  33540. * Add a new key and its corresponding value
  33541. * @param key the key to add
  33542. * @param value the value corresponding to the key
  33543. * @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
  33544. */
  33545. add(key: string, value: T): boolean;
  33546. /**
  33547. * Update a specific value associated to a key
  33548. * @param key defines the key to use
  33549. * @param value defines the value to store
  33550. * @returns true if the value was updated (or false if the key was not found)
  33551. */
  33552. set(key: string, value: T): boolean;
  33553. /**
  33554. * Get the element of the given key and remove it from the dictionary
  33555. * @param key defines the key to search
  33556. * @returns the value associated with the key or null if not found
  33557. */
  33558. getAndRemove(key: string): Nullable<T>;
  33559. /**
  33560. * Remove a key/value from the dictionary.
  33561. * @param key the key to remove
  33562. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  33563. */
  33564. remove(key: string): boolean;
  33565. /**
  33566. * Clear the whole content of the dictionary
  33567. */
  33568. clear(): void;
  33569. /**
  33570. * Gets the current count
  33571. */
  33572. readonly count: number;
  33573. /**
  33574. * Execute a callback on each key/val of the dictionary.
  33575. * Note that you can remove any element in this dictionary in the callback implementation
  33576. * @param callback the callback to execute on a given key/value pair
  33577. */
  33578. forEach(callback: (key: string, val: T) => void): void;
  33579. /**
  33580. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  33581. * If the callback returns null or undefined the method will iterate to the next key/value pair
  33582. * Note that you can remove any element in this dictionary in the callback implementation
  33583. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  33584. * @returns the first item
  33585. */
  33586. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  33587. private _count;
  33588. private _data;
  33589. }
  33590. }
  33591. declare module "babylonjs/Collisions/collisionCoordinator" {
  33592. import { Nullable } from "babylonjs/types";
  33593. import { Scene } from "babylonjs/scene";
  33594. import { Vector3 } from "babylonjs/Maths/math.vector";
  33595. import { Collider } from "babylonjs/Collisions/collider";
  33596. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33597. /** @hidden */
  33598. export interface ICollisionCoordinator {
  33599. createCollider(): Collider;
  33600. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  33601. init(scene: Scene): void;
  33602. }
  33603. /** @hidden */
  33604. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  33605. private _scene;
  33606. private _scaledPosition;
  33607. private _scaledVelocity;
  33608. private _finalPosition;
  33609. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  33610. createCollider(): Collider;
  33611. init(scene: Scene): void;
  33612. private _collideWithWorld;
  33613. }
  33614. }
  33615. declare module "babylonjs/Inputs/scene.inputManager" {
  33616. import { Nullable } from "babylonjs/types";
  33617. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33618. import { Vector2 } from "babylonjs/Maths/math.vector";
  33619. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33620. import { Scene } from "babylonjs/scene";
  33621. /**
  33622. * Class used to manage all inputs for the scene.
  33623. */
  33624. export class InputManager {
  33625. /** The distance in pixel that you have to move to prevent some events */
  33626. static DragMovementThreshold: number;
  33627. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  33628. static LongPressDelay: number;
  33629. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  33630. static DoubleClickDelay: number;
  33631. /** If you need to check double click without raising a single click at first click, enable this flag */
  33632. static ExclusiveDoubleClickMode: boolean;
  33633. private _wheelEventName;
  33634. private _onPointerMove;
  33635. private _onPointerDown;
  33636. private _onPointerUp;
  33637. private _initClickEvent;
  33638. private _initActionManager;
  33639. private _delayedSimpleClick;
  33640. private _delayedSimpleClickTimeout;
  33641. private _previousDelayedSimpleClickTimeout;
  33642. private _meshPickProceed;
  33643. private _previousButtonPressed;
  33644. private _currentPickResult;
  33645. private _previousPickResult;
  33646. private _totalPointersPressed;
  33647. private _doubleClickOccured;
  33648. private _pointerOverMesh;
  33649. private _pickedDownMesh;
  33650. private _pickedUpMesh;
  33651. private _pointerX;
  33652. private _pointerY;
  33653. private _unTranslatedPointerX;
  33654. private _unTranslatedPointerY;
  33655. private _startingPointerPosition;
  33656. private _previousStartingPointerPosition;
  33657. private _startingPointerTime;
  33658. private _previousStartingPointerTime;
  33659. private _pointerCaptures;
  33660. private _onKeyDown;
  33661. private _onKeyUp;
  33662. private _onCanvasFocusObserver;
  33663. private _onCanvasBlurObserver;
  33664. private _scene;
  33665. /**
  33666. * Creates a new InputManager
  33667. * @param scene defines the hosting scene
  33668. */
  33669. constructor(scene: Scene);
  33670. /**
  33671. * Gets the mesh that is currently under the pointer
  33672. */
  33673. readonly meshUnderPointer: Nullable<AbstractMesh>;
  33674. /**
  33675. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  33676. */
  33677. readonly unTranslatedPointer: Vector2;
  33678. /**
  33679. * Gets or sets the current on-screen X position of the pointer
  33680. */
  33681. pointerX: number;
  33682. /**
  33683. * Gets or sets the current on-screen Y position of the pointer
  33684. */
  33685. pointerY: number;
  33686. private _updatePointerPosition;
  33687. private _processPointerMove;
  33688. private _setRayOnPointerInfo;
  33689. private _checkPrePointerObservable;
  33690. /**
  33691. * Use this method to simulate a pointer move on a mesh
  33692. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33693. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33694. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33695. */
  33696. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  33697. /**
  33698. * Use this method to simulate a pointer down on a mesh
  33699. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33700. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33701. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33702. */
  33703. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  33704. private _processPointerDown;
  33705. /** @hidden */
  33706. _isPointerSwiping(): boolean;
  33707. /**
  33708. * Use this method to simulate a pointer up on a mesh
  33709. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33710. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33711. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33712. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  33713. */
  33714. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  33715. private _processPointerUp;
  33716. /**
  33717. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  33718. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  33719. * @returns true if the pointer was captured
  33720. */
  33721. isPointerCaptured(pointerId?: number): boolean;
  33722. /**
  33723. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  33724. * @param attachUp defines if you want to attach events to pointerup
  33725. * @param attachDown defines if you want to attach events to pointerdown
  33726. * @param attachMove defines if you want to attach events to pointermove
  33727. */
  33728. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  33729. /**
  33730. * Detaches all event handlers
  33731. */
  33732. detachControl(): void;
  33733. /**
  33734. * Force the value of meshUnderPointer
  33735. * @param mesh defines the mesh to use
  33736. */
  33737. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  33738. /**
  33739. * Gets the mesh under the pointer
  33740. * @returns a Mesh or null if no mesh is under the pointer
  33741. */
  33742. getPointerOverMesh(): Nullable<AbstractMesh>;
  33743. }
  33744. }
  33745. declare module "babylonjs/Misc/uniqueIdGenerator" {
  33746. /**
  33747. * Helper class used to generate session unique ID
  33748. */
  33749. export class UniqueIdGenerator {
  33750. private static _UniqueIdCounter;
  33751. /**
  33752. * Gets an unique (relatively to the current scene) Id
  33753. */
  33754. static readonly UniqueId: number;
  33755. }
  33756. }
  33757. declare module "babylonjs/Animations/animationGroup" {
  33758. import { Animatable } from "babylonjs/Animations/animatable";
  33759. import { Animation } from "babylonjs/Animations/animation";
  33760. import { Scene, IDisposable } from "babylonjs/scene";
  33761. import { Observable } from "babylonjs/Misc/observable";
  33762. import { Nullable } from "babylonjs/types";
  33763. import "babylonjs/Animations/animatable";
  33764. /**
  33765. * This class defines the direct association between an animation and a target
  33766. */
  33767. export class TargetedAnimation {
  33768. /**
  33769. * Animation to perform
  33770. */
  33771. animation: Animation;
  33772. /**
  33773. * Target to animate
  33774. */
  33775. target: any;
  33776. /**
  33777. * Serialize the object
  33778. * @returns the JSON object representing the current entity
  33779. */
  33780. serialize(): any;
  33781. }
  33782. /**
  33783. * Use this class to create coordinated animations on multiple targets
  33784. */
  33785. export class AnimationGroup implements IDisposable {
  33786. /** The name of the animation group */
  33787. name: string;
  33788. private _scene;
  33789. private _targetedAnimations;
  33790. private _animatables;
  33791. private _from;
  33792. private _to;
  33793. private _isStarted;
  33794. private _isPaused;
  33795. private _speedRatio;
  33796. private _loopAnimation;
  33797. /**
  33798. * Gets or sets the unique id of the node
  33799. */
  33800. uniqueId: number;
  33801. /**
  33802. * This observable will notify when one animation have ended
  33803. */
  33804. onAnimationEndObservable: Observable<TargetedAnimation>;
  33805. /**
  33806. * Observer raised when one animation loops
  33807. */
  33808. onAnimationLoopObservable: Observable<TargetedAnimation>;
  33809. /**
  33810. * Observer raised when all animations have looped
  33811. */
  33812. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  33813. /**
  33814. * This observable will notify when all animations have ended.
  33815. */
  33816. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  33817. /**
  33818. * This observable will notify when all animations have paused.
  33819. */
  33820. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  33821. /**
  33822. * This observable will notify when all animations are playing.
  33823. */
  33824. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  33825. /**
  33826. * Gets the first frame
  33827. */
  33828. readonly from: number;
  33829. /**
  33830. * Gets the last frame
  33831. */
  33832. readonly to: number;
  33833. /**
  33834. * Define if the animations are started
  33835. */
  33836. readonly isStarted: boolean;
  33837. /**
  33838. * Gets a value indicating that the current group is playing
  33839. */
  33840. readonly isPlaying: boolean;
  33841. /**
  33842. * Gets or sets the speed ratio to use for all animations
  33843. */
  33844. /**
  33845. * Gets or sets the speed ratio to use for all animations
  33846. */
  33847. speedRatio: number;
  33848. /**
  33849. * Gets or sets if all animations should loop or not
  33850. */
  33851. loopAnimation: boolean;
  33852. /**
  33853. * Gets the targeted animations for this animation group
  33854. */
  33855. readonly targetedAnimations: Array<TargetedAnimation>;
  33856. /**
  33857. * returning the list of animatables controlled by this animation group.
  33858. */
  33859. readonly animatables: Array<Animatable>;
  33860. /**
  33861. * Instantiates a new Animation Group.
  33862. * This helps managing several animations at once.
  33863. * @see http://doc.babylonjs.com/how_to/group
  33864. * @param name Defines the name of the group
  33865. * @param scene Defines the scene the group belongs to
  33866. */
  33867. constructor(
  33868. /** The name of the animation group */
  33869. name: string, scene?: Nullable<Scene>);
  33870. /**
  33871. * Add an animation (with its target) in the group
  33872. * @param animation defines the animation we want to add
  33873. * @param target defines the target of the animation
  33874. * @returns the TargetedAnimation object
  33875. */
  33876. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  33877. /**
  33878. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  33879. * It can add constant keys at begin or end
  33880. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  33881. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  33882. * @returns the animation group
  33883. */
  33884. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  33885. private _animationLoopCount;
  33886. private _animationLoopFlags;
  33887. private _processLoop;
  33888. /**
  33889. * Start all animations on given targets
  33890. * @param loop defines if animations must loop
  33891. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  33892. * @param from defines the from key (optional)
  33893. * @param to defines the to key (optional)
  33894. * @returns the current animation group
  33895. */
  33896. start(loop?: boolean, speedRatio?: number, from?: number, to?: number): AnimationGroup;
  33897. /**
  33898. * Pause all animations
  33899. * @returns the animation group
  33900. */
  33901. pause(): AnimationGroup;
  33902. /**
  33903. * Play all animations to initial state
  33904. * This function will start() the animations if they were not started or will restart() them if they were paused
  33905. * @param loop defines if animations must loop
  33906. * @returns the animation group
  33907. */
  33908. play(loop?: boolean): AnimationGroup;
  33909. /**
  33910. * Reset all animations to initial state
  33911. * @returns the animation group
  33912. */
  33913. reset(): AnimationGroup;
  33914. /**
  33915. * Restart animations from key 0
  33916. * @returns the animation group
  33917. */
  33918. restart(): AnimationGroup;
  33919. /**
  33920. * Stop all animations
  33921. * @returns the animation group
  33922. */
  33923. stop(): AnimationGroup;
  33924. /**
  33925. * Set animation weight for all animatables
  33926. * @param weight defines the weight to use
  33927. * @return the animationGroup
  33928. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  33929. */
  33930. setWeightForAllAnimatables(weight: number): AnimationGroup;
  33931. /**
  33932. * Synchronize and normalize all animatables with a source animatable
  33933. * @param root defines the root animatable to synchronize with
  33934. * @return the animationGroup
  33935. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  33936. */
  33937. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  33938. /**
  33939. * Goes to a specific frame in this animation group
  33940. * @param frame the frame number to go to
  33941. * @return the animationGroup
  33942. */
  33943. goToFrame(frame: number): AnimationGroup;
  33944. /**
  33945. * Dispose all associated resources
  33946. */
  33947. dispose(): void;
  33948. private _checkAnimationGroupEnded;
  33949. /**
  33950. * Clone the current animation group and returns a copy
  33951. * @param newName defines the name of the new group
  33952. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  33953. * @returns the new aniamtion group
  33954. */
  33955. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  33956. /**
  33957. * Serializes the animationGroup to an object
  33958. * @returns Serialized object
  33959. */
  33960. serialize(): any;
  33961. /**
  33962. * Returns a new AnimationGroup object parsed from the source provided.
  33963. * @param parsedAnimationGroup defines the source
  33964. * @param scene defines the scene that will receive the animationGroup
  33965. * @returns a new AnimationGroup
  33966. */
  33967. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  33968. /**
  33969. * Returns the string "AnimationGroup"
  33970. * @returns "AnimationGroup"
  33971. */
  33972. getClassName(): string;
  33973. /**
  33974. * Creates a detailled string about the object
  33975. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  33976. * @returns a string representing the object
  33977. */
  33978. toString(fullDetails?: boolean): string;
  33979. }
  33980. }
  33981. declare module "babylonjs/scene" {
  33982. import { Nullable } from "babylonjs/types";
  33983. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  33984. import { Observable } from "babylonjs/Misc/observable";
  33985. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  33986. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  33987. import { Geometry } from "babylonjs/Meshes/geometry";
  33988. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33989. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33990. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33991. import { Mesh } from "babylonjs/Meshes/mesh";
  33992. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33993. import { Bone } from "babylonjs/Bones/bone";
  33994. import { Skeleton } from "babylonjs/Bones/skeleton";
  33995. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  33996. import { Camera } from "babylonjs/Cameras/camera";
  33997. import { AbstractScene } from "babylonjs/abstractScene";
  33998. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  33999. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  34000. import { Material } from "babylonjs/Materials/material";
  34001. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34002. import { Effect } from "babylonjs/Materials/effect";
  34003. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  34004. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  34005. import { Light } from "babylonjs/Lights/light";
  34006. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  34007. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  34008. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  34009. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  34010. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  34011. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  34012. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  34013. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  34014. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  34015. import { Engine } from "babylonjs/Engines/engine";
  34016. import { Node } from "babylonjs/node";
  34017. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  34018. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34019. import { WebRequest } from "babylonjs/Misc/webRequest";
  34020. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  34021. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  34022. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  34023. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  34024. import { Plane } from "babylonjs/Maths/math.plane";
  34025. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  34026. import { Ray } from "babylonjs/Culling/ray";
  34027. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  34028. import { Animation } from "babylonjs/Animations/animation";
  34029. import { Animatable } from "babylonjs/Animations/animatable";
  34030. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  34031. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34032. import { Collider } from "babylonjs/Collisions/collider";
  34033. /**
  34034. * Define an interface for all classes that will hold resources
  34035. */
  34036. export interface IDisposable {
  34037. /**
  34038. * Releases all held resources
  34039. */
  34040. dispose(): void;
  34041. }
  34042. /** Interface defining initialization parameters for Scene class */
  34043. export interface SceneOptions {
  34044. /**
  34045. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  34046. * It will improve performance when the number of geometries becomes important.
  34047. */
  34048. useGeometryUniqueIdsMap?: boolean;
  34049. /**
  34050. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  34051. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  34052. */
  34053. useMaterialMeshMap?: boolean;
  34054. /**
  34055. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  34056. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  34057. */
  34058. useClonedMeshhMap?: boolean;
  34059. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  34060. virtual?: boolean;
  34061. }
  34062. /**
  34063. * Represents a scene to be rendered by the engine.
  34064. * @see http://doc.babylonjs.com/features/scene
  34065. */
  34066. export class Scene extends AbstractScene implements IAnimatable {
  34067. /** The fog is deactivated */
  34068. static readonly FOGMODE_NONE: number;
  34069. /** The fog density is following an exponential function */
  34070. static readonly FOGMODE_EXP: number;
  34071. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  34072. static readonly FOGMODE_EXP2: number;
  34073. /** The fog density is following a linear function. */
  34074. static readonly FOGMODE_LINEAR: number;
  34075. /**
  34076. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  34077. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34078. */
  34079. static MinDeltaTime: number;
  34080. /**
  34081. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  34082. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34083. */
  34084. static MaxDeltaTime: number;
  34085. /**
  34086. * Factory used to create the default material.
  34087. * @param name The name of the material to create
  34088. * @param scene The scene to create the material for
  34089. * @returns The default material
  34090. */
  34091. static DefaultMaterialFactory(scene: Scene): Material;
  34092. /**
  34093. * Factory used to create the a collision coordinator.
  34094. * @returns The collision coordinator
  34095. */
  34096. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  34097. /** @hidden */
  34098. _inputManager: InputManager;
  34099. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  34100. cameraToUseForPointers: Nullable<Camera>;
  34101. /** @hidden */
  34102. readonly _isScene: boolean;
  34103. /**
  34104. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  34105. */
  34106. autoClear: boolean;
  34107. /**
  34108. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  34109. */
  34110. autoClearDepthAndStencil: boolean;
  34111. /**
  34112. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  34113. */
  34114. clearColor: Color4;
  34115. /**
  34116. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  34117. */
  34118. ambientColor: Color3;
  34119. /**
  34120. * This is use to store the default BRDF lookup for PBR materials in your scene.
  34121. * It should only be one of the following (if not the default embedded one):
  34122. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  34123. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  34124. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  34125. * The material properties need to be setup according to the type of texture in use.
  34126. */
  34127. environmentBRDFTexture: BaseTexture;
  34128. /** @hidden */
  34129. protected _environmentTexture: Nullable<BaseTexture>;
  34130. /**
  34131. * Texture used in all pbr material as the reflection texture.
  34132. * As in the majority of the scene they are the same (exception for multi room and so on),
  34133. * this is easier to reference from here than from all the materials.
  34134. */
  34135. /**
  34136. * Texture used in all pbr material as the reflection texture.
  34137. * As in the majority of the scene they are the same (exception for multi room and so on),
  34138. * this is easier to set here than in all the materials.
  34139. */
  34140. environmentTexture: Nullable<BaseTexture>;
  34141. /** @hidden */
  34142. protected _environmentIntensity: number;
  34143. /**
  34144. * Intensity of the environment in all pbr material.
  34145. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  34146. * As in the majority of the scene they are the same (exception for multi room and so on),
  34147. * this is easier to reference from here than from all the materials.
  34148. */
  34149. /**
  34150. * Intensity of the environment in all pbr material.
  34151. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  34152. * As in the majority of the scene they are the same (exception for multi room and so on),
  34153. * this is easier to set here than in all the materials.
  34154. */
  34155. environmentIntensity: number;
  34156. /** @hidden */
  34157. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  34158. /**
  34159. * Default image processing configuration used either in the rendering
  34160. * Forward main pass or through the imageProcessingPostProcess if present.
  34161. * As in the majority of the scene they are the same (exception for multi camera),
  34162. * this is easier to reference from here than from all the materials and post process.
  34163. *
  34164. * No setter as we it is a shared configuration, you can set the values instead.
  34165. */
  34166. readonly imageProcessingConfiguration: ImageProcessingConfiguration;
  34167. private _forceWireframe;
  34168. /**
  34169. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  34170. */
  34171. forceWireframe: boolean;
  34172. private _forcePointsCloud;
  34173. /**
  34174. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  34175. */
  34176. forcePointsCloud: boolean;
  34177. /**
  34178. * Gets or sets the active clipplane 1
  34179. */
  34180. clipPlane: Nullable<Plane>;
  34181. /**
  34182. * Gets or sets the active clipplane 2
  34183. */
  34184. clipPlane2: Nullable<Plane>;
  34185. /**
  34186. * Gets or sets the active clipplane 3
  34187. */
  34188. clipPlane3: Nullable<Plane>;
  34189. /**
  34190. * Gets or sets the active clipplane 4
  34191. */
  34192. clipPlane4: Nullable<Plane>;
  34193. /**
  34194. * Gets or sets a boolean indicating if animations are enabled
  34195. */
  34196. animationsEnabled: boolean;
  34197. private _animationPropertiesOverride;
  34198. /**
  34199. * Gets or sets the animation properties override
  34200. */
  34201. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  34202. /**
  34203. * Gets or sets a boolean indicating if a constant deltatime has to be used
  34204. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  34205. */
  34206. useConstantAnimationDeltaTime: boolean;
  34207. /**
  34208. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  34209. * Please note that it requires to run a ray cast through the scene on every frame
  34210. */
  34211. constantlyUpdateMeshUnderPointer: boolean;
  34212. /**
  34213. * Defines the HTML cursor to use when hovering over interactive elements
  34214. */
  34215. hoverCursor: string;
  34216. /**
  34217. * Defines the HTML default cursor to use (empty by default)
  34218. */
  34219. defaultCursor: string;
  34220. /**
  34221. * Defines wether cursors are handled by the scene.
  34222. */
  34223. doNotHandleCursors: boolean;
  34224. /**
  34225. * This is used to call preventDefault() on pointer down
  34226. * in order to block unwanted artifacts like system double clicks
  34227. */
  34228. preventDefaultOnPointerDown: boolean;
  34229. /**
  34230. * This is used to call preventDefault() on pointer up
  34231. * in order to block unwanted artifacts like system double clicks
  34232. */
  34233. preventDefaultOnPointerUp: boolean;
  34234. /**
  34235. * Gets or sets user defined metadata
  34236. */
  34237. metadata: any;
  34238. /**
  34239. * For internal use only. Please do not use.
  34240. */
  34241. reservedDataStore: any;
  34242. /**
  34243. * Gets the name of the plugin used to load this scene (null by default)
  34244. */
  34245. loadingPluginName: string;
  34246. /**
  34247. * Use this array to add regular expressions used to disable offline support for specific urls
  34248. */
  34249. disableOfflineSupportExceptionRules: RegExp[];
  34250. /**
  34251. * An event triggered when the scene is disposed.
  34252. */
  34253. onDisposeObservable: Observable<Scene>;
  34254. private _onDisposeObserver;
  34255. /** Sets a function to be executed when this scene is disposed. */
  34256. onDispose: () => void;
  34257. /**
  34258. * An event triggered before rendering the scene (right after animations and physics)
  34259. */
  34260. onBeforeRenderObservable: Observable<Scene>;
  34261. private _onBeforeRenderObserver;
  34262. /** Sets a function to be executed before rendering this scene */
  34263. beforeRender: Nullable<() => void>;
  34264. /**
  34265. * An event triggered after rendering the scene
  34266. */
  34267. onAfterRenderObservable: Observable<Scene>;
  34268. /**
  34269. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  34270. */
  34271. onAfterRenderCameraObservable: Observable<Camera>;
  34272. private _onAfterRenderObserver;
  34273. /** Sets a function to be executed after rendering this scene */
  34274. afterRender: Nullable<() => void>;
  34275. /**
  34276. * An event triggered before animating the scene
  34277. */
  34278. onBeforeAnimationsObservable: Observable<Scene>;
  34279. /**
  34280. * An event triggered after animations processing
  34281. */
  34282. onAfterAnimationsObservable: Observable<Scene>;
  34283. /**
  34284. * An event triggered before draw calls are ready to be sent
  34285. */
  34286. onBeforeDrawPhaseObservable: Observable<Scene>;
  34287. /**
  34288. * An event triggered after draw calls have been sent
  34289. */
  34290. onAfterDrawPhaseObservable: Observable<Scene>;
  34291. /**
  34292. * An event triggered when the scene is ready
  34293. */
  34294. onReadyObservable: Observable<Scene>;
  34295. /**
  34296. * An event triggered before rendering a camera
  34297. */
  34298. onBeforeCameraRenderObservable: Observable<Camera>;
  34299. private _onBeforeCameraRenderObserver;
  34300. /** Sets a function to be executed before rendering a camera*/
  34301. beforeCameraRender: () => void;
  34302. /**
  34303. * An event triggered after rendering a camera
  34304. */
  34305. onAfterCameraRenderObservable: Observable<Camera>;
  34306. private _onAfterCameraRenderObserver;
  34307. /** Sets a function to be executed after rendering a camera*/
  34308. afterCameraRender: () => void;
  34309. /**
  34310. * An event triggered when active meshes evaluation is about to start
  34311. */
  34312. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  34313. /**
  34314. * An event triggered when active meshes evaluation is done
  34315. */
  34316. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  34317. /**
  34318. * An event triggered when particles rendering is about to start
  34319. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  34320. */
  34321. onBeforeParticlesRenderingObservable: Observable<Scene>;
  34322. /**
  34323. * An event triggered when particles rendering is done
  34324. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  34325. */
  34326. onAfterParticlesRenderingObservable: Observable<Scene>;
  34327. /**
  34328. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  34329. */
  34330. onDataLoadedObservable: Observable<Scene>;
  34331. /**
  34332. * An event triggered when a camera is created
  34333. */
  34334. onNewCameraAddedObservable: Observable<Camera>;
  34335. /**
  34336. * An event triggered when a camera is removed
  34337. */
  34338. onCameraRemovedObservable: Observable<Camera>;
  34339. /**
  34340. * An event triggered when a light is created
  34341. */
  34342. onNewLightAddedObservable: Observable<Light>;
  34343. /**
  34344. * An event triggered when a light is removed
  34345. */
  34346. onLightRemovedObservable: Observable<Light>;
  34347. /**
  34348. * An event triggered when a geometry is created
  34349. */
  34350. onNewGeometryAddedObservable: Observable<Geometry>;
  34351. /**
  34352. * An event triggered when a geometry is removed
  34353. */
  34354. onGeometryRemovedObservable: Observable<Geometry>;
  34355. /**
  34356. * An event triggered when a transform node is created
  34357. */
  34358. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  34359. /**
  34360. * An event triggered when a transform node is removed
  34361. */
  34362. onTransformNodeRemovedObservable: Observable<TransformNode>;
  34363. /**
  34364. * An event triggered when a mesh is created
  34365. */
  34366. onNewMeshAddedObservable: Observable<AbstractMesh>;
  34367. /**
  34368. * An event triggered when a mesh is removed
  34369. */
  34370. onMeshRemovedObservable: Observable<AbstractMesh>;
  34371. /**
  34372. * An event triggered when a skeleton is created
  34373. */
  34374. onNewSkeletonAddedObservable: Observable<Skeleton>;
  34375. /**
  34376. * An event triggered when a skeleton is removed
  34377. */
  34378. onSkeletonRemovedObservable: Observable<Skeleton>;
  34379. /**
  34380. * An event triggered when a material is created
  34381. */
  34382. onNewMaterialAddedObservable: Observable<Material>;
  34383. /**
  34384. * An event triggered when a material is removed
  34385. */
  34386. onMaterialRemovedObservable: Observable<Material>;
  34387. /**
  34388. * An event triggered when a texture is created
  34389. */
  34390. onNewTextureAddedObservable: Observable<BaseTexture>;
  34391. /**
  34392. * An event triggered when a texture is removed
  34393. */
  34394. onTextureRemovedObservable: Observable<BaseTexture>;
  34395. /**
  34396. * An event triggered when render targets are about to be rendered
  34397. * Can happen multiple times per frame.
  34398. */
  34399. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  34400. /**
  34401. * An event triggered when render targets were rendered.
  34402. * Can happen multiple times per frame.
  34403. */
  34404. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  34405. /**
  34406. * An event triggered before calculating deterministic simulation step
  34407. */
  34408. onBeforeStepObservable: Observable<Scene>;
  34409. /**
  34410. * An event triggered after calculating deterministic simulation step
  34411. */
  34412. onAfterStepObservable: Observable<Scene>;
  34413. /**
  34414. * An event triggered when the activeCamera property is updated
  34415. */
  34416. onActiveCameraChanged: Observable<Scene>;
  34417. /**
  34418. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  34419. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  34420. * 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)
  34421. */
  34422. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  34423. /**
  34424. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  34425. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  34426. * 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)
  34427. */
  34428. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  34429. /**
  34430. * This Observable will when a mesh has been imported into the scene.
  34431. */
  34432. onMeshImportedObservable: Observable<AbstractMesh>;
  34433. /**
  34434. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  34435. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  34436. */
  34437. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  34438. /** @hidden */
  34439. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  34440. /**
  34441. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  34442. */
  34443. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  34444. /**
  34445. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  34446. */
  34447. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  34448. /**
  34449. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  34450. */
  34451. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  34452. /** Callback called when a pointer move is detected */
  34453. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  34454. /** Callback called when a pointer down is detected */
  34455. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  34456. /** Callback called when a pointer up is detected */
  34457. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  34458. /** Callback called when a pointer pick is detected */
  34459. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  34460. /**
  34461. * 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).
  34462. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  34463. */
  34464. onPrePointerObservable: Observable<PointerInfoPre>;
  34465. /**
  34466. * Observable event triggered each time an input event is received from the rendering canvas
  34467. */
  34468. onPointerObservable: Observable<PointerInfo>;
  34469. /**
  34470. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  34471. */
  34472. readonly unTranslatedPointer: Vector2;
  34473. /**
  34474. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  34475. */
  34476. static DragMovementThreshold: number;
  34477. /**
  34478. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  34479. */
  34480. static LongPressDelay: number;
  34481. /**
  34482. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  34483. */
  34484. static DoubleClickDelay: number;
  34485. /** If you need to check double click without raising a single click at first click, enable this flag */
  34486. static ExclusiveDoubleClickMode: boolean;
  34487. /** @hidden */
  34488. _mirroredCameraPosition: Nullable<Vector3>;
  34489. /**
  34490. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  34491. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  34492. */
  34493. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  34494. /**
  34495. * Observable event triggered each time an keyboard event is received from the hosting window
  34496. */
  34497. onKeyboardObservable: Observable<KeyboardInfo>;
  34498. private _useRightHandedSystem;
  34499. /**
  34500. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  34501. */
  34502. useRightHandedSystem: boolean;
  34503. private _timeAccumulator;
  34504. private _currentStepId;
  34505. private _currentInternalStep;
  34506. /**
  34507. * Sets the step Id used by deterministic lock step
  34508. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34509. * @param newStepId defines the step Id
  34510. */
  34511. setStepId(newStepId: number): void;
  34512. /**
  34513. * Gets the step Id used by deterministic lock step
  34514. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34515. * @returns the step Id
  34516. */
  34517. getStepId(): number;
  34518. /**
  34519. * Gets the internal step used by deterministic lock step
  34520. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34521. * @returns the internal step
  34522. */
  34523. getInternalStep(): number;
  34524. private _fogEnabled;
  34525. /**
  34526. * Gets or sets a boolean indicating if fog is enabled on this scene
  34527. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34528. * (Default is true)
  34529. */
  34530. fogEnabled: boolean;
  34531. private _fogMode;
  34532. /**
  34533. * Gets or sets the fog mode to use
  34534. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34535. * | mode | value |
  34536. * | --- | --- |
  34537. * | FOGMODE_NONE | 0 |
  34538. * | FOGMODE_EXP | 1 |
  34539. * | FOGMODE_EXP2 | 2 |
  34540. * | FOGMODE_LINEAR | 3 |
  34541. */
  34542. fogMode: number;
  34543. /**
  34544. * Gets or sets the fog color to use
  34545. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34546. * (Default is Color3(0.2, 0.2, 0.3))
  34547. */
  34548. fogColor: Color3;
  34549. /**
  34550. * Gets or sets the fog density to use
  34551. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34552. * (Default is 0.1)
  34553. */
  34554. fogDensity: number;
  34555. /**
  34556. * Gets or sets the fog start distance to use
  34557. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34558. * (Default is 0)
  34559. */
  34560. fogStart: number;
  34561. /**
  34562. * Gets or sets the fog end distance to use
  34563. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34564. * (Default is 1000)
  34565. */
  34566. fogEnd: number;
  34567. private _shadowsEnabled;
  34568. /**
  34569. * Gets or sets a boolean indicating if shadows are enabled on this scene
  34570. */
  34571. shadowsEnabled: boolean;
  34572. private _lightsEnabled;
  34573. /**
  34574. * Gets or sets a boolean indicating if lights are enabled on this scene
  34575. */
  34576. lightsEnabled: boolean;
  34577. /** All of the active cameras added to this scene. */
  34578. activeCameras: Camera[];
  34579. /** @hidden */
  34580. _activeCamera: Nullable<Camera>;
  34581. /** Gets or sets the current active camera */
  34582. activeCamera: Nullable<Camera>;
  34583. private _defaultMaterial;
  34584. /** The default material used on meshes when no material is affected */
  34585. /** The default material used on meshes when no material is affected */
  34586. defaultMaterial: Material;
  34587. private _texturesEnabled;
  34588. /**
  34589. * Gets or sets a boolean indicating if textures are enabled on this scene
  34590. */
  34591. texturesEnabled: boolean;
  34592. /**
  34593. * Gets or sets a boolean indicating if particles are enabled on this scene
  34594. */
  34595. particlesEnabled: boolean;
  34596. /**
  34597. * Gets or sets a boolean indicating if sprites are enabled on this scene
  34598. */
  34599. spritesEnabled: boolean;
  34600. private _skeletonsEnabled;
  34601. /**
  34602. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  34603. */
  34604. skeletonsEnabled: boolean;
  34605. /**
  34606. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  34607. */
  34608. lensFlaresEnabled: boolean;
  34609. /**
  34610. * Gets or sets a boolean indicating if collisions are enabled on this scene
  34611. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  34612. */
  34613. collisionsEnabled: boolean;
  34614. private _collisionCoordinator;
  34615. /** @hidden */
  34616. readonly collisionCoordinator: ICollisionCoordinator;
  34617. /**
  34618. * Defines the gravity applied to this scene (used only for collisions)
  34619. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  34620. */
  34621. gravity: Vector3;
  34622. /**
  34623. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  34624. */
  34625. postProcessesEnabled: boolean;
  34626. /**
  34627. * The list of postprocesses added to the scene
  34628. */
  34629. postProcesses: PostProcess[];
  34630. /**
  34631. * Gets the current postprocess manager
  34632. */
  34633. postProcessManager: PostProcessManager;
  34634. /**
  34635. * Gets or sets a boolean indicating if render targets are enabled on this scene
  34636. */
  34637. renderTargetsEnabled: boolean;
  34638. /**
  34639. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  34640. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  34641. */
  34642. dumpNextRenderTargets: boolean;
  34643. /**
  34644. * The list of user defined render targets added to the scene
  34645. */
  34646. customRenderTargets: RenderTargetTexture[];
  34647. /**
  34648. * Defines if texture loading must be delayed
  34649. * If true, textures will only be loaded when they need to be rendered
  34650. */
  34651. useDelayedTextureLoading: boolean;
  34652. /**
  34653. * Gets the list of meshes imported to the scene through SceneLoader
  34654. */
  34655. importedMeshesFiles: String[];
  34656. /**
  34657. * Gets or sets a boolean indicating if probes are enabled on this scene
  34658. */
  34659. probesEnabled: boolean;
  34660. /**
  34661. * Gets or sets the current offline provider to use to store scene data
  34662. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  34663. */
  34664. offlineProvider: IOfflineProvider;
  34665. /**
  34666. * Gets or sets the action manager associated with the scene
  34667. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  34668. */
  34669. actionManager: AbstractActionManager;
  34670. private _meshesForIntersections;
  34671. /**
  34672. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  34673. */
  34674. proceduralTexturesEnabled: boolean;
  34675. private _engine;
  34676. private _totalVertices;
  34677. /** @hidden */
  34678. _activeIndices: PerfCounter;
  34679. /** @hidden */
  34680. _activeParticles: PerfCounter;
  34681. /** @hidden */
  34682. _activeBones: PerfCounter;
  34683. private _animationRatio;
  34684. /** @hidden */
  34685. _animationTimeLast: number;
  34686. /** @hidden */
  34687. _animationTime: number;
  34688. /**
  34689. * Gets or sets a general scale for animation speed
  34690. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  34691. */
  34692. animationTimeScale: number;
  34693. /** @hidden */
  34694. _cachedMaterial: Nullable<Material>;
  34695. /** @hidden */
  34696. _cachedEffect: Nullable<Effect>;
  34697. /** @hidden */
  34698. _cachedVisibility: Nullable<number>;
  34699. private _renderId;
  34700. private _frameId;
  34701. private _executeWhenReadyTimeoutId;
  34702. private _intermediateRendering;
  34703. private _viewUpdateFlag;
  34704. private _projectionUpdateFlag;
  34705. /** @hidden */
  34706. _toBeDisposed: Nullable<IDisposable>[];
  34707. private _activeRequests;
  34708. /** @hidden */
  34709. _pendingData: any[];
  34710. private _isDisposed;
  34711. /**
  34712. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  34713. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  34714. */
  34715. dispatchAllSubMeshesOfActiveMeshes: boolean;
  34716. private _activeMeshes;
  34717. private _processedMaterials;
  34718. private _renderTargets;
  34719. /** @hidden */
  34720. _activeParticleSystems: SmartArray<IParticleSystem>;
  34721. private _activeSkeletons;
  34722. private _softwareSkinnedMeshes;
  34723. private _renderingManager;
  34724. /** @hidden */
  34725. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  34726. private _transformMatrix;
  34727. private _sceneUbo;
  34728. /** @hidden */
  34729. _viewMatrix: Matrix;
  34730. private _projectionMatrix;
  34731. /** @hidden */
  34732. _forcedViewPosition: Nullable<Vector3>;
  34733. /** @hidden */
  34734. _frustumPlanes: Plane[];
  34735. /**
  34736. * Gets the list of frustum planes (built from the active camera)
  34737. */
  34738. readonly frustumPlanes: Plane[];
  34739. /**
  34740. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  34741. * This is useful if there are more lights that the maximum simulteanous authorized
  34742. */
  34743. requireLightSorting: boolean;
  34744. /** @hidden */
  34745. readonly useMaterialMeshMap: boolean;
  34746. /** @hidden */
  34747. readonly useClonedMeshhMap: boolean;
  34748. private _externalData;
  34749. private _uid;
  34750. /**
  34751. * @hidden
  34752. * Backing store of defined scene components.
  34753. */
  34754. _components: ISceneComponent[];
  34755. /**
  34756. * @hidden
  34757. * Backing store of defined scene components.
  34758. */
  34759. _serializableComponents: ISceneSerializableComponent[];
  34760. /**
  34761. * List of components to register on the next registration step.
  34762. */
  34763. private _transientComponents;
  34764. /**
  34765. * Registers the transient components if needed.
  34766. */
  34767. private _registerTransientComponents;
  34768. /**
  34769. * @hidden
  34770. * Add a component to the scene.
  34771. * Note that the ccomponent could be registered on th next frame if this is called after
  34772. * the register component stage.
  34773. * @param component Defines the component to add to the scene
  34774. */
  34775. _addComponent(component: ISceneComponent): void;
  34776. /**
  34777. * @hidden
  34778. * Gets a component from the scene.
  34779. * @param name defines the name of the component to retrieve
  34780. * @returns the component or null if not present
  34781. */
  34782. _getComponent(name: string): Nullable<ISceneComponent>;
  34783. /**
  34784. * @hidden
  34785. * Defines the actions happening before camera updates.
  34786. */
  34787. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  34788. /**
  34789. * @hidden
  34790. * Defines the actions happening before clear the canvas.
  34791. */
  34792. _beforeClearStage: Stage<SimpleStageAction>;
  34793. /**
  34794. * @hidden
  34795. * Defines the actions when collecting render targets for the frame.
  34796. */
  34797. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  34798. /**
  34799. * @hidden
  34800. * Defines the actions happening for one camera in the frame.
  34801. */
  34802. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  34803. /**
  34804. * @hidden
  34805. * Defines the actions happening during the per mesh ready checks.
  34806. */
  34807. _isReadyForMeshStage: Stage<MeshStageAction>;
  34808. /**
  34809. * @hidden
  34810. * Defines the actions happening before evaluate active mesh checks.
  34811. */
  34812. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  34813. /**
  34814. * @hidden
  34815. * Defines the actions happening during the evaluate sub mesh checks.
  34816. */
  34817. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  34818. /**
  34819. * @hidden
  34820. * Defines the actions happening during the active mesh stage.
  34821. */
  34822. _activeMeshStage: Stage<ActiveMeshStageAction>;
  34823. /**
  34824. * @hidden
  34825. * Defines the actions happening during the per camera render target step.
  34826. */
  34827. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  34828. /**
  34829. * @hidden
  34830. * Defines the actions happening just before the active camera is drawing.
  34831. */
  34832. _beforeCameraDrawStage: Stage<CameraStageAction>;
  34833. /**
  34834. * @hidden
  34835. * Defines the actions happening just before a render target is drawing.
  34836. */
  34837. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  34838. /**
  34839. * @hidden
  34840. * Defines the actions happening just before a rendering group is drawing.
  34841. */
  34842. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  34843. /**
  34844. * @hidden
  34845. * Defines the actions happening just before a mesh is drawing.
  34846. */
  34847. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  34848. /**
  34849. * @hidden
  34850. * Defines the actions happening just after a mesh has been drawn.
  34851. */
  34852. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  34853. /**
  34854. * @hidden
  34855. * Defines the actions happening just after a rendering group has been drawn.
  34856. */
  34857. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  34858. /**
  34859. * @hidden
  34860. * Defines the actions happening just after the active camera has been drawn.
  34861. */
  34862. _afterCameraDrawStage: Stage<CameraStageAction>;
  34863. /**
  34864. * @hidden
  34865. * Defines the actions happening just after a render target has been drawn.
  34866. */
  34867. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  34868. /**
  34869. * @hidden
  34870. * Defines the actions happening just after rendering all cameras and computing intersections.
  34871. */
  34872. _afterRenderStage: Stage<SimpleStageAction>;
  34873. /**
  34874. * @hidden
  34875. * Defines the actions happening when a pointer move event happens.
  34876. */
  34877. _pointerMoveStage: Stage<PointerMoveStageAction>;
  34878. /**
  34879. * @hidden
  34880. * Defines the actions happening when a pointer down event happens.
  34881. */
  34882. _pointerDownStage: Stage<PointerUpDownStageAction>;
  34883. /**
  34884. * @hidden
  34885. * Defines the actions happening when a pointer up event happens.
  34886. */
  34887. _pointerUpStage: Stage<PointerUpDownStageAction>;
  34888. /**
  34889. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  34890. */
  34891. private geometriesByUniqueId;
  34892. /**
  34893. * Creates a new Scene
  34894. * @param engine defines the engine to use to render this scene
  34895. * @param options defines the scene options
  34896. */
  34897. constructor(engine: Engine, options?: SceneOptions);
  34898. /**
  34899. * Gets a string idenfifying the name of the class
  34900. * @returns "Scene" string
  34901. */
  34902. getClassName(): string;
  34903. private _defaultMeshCandidates;
  34904. /**
  34905. * @hidden
  34906. */
  34907. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  34908. private _defaultSubMeshCandidates;
  34909. /**
  34910. * @hidden
  34911. */
  34912. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  34913. /**
  34914. * Sets the default candidate providers for the scene.
  34915. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  34916. * and getCollidingSubMeshCandidates to their default function
  34917. */
  34918. setDefaultCandidateProviders(): void;
  34919. /**
  34920. * Gets the mesh that is currently under the pointer
  34921. */
  34922. readonly meshUnderPointer: Nullable<AbstractMesh>;
  34923. /**
  34924. * Gets or sets the current on-screen X position of the pointer
  34925. */
  34926. pointerX: number;
  34927. /**
  34928. * Gets or sets the current on-screen Y position of the pointer
  34929. */
  34930. pointerY: number;
  34931. /**
  34932. * Gets the cached material (ie. the latest rendered one)
  34933. * @returns the cached material
  34934. */
  34935. getCachedMaterial(): Nullable<Material>;
  34936. /**
  34937. * Gets the cached effect (ie. the latest rendered one)
  34938. * @returns the cached effect
  34939. */
  34940. getCachedEffect(): Nullable<Effect>;
  34941. /**
  34942. * Gets the cached visibility state (ie. the latest rendered one)
  34943. * @returns the cached visibility state
  34944. */
  34945. getCachedVisibility(): Nullable<number>;
  34946. /**
  34947. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  34948. * @param material defines the current material
  34949. * @param effect defines the current effect
  34950. * @param visibility defines the current visibility state
  34951. * @returns true if one parameter is not cached
  34952. */
  34953. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  34954. /**
  34955. * Gets the engine associated with the scene
  34956. * @returns an Engine
  34957. */
  34958. getEngine(): Engine;
  34959. /**
  34960. * Gets the total number of vertices rendered per frame
  34961. * @returns the total number of vertices rendered per frame
  34962. */
  34963. getTotalVertices(): number;
  34964. /**
  34965. * Gets the performance counter for total vertices
  34966. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34967. */
  34968. readonly totalVerticesPerfCounter: PerfCounter;
  34969. /**
  34970. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  34971. * @returns the total number of active indices rendered per frame
  34972. */
  34973. getActiveIndices(): number;
  34974. /**
  34975. * Gets the performance counter for active indices
  34976. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34977. */
  34978. readonly totalActiveIndicesPerfCounter: PerfCounter;
  34979. /**
  34980. * Gets the total number of active particles rendered per frame
  34981. * @returns the total number of active particles rendered per frame
  34982. */
  34983. getActiveParticles(): number;
  34984. /**
  34985. * Gets the performance counter for active particles
  34986. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34987. */
  34988. readonly activeParticlesPerfCounter: PerfCounter;
  34989. /**
  34990. * Gets the total number of active bones rendered per frame
  34991. * @returns the total number of active bones rendered per frame
  34992. */
  34993. getActiveBones(): number;
  34994. /**
  34995. * Gets the performance counter for active bones
  34996. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  34997. */
  34998. readonly activeBonesPerfCounter: PerfCounter;
  34999. /**
  35000. * Gets the array of active meshes
  35001. * @returns an array of AbstractMesh
  35002. */
  35003. getActiveMeshes(): SmartArray<AbstractMesh>;
  35004. /**
  35005. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  35006. * @returns a number
  35007. */
  35008. getAnimationRatio(): number;
  35009. /**
  35010. * Gets an unique Id for the current render phase
  35011. * @returns a number
  35012. */
  35013. getRenderId(): number;
  35014. /**
  35015. * Gets an unique Id for the current frame
  35016. * @returns a number
  35017. */
  35018. getFrameId(): number;
  35019. /** Call this function if you want to manually increment the render Id*/
  35020. incrementRenderId(): void;
  35021. private _createUbo;
  35022. /**
  35023. * Use this method to simulate a pointer move on a mesh
  35024. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35025. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35026. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35027. * @returns the current scene
  35028. */
  35029. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  35030. /**
  35031. * Use this method to simulate a pointer down on a mesh
  35032. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35033. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35034. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35035. * @returns the current scene
  35036. */
  35037. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  35038. /**
  35039. * Use this method to simulate a pointer up on a mesh
  35040. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35041. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35042. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35043. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  35044. * @returns the current scene
  35045. */
  35046. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  35047. /**
  35048. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  35049. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  35050. * @returns true if the pointer was captured
  35051. */
  35052. isPointerCaptured(pointerId?: number): boolean;
  35053. /**
  35054. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  35055. * @param attachUp defines if you want to attach events to pointerup
  35056. * @param attachDown defines if you want to attach events to pointerdown
  35057. * @param attachMove defines if you want to attach events to pointermove
  35058. */
  35059. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  35060. /** Detaches all event handlers*/
  35061. detachControl(): void;
  35062. /**
  35063. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  35064. * Delay loaded resources are not taking in account
  35065. * @return true if all required resources are ready
  35066. */
  35067. isReady(): boolean;
  35068. /** Resets all cached information relative to material (including effect and visibility) */
  35069. resetCachedMaterial(): void;
  35070. /**
  35071. * Registers a function to be called before every frame render
  35072. * @param func defines the function to register
  35073. */
  35074. registerBeforeRender(func: () => void): void;
  35075. /**
  35076. * Unregisters a function called before every frame render
  35077. * @param func defines the function to unregister
  35078. */
  35079. unregisterBeforeRender(func: () => void): void;
  35080. /**
  35081. * Registers a function to be called after every frame render
  35082. * @param func defines the function to register
  35083. */
  35084. registerAfterRender(func: () => void): void;
  35085. /**
  35086. * Unregisters a function called after every frame render
  35087. * @param func defines the function to unregister
  35088. */
  35089. unregisterAfterRender(func: () => void): void;
  35090. private _executeOnceBeforeRender;
  35091. /**
  35092. * The provided function will run before render once and will be disposed afterwards.
  35093. * A timeout delay can be provided so that the function will be executed in N ms.
  35094. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  35095. * @param func The function to be executed.
  35096. * @param timeout optional delay in ms
  35097. */
  35098. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  35099. /** @hidden */
  35100. _addPendingData(data: any): void;
  35101. /** @hidden */
  35102. _removePendingData(data: any): void;
  35103. /**
  35104. * Returns the number of items waiting to be loaded
  35105. * @returns the number of items waiting to be loaded
  35106. */
  35107. getWaitingItemsCount(): number;
  35108. /**
  35109. * Returns a boolean indicating if the scene is still loading data
  35110. */
  35111. readonly isLoading: boolean;
  35112. /**
  35113. * Registers a function to be executed when the scene is ready
  35114. * @param {Function} func - the function to be executed
  35115. */
  35116. executeWhenReady(func: () => void): void;
  35117. /**
  35118. * Returns a promise that resolves when the scene is ready
  35119. * @returns A promise that resolves when the scene is ready
  35120. */
  35121. whenReadyAsync(): Promise<void>;
  35122. /** @hidden */
  35123. _checkIsReady(): void;
  35124. /**
  35125. * Gets all animatable attached to the scene
  35126. */
  35127. readonly animatables: Animatable[];
  35128. /**
  35129. * Resets the last animation time frame.
  35130. * Useful to override when animations start running when loading a scene for the first time.
  35131. */
  35132. resetLastAnimationTimeFrame(): void;
  35133. /**
  35134. * Gets the current view matrix
  35135. * @returns a Matrix
  35136. */
  35137. getViewMatrix(): Matrix;
  35138. /**
  35139. * Gets the current projection matrix
  35140. * @returns a Matrix
  35141. */
  35142. getProjectionMatrix(): Matrix;
  35143. /**
  35144. * Gets the current transform matrix
  35145. * @returns a Matrix made of View * Projection
  35146. */
  35147. getTransformMatrix(): Matrix;
  35148. /**
  35149. * Sets the current transform matrix
  35150. * @param viewL defines the View matrix to use
  35151. * @param projectionL defines the Projection matrix to use
  35152. * @param viewR defines the right View matrix to use (if provided)
  35153. * @param projectionR defines the right Projection matrix to use (if provided)
  35154. */
  35155. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  35156. /**
  35157. * Gets the uniform buffer used to store scene data
  35158. * @returns a UniformBuffer
  35159. */
  35160. getSceneUniformBuffer(): UniformBuffer;
  35161. /**
  35162. * Gets an unique (relatively to the current scene) Id
  35163. * @returns an unique number for the scene
  35164. */
  35165. getUniqueId(): number;
  35166. /**
  35167. * Add a mesh to the list of scene's meshes
  35168. * @param newMesh defines the mesh to add
  35169. * @param recursive if all child meshes should also be added to the scene
  35170. */
  35171. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  35172. /**
  35173. * Remove a mesh for the list of scene's meshes
  35174. * @param toRemove defines the mesh to remove
  35175. * @param recursive if all child meshes should also be removed from the scene
  35176. * @returns the index where the mesh was in the mesh list
  35177. */
  35178. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  35179. /**
  35180. * Add a transform node to the list of scene's transform nodes
  35181. * @param newTransformNode defines the transform node to add
  35182. */
  35183. addTransformNode(newTransformNode: TransformNode): void;
  35184. /**
  35185. * Remove a transform node for the list of scene's transform nodes
  35186. * @param toRemove defines the transform node to remove
  35187. * @returns the index where the transform node was in the transform node list
  35188. */
  35189. removeTransformNode(toRemove: TransformNode): number;
  35190. /**
  35191. * Remove a skeleton for the list of scene's skeletons
  35192. * @param toRemove defines the skeleton to remove
  35193. * @returns the index where the skeleton was in the skeleton list
  35194. */
  35195. removeSkeleton(toRemove: Skeleton): number;
  35196. /**
  35197. * Remove a morph target for the list of scene's morph targets
  35198. * @param toRemove defines the morph target to remove
  35199. * @returns the index where the morph target was in the morph target list
  35200. */
  35201. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  35202. /**
  35203. * Remove a light for the list of scene's lights
  35204. * @param toRemove defines the light to remove
  35205. * @returns the index where the light was in the light list
  35206. */
  35207. removeLight(toRemove: Light): number;
  35208. /**
  35209. * Remove a camera for the list of scene's cameras
  35210. * @param toRemove defines the camera to remove
  35211. * @returns the index where the camera was in the camera list
  35212. */
  35213. removeCamera(toRemove: Camera): number;
  35214. /**
  35215. * Remove a particle system for the list of scene's particle systems
  35216. * @param toRemove defines the particle system to remove
  35217. * @returns the index where the particle system was in the particle system list
  35218. */
  35219. removeParticleSystem(toRemove: IParticleSystem): number;
  35220. /**
  35221. * Remove a animation for the list of scene's animations
  35222. * @param toRemove defines the animation to remove
  35223. * @returns the index where the animation was in the animation list
  35224. */
  35225. removeAnimation(toRemove: Animation): number;
  35226. /**
  35227. * Will stop the animation of the given target
  35228. * @param target - the target
  35229. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  35230. * @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)
  35231. */
  35232. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  35233. /**
  35234. * Removes the given animation group from this scene.
  35235. * @param toRemove The animation group to remove
  35236. * @returns The index of the removed animation group
  35237. */
  35238. removeAnimationGroup(toRemove: AnimationGroup): number;
  35239. /**
  35240. * Removes the given multi-material from this scene.
  35241. * @param toRemove The multi-material to remove
  35242. * @returns The index of the removed multi-material
  35243. */
  35244. removeMultiMaterial(toRemove: MultiMaterial): number;
  35245. /**
  35246. * Removes the given material from this scene.
  35247. * @param toRemove The material to remove
  35248. * @returns The index of the removed material
  35249. */
  35250. removeMaterial(toRemove: Material): number;
  35251. /**
  35252. * Removes the given action manager from this scene.
  35253. * @param toRemove The action manager to remove
  35254. * @returns The index of the removed action manager
  35255. */
  35256. removeActionManager(toRemove: AbstractActionManager): number;
  35257. /**
  35258. * Removes the given texture from this scene.
  35259. * @param toRemove The texture to remove
  35260. * @returns The index of the removed texture
  35261. */
  35262. removeTexture(toRemove: BaseTexture): number;
  35263. /**
  35264. * Adds the given light to this scene
  35265. * @param newLight The light to add
  35266. */
  35267. addLight(newLight: Light): void;
  35268. /**
  35269. * Sorts the list list based on light priorities
  35270. */
  35271. sortLightsByPriority(): void;
  35272. /**
  35273. * Adds the given camera to this scene
  35274. * @param newCamera The camera to add
  35275. */
  35276. addCamera(newCamera: Camera): void;
  35277. /**
  35278. * Adds the given skeleton to this scene
  35279. * @param newSkeleton The skeleton to add
  35280. */
  35281. addSkeleton(newSkeleton: Skeleton): void;
  35282. /**
  35283. * Adds the given particle system to this scene
  35284. * @param newParticleSystem The particle system to add
  35285. */
  35286. addParticleSystem(newParticleSystem: IParticleSystem): void;
  35287. /**
  35288. * Adds the given animation to this scene
  35289. * @param newAnimation The animation to add
  35290. */
  35291. addAnimation(newAnimation: Animation): void;
  35292. /**
  35293. * Adds the given animation group to this scene.
  35294. * @param newAnimationGroup The animation group to add
  35295. */
  35296. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  35297. /**
  35298. * Adds the given multi-material to this scene
  35299. * @param newMultiMaterial The multi-material to add
  35300. */
  35301. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  35302. /**
  35303. * Adds the given material to this scene
  35304. * @param newMaterial The material to add
  35305. */
  35306. addMaterial(newMaterial: Material): void;
  35307. /**
  35308. * Adds the given morph target to this scene
  35309. * @param newMorphTargetManager The morph target to add
  35310. */
  35311. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  35312. /**
  35313. * Adds the given geometry to this scene
  35314. * @param newGeometry The geometry to add
  35315. */
  35316. addGeometry(newGeometry: Geometry): void;
  35317. /**
  35318. * Adds the given action manager to this scene
  35319. * @param newActionManager The action manager to add
  35320. */
  35321. addActionManager(newActionManager: AbstractActionManager): void;
  35322. /**
  35323. * Adds the given texture to this scene.
  35324. * @param newTexture The texture to add
  35325. */
  35326. addTexture(newTexture: BaseTexture): void;
  35327. /**
  35328. * Switch active camera
  35329. * @param newCamera defines the new active camera
  35330. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  35331. */
  35332. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  35333. /**
  35334. * sets the active camera of the scene using its ID
  35335. * @param id defines the camera's ID
  35336. * @return the new active camera or null if none found.
  35337. */
  35338. setActiveCameraByID(id: string): Nullable<Camera>;
  35339. /**
  35340. * sets the active camera of the scene using its name
  35341. * @param name defines the camera's name
  35342. * @returns the new active camera or null if none found.
  35343. */
  35344. setActiveCameraByName(name: string): Nullable<Camera>;
  35345. /**
  35346. * get an animation group using its name
  35347. * @param name defines the material's name
  35348. * @return the animation group or null if none found.
  35349. */
  35350. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  35351. /**
  35352. * Get a material using its unique id
  35353. * @param uniqueId defines the material's unique id
  35354. * @return the material or null if none found.
  35355. */
  35356. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  35357. /**
  35358. * get a material using its id
  35359. * @param id defines the material's ID
  35360. * @return the material or null if none found.
  35361. */
  35362. getMaterialByID(id: string): Nullable<Material>;
  35363. /**
  35364. * Gets a the last added material using a given id
  35365. * @param id defines the material's ID
  35366. * @return the last material with the given id or null if none found.
  35367. */
  35368. getLastMaterialByID(id: string): Nullable<Material>;
  35369. /**
  35370. * Gets a material using its name
  35371. * @param name defines the material's name
  35372. * @return the material or null if none found.
  35373. */
  35374. getMaterialByName(name: string): Nullable<Material>;
  35375. /**
  35376. * Get a texture using its unique id
  35377. * @param uniqueId defines the texture's unique id
  35378. * @return the texture or null if none found.
  35379. */
  35380. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  35381. /**
  35382. * Gets a camera using its id
  35383. * @param id defines the id to look for
  35384. * @returns the camera or null if not found
  35385. */
  35386. getCameraByID(id: string): Nullable<Camera>;
  35387. /**
  35388. * Gets a camera using its unique id
  35389. * @param uniqueId defines the unique id to look for
  35390. * @returns the camera or null if not found
  35391. */
  35392. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  35393. /**
  35394. * Gets a camera using its name
  35395. * @param name defines the camera's name
  35396. * @return the camera or null if none found.
  35397. */
  35398. getCameraByName(name: string): Nullable<Camera>;
  35399. /**
  35400. * Gets a bone using its id
  35401. * @param id defines the bone's id
  35402. * @return the bone or null if not found
  35403. */
  35404. getBoneByID(id: string): Nullable<Bone>;
  35405. /**
  35406. * Gets a bone using its id
  35407. * @param name defines the bone's name
  35408. * @return the bone or null if not found
  35409. */
  35410. getBoneByName(name: string): Nullable<Bone>;
  35411. /**
  35412. * Gets a light node using its name
  35413. * @param name defines the the light's name
  35414. * @return the light or null if none found.
  35415. */
  35416. getLightByName(name: string): Nullable<Light>;
  35417. /**
  35418. * Gets a light node using its id
  35419. * @param id defines the light's id
  35420. * @return the light or null if none found.
  35421. */
  35422. getLightByID(id: string): Nullable<Light>;
  35423. /**
  35424. * Gets a light node using its scene-generated unique ID
  35425. * @param uniqueId defines the light's unique id
  35426. * @return the light or null if none found.
  35427. */
  35428. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  35429. /**
  35430. * Gets a particle system by id
  35431. * @param id defines the particle system id
  35432. * @return the corresponding system or null if none found
  35433. */
  35434. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  35435. /**
  35436. * Gets a geometry using its ID
  35437. * @param id defines the geometry's id
  35438. * @return the geometry or null if none found.
  35439. */
  35440. getGeometryByID(id: string): Nullable<Geometry>;
  35441. private _getGeometryByUniqueID;
  35442. /**
  35443. * Add a new geometry to this scene
  35444. * @param geometry defines the geometry to be added to the scene.
  35445. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  35446. * @return a boolean defining if the geometry was added or not
  35447. */
  35448. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  35449. /**
  35450. * Removes an existing geometry
  35451. * @param geometry defines the geometry to be removed from the scene
  35452. * @return a boolean defining if the geometry was removed or not
  35453. */
  35454. removeGeometry(geometry: Geometry): boolean;
  35455. /**
  35456. * Gets the list of geometries attached to the scene
  35457. * @returns an array of Geometry
  35458. */
  35459. getGeometries(): Geometry[];
  35460. /**
  35461. * Gets the first added mesh found of a given ID
  35462. * @param id defines the id to search for
  35463. * @return the mesh found or null if not found at all
  35464. */
  35465. getMeshByID(id: string): Nullable<AbstractMesh>;
  35466. /**
  35467. * Gets a list of meshes using their id
  35468. * @param id defines the id to search for
  35469. * @returns a list of meshes
  35470. */
  35471. getMeshesByID(id: string): Array<AbstractMesh>;
  35472. /**
  35473. * Gets the first added transform node found of a given ID
  35474. * @param id defines the id to search for
  35475. * @return the found transform node or null if not found at all.
  35476. */
  35477. getTransformNodeByID(id: string): Nullable<TransformNode>;
  35478. /**
  35479. * Gets a transform node with its auto-generated unique id
  35480. * @param uniqueId efines the unique id to search for
  35481. * @return the found transform node or null if not found at all.
  35482. */
  35483. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  35484. /**
  35485. * Gets a list of transform nodes using their id
  35486. * @param id defines the id to search for
  35487. * @returns a list of transform nodes
  35488. */
  35489. getTransformNodesByID(id: string): Array<TransformNode>;
  35490. /**
  35491. * Gets a mesh with its auto-generated unique id
  35492. * @param uniqueId defines the unique id to search for
  35493. * @return the found mesh or null if not found at all.
  35494. */
  35495. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  35496. /**
  35497. * Gets a the last added mesh using a given id
  35498. * @param id defines the id to search for
  35499. * @return the found mesh or null if not found at all.
  35500. */
  35501. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  35502. /**
  35503. * Gets a the last added node (Mesh, Camera, Light) using a given id
  35504. * @param id defines the id to search for
  35505. * @return the found node or null if not found at all
  35506. */
  35507. getLastEntryByID(id: string): Nullable<Node>;
  35508. /**
  35509. * Gets a node (Mesh, Camera, Light) using a given id
  35510. * @param id defines the id to search for
  35511. * @return the found node or null if not found at all
  35512. */
  35513. getNodeByID(id: string): Nullable<Node>;
  35514. /**
  35515. * Gets a node (Mesh, Camera, Light) using a given name
  35516. * @param name defines the name to search for
  35517. * @return the found node or null if not found at all.
  35518. */
  35519. getNodeByName(name: string): Nullable<Node>;
  35520. /**
  35521. * Gets a mesh using a given name
  35522. * @param name defines the name to search for
  35523. * @return the found mesh or null if not found at all.
  35524. */
  35525. getMeshByName(name: string): Nullable<AbstractMesh>;
  35526. /**
  35527. * Gets a transform node using a given name
  35528. * @param name defines the name to search for
  35529. * @return the found transform node or null if not found at all.
  35530. */
  35531. getTransformNodeByName(name: string): Nullable<TransformNode>;
  35532. /**
  35533. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  35534. * @param id defines the id to search for
  35535. * @return the found skeleton or null if not found at all.
  35536. */
  35537. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  35538. /**
  35539. * Gets a skeleton using a given auto generated unique id
  35540. * @param uniqueId defines the unique id to search for
  35541. * @return the found skeleton or null if not found at all.
  35542. */
  35543. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  35544. /**
  35545. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  35546. * @param id defines the id to search for
  35547. * @return the found skeleton or null if not found at all.
  35548. */
  35549. getSkeletonById(id: string): Nullable<Skeleton>;
  35550. /**
  35551. * Gets a skeleton using a given name
  35552. * @param name defines the name to search for
  35553. * @return the found skeleton or null if not found at all.
  35554. */
  35555. getSkeletonByName(name: string): Nullable<Skeleton>;
  35556. /**
  35557. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  35558. * @param id defines the id to search for
  35559. * @return the found morph target manager or null if not found at all.
  35560. */
  35561. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  35562. /**
  35563. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  35564. * @param id defines the id to search for
  35565. * @return the found morph target or null if not found at all.
  35566. */
  35567. getMorphTargetById(id: string): Nullable<MorphTarget>;
  35568. /**
  35569. * Gets a boolean indicating if the given mesh is active
  35570. * @param mesh defines the mesh to look for
  35571. * @returns true if the mesh is in the active list
  35572. */
  35573. isActiveMesh(mesh: AbstractMesh): boolean;
  35574. /**
  35575. * Return a unique id as a string which can serve as an identifier for the scene
  35576. */
  35577. readonly uid: string;
  35578. /**
  35579. * Add an externaly attached data from its key.
  35580. * This method call will fail and return false, if such key already exists.
  35581. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  35582. * @param key the unique key that identifies the data
  35583. * @param data the data object to associate to the key for this Engine instance
  35584. * @return true if no such key were already present and the data was added successfully, false otherwise
  35585. */
  35586. addExternalData<T>(key: string, data: T): boolean;
  35587. /**
  35588. * Get an externaly attached data from its key
  35589. * @param key the unique key that identifies the data
  35590. * @return the associated data, if present (can be null), or undefined if not present
  35591. */
  35592. getExternalData<T>(key: string): Nullable<T>;
  35593. /**
  35594. * Get an externaly attached data from its key, create it using a factory if it's not already present
  35595. * @param key the unique key that identifies the data
  35596. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  35597. * @return the associated data, can be null if the factory returned null.
  35598. */
  35599. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  35600. /**
  35601. * Remove an externaly attached data from the Engine instance
  35602. * @param key the unique key that identifies the data
  35603. * @return true if the data was successfully removed, false if it doesn't exist
  35604. */
  35605. removeExternalData(key: string): boolean;
  35606. private _evaluateSubMesh;
  35607. /**
  35608. * Clear the processed materials smart array preventing retention point in material dispose.
  35609. */
  35610. freeProcessedMaterials(): void;
  35611. private _preventFreeActiveMeshesAndRenderingGroups;
  35612. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  35613. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  35614. * when disposing several meshes in a row or a hierarchy of meshes.
  35615. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  35616. */
  35617. blockfreeActiveMeshesAndRenderingGroups: boolean;
  35618. /**
  35619. * Clear the active meshes smart array preventing retention point in mesh dispose.
  35620. */
  35621. freeActiveMeshes(): void;
  35622. /**
  35623. * Clear the info related to rendering groups preventing retention points during dispose.
  35624. */
  35625. freeRenderingGroups(): void;
  35626. /** @hidden */
  35627. _isInIntermediateRendering(): boolean;
  35628. /**
  35629. * Lambda returning the list of potentially active meshes.
  35630. */
  35631. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  35632. /**
  35633. * Lambda returning the list of potentially active sub meshes.
  35634. */
  35635. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  35636. /**
  35637. * Lambda returning the list of potentially intersecting sub meshes.
  35638. */
  35639. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  35640. /**
  35641. * Lambda returning the list of potentially colliding sub meshes.
  35642. */
  35643. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  35644. private _activeMeshesFrozen;
  35645. /**
  35646. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  35647. * @returns the current scene
  35648. */
  35649. freezeActiveMeshes(): Scene;
  35650. /**
  35651. * Use this function to restart evaluating active meshes on every frame
  35652. * @returns the current scene
  35653. */
  35654. unfreezeActiveMeshes(): Scene;
  35655. private _evaluateActiveMeshes;
  35656. private _activeMesh;
  35657. /**
  35658. * Update the transform matrix to update from the current active camera
  35659. * @param force defines a boolean used to force the update even if cache is up to date
  35660. */
  35661. updateTransformMatrix(force?: boolean): void;
  35662. private _bindFrameBuffer;
  35663. /** @hidden */
  35664. _allowPostProcessClearColor: boolean;
  35665. /** @hidden */
  35666. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  35667. private _processSubCameras;
  35668. private _checkIntersections;
  35669. /** @hidden */
  35670. _advancePhysicsEngineStep(step: number): void;
  35671. /**
  35672. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  35673. */
  35674. getDeterministicFrameTime: () => number;
  35675. /** @hidden */
  35676. _animate(): void;
  35677. /** Execute all animations (for a frame) */
  35678. animate(): void;
  35679. /**
  35680. * Render the scene
  35681. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  35682. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  35683. */
  35684. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  35685. /**
  35686. * Freeze all materials
  35687. * A frozen material will not be updatable but should be faster to render
  35688. */
  35689. freezeMaterials(): void;
  35690. /**
  35691. * Unfreeze all materials
  35692. * A frozen material will not be updatable but should be faster to render
  35693. */
  35694. unfreezeMaterials(): void;
  35695. /**
  35696. * Releases all held ressources
  35697. */
  35698. dispose(): void;
  35699. /**
  35700. * Gets if the scene is already disposed
  35701. */
  35702. readonly isDisposed: boolean;
  35703. /**
  35704. * Call this function to reduce memory footprint of the scene.
  35705. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  35706. */
  35707. clearCachedVertexData(): void;
  35708. /**
  35709. * This function will remove the local cached buffer data from texture.
  35710. * It will save memory but will prevent the texture from being rebuilt
  35711. */
  35712. cleanCachedTextureBuffer(): void;
  35713. /**
  35714. * Get the world extend vectors with an optional filter
  35715. *
  35716. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  35717. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  35718. */
  35719. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  35720. min: Vector3;
  35721. max: Vector3;
  35722. };
  35723. /**
  35724. * Creates a ray that can be used to pick in the scene
  35725. * @param x defines the x coordinate of the origin (on-screen)
  35726. * @param y defines the y coordinate of the origin (on-screen)
  35727. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  35728. * @param camera defines the camera to use for the picking
  35729. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  35730. * @returns a Ray
  35731. */
  35732. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  35733. /**
  35734. * Creates a ray that can be used to pick in the scene
  35735. * @param x defines the x coordinate of the origin (on-screen)
  35736. * @param y defines the y coordinate of the origin (on-screen)
  35737. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  35738. * @param result defines the ray where to store the picking ray
  35739. * @param camera defines the camera to use for the picking
  35740. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  35741. * @returns the current scene
  35742. */
  35743. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  35744. /**
  35745. * Creates a ray that can be used to pick in the scene
  35746. * @param x defines the x coordinate of the origin (on-screen)
  35747. * @param y defines the y coordinate of the origin (on-screen)
  35748. * @param camera defines the camera to use for the picking
  35749. * @returns a Ray
  35750. */
  35751. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  35752. /**
  35753. * Creates a ray that can be used to pick in the scene
  35754. * @param x defines the x coordinate of the origin (on-screen)
  35755. * @param y defines the y coordinate of the origin (on-screen)
  35756. * @param result defines the ray where to store the picking ray
  35757. * @param camera defines the camera to use for the picking
  35758. * @returns the current scene
  35759. */
  35760. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  35761. /** Launch a ray to try to pick a mesh in the scene
  35762. * @param x position on screen
  35763. * @param y position on screen
  35764. * @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
  35765. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  35766. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  35767. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35768. * @returns a PickingInfo
  35769. */
  35770. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  35771. /** Use the given ray to pick a mesh in the scene
  35772. * @param ray The ray to use to pick meshes
  35773. * @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
  35774. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null
  35775. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35776. * @returns a PickingInfo
  35777. */
  35778. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  35779. /**
  35780. * Launch a ray to try to pick a mesh in the scene
  35781. * @param x X position on screen
  35782. * @param y Y position on screen
  35783. * @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
  35784. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  35785. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35786. * @returns an array of PickingInfo
  35787. */
  35788. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  35789. /**
  35790. * Launch a ray to try to pick a mesh in the scene
  35791. * @param ray Ray to use
  35792. * @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
  35793. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35794. * @returns an array of PickingInfo
  35795. */
  35796. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  35797. /**
  35798. * Force the value of meshUnderPointer
  35799. * @param mesh defines the mesh to use
  35800. */
  35801. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  35802. /**
  35803. * Gets the mesh under the pointer
  35804. * @returns a Mesh or null if no mesh is under the pointer
  35805. */
  35806. getPointerOverMesh(): Nullable<AbstractMesh>;
  35807. /** @hidden */
  35808. _rebuildGeometries(): void;
  35809. /** @hidden */
  35810. _rebuildTextures(): void;
  35811. private _getByTags;
  35812. /**
  35813. * Get a list of meshes by tags
  35814. * @param tagsQuery defines the tags query to use
  35815. * @param forEach defines a predicate used to filter results
  35816. * @returns an array of Mesh
  35817. */
  35818. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  35819. /**
  35820. * Get a list of cameras by tags
  35821. * @param tagsQuery defines the tags query to use
  35822. * @param forEach defines a predicate used to filter results
  35823. * @returns an array of Camera
  35824. */
  35825. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  35826. /**
  35827. * Get a list of lights by tags
  35828. * @param tagsQuery defines the tags query to use
  35829. * @param forEach defines a predicate used to filter results
  35830. * @returns an array of Light
  35831. */
  35832. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  35833. /**
  35834. * Get a list of materials by tags
  35835. * @param tagsQuery defines the tags query to use
  35836. * @param forEach defines a predicate used to filter results
  35837. * @returns an array of Material
  35838. */
  35839. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  35840. /**
  35841. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  35842. * This allowed control for front to back rendering or reversly depending of the special needs.
  35843. *
  35844. * @param renderingGroupId The rendering group id corresponding to its index
  35845. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  35846. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  35847. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  35848. */
  35849. 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;
  35850. /**
  35851. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  35852. *
  35853. * @param renderingGroupId The rendering group id corresponding to its index
  35854. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  35855. * @param depth Automatically clears depth between groups if true and autoClear is true.
  35856. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  35857. */
  35858. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  35859. /**
  35860. * Gets the current auto clear configuration for one rendering group of the rendering
  35861. * manager.
  35862. * @param index the rendering group index to get the information for
  35863. * @returns The auto clear setup for the requested rendering group
  35864. */
  35865. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  35866. private _blockMaterialDirtyMechanism;
  35867. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  35868. blockMaterialDirtyMechanism: boolean;
  35869. /**
  35870. * Will flag all materials as dirty to trigger new shader compilation
  35871. * @param flag defines the flag used to specify which material part must be marked as dirty
  35872. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  35873. */
  35874. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  35875. /** @hidden */
  35876. _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;
  35877. /** @hidden */
  35878. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  35879. /** @hidden */
  35880. _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;
  35881. /** @hidden */
  35882. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  35883. /** @hidden */
  35884. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  35885. /** @hidden */
  35886. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  35887. }
  35888. }
  35889. declare module "babylonjs/assetContainer" {
  35890. import { AbstractScene } from "babylonjs/abstractScene";
  35891. import { Scene } from "babylonjs/scene";
  35892. import { Mesh } from "babylonjs/Meshes/mesh";
  35893. import { TransformNode } from "babylonjs/Meshes/transformNode";
  35894. import { Skeleton } from "babylonjs/Bones/skeleton";
  35895. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  35896. /**
  35897. * Set of assets to keep when moving a scene into an asset container.
  35898. */
  35899. export class KeepAssets extends AbstractScene {
  35900. }
  35901. /**
  35902. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  35903. */
  35904. export class InstantiatedEntries {
  35905. /**
  35906. * List of new root nodes (eg. nodes with no parent)
  35907. */
  35908. rootNodes: TransformNode[];
  35909. /**
  35910. * List of new skeletons
  35911. */
  35912. skeletons: Skeleton[];
  35913. /**
  35914. * List of new animation groups
  35915. */
  35916. animationGroups: AnimationGroup[];
  35917. }
  35918. /**
  35919. * Container with a set of assets that can be added or removed from a scene.
  35920. */
  35921. export class AssetContainer extends AbstractScene {
  35922. /**
  35923. * The scene the AssetContainer belongs to.
  35924. */
  35925. scene: Scene;
  35926. /**
  35927. * Instantiates an AssetContainer.
  35928. * @param scene The scene the AssetContainer belongs to.
  35929. */
  35930. constructor(scene: Scene);
  35931. /**
  35932. * Instantiate or clone all meshes and add the new ones to the scene.
  35933. * Skeletons and animation groups will all be cloned
  35934. * @param nameFunction defines an optional function used to get new names for clones
  35935. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  35936. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  35937. */
  35938. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  35939. /**
  35940. * Adds all the assets from the container to the scene.
  35941. */
  35942. addAllToScene(): void;
  35943. /**
  35944. * Removes all the assets in the container from the scene
  35945. */
  35946. removeAllFromScene(): void;
  35947. /**
  35948. * Disposes all the assets in the container
  35949. */
  35950. dispose(): void;
  35951. private _moveAssets;
  35952. /**
  35953. * Removes all the assets contained in the scene and adds them to the container.
  35954. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  35955. */
  35956. moveAllFromScene(keepAssets?: KeepAssets): void;
  35957. /**
  35958. * 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.
  35959. * @returns the root mesh
  35960. */
  35961. createRootMesh(): Mesh;
  35962. }
  35963. }
  35964. declare module "babylonjs/abstractScene" {
  35965. import { Scene } from "babylonjs/scene";
  35966. import { Nullable } from "babylonjs/types";
  35967. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  35968. import { TransformNode } from "babylonjs/Meshes/transformNode";
  35969. import { Geometry } from "babylonjs/Meshes/geometry";
  35970. import { Skeleton } from "babylonjs/Bones/skeleton";
  35971. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  35972. import { AssetContainer } from "babylonjs/assetContainer";
  35973. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  35974. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  35975. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35976. import { Material } from "babylonjs/Materials/material";
  35977. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  35978. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  35979. import { Camera } from "babylonjs/Cameras/camera";
  35980. import { Light } from "babylonjs/Lights/light";
  35981. import { Node } from "babylonjs/node";
  35982. import { Animation } from "babylonjs/Animations/animation";
  35983. /**
  35984. * Defines how the parser contract is defined.
  35985. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  35986. */
  35987. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  35988. /**
  35989. * Defines how the individual parser contract is defined.
  35990. * These parser can parse an individual asset
  35991. */
  35992. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  35993. /**
  35994. * Base class of the scene acting as a container for the different elements composing a scene.
  35995. * This class is dynamically extended by the different components of the scene increasing
  35996. * flexibility and reducing coupling
  35997. */
  35998. export abstract class AbstractScene {
  35999. /**
  36000. * Stores the list of available parsers in the application.
  36001. */
  36002. private static _BabylonFileParsers;
  36003. /**
  36004. * Stores the list of available individual parsers in the application.
  36005. */
  36006. private static _IndividualBabylonFileParsers;
  36007. /**
  36008. * Adds a parser in the list of available ones
  36009. * @param name Defines the name of the parser
  36010. * @param parser Defines the parser to add
  36011. */
  36012. static AddParser(name: string, parser: BabylonFileParser): void;
  36013. /**
  36014. * Gets a general parser from the list of avaialble ones
  36015. * @param name Defines the name of the parser
  36016. * @returns the requested parser or null
  36017. */
  36018. static GetParser(name: string): Nullable<BabylonFileParser>;
  36019. /**
  36020. * Adds n individual parser in the list of available ones
  36021. * @param name Defines the name of the parser
  36022. * @param parser Defines the parser to add
  36023. */
  36024. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  36025. /**
  36026. * Gets an individual parser from the list of avaialble ones
  36027. * @param name Defines the name of the parser
  36028. * @returns the requested parser or null
  36029. */
  36030. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  36031. /**
  36032. * Parser json data and populate both a scene and its associated container object
  36033. * @param jsonData Defines the data to parse
  36034. * @param scene Defines the scene to parse the data for
  36035. * @param container Defines the container attached to the parsing sequence
  36036. * @param rootUrl Defines the root url of the data
  36037. */
  36038. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  36039. /**
  36040. * Gets the list of root nodes (ie. nodes with no parent)
  36041. */
  36042. rootNodes: Node[];
  36043. /** All of the cameras added to this scene
  36044. * @see http://doc.babylonjs.com/babylon101/cameras
  36045. */
  36046. cameras: Camera[];
  36047. /**
  36048. * All of the lights added to this scene
  36049. * @see http://doc.babylonjs.com/babylon101/lights
  36050. */
  36051. lights: Light[];
  36052. /**
  36053. * All of the (abstract) meshes added to this scene
  36054. */
  36055. meshes: AbstractMesh[];
  36056. /**
  36057. * The list of skeletons added to the scene
  36058. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  36059. */
  36060. skeletons: Skeleton[];
  36061. /**
  36062. * All of the particle systems added to this scene
  36063. * @see http://doc.babylonjs.com/babylon101/particles
  36064. */
  36065. particleSystems: IParticleSystem[];
  36066. /**
  36067. * Gets a list of Animations associated with the scene
  36068. */
  36069. animations: Animation[];
  36070. /**
  36071. * All of the animation groups added to this scene
  36072. * @see http://doc.babylonjs.com/how_to/group
  36073. */
  36074. animationGroups: AnimationGroup[];
  36075. /**
  36076. * All of the multi-materials added to this scene
  36077. * @see http://doc.babylonjs.com/how_to/multi_materials
  36078. */
  36079. multiMaterials: MultiMaterial[];
  36080. /**
  36081. * All of the materials added to this scene
  36082. * In the context of a Scene, it is not supposed to be modified manually.
  36083. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  36084. * Note also that the order of the Material within the array is not significant and might change.
  36085. * @see http://doc.babylonjs.com/babylon101/materials
  36086. */
  36087. materials: Material[];
  36088. /**
  36089. * The list of morph target managers added to the scene
  36090. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  36091. */
  36092. morphTargetManagers: MorphTargetManager[];
  36093. /**
  36094. * The list of geometries used in the scene.
  36095. */
  36096. geometries: Geometry[];
  36097. /**
  36098. * All of the tranform nodes added to this scene
  36099. * In the context of a Scene, it is not supposed to be modified manually.
  36100. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  36101. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  36102. * @see http://doc.babylonjs.com/how_to/transformnode
  36103. */
  36104. transformNodes: TransformNode[];
  36105. /**
  36106. * ActionManagers available on the scene.
  36107. */
  36108. actionManagers: AbstractActionManager[];
  36109. /**
  36110. * Textures to keep.
  36111. */
  36112. textures: BaseTexture[];
  36113. /**
  36114. * Environment texture for the scene
  36115. */
  36116. environmentTexture: Nullable<BaseTexture>;
  36117. }
  36118. }
  36119. declare module "babylonjs/Audio/sound" {
  36120. import { Observable } from "babylonjs/Misc/observable";
  36121. import { Vector3 } from "babylonjs/Maths/math.vector";
  36122. import { Nullable } from "babylonjs/types";
  36123. import { Scene } from "babylonjs/scene";
  36124. import { TransformNode } from "babylonjs/Meshes/transformNode";
  36125. /**
  36126. * Interface used to define options for Sound class
  36127. */
  36128. export interface ISoundOptions {
  36129. /**
  36130. * Does the sound autoplay once loaded.
  36131. */
  36132. autoplay?: boolean;
  36133. /**
  36134. * Does the sound loop after it finishes playing once.
  36135. */
  36136. loop?: boolean;
  36137. /**
  36138. * Sound's volume
  36139. */
  36140. volume?: number;
  36141. /**
  36142. * Is it a spatial sound?
  36143. */
  36144. spatialSound?: boolean;
  36145. /**
  36146. * Maximum distance to hear that sound
  36147. */
  36148. maxDistance?: number;
  36149. /**
  36150. * Uses user defined attenuation function
  36151. */
  36152. useCustomAttenuation?: boolean;
  36153. /**
  36154. * Define the roll off factor of spatial sounds.
  36155. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36156. */
  36157. rolloffFactor?: number;
  36158. /**
  36159. * Define the reference distance the sound should be heard perfectly.
  36160. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36161. */
  36162. refDistance?: number;
  36163. /**
  36164. * Define the distance attenuation model the sound will follow.
  36165. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36166. */
  36167. distanceModel?: string;
  36168. /**
  36169. * Defines the playback speed (1 by default)
  36170. */
  36171. playbackRate?: number;
  36172. /**
  36173. * Defines if the sound is from a streaming source
  36174. */
  36175. streaming?: boolean;
  36176. /**
  36177. * Defines an optional length (in seconds) inside the sound file
  36178. */
  36179. length?: number;
  36180. /**
  36181. * Defines an optional offset (in seconds) inside the sound file
  36182. */
  36183. offset?: number;
  36184. /**
  36185. * If true, URLs will not be required to state the audio file codec to use.
  36186. */
  36187. skipCodecCheck?: boolean;
  36188. }
  36189. /**
  36190. * Defines a sound that can be played in the application.
  36191. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  36192. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36193. */
  36194. export class Sound {
  36195. /**
  36196. * The name of the sound in the scene.
  36197. */
  36198. name: string;
  36199. /**
  36200. * Does the sound autoplay once loaded.
  36201. */
  36202. autoplay: boolean;
  36203. /**
  36204. * Does the sound loop after it finishes playing once.
  36205. */
  36206. loop: boolean;
  36207. /**
  36208. * Does the sound use a custom attenuation curve to simulate the falloff
  36209. * happening when the source gets further away from the camera.
  36210. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  36211. */
  36212. useCustomAttenuation: boolean;
  36213. /**
  36214. * The sound track id this sound belongs to.
  36215. */
  36216. soundTrackId: number;
  36217. /**
  36218. * Is this sound currently played.
  36219. */
  36220. isPlaying: boolean;
  36221. /**
  36222. * Is this sound currently paused.
  36223. */
  36224. isPaused: boolean;
  36225. /**
  36226. * Does this sound enables spatial sound.
  36227. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36228. */
  36229. spatialSound: boolean;
  36230. /**
  36231. * Define the reference distance the sound should be heard perfectly.
  36232. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36233. */
  36234. refDistance: number;
  36235. /**
  36236. * Define the roll off factor of spatial sounds.
  36237. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36238. */
  36239. rolloffFactor: number;
  36240. /**
  36241. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  36242. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36243. */
  36244. maxDistance: number;
  36245. /**
  36246. * Define the distance attenuation model the sound will follow.
  36247. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36248. */
  36249. distanceModel: string;
  36250. /**
  36251. * @hidden
  36252. * Back Compat
  36253. **/
  36254. onended: () => any;
  36255. /**
  36256. * Observable event when the current playing sound finishes.
  36257. */
  36258. onEndedObservable: Observable<Sound>;
  36259. private _panningModel;
  36260. private _playbackRate;
  36261. private _streaming;
  36262. private _startTime;
  36263. private _startOffset;
  36264. private _position;
  36265. /** @hidden */
  36266. _positionInEmitterSpace: boolean;
  36267. private _localDirection;
  36268. private _volume;
  36269. private _isReadyToPlay;
  36270. private _isDirectional;
  36271. private _readyToPlayCallback;
  36272. private _audioBuffer;
  36273. private _soundSource;
  36274. private _streamingSource;
  36275. private _soundPanner;
  36276. private _soundGain;
  36277. private _inputAudioNode;
  36278. private _outputAudioNode;
  36279. private _coneInnerAngle;
  36280. private _coneOuterAngle;
  36281. private _coneOuterGain;
  36282. private _scene;
  36283. private _connectedTransformNode;
  36284. private _customAttenuationFunction;
  36285. private _registerFunc;
  36286. private _isOutputConnected;
  36287. private _htmlAudioElement;
  36288. private _urlType;
  36289. private _length?;
  36290. private _offset?;
  36291. /** @hidden */
  36292. static _SceneComponentInitialization: (scene: Scene) => void;
  36293. /**
  36294. * Create a sound and attach it to a scene
  36295. * @param name Name of your sound
  36296. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  36297. * @param scene defines the scene the sound belongs to
  36298. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  36299. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  36300. */
  36301. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  36302. /**
  36303. * Release the sound and its associated resources
  36304. */
  36305. dispose(): void;
  36306. /**
  36307. * Gets if the sounds is ready to be played or not.
  36308. * @returns true if ready, otherwise false
  36309. */
  36310. isReady(): boolean;
  36311. private _soundLoaded;
  36312. /**
  36313. * Sets the data of the sound from an audiobuffer
  36314. * @param audioBuffer The audioBuffer containing the data
  36315. */
  36316. setAudioBuffer(audioBuffer: AudioBuffer): void;
  36317. /**
  36318. * Updates the current sounds options such as maxdistance, loop...
  36319. * @param options A JSON object containing values named as the object properties
  36320. */
  36321. updateOptions(options: ISoundOptions): void;
  36322. private _createSpatialParameters;
  36323. private _updateSpatialParameters;
  36324. /**
  36325. * Switch the panning model to HRTF:
  36326. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  36327. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36328. */
  36329. switchPanningModelToHRTF(): void;
  36330. /**
  36331. * Switch the panning model to Equal Power:
  36332. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  36333. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36334. */
  36335. switchPanningModelToEqualPower(): void;
  36336. private _switchPanningModel;
  36337. /**
  36338. * Connect this sound to a sound track audio node like gain...
  36339. * @param soundTrackAudioNode the sound track audio node to connect to
  36340. */
  36341. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  36342. /**
  36343. * Transform this sound into a directional source
  36344. * @param coneInnerAngle Size of the inner cone in degree
  36345. * @param coneOuterAngle Size of the outer cone in degree
  36346. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  36347. */
  36348. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  36349. /**
  36350. * Gets or sets the inner angle for the directional cone.
  36351. */
  36352. /**
  36353. * Gets or sets the inner angle for the directional cone.
  36354. */
  36355. directionalConeInnerAngle: number;
  36356. /**
  36357. * Gets or sets the outer angle for the directional cone.
  36358. */
  36359. /**
  36360. * Gets or sets the outer angle for the directional cone.
  36361. */
  36362. directionalConeOuterAngle: number;
  36363. /**
  36364. * Sets the position of the emitter if spatial sound is enabled
  36365. * @param newPosition Defines the new posisiton
  36366. */
  36367. setPosition(newPosition: Vector3): void;
  36368. /**
  36369. * Sets the local direction of the emitter if spatial sound is enabled
  36370. * @param newLocalDirection Defines the new local direction
  36371. */
  36372. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  36373. private _updateDirection;
  36374. /** @hidden */
  36375. updateDistanceFromListener(): void;
  36376. /**
  36377. * Sets a new custom attenuation function for the sound.
  36378. * @param callback Defines the function used for the attenuation
  36379. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  36380. */
  36381. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  36382. /**
  36383. * Play the sound
  36384. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  36385. * @param offset (optional) Start the sound at a specific time in seconds
  36386. * @param length (optional) Sound duration (in seconds)
  36387. */
  36388. play(time?: number, offset?: number, length?: number): void;
  36389. private _onended;
  36390. /**
  36391. * Stop the sound
  36392. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  36393. */
  36394. stop(time?: number): void;
  36395. /**
  36396. * Put the sound in pause
  36397. */
  36398. pause(): void;
  36399. /**
  36400. * Sets a dedicated volume for this sounds
  36401. * @param newVolume Define the new volume of the sound
  36402. * @param time Define time for gradual change to new volume
  36403. */
  36404. setVolume(newVolume: number, time?: number): void;
  36405. /**
  36406. * Set the sound play back rate
  36407. * @param newPlaybackRate Define the playback rate the sound should be played at
  36408. */
  36409. setPlaybackRate(newPlaybackRate: number): void;
  36410. /**
  36411. * Gets the volume of the sound.
  36412. * @returns the volume of the sound
  36413. */
  36414. getVolume(): number;
  36415. /**
  36416. * Attach the sound to a dedicated mesh
  36417. * @param transformNode The transform node to connect the sound with
  36418. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  36419. */
  36420. attachToMesh(transformNode: TransformNode): void;
  36421. /**
  36422. * Detach the sound from the previously attached mesh
  36423. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  36424. */
  36425. detachFromMesh(): void;
  36426. private _onRegisterAfterWorldMatrixUpdate;
  36427. /**
  36428. * Clone the current sound in the scene.
  36429. * @returns the new sound clone
  36430. */
  36431. clone(): Nullable<Sound>;
  36432. /**
  36433. * Gets the current underlying audio buffer containing the data
  36434. * @returns the audio buffer
  36435. */
  36436. getAudioBuffer(): Nullable<AudioBuffer>;
  36437. /**
  36438. * Serializes the Sound in a JSON representation
  36439. * @returns the JSON representation of the sound
  36440. */
  36441. serialize(): any;
  36442. /**
  36443. * Parse a JSON representation of a sound to innstantiate in a given scene
  36444. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  36445. * @param scene Define the scene the new parsed sound should be created in
  36446. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  36447. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  36448. * @returns the newly parsed sound
  36449. */
  36450. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  36451. }
  36452. }
  36453. declare module "babylonjs/Actions/directAudioActions" {
  36454. import { Action } from "babylonjs/Actions/action";
  36455. import { Condition } from "babylonjs/Actions/condition";
  36456. import { Sound } from "babylonjs/Audio/sound";
  36457. /**
  36458. * This defines an action helpful to play a defined sound on a triggered action.
  36459. */
  36460. export class PlaySoundAction extends Action {
  36461. private _sound;
  36462. /**
  36463. * Instantiate the action
  36464. * @param triggerOptions defines the trigger options
  36465. * @param sound defines the sound to play
  36466. * @param condition defines the trigger related conditions
  36467. */
  36468. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  36469. /** @hidden */
  36470. _prepare(): void;
  36471. /**
  36472. * Execute the action and play the sound.
  36473. */
  36474. execute(): void;
  36475. /**
  36476. * Serializes the actions and its related information.
  36477. * @param parent defines the object to serialize in
  36478. * @returns the serialized object
  36479. */
  36480. serialize(parent: any): any;
  36481. }
  36482. /**
  36483. * This defines an action helpful to stop a defined sound on a triggered action.
  36484. */
  36485. export class StopSoundAction extends Action {
  36486. private _sound;
  36487. /**
  36488. * Instantiate the action
  36489. * @param triggerOptions defines the trigger options
  36490. * @param sound defines the sound to stop
  36491. * @param condition defines the trigger related conditions
  36492. */
  36493. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  36494. /** @hidden */
  36495. _prepare(): void;
  36496. /**
  36497. * Execute the action and stop the sound.
  36498. */
  36499. execute(): void;
  36500. /**
  36501. * Serializes the actions and its related information.
  36502. * @param parent defines the object to serialize in
  36503. * @returns the serialized object
  36504. */
  36505. serialize(parent: any): any;
  36506. }
  36507. }
  36508. declare module "babylonjs/Actions/interpolateValueAction" {
  36509. import { Action } from "babylonjs/Actions/action";
  36510. import { Condition } from "babylonjs/Actions/condition";
  36511. import { Observable } from "babylonjs/Misc/observable";
  36512. /**
  36513. * This defines an action responsible to change the value of a property
  36514. * by interpolating between its current value and the newly set one once triggered.
  36515. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  36516. */
  36517. export class InterpolateValueAction extends Action {
  36518. /**
  36519. * Defines the path of the property where the value should be interpolated
  36520. */
  36521. propertyPath: string;
  36522. /**
  36523. * Defines the target value at the end of the interpolation.
  36524. */
  36525. value: any;
  36526. /**
  36527. * Defines the time it will take for the property to interpolate to the value.
  36528. */
  36529. duration: number;
  36530. /**
  36531. * Defines if the other scene animations should be stopped when the action has been triggered
  36532. */
  36533. stopOtherAnimations?: boolean;
  36534. /**
  36535. * Defines a callback raised once the interpolation animation has been done.
  36536. */
  36537. onInterpolationDone?: () => void;
  36538. /**
  36539. * Observable triggered once the interpolation animation has been done.
  36540. */
  36541. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  36542. private _target;
  36543. private _effectiveTarget;
  36544. private _property;
  36545. /**
  36546. * Instantiate the action
  36547. * @param triggerOptions defines the trigger options
  36548. * @param target defines the object containing the value to interpolate
  36549. * @param propertyPath defines the path to the property in the target object
  36550. * @param value defines the target value at the end of the interpolation
  36551. * @param duration deines the time it will take for the property to interpolate to the value.
  36552. * @param condition defines the trigger related conditions
  36553. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  36554. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  36555. */
  36556. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  36557. /** @hidden */
  36558. _prepare(): void;
  36559. /**
  36560. * Execute the action starts the value interpolation.
  36561. */
  36562. execute(): void;
  36563. /**
  36564. * Serializes the actions and its related information.
  36565. * @param parent defines the object to serialize in
  36566. * @returns the serialized object
  36567. */
  36568. serialize(parent: any): any;
  36569. }
  36570. }
  36571. declare module "babylonjs/Actions/index" {
  36572. export * from "babylonjs/Actions/abstractActionManager";
  36573. export * from "babylonjs/Actions/action";
  36574. export * from "babylonjs/Actions/actionEvent";
  36575. export * from "babylonjs/Actions/actionManager";
  36576. export * from "babylonjs/Actions/condition";
  36577. export * from "babylonjs/Actions/directActions";
  36578. export * from "babylonjs/Actions/directAudioActions";
  36579. export * from "babylonjs/Actions/interpolateValueAction";
  36580. }
  36581. declare module "babylonjs/Animations/index" {
  36582. export * from "babylonjs/Animations/animatable";
  36583. export * from "babylonjs/Animations/animation";
  36584. export * from "babylonjs/Animations/animationGroup";
  36585. export * from "babylonjs/Animations/animationPropertiesOverride";
  36586. export * from "babylonjs/Animations/easing";
  36587. export * from "babylonjs/Animations/runtimeAnimation";
  36588. export * from "babylonjs/Animations/animationEvent";
  36589. export * from "babylonjs/Animations/animationGroup";
  36590. export * from "babylonjs/Animations/animationKey";
  36591. export * from "babylonjs/Animations/animationRange";
  36592. export * from "babylonjs/Animations/animatable.interface";
  36593. }
  36594. declare module "babylonjs/Audio/soundTrack" {
  36595. import { Sound } from "babylonjs/Audio/sound";
  36596. import { Analyser } from "babylonjs/Audio/analyser";
  36597. import { Scene } from "babylonjs/scene";
  36598. /**
  36599. * Options allowed during the creation of a sound track.
  36600. */
  36601. export interface ISoundTrackOptions {
  36602. /**
  36603. * The volume the sound track should take during creation
  36604. */
  36605. volume?: number;
  36606. /**
  36607. * Define if the sound track is the main sound track of the scene
  36608. */
  36609. mainTrack?: boolean;
  36610. }
  36611. /**
  36612. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  36613. * It will be also used in a future release to apply effects on a specific track.
  36614. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  36615. */
  36616. export class SoundTrack {
  36617. /**
  36618. * The unique identifier of the sound track in the scene.
  36619. */
  36620. id: number;
  36621. /**
  36622. * The list of sounds included in the sound track.
  36623. */
  36624. soundCollection: Array<Sound>;
  36625. private _outputAudioNode;
  36626. private _scene;
  36627. private _isMainTrack;
  36628. private _connectedAnalyser;
  36629. private _options;
  36630. private _isInitialized;
  36631. /**
  36632. * Creates a new sound track.
  36633. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  36634. * @param scene Define the scene the sound track belongs to
  36635. * @param options
  36636. */
  36637. constructor(scene: Scene, options?: ISoundTrackOptions);
  36638. private _initializeSoundTrackAudioGraph;
  36639. /**
  36640. * Release the sound track and its associated resources
  36641. */
  36642. dispose(): void;
  36643. /**
  36644. * Adds a sound to this sound track
  36645. * @param sound define the cound to add
  36646. * @ignoreNaming
  36647. */
  36648. AddSound(sound: Sound): void;
  36649. /**
  36650. * Removes a sound to this sound track
  36651. * @param sound define the cound to remove
  36652. * @ignoreNaming
  36653. */
  36654. RemoveSound(sound: Sound): void;
  36655. /**
  36656. * Set a global volume for the full sound track.
  36657. * @param newVolume Define the new volume of the sound track
  36658. */
  36659. setVolume(newVolume: number): void;
  36660. /**
  36661. * Switch the panning model to HRTF:
  36662. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  36663. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36664. */
  36665. switchPanningModelToHRTF(): void;
  36666. /**
  36667. * Switch the panning model to Equal Power:
  36668. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  36669. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36670. */
  36671. switchPanningModelToEqualPower(): void;
  36672. /**
  36673. * Connect the sound track to an audio analyser allowing some amazing
  36674. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  36675. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  36676. * @param analyser The analyser to connect to the engine
  36677. */
  36678. connectToAnalyser(analyser: Analyser): void;
  36679. }
  36680. }
  36681. declare module "babylonjs/Audio/audioSceneComponent" {
  36682. import { Sound } from "babylonjs/Audio/sound";
  36683. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  36684. import { Nullable } from "babylonjs/types";
  36685. import { Vector3 } from "babylonjs/Maths/math.vector";
  36686. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  36687. import { Scene } from "babylonjs/scene";
  36688. import { AbstractScene } from "babylonjs/abstractScene";
  36689. import "babylonjs/Audio/audioEngine";
  36690. module "babylonjs/abstractScene" {
  36691. interface AbstractScene {
  36692. /**
  36693. * The list of sounds used in the scene.
  36694. */
  36695. sounds: Nullable<Array<Sound>>;
  36696. }
  36697. }
  36698. module "babylonjs/scene" {
  36699. interface Scene {
  36700. /**
  36701. * @hidden
  36702. * Backing field
  36703. */
  36704. _mainSoundTrack: SoundTrack;
  36705. /**
  36706. * The main sound track played by the scene.
  36707. * It cotains your primary collection of sounds.
  36708. */
  36709. mainSoundTrack: SoundTrack;
  36710. /**
  36711. * The list of sound tracks added to the scene
  36712. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36713. */
  36714. soundTracks: Nullable<Array<SoundTrack>>;
  36715. /**
  36716. * Gets a sound using a given name
  36717. * @param name defines the name to search for
  36718. * @return the found sound or null if not found at all.
  36719. */
  36720. getSoundByName(name: string): Nullable<Sound>;
  36721. /**
  36722. * Gets or sets if audio support is enabled
  36723. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36724. */
  36725. audioEnabled: boolean;
  36726. /**
  36727. * Gets or sets if audio will be output to headphones
  36728. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36729. */
  36730. headphone: boolean;
  36731. /**
  36732. * Gets or sets custom audio listener position provider
  36733. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36734. */
  36735. audioListenerPositionProvider: Nullable<() => Vector3>;
  36736. /**
  36737. * Gets or sets a refresh rate when using 3D audio positioning
  36738. */
  36739. audioPositioningRefreshRate: number;
  36740. }
  36741. }
  36742. /**
  36743. * Defines the sound scene component responsible to manage any sounds
  36744. * in a given scene.
  36745. */
  36746. export class AudioSceneComponent implements ISceneSerializableComponent {
  36747. /**
  36748. * The component name helpfull to identify the component in the list of scene components.
  36749. */
  36750. readonly name: string;
  36751. /**
  36752. * The scene the component belongs to.
  36753. */
  36754. scene: Scene;
  36755. private _audioEnabled;
  36756. /**
  36757. * Gets whether audio is enabled or not.
  36758. * Please use related enable/disable method to switch state.
  36759. */
  36760. readonly audioEnabled: boolean;
  36761. private _headphone;
  36762. /**
  36763. * Gets whether audio is outputing to headphone or not.
  36764. * Please use the according Switch methods to change output.
  36765. */
  36766. readonly headphone: boolean;
  36767. /**
  36768. * Gets or sets a refresh rate when using 3D audio positioning
  36769. */
  36770. audioPositioningRefreshRate: number;
  36771. private _audioListenerPositionProvider;
  36772. /**
  36773. * Gets the current audio listener position provider
  36774. */
  36775. /**
  36776. * Sets a custom listener position for all sounds in the scene
  36777. * By default, this is the position of the first active camera
  36778. */
  36779. audioListenerPositionProvider: Nullable<() => Vector3>;
  36780. /**
  36781. * Creates a new instance of the component for the given scene
  36782. * @param scene Defines the scene to register the component in
  36783. */
  36784. constructor(scene: Scene);
  36785. /**
  36786. * Registers the component in a given scene
  36787. */
  36788. register(): void;
  36789. /**
  36790. * Rebuilds the elements related to this component in case of
  36791. * context lost for instance.
  36792. */
  36793. rebuild(): void;
  36794. /**
  36795. * Serializes the component data to the specified json object
  36796. * @param serializationObject The object to serialize to
  36797. */
  36798. serialize(serializationObject: any): void;
  36799. /**
  36800. * Adds all the elements from the container to the scene
  36801. * @param container the container holding the elements
  36802. */
  36803. addFromContainer(container: AbstractScene): void;
  36804. /**
  36805. * Removes all the elements in the container from the scene
  36806. * @param container contains the elements to remove
  36807. * @param dispose if the removed element should be disposed (default: false)
  36808. */
  36809. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  36810. /**
  36811. * Disposes the component and the associated ressources.
  36812. */
  36813. dispose(): void;
  36814. /**
  36815. * Disables audio in the associated scene.
  36816. */
  36817. disableAudio(): void;
  36818. /**
  36819. * Enables audio in the associated scene.
  36820. */
  36821. enableAudio(): void;
  36822. /**
  36823. * Switch audio to headphone output.
  36824. */
  36825. switchAudioModeForHeadphones(): void;
  36826. /**
  36827. * Switch audio to normal speakers.
  36828. */
  36829. switchAudioModeForNormalSpeakers(): void;
  36830. private _cachedCameraDirection;
  36831. private _cachedCameraPosition;
  36832. private _lastCheck;
  36833. private _afterRender;
  36834. }
  36835. }
  36836. declare module "babylonjs/Audio/weightedsound" {
  36837. import { Sound } from "babylonjs/Audio/sound";
  36838. /**
  36839. * Wraps one or more Sound objects and selects one with random weight for playback.
  36840. */
  36841. export class WeightedSound {
  36842. /** When true a Sound will be selected and played when the current playing Sound completes. */
  36843. loop: boolean;
  36844. private _coneInnerAngle;
  36845. private _coneOuterAngle;
  36846. private _volume;
  36847. /** A Sound is currently playing. */
  36848. isPlaying: boolean;
  36849. /** A Sound is currently paused. */
  36850. isPaused: boolean;
  36851. private _sounds;
  36852. private _weights;
  36853. private _currentIndex?;
  36854. /**
  36855. * Creates a new WeightedSound from the list of sounds given.
  36856. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  36857. * @param sounds Array of Sounds that will be selected from.
  36858. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  36859. */
  36860. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  36861. /**
  36862. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  36863. */
  36864. /**
  36865. * The size of cone in degress for a directional sound in which there will be no attenuation.
  36866. */
  36867. directionalConeInnerAngle: number;
  36868. /**
  36869. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  36870. * Listener angles between innerAngle and outerAngle will falloff linearly.
  36871. */
  36872. /**
  36873. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  36874. * Listener angles between innerAngle and outerAngle will falloff linearly.
  36875. */
  36876. directionalConeOuterAngle: number;
  36877. /**
  36878. * Playback volume.
  36879. */
  36880. /**
  36881. * Playback volume.
  36882. */
  36883. volume: number;
  36884. private _onended;
  36885. /**
  36886. * Suspend playback
  36887. */
  36888. pause(): void;
  36889. /**
  36890. * Stop playback
  36891. */
  36892. stop(): void;
  36893. /**
  36894. * Start playback.
  36895. * @param startOffset Position the clip head at a specific time in seconds.
  36896. */
  36897. play(startOffset?: number): void;
  36898. }
  36899. }
  36900. declare module "babylonjs/Audio/index" {
  36901. export * from "babylonjs/Audio/analyser";
  36902. export * from "babylonjs/Audio/audioEngine";
  36903. export * from "babylonjs/Audio/audioSceneComponent";
  36904. export * from "babylonjs/Audio/sound";
  36905. export * from "babylonjs/Audio/soundTrack";
  36906. export * from "babylonjs/Audio/weightedsound";
  36907. }
  36908. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  36909. import { Behavior } from "babylonjs/Behaviors/behavior";
  36910. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  36911. import { BackEase } from "babylonjs/Animations/easing";
  36912. /**
  36913. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  36914. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  36915. */
  36916. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  36917. /**
  36918. * Gets the name of the behavior.
  36919. */
  36920. readonly name: string;
  36921. /**
  36922. * The easing function used by animations
  36923. */
  36924. static EasingFunction: BackEase;
  36925. /**
  36926. * The easing mode used by animations
  36927. */
  36928. static EasingMode: number;
  36929. /**
  36930. * The duration of the animation, in milliseconds
  36931. */
  36932. transitionDuration: number;
  36933. /**
  36934. * Length of the distance animated by the transition when lower radius is reached
  36935. */
  36936. lowerRadiusTransitionRange: number;
  36937. /**
  36938. * Length of the distance animated by the transition when upper radius is reached
  36939. */
  36940. upperRadiusTransitionRange: number;
  36941. private _autoTransitionRange;
  36942. /**
  36943. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  36944. */
  36945. /**
  36946. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  36947. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  36948. */
  36949. autoTransitionRange: boolean;
  36950. private _attachedCamera;
  36951. private _onAfterCheckInputsObserver;
  36952. private _onMeshTargetChangedObserver;
  36953. /**
  36954. * Initializes the behavior.
  36955. */
  36956. init(): void;
  36957. /**
  36958. * Attaches the behavior to its arc rotate camera.
  36959. * @param camera Defines the camera to attach the behavior to
  36960. */
  36961. attach(camera: ArcRotateCamera): void;
  36962. /**
  36963. * Detaches the behavior from its current arc rotate camera.
  36964. */
  36965. detach(): void;
  36966. private _radiusIsAnimating;
  36967. private _radiusBounceTransition;
  36968. private _animatables;
  36969. private _cachedWheelPrecision;
  36970. /**
  36971. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  36972. * @param radiusLimit The limit to check against.
  36973. * @return Bool to indicate if at limit.
  36974. */
  36975. private _isRadiusAtLimit;
  36976. /**
  36977. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  36978. * @param radiusDelta The delta by which to animate to. Can be negative.
  36979. */
  36980. private _applyBoundRadiusAnimation;
  36981. /**
  36982. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  36983. */
  36984. protected _clearAnimationLocks(): void;
  36985. /**
  36986. * Stops and removes all animations that have been applied to the camera
  36987. */
  36988. stopAllAnimations(): void;
  36989. }
  36990. }
  36991. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  36992. import { Behavior } from "babylonjs/Behaviors/behavior";
  36993. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  36994. import { ExponentialEase } from "babylonjs/Animations/easing";
  36995. import { Nullable } from "babylonjs/types";
  36996. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  36997. import { Vector3 } from "babylonjs/Maths/math.vector";
  36998. /**
  36999. * 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.
  37000. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37001. */
  37002. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  37003. /**
  37004. * Gets the name of the behavior.
  37005. */
  37006. readonly name: string;
  37007. private _mode;
  37008. private _radiusScale;
  37009. private _positionScale;
  37010. private _defaultElevation;
  37011. private _elevationReturnTime;
  37012. private _elevationReturnWaitTime;
  37013. private _zoomStopsAnimation;
  37014. private _framingTime;
  37015. /**
  37016. * The easing function used by animations
  37017. */
  37018. static EasingFunction: ExponentialEase;
  37019. /**
  37020. * The easing mode used by animations
  37021. */
  37022. static EasingMode: number;
  37023. /**
  37024. * Sets the current mode used by the behavior
  37025. */
  37026. /**
  37027. * Gets current mode used by the behavior.
  37028. */
  37029. mode: number;
  37030. /**
  37031. * Sets the scale applied to the radius (1 by default)
  37032. */
  37033. /**
  37034. * Gets the scale applied to the radius
  37035. */
  37036. radiusScale: number;
  37037. /**
  37038. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  37039. */
  37040. /**
  37041. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  37042. */
  37043. positionScale: number;
  37044. /**
  37045. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  37046. * behaviour is triggered, in radians.
  37047. */
  37048. /**
  37049. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  37050. * behaviour is triggered, in radians.
  37051. */
  37052. defaultElevation: number;
  37053. /**
  37054. * Sets the time (in milliseconds) taken to return to the default beta position.
  37055. * Negative value indicates camera should not return to default.
  37056. */
  37057. /**
  37058. * Gets the time (in milliseconds) taken to return to the default beta position.
  37059. * Negative value indicates camera should not return to default.
  37060. */
  37061. elevationReturnTime: number;
  37062. /**
  37063. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  37064. */
  37065. /**
  37066. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  37067. */
  37068. elevationReturnWaitTime: number;
  37069. /**
  37070. * Sets the flag that indicates if user zooming should stop animation.
  37071. */
  37072. /**
  37073. * Gets the flag that indicates if user zooming should stop animation.
  37074. */
  37075. zoomStopsAnimation: boolean;
  37076. /**
  37077. * Sets the transition time when framing the mesh, in milliseconds
  37078. */
  37079. /**
  37080. * Gets the transition time when framing the mesh, in milliseconds
  37081. */
  37082. framingTime: number;
  37083. /**
  37084. * Define if the behavior should automatically change the configured
  37085. * camera limits and sensibilities.
  37086. */
  37087. autoCorrectCameraLimitsAndSensibility: boolean;
  37088. private _onPrePointerObservableObserver;
  37089. private _onAfterCheckInputsObserver;
  37090. private _onMeshTargetChangedObserver;
  37091. private _attachedCamera;
  37092. private _isPointerDown;
  37093. private _lastInteractionTime;
  37094. /**
  37095. * Initializes the behavior.
  37096. */
  37097. init(): void;
  37098. /**
  37099. * Attaches the behavior to its arc rotate camera.
  37100. * @param camera Defines the camera to attach the behavior to
  37101. */
  37102. attach(camera: ArcRotateCamera): void;
  37103. /**
  37104. * Detaches the behavior from its current arc rotate camera.
  37105. */
  37106. detach(): void;
  37107. private _animatables;
  37108. private _betaIsAnimating;
  37109. private _betaTransition;
  37110. private _radiusTransition;
  37111. private _vectorTransition;
  37112. /**
  37113. * Targets the given mesh and updates zoom level accordingly.
  37114. * @param mesh The mesh to target.
  37115. * @param radius Optional. If a cached radius position already exists, overrides default.
  37116. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37117. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37118. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37119. */
  37120. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37121. /**
  37122. * Targets the given mesh with its children and updates zoom level accordingly.
  37123. * @param mesh The mesh to target.
  37124. * @param radius Optional. If a cached radius position already exists, overrides default.
  37125. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37126. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37127. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37128. */
  37129. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37130. /**
  37131. * Targets the given meshes with their children and updates zoom level accordingly.
  37132. * @param meshes The mesh to target.
  37133. * @param radius Optional. If a cached radius position already exists, overrides default.
  37134. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37135. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37136. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37137. */
  37138. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37139. /**
  37140. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  37141. * @param minimumWorld Determines the smaller position of the bounding box extend
  37142. * @param maximumWorld Determines the bigger position of the bounding box extend
  37143. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37144. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37145. */
  37146. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37147. /**
  37148. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  37149. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  37150. * frustum width.
  37151. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  37152. * to fully enclose the mesh in the viewing frustum.
  37153. */
  37154. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  37155. /**
  37156. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  37157. * is automatically returned to its default position (expected to be above ground plane).
  37158. */
  37159. private _maintainCameraAboveGround;
  37160. /**
  37161. * Returns the frustum slope based on the canvas ratio and camera FOV
  37162. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  37163. */
  37164. private _getFrustumSlope;
  37165. /**
  37166. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  37167. */
  37168. private _clearAnimationLocks;
  37169. /**
  37170. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  37171. */
  37172. private _applyUserInteraction;
  37173. /**
  37174. * Stops and removes all animations that have been applied to the camera
  37175. */
  37176. stopAllAnimations(): void;
  37177. /**
  37178. * Gets a value indicating if the user is moving the camera
  37179. */
  37180. readonly isUserIsMoving: boolean;
  37181. /**
  37182. * The camera can move all the way towards the mesh.
  37183. */
  37184. static IgnoreBoundsSizeMode: number;
  37185. /**
  37186. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  37187. */
  37188. static FitFrustumSidesMode: number;
  37189. }
  37190. }
  37191. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  37192. import { Nullable } from "babylonjs/types";
  37193. import { Camera } from "babylonjs/Cameras/camera";
  37194. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37195. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  37196. /**
  37197. * Base class for Camera Pointer Inputs.
  37198. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  37199. * for example usage.
  37200. */
  37201. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  37202. /**
  37203. * Defines the camera the input is attached to.
  37204. */
  37205. abstract camera: Camera;
  37206. /**
  37207. * Whether keyboard modifier keys are pressed at time of last mouse event.
  37208. */
  37209. protected _altKey: boolean;
  37210. protected _ctrlKey: boolean;
  37211. protected _metaKey: boolean;
  37212. protected _shiftKey: boolean;
  37213. /**
  37214. * Which mouse buttons were pressed at time of last mouse event.
  37215. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  37216. */
  37217. protected _buttonsPressed: number;
  37218. /**
  37219. * Defines the buttons associated with the input to handle camera move.
  37220. */
  37221. buttons: number[];
  37222. /**
  37223. * Attach the input controls to a specific dom element to get the input from.
  37224. * @param element Defines the element the controls should be listened from
  37225. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37226. */
  37227. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37228. /**
  37229. * Detach the current controls from the specified dom element.
  37230. * @param element Defines the element to stop listening the inputs from
  37231. */
  37232. detachControl(element: Nullable<HTMLElement>): void;
  37233. /**
  37234. * Gets the class name of the current input.
  37235. * @returns the class name
  37236. */
  37237. getClassName(): string;
  37238. /**
  37239. * Get the friendly name associated with the input class.
  37240. * @returns the input friendly name
  37241. */
  37242. getSimpleName(): string;
  37243. /**
  37244. * Called on pointer POINTERDOUBLETAP event.
  37245. * Override this method to provide functionality on POINTERDOUBLETAP event.
  37246. */
  37247. protected onDoubleTap(type: string): void;
  37248. /**
  37249. * Called on pointer POINTERMOVE event if only a single touch is active.
  37250. * Override this method to provide functionality.
  37251. */
  37252. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  37253. /**
  37254. * Called on pointer POINTERMOVE event if multiple touches are active.
  37255. * Override this method to provide functionality.
  37256. */
  37257. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  37258. /**
  37259. * Called on JS contextmenu event.
  37260. * Override this method to provide functionality.
  37261. */
  37262. protected onContextMenu(evt: PointerEvent): void;
  37263. /**
  37264. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  37265. * press.
  37266. * Override this method to provide functionality.
  37267. */
  37268. protected onButtonDown(evt: PointerEvent): void;
  37269. /**
  37270. * Called each time a new POINTERUP event occurs. Ie, for each button
  37271. * release.
  37272. * Override this method to provide functionality.
  37273. */
  37274. protected onButtonUp(evt: PointerEvent): void;
  37275. /**
  37276. * Called when window becomes inactive.
  37277. * Override this method to provide functionality.
  37278. */
  37279. protected onLostFocus(): void;
  37280. private _pointerInput;
  37281. private _observer;
  37282. private _onLostFocus;
  37283. private pointA;
  37284. private pointB;
  37285. }
  37286. }
  37287. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  37288. import { Nullable } from "babylonjs/types";
  37289. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37290. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  37291. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  37292. /**
  37293. * Manage the pointers inputs to control an arc rotate camera.
  37294. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37295. */
  37296. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  37297. /**
  37298. * Defines the camera the input is attached to.
  37299. */
  37300. camera: ArcRotateCamera;
  37301. /**
  37302. * Gets the class name of the current input.
  37303. * @returns the class name
  37304. */
  37305. getClassName(): string;
  37306. /**
  37307. * Defines the buttons associated with the input to handle camera move.
  37308. */
  37309. buttons: number[];
  37310. /**
  37311. * Defines the pointer angular sensibility along the X axis or how fast is
  37312. * the camera rotating.
  37313. */
  37314. angularSensibilityX: number;
  37315. /**
  37316. * Defines the pointer angular sensibility along the Y axis or how fast is
  37317. * the camera rotating.
  37318. */
  37319. angularSensibilityY: number;
  37320. /**
  37321. * Defines the pointer pinch precision or how fast is the camera zooming.
  37322. */
  37323. pinchPrecision: number;
  37324. /**
  37325. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  37326. * from 0.
  37327. * It defines the percentage of current camera.radius to use as delta when
  37328. * pinch zoom is used.
  37329. */
  37330. pinchDeltaPercentage: number;
  37331. /**
  37332. * Defines the pointer panning sensibility or how fast is the camera moving.
  37333. */
  37334. panningSensibility: number;
  37335. /**
  37336. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  37337. */
  37338. multiTouchPanning: boolean;
  37339. /**
  37340. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  37341. * zoom (pinch) through multitouch.
  37342. */
  37343. multiTouchPanAndZoom: boolean;
  37344. /**
  37345. * Revers pinch action direction.
  37346. */
  37347. pinchInwards: boolean;
  37348. private _isPanClick;
  37349. private _twoFingerActivityCount;
  37350. private _isPinching;
  37351. /**
  37352. * Called on pointer POINTERMOVE event if only a single touch is active.
  37353. */
  37354. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  37355. /**
  37356. * Called on pointer POINTERDOUBLETAP event.
  37357. */
  37358. protected onDoubleTap(type: string): void;
  37359. /**
  37360. * Called on pointer POINTERMOVE event if multiple touches are active.
  37361. */
  37362. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  37363. /**
  37364. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  37365. * press.
  37366. */
  37367. protected onButtonDown(evt: PointerEvent): void;
  37368. /**
  37369. * Called each time a new POINTERUP event occurs. Ie, for each button
  37370. * release.
  37371. */
  37372. protected onButtonUp(evt: PointerEvent): void;
  37373. /**
  37374. * Called when window becomes inactive.
  37375. */
  37376. protected onLostFocus(): void;
  37377. }
  37378. }
  37379. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  37380. import { Nullable } from "babylonjs/types";
  37381. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37382. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37383. /**
  37384. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  37385. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37386. */
  37387. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  37388. /**
  37389. * Defines the camera the input is attached to.
  37390. */
  37391. camera: ArcRotateCamera;
  37392. /**
  37393. * Defines the list of key codes associated with the up action (increase alpha)
  37394. */
  37395. keysUp: number[];
  37396. /**
  37397. * Defines the list of key codes associated with the down action (decrease alpha)
  37398. */
  37399. keysDown: number[];
  37400. /**
  37401. * Defines the list of key codes associated with the left action (increase beta)
  37402. */
  37403. keysLeft: number[];
  37404. /**
  37405. * Defines the list of key codes associated with the right action (decrease beta)
  37406. */
  37407. keysRight: number[];
  37408. /**
  37409. * Defines the list of key codes associated with the reset action.
  37410. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  37411. */
  37412. keysReset: number[];
  37413. /**
  37414. * Defines the panning sensibility of the inputs.
  37415. * (How fast is the camera paning)
  37416. */
  37417. panningSensibility: number;
  37418. /**
  37419. * Defines the zooming sensibility of the inputs.
  37420. * (How fast is the camera zooming)
  37421. */
  37422. zoomingSensibility: number;
  37423. /**
  37424. * Defines wether maintaining the alt key down switch the movement mode from
  37425. * orientation to zoom.
  37426. */
  37427. useAltToZoom: boolean;
  37428. /**
  37429. * Rotation speed of the camera
  37430. */
  37431. angularSpeed: number;
  37432. private _keys;
  37433. private _ctrlPressed;
  37434. private _altPressed;
  37435. private _onCanvasBlurObserver;
  37436. private _onKeyboardObserver;
  37437. private _engine;
  37438. private _scene;
  37439. /**
  37440. * Attach the input controls to a specific dom element to get the input from.
  37441. * @param element Defines the element the controls should be listened from
  37442. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37443. */
  37444. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37445. /**
  37446. * Detach the current controls from the specified dom element.
  37447. * @param element Defines the element to stop listening the inputs from
  37448. */
  37449. detachControl(element: Nullable<HTMLElement>): void;
  37450. /**
  37451. * Update the current camera state depending on the inputs that have been used this frame.
  37452. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  37453. */
  37454. checkInputs(): void;
  37455. /**
  37456. * Gets the class name of the current intput.
  37457. * @returns the class name
  37458. */
  37459. getClassName(): string;
  37460. /**
  37461. * Get the friendly name associated with the input class.
  37462. * @returns the input friendly name
  37463. */
  37464. getSimpleName(): string;
  37465. }
  37466. }
  37467. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  37468. import { Nullable } from "babylonjs/types";
  37469. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37470. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37471. /**
  37472. * Manage the mouse wheel inputs to control an arc rotate camera.
  37473. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37474. */
  37475. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  37476. /**
  37477. * Defines the camera the input is attached to.
  37478. */
  37479. camera: ArcRotateCamera;
  37480. /**
  37481. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  37482. */
  37483. wheelPrecision: number;
  37484. /**
  37485. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  37486. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  37487. */
  37488. wheelDeltaPercentage: number;
  37489. private _wheel;
  37490. private _observer;
  37491. private computeDeltaFromMouseWheelLegacyEvent;
  37492. /**
  37493. * Attach the input controls to a specific dom element to get the input from.
  37494. * @param element Defines the element the controls should be listened from
  37495. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37496. */
  37497. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37498. /**
  37499. * Detach the current controls from the specified dom element.
  37500. * @param element Defines the element to stop listening the inputs from
  37501. */
  37502. detachControl(element: Nullable<HTMLElement>): void;
  37503. /**
  37504. * Gets the class name of the current intput.
  37505. * @returns the class name
  37506. */
  37507. getClassName(): string;
  37508. /**
  37509. * Get the friendly name associated with the input class.
  37510. * @returns the input friendly name
  37511. */
  37512. getSimpleName(): string;
  37513. }
  37514. }
  37515. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  37516. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37517. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  37518. /**
  37519. * Default Inputs manager for the ArcRotateCamera.
  37520. * It groups all the default supported inputs for ease of use.
  37521. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37522. */
  37523. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  37524. /**
  37525. * Instantiates a new ArcRotateCameraInputsManager.
  37526. * @param camera Defines the camera the inputs belong to
  37527. */
  37528. constructor(camera: ArcRotateCamera);
  37529. /**
  37530. * Add mouse wheel input support to the input manager.
  37531. * @returns the current input manager
  37532. */
  37533. addMouseWheel(): ArcRotateCameraInputsManager;
  37534. /**
  37535. * Add pointers input support to the input manager.
  37536. * @returns the current input manager
  37537. */
  37538. addPointers(): ArcRotateCameraInputsManager;
  37539. /**
  37540. * Add keyboard input support to the input manager.
  37541. * @returns the current input manager
  37542. */
  37543. addKeyboard(): ArcRotateCameraInputsManager;
  37544. }
  37545. }
  37546. declare module "babylonjs/Cameras/arcRotateCamera" {
  37547. import { Observable } from "babylonjs/Misc/observable";
  37548. import { Nullable } from "babylonjs/types";
  37549. import { Scene } from "babylonjs/scene";
  37550. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  37551. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37552. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  37553. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  37554. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  37555. import { Camera } from "babylonjs/Cameras/camera";
  37556. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  37557. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  37558. import { Collider } from "babylonjs/Collisions/collider";
  37559. /**
  37560. * This represents an orbital type of camera.
  37561. *
  37562. * 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.
  37563. * 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.
  37564. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  37565. */
  37566. export class ArcRotateCamera extends TargetCamera {
  37567. /**
  37568. * Defines the rotation angle of the camera along the longitudinal axis.
  37569. */
  37570. alpha: number;
  37571. /**
  37572. * Defines the rotation angle of the camera along the latitudinal axis.
  37573. */
  37574. beta: number;
  37575. /**
  37576. * Defines the radius of the camera from it s target point.
  37577. */
  37578. radius: number;
  37579. protected _target: Vector3;
  37580. protected _targetHost: Nullable<AbstractMesh>;
  37581. /**
  37582. * Defines the target point of the camera.
  37583. * The camera looks towards it form the radius distance.
  37584. */
  37585. target: Vector3;
  37586. /**
  37587. * Define the current local position of the camera in the scene
  37588. */
  37589. position: Vector3;
  37590. protected _upVector: Vector3;
  37591. protected _upToYMatrix: Matrix;
  37592. protected _YToUpMatrix: Matrix;
  37593. /**
  37594. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  37595. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  37596. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  37597. */
  37598. upVector: Vector3;
  37599. /**
  37600. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  37601. */
  37602. setMatUp(): void;
  37603. /**
  37604. * Current inertia value on the longitudinal axis.
  37605. * The bigger this number the longer it will take for the camera to stop.
  37606. */
  37607. inertialAlphaOffset: number;
  37608. /**
  37609. * Current inertia value on the latitudinal axis.
  37610. * The bigger this number the longer it will take for the camera to stop.
  37611. */
  37612. inertialBetaOffset: number;
  37613. /**
  37614. * Current inertia value on the radius axis.
  37615. * The bigger this number the longer it will take for the camera to stop.
  37616. */
  37617. inertialRadiusOffset: number;
  37618. /**
  37619. * Minimum allowed angle on the longitudinal axis.
  37620. * This can help limiting how the Camera is able to move in the scene.
  37621. */
  37622. lowerAlphaLimit: Nullable<number>;
  37623. /**
  37624. * Maximum allowed angle on the longitudinal axis.
  37625. * This can help limiting how the Camera is able to move in the scene.
  37626. */
  37627. upperAlphaLimit: Nullable<number>;
  37628. /**
  37629. * Minimum allowed angle on the latitudinal axis.
  37630. * This can help limiting how the Camera is able to move in the scene.
  37631. */
  37632. lowerBetaLimit: number;
  37633. /**
  37634. * Maximum allowed angle on the latitudinal axis.
  37635. * This can help limiting how the Camera is able to move in the scene.
  37636. */
  37637. upperBetaLimit: number;
  37638. /**
  37639. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  37640. * This can help limiting how the Camera is able to move in the scene.
  37641. */
  37642. lowerRadiusLimit: Nullable<number>;
  37643. /**
  37644. * Maximum allowed distance of the camera to the target (The camera can not get further).
  37645. * This can help limiting how the Camera is able to move in the scene.
  37646. */
  37647. upperRadiusLimit: Nullable<number>;
  37648. /**
  37649. * Defines the current inertia value used during panning of the camera along the X axis.
  37650. */
  37651. inertialPanningX: number;
  37652. /**
  37653. * Defines the current inertia value used during panning of the camera along the Y axis.
  37654. */
  37655. inertialPanningY: number;
  37656. /**
  37657. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  37658. * Basically if your fingers moves away from more than this distance you will be considered
  37659. * in pinch mode.
  37660. */
  37661. pinchToPanMaxDistance: number;
  37662. /**
  37663. * Defines the maximum distance the camera can pan.
  37664. * This could help keeping the cammera always in your scene.
  37665. */
  37666. panningDistanceLimit: Nullable<number>;
  37667. /**
  37668. * Defines the target of the camera before paning.
  37669. */
  37670. panningOriginTarget: Vector3;
  37671. /**
  37672. * Defines the value of the inertia used during panning.
  37673. * 0 would mean stop inertia and one would mean no decelleration at all.
  37674. */
  37675. panningInertia: number;
  37676. /**
  37677. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  37678. */
  37679. angularSensibilityX: number;
  37680. /**
  37681. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  37682. */
  37683. angularSensibilityY: number;
  37684. /**
  37685. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  37686. */
  37687. pinchPrecision: number;
  37688. /**
  37689. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  37690. * It will be used instead of pinchDeltaPrecision if different from 0.
  37691. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  37692. */
  37693. pinchDeltaPercentage: number;
  37694. /**
  37695. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  37696. */
  37697. panningSensibility: number;
  37698. /**
  37699. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  37700. */
  37701. keysUp: number[];
  37702. /**
  37703. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  37704. */
  37705. keysDown: number[];
  37706. /**
  37707. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  37708. */
  37709. keysLeft: number[];
  37710. /**
  37711. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  37712. */
  37713. keysRight: number[];
  37714. /**
  37715. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  37716. */
  37717. wheelPrecision: number;
  37718. /**
  37719. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  37720. * It will be used instead of pinchDeltaPrecision if different from 0.
  37721. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  37722. */
  37723. wheelDeltaPercentage: number;
  37724. /**
  37725. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  37726. */
  37727. zoomOnFactor: number;
  37728. /**
  37729. * Defines a screen offset for the camera position.
  37730. */
  37731. targetScreenOffset: Vector2;
  37732. /**
  37733. * Allows the camera to be completely reversed.
  37734. * If false the camera can not arrive upside down.
  37735. */
  37736. allowUpsideDown: boolean;
  37737. /**
  37738. * Define if double tap/click is used to restore the previously saved state of the camera.
  37739. */
  37740. useInputToRestoreState: boolean;
  37741. /** @hidden */
  37742. _viewMatrix: Matrix;
  37743. /** @hidden */
  37744. _useCtrlForPanning: boolean;
  37745. /** @hidden */
  37746. _panningMouseButton: number;
  37747. /**
  37748. * Defines the input associated to the camera.
  37749. */
  37750. inputs: ArcRotateCameraInputsManager;
  37751. /** @hidden */
  37752. _reset: () => void;
  37753. /**
  37754. * Defines the allowed panning axis.
  37755. */
  37756. panningAxis: Vector3;
  37757. protected _localDirection: Vector3;
  37758. protected _transformedDirection: Vector3;
  37759. private _bouncingBehavior;
  37760. /**
  37761. * Gets the bouncing behavior of the camera if it has been enabled.
  37762. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  37763. */
  37764. readonly bouncingBehavior: Nullable<BouncingBehavior>;
  37765. /**
  37766. * Defines if the bouncing behavior of the camera is enabled on the camera.
  37767. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  37768. */
  37769. useBouncingBehavior: boolean;
  37770. private _framingBehavior;
  37771. /**
  37772. * Gets the framing behavior of the camera if it has been enabled.
  37773. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37774. */
  37775. readonly framingBehavior: Nullable<FramingBehavior>;
  37776. /**
  37777. * Defines if the framing behavior of the camera is enabled on the camera.
  37778. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37779. */
  37780. useFramingBehavior: boolean;
  37781. private _autoRotationBehavior;
  37782. /**
  37783. * Gets the auto rotation behavior of the camera if it has been enabled.
  37784. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  37785. */
  37786. readonly autoRotationBehavior: Nullable<AutoRotationBehavior>;
  37787. /**
  37788. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  37789. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  37790. */
  37791. useAutoRotationBehavior: boolean;
  37792. /**
  37793. * Observable triggered when the mesh target has been changed on the camera.
  37794. */
  37795. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  37796. /**
  37797. * Event raised when the camera is colliding with a mesh.
  37798. */
  37799. onCollide: (collidedMesh: AbstractMesh) => void;
  37800. /**
  37801. * Defines whether the camera should check collision with the objects oh the scene.
  37802. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  37803. */
  37804. checkCollisions: boolean;
  37805. /**
  37806. * Defines the collision radius of the camera.
  37807. * This simulates a sphere around the camera.
  37808. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  37809. */
  37810. collisionRadius: Vector3;
  37811. protected _collider: Collider;
  37812. protected _previousPosition: Vector3;
  37813. protected _collisionVelocity: Vector3;
  37814. protected _newPosition: Vector3;
  37815. protected _previousAlpha: number;
  37816. protected _previousBeta: number;
  37817. protected _previousRadius: number;
  37818. protected _collisionTriggered: boolean;
  37819. protected _targetBoundingCenter: Nullable<Vector3>;
  37820. private _computationVector;
  37821. /**
  37822. * Instantiates a new ArcRotateCamera in a given scene
  37823. * @param name Defines the name of the camera
  37824. * @param alpha Defines the camera rotation along the logitudinal axis
  37825. * @param beta Defines the camera rotation along the latitudinal axis
  37826. * @param radius Defines the camera distance from its target
  37827. * @param target Defines the camera target
  37828. * @param scene Defines the scene the camera belongs to
  37829. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  37830. */
  37831. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  37832. /** @hidden */
  37833. _initCache(): void;
  37834. /** @hidden */
  37835. _updateCache(ignoreParentClass?: boolean): void;
  37836. protected _getTargetPosition(): Vector3;
  37837. private _storedAlpha;
  37838. private _storedBeta;
  37839. private _storedRadius;
  37840. private _storedTarget;
  37841. private _storedTargetScreenOffset;
  37842. /**
  37843. * Stores the current state of the camera (alpha, beta, radius and target)
  37844. * @returns the camera itself
  37845. */
  37846. storeState(): Camera;
  37847. /**
  37848. * @hidden
  37849. * Restored camera state. You must call storeState() first
  37850. */
  37851. _restoreStateValues(): boolean;
  37852. /** @hidden */
  37853. _isSynchronizedViewMatrix(): boolean;
  37854. /**
  37855. * Attached controls to the current camera.
  37856. * @param element Defines the element the controls should be listened from
  37857. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37858. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  37859. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  37860. */
  37861. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  37862. /**
  37863. * Detach the current controls from the camera.
  37864. * The camera will stop reacting to inputs.
  37865. * @param element Defines the element to stop listening the inputs from
  37866. */
  37867. detachControl(element: HTMLElement): void;
  37868. /** @hidden */
  37869. _checkInputs(): void;
  37870. protected _checkLimits(): void;
  37871. /**
  37872. * Rebuilds angles (alpha, beta) and radius from the give position and target
  37873. */
  37874. rebuildAnglesAndRadius(): void;
  37875. /**
  37876. * Use a position to define the current camera related information like alpha, beta and radius
  37877. * @param position Defines the position to set the camera at
  37878. */
  37879. setPosition(position: Vector3): void;
  37880. /**
  37881. * Defines the target the camera should look at.
  37882. * This will automatically adapt alpha beta and radius to fit within the new target.
  37883. * @param target Defines the new target as a Vector or a mesh
  37884. * @param toBoundingCenter In case of a mesh target, defines wether to target the mesh position or its bounding information center
  37885. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  37886. */
  37887. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  37888. /** @hidden */
  37889. _getViewMatrix(): Matrix;
  37890. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  37891. /**
  37892. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  37893. * @param meshes Defines the mesh to zoom on
  37894. * @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)
  37895. */
  37896. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  37897. /**
  37898. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  37899. * The target will be changed but the radius
  37900. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  37901. * @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)
  37902. */
  37903. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  37904. min: Vector3;
  37905. max: Vector3;
  37906. distance: number;
  37907. }, doNotUpdateMaxZ?: boolean): void;
  37908. /**
  37909. * @override
  37910. * Override Camera.createRigCamera
  37911. */
  37912. createRigCamera(name: string, cameraIndex: number): Camera;
  37913. /**
  37914. * @hidden
  37915. * @override
  37916. * Override Camera._updateRigCameras
  37917. */
  37918. _updateRigCameras(): void;
  37919. /**
  37920. * Destroy the camera and release the current resources hold by it.
  37921. */
  37922. dispose(): void;
  37923. /**
  37924. * Gets the current object class name.
  37925. * @return the class name
  37926. */
  37927. getClassName(): string;
  37928. }
  37929. }
  37930. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  37931. import { Behavior } from "babylonjs/Behaviors/behavior";
  37932. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37933. /**
  37934. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  37935. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  37936. */
  37937. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  37938. /**
  37939. * Gets the name of the behavior.
  37940. */
  37941. readonly name: string;
  37942. private _zoomStopsAnimation;
  37943. private _idleRotationSpeed;
  37944. private _idleRotationWaitTime;
  37945. private _idleRotationSpinupTime;
  37946. /**
  37947. * Sets the flag that indicates if user zooming should stop animation.
  37948. */
  37949. /**
  37950. * Gets the flag that indicates if user zooming should stop animation.
  37951. */
  37952. zoomStopsAnimation: boolean;
  37953. /**
  37954. * Sets the default speed at which the camera rotates around the model.
  37955. */
  37956. /**
  37957. * Gets the default speed at which the camera rotates around the model.
  37958. */
  37959. idleRotationSpeed: number;
  37960. /**
  37961. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  37962. */
  37963. /**
  37964. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  37965. */
  37966. idleRotationWaitTime: number;
  37967. /**
  37968. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  37969. */
  37970. /**
  37971. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  37972. */
  37973. idleRotationSpinupTime: number;
  37974. /**
  37975. * Gets a value indicating if the camera is currently rotating because of this behavior
  37976. */
  37977. readonly rotationInProgress: boolean;
  37978. private _onPrePointerObservableObserver;
  37979. private _onAfterCheckInputsObserver;
  37980. private _attachedCamera;
  37981. private _isPointerDown;
  37982. private _lastFrameTime;
  37983. private _lastInteractionTime;
  37984. private _cameraRotationSpeed;
  37985. /**
  37986. * Initializes the behavior.
  37987. */
  37988. init(): void;
  37989. /**
  37990. * Attaches the behavior to its arc rotate camera.
  37991. * @param camera Defines the camera to attach the behavior to
  37992. */
  37993. attach(camera: ArcRotateCamera): void;
  37994. /**
  37995. * Detaches the behavior from its current arc rotate camera.
  37996. */
  37997. detach(): void;
  37998. /**
  37999. * Returns true if user is scrolling.
  38000. * @return true if user is scrolling.
  38001. */
  38002. private _userIsZooming;
  38003. private _lastFrameRadius;
  38004. private _shouldAnimationStopForInteraction;
  38005. /**
  38006. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  38007. */
  38008. private _applyUserInteraction;
  38009. private _userIsMoving;
  38010. }
  38011. }
  38012. declare module "babylonjs/Behaviors/Cameras/index" {
  38013. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  38014. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  38015. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  38016. }
  38017. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  38018. import { Mesh } from "babylonjs/Meshes/mesh";
  38019. import { TransformNode } from "babylonjs/Meshes/transformNode";
  38020. import { Behavior } from "babylonjs/Behaviors/behavior";
  38021. /**
  38022. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  38023. */
  38024. export class AttachToBoxBehavior implements Behavior<Mesh> {
  38025. private ui;
  38026. /**
  38027. * The name of the behavior
  38028. */
  38029. name: string;
  38030. /**
  38031. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  38032. */
  38033. distanceAwayFromFace: number;
  38034. /**
  38035. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  38036. */
  38037. distanceAwayFromBottomOfFace: number;
  38038. private _faceVectors;
  38039. private _target;
  38040. private _scene;
  38041. private _onRenderObserver;
  38042. private _tmpMatrix;
  38043. private _tmpVector;
  38044. /**
  38045. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  38046. * @param ui The transform node that should be attched to the mesh
  38047. */
  38048. constructor(ui: TransformNode);
  38049. /**
  38050. * Initializes the behavior
  38051. */
  38052. init(): void;
  38053. private _closestFace;
  38054. private _zeroVector;
  38055. private _lookAtTmpMatrix;
  38056. private _lookAtToRef;
  38057. /**
  38058. * Attaches the AttachToBoxBehavior to the passed in mesh
  38059. * @param target The mesh that the specified node will be attached to
  38060. */
  38061. attach(target: Mesh): void;
  38062. /**
  38063. * Detaches the behavior from the mesh
  38064. */
  38065. detach(): void;
  38066. }
  38067. }
  38068. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  38069. import { Behavior } from "babylonjs/Behaviors/behavior";
  38070. import { Mesh } from "babylonjs/Meshes/mesh";
  38071. /**
  38072. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  38073. */
  38074. export class FadeInOutBehavior implements Behavior<Mesh> {
  38075. /**
  38076. * Time in milliseconds to delay before fading in (Default: 0)
  38077. */
  38078. delay: number;
  38079. /**
  38080. * Time in milliseconds for the mesh to fade in (Default: 300)
  38081. */
  38082. fadeInTime: number;
  38083. private _millisecondsPerFrame;
  38084. private _hovered;
  38085. private _hoverValue;
  38086. private _ownerNode;
  38087. /**
  38088. * Instatiates the FadeInOutBehavior
  38089. */
  38090. constructor();
  38091. /**
  38092. * The name of the behavior
  38093. */
  38094. readonly name: string;
  38095. /**
  38096. * Initializes the behavior
  38097. */
  38098. init(): void;
  38099. /**
  38100. * Attaches the fade behavior on the passed in mesh
  38101. * @param ownerNode The mesh that will be faded in/out once attached
  38102. */
  38103. attach(ownerNode: Mesh): void;
  38104. /**
  38105. * Detaches the behavior from the mesh
  38106. */
  38107. detach(): void;
  38108. /**
  38109. * Triggers the mesh to begin fading in or out
  38110. * @param value if the object should fade in or out (true to fade in)
  38111. */
  38112. fadeIn(value: boolean): void;
  38113. private _update;
  38114. private _setAllVisibility;
  38115. }
  38116. }
  38117. declare module "babylonjs/Misc/pivotTools" {
  38118. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38119. /**
  38120. * Class containing a set of static utilities functions for managing Pivots
  38121. * @hidden
  38122. */
  38123. export class PivotTools {
  38124. private static _PivotCached;
  38125. private static _OldPivotPoint;
  38126. private static _PivotTranslation;
  38127. private static _PivotTmpVector;
  38128. /** @hidden */
  38129. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  38130. /** @hidden */
  38131. static _RestorePivotPoint(mesh: AbstractMesh): void;
  38132. }
  38133. }
  38134. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  38135. import { Scene } from "babylonjs/scene";
  38136. import { Vector4 } from "babylonjs/Maths/math.vector";
  38137. import { Mesh } from "babylonjs/Meshes/mesh";
  38138. import { Nullable } from "babylonjs/types";
  38139. import { Plane } from "babylonjs/Maths/math.plane";
  38140. /**
  38141. * Class containing static functions to help procedurally build meshes
  38142. */
  38143. export class PlaneBuilder {
  38144. /**
  38145. * Creates a plane mesh
  38146. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  38147. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  38148. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  38149. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  38150. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  38151. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  38152. * @param name defines the name of the mesh
  38153. * @param options defines the options used to create the mesh
  38154. * @param scene defines the hosting scene
  38155. * @returns the plane mesh
  38156. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  38157. */
  38158. static CreatePlane(name: string, options: {
  38159. size?: number;
  38160. width?: number;
  38161. height?: number;
  38162. sideOrientation?: number;
  38163. frontUVs?: Vector4;
  38164. backUVs?: Vector4;
  38165. updatable?: boolean;
  38166. sourcePlane?: Plane;
  38167. }, scene?: Nullable<Scene>): Mesh;
  38168. }
  38169. }
  38170. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  38171. import { Behavior } from "babylonjs/Behaviors/behavior";
  38172. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38173. import { Observable } from "babylonjs/Misc/observable";
  38174. import { Vector3 } from "babylonjs/Maths/math.vector";
  38175. import { Ray } from "babylonjs/Culling/ray";
  38176. import "babylonjs/Meshes/Builders/planeBuilder";
  38177. /**
  38178. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  38179. */
  38180. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  38181. private static _AnyMouseID;
  38182. /**
  38183. * Abstract mesh the behavior is set on
  38184. */
  38185. attachedNode: AbstractMesh;
  38186. private _dragPlane;
  38187. private _scene;
  38188. private _pointerObserver;
  38189. private _beforeRenderObserver;
  38190. private static _planeScene;
  38191. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  38192. /**
  38193. * 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)
  38194. */
  38195. maxDragAngle: number;
  38196. /**
  38197. * @hidden
  38198. */
  38199. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  38200. /**
  38201. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  38202. */
  38203. currentDraggingPointerID: number;
  38204. /**
  38205. * The last position where the pointer hit the drag plane in world space
  38206. */
  38207. lastDragPosition: Vector3;
  38208. /**
  38209. * If the behavior is currently in a dragging state
  38210. */
  38211. dragging: boolean;
  38212. /**
  38213. * 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)
  38214. */
  38215. dragDeltaRatio: number;
  38216. /**
  38217. * If the drag plane orientation should be updated during the dragging (Default: true)
  38218. */
  38219. updateDragPlane: boolean;
  38220. private _debugMode;
  38221. private _moving;
  38222. /**
  38223. * Fires each time the attached mesh is dragged with the pointer
  38224. * * delta between last drag position and current drag position in world space
  38225. * * dragDistance along the drag axis
  38226. * * dragPlaneNormal normal of the current drag plane used during the drag
  38227. * * dragPlanePoint in world space where the drag intersects the drag plane
  38228. */
  38229. onDragObservable: Observable<{
  38230. delta: Vector3;
  38231. dragPlanePoint: Vector3;
  38232. dragPlaneNormal: Vector3;
  38233. dragDistance: number;
  38234. pointerId: number;
  38235. }>;
  38236. /**
  38237. * Fires each time a drag begins (eg. mouse down on mesh)
  38238. */
  38239. onDragStartObservable: Observable<{
  38240. dragPlanePoint: Vector3;
  38241. pointerId: number;
  38242. }>;
  38243. /**
  38244. * Fires each time a drag ends (eg. mouse release after drag)
  38245. */
  38246. onDragEndObservable: Observable<{
  38247. dragPlanePoint: Vector3;
  38248. pointerId: number;
  38249. }>;
  38250. /**
  38251. * If the attached mesh should be moved when dragged
  38252. */
  38253. moveAttached: boolean;
  38254. /**
  38255. * If the drag behavior will react to drag events (Default: true)
  38256. */
  38257. enabled: boolean;
  38258. /**
  38259. * If pointer events should start and release the drag (Default: true)
  38260. */
  38261. startAndReleaseDragOnPointerEvents: boolean;
  38262. /**
  38263. * If camera controls should be detached during the drag
  38264. */
  38265. detachCameraControls: boolean;
  38266. /**
  38267. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  38268. */
  38269. useObjectOrienationForDragging: boolean;
  38270. private _options;
  38271. /**
  38272. * Creates a pointer drag behavior that can be attached to a mesh
  38273. * @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)
  38274. */
  38275. constructor(options?: {
  38276. dragAxis?: Vector3;
  38277. dragPlaneNormal?: Vector3;
  38278. });
  38279. /**
  38280. * Predicate to determine if it is valid to move the object to a new position when it is moved
  38281. */
  38282. validateDrag: (targetPosition: Vector3) => boolean;
  38283. /**
  38284. * The name of the behavior
  38285. */
  38286. readonly name: string;
  38287. /**
  38288. * Initializes the behavior
  38289. */
  38290. init(): void;
  38291. private _tmpVector;
  38292. private _alternatePickedPoint;
  38293. private _worldDragAxis;
  38294. private _targetPosition;
  38295. private _attachedElement;
  38296. /**
  38297. * Attaches the drag behavior the passed in mesh
  38298. * @param ownerNode The mesh that will be dragged around once attached
  38299. * @param predicate Predicate to use for pick filtering
  38300. */
  38301. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  38302. /**
  38303. * Force relase the drag action by code.
  38304. */
  38305. releaseDrag(): void;
  38306. private _startDragRay;
  38307. private _lastPointerRay;
  38308. /**
  38309. * Simulates the start of a pointer drag event on the behavior
  38310. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  38311. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  38312. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  38313. */
  38314. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  38315. private _startDrag;
  38316. private _dragDelta;
  38317. private _moveDrag;
  38318. private _pickWithRayOnDragPlane;
  38319. private _pointA;
  38320. private _pointB;
  38321. private _pointC;
  38322. private _lineA;
  38323. private _lineB;
  38324. private _localAxis;
  38325. private _lookAt;
  38326. private _updateDragPlanePosition;
  38327. /**
  38328. * Detaches the behavior from the mesh
  38329. */
  38330. detach(): void;
  38331. }
  38332. }
  38333. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  38334. import { Mesh } from "babylonjs/Meshes/mesh";
  38335. import { Behavior } from "babylonjs/Behaviors/behavior";
  38336. /**
  38337. * A behavior that when attached to a mesh will allow the mesh to be scaled
  38338. */
  38339. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  38340. private _dragBehaviorA;
  38341. private _dragBehaviorB;
  38342. private _startDistance;
  38343. private _initialScale;
  38344. private _targetScale;
  38345. private _ownerNode;
  38346. private _sceneRenderObserver;
  38347. /**
  38348. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  38349. */
  38350. constructor();
  38351. /**
  38352. * The name of the behavior
  38353. */
  38354. readonly name: string;
  38355. /**
  38356. * Initializes the behavior
  38357. */
  38358. init(): void;
  38359. private _getCurrentDistance;
  38360. /**
  38361. * Attaches the scale behavior the passed in mesh
  38362. * @param ownerNode The mesh that will be scaled around once attached
  38363. */
  38364. attach(ownerNode: Mesh): void;
  38365. /**
  38366. * Detaches the behavior from the mesh
  38367. */
  38368. detach(): void;
  38369. }
  38370. }
  38371. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  38372. import { Behavior } from "babylonjs/Behaviors/behavior";
  38373. import { Mesh } from "babylonjs/Meshes/mesh";
  38374. import { Observable } from "babylonjs/Misc/observable";
  38375. /**
  38376. * 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
  38377. */
  38378. export class SixDofDragBehavior implements Behavior<Mesh> {
  38379. private static _virtualScene;
  38380. private _ownerNode;
  38381. private _sceneRenderObserver;
  38382. private _scene;
  38383. private _targetPosition;
  38384. private _virtualOriginMesh;
  38385. private _virtualDragMesh;
  38386. private _pointerObserver;
  38387. private _moving;
  38388. private _startingOrientation;
  38389. /**
  38390. * 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)
  38391. */
  38392. private zDragFactor;
  38393. /**
  38394. * If the object should rotate to face the drag origin
  38395. */
  38396. rotateDraggedObject: boolean;
  38397. /**
  38398. * If the behavior is currently in a dragging state
  38399. */
  38400. dragging: boolean;
  38401. /**
  38402. * 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)
  38403. */
  38404. dragDeltaRatio: number;
  38405. /**
  38406. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  38407. */
  38408. currentDraggingPointerID: number;
  38409. /**
  38410. * If camera controls should be detached during the drag
  38411. */
  38412. detachCameraControls: boolean;
  38413. /**
  38414. * Fires each time a drag starts
  38415. */
  38416. onDragStartObservable: Observable<{}>;
  38417. /**
  38418. * Fires each time a drag ends (eg. mouse release after drag)
  38419. */
  38420. onDragEndObservable: Observable<{}>;
  38421. /**
  38422. * 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
  38423. */
  38424. constructor();
  38425. /**
  38426. * The name of the behavior
  38427. */
  38428. readonly name: string;
  38429. /**
  38430. * Initializes the behavior
  38431. */
  38432. init(): void;
  38433. /**
  38434. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  38435. */
  38436. private readonly _pointerCamera;
  38437. /**
  38438. * Attaches the scale behavior the passed in mesh
  38439. * @param ownerNode The mesh that will be scaled around once attached
  38440. */
  38441. attach(ownerNode: Mesh): void;
  38442. /**
  38443. * Detaches the behavior from the mesh
  38444. */
  38445. detach(): void;
  38446. }
  38447. }
  38448. declare module "babylonjs/Behaviors/Meshes/index" {
  38449. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  38450. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  38451. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  38452. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  38453. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  38454. }
  38455. declare module "babylonjs/Behaviors/index" {
  38456. export * from "babylonjs/Behaviors/behavior";
  38457. export * from "babylonjs/Behaviors/Cameras/index";
  38458. export * from "babylonjs/Behaviors/Meshes/index";
  38459. }
  38460. declare module "babylonjs/Bones/boneIKController" {
  38461. import { Bone } from "babylonjs/Bones/bone";
  38462. import { Vector3 } from "babylonjs/Maths/math.vector";
  38463. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38464. import { Nullable } from "babylonjs/types";
  38465. /**
  38466. * Class used to apply inverse kinematics to bones
  38467. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  38468. */
  38469. export class BoneIKController {
  38470. private static _tmpVecs;
  38471. private static _tmpQuat;
  38472. private static _tmpMats;
  38473. /**
  38474. * Gets or sets the target mesh
  38475. */
  38476. targetMesh: AbstractMesh;
  38477. /** Gets or sets the mesh used as pole */
  38478. poleTargetMesh: AbstractMesh;
  38479. /**
  38480. * Gets or sets the bone used as pole
  38481. */
  38482. poleTargetBone: Nullable<Bone>;
  38483. /**
  38484. * Gets or sets the target position
  38485. */
  38486. targetPosition: Vector3;
  38487. /**
  38488. * Gets or sets the pole target position
  38489. */
  38490. poleTargetPosition: Vector3;
  38491. /**
  38492. * Gets or sets the pole target local offset
  38493. */
  38494. poleTargetLocalOffset: Vector3;
  38495. /**
  38496. * Gets or sets the pole angle
  38497. */
  38498. poleAngle: number;
  38499. /**
  38500. * Gets or sets the mesh associated with the controller
  38501. */
  38502. mesh: AbstractMesh;
  38503. /**
  38504. * 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)
  38505. */
  38506. slerpAmount: number;
  38507. private _bone1Quat;
  38508. private _bone1Mat;
  38509. private _bone2Ang;
  38510. private _bone1;
  38511. private _bone2;
  38512. private _bone1Length;
  38513. private _bone2Length;
  38514. private _maxAngle;
  38515. private _maxReach;
  38516. private _rightHandedSystem;
  38517. private _bendAxis;
  38518. private _slerping;
  38519. private _adjustRoll;
  38520. /**
  38521. * Gets or sets maximum allowed angle
  38522. */
  38523. maxAngle: number;
  38524. /**
  38525. * Creates a new BoneIKController
  38526. * @param mesh defines the mesh to control
  38527. * @param bone defines the bone to control
  38528. * @param options defines options to set up the controller
  38529. */
  38530. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  38531. targetMesh?: AbstractMesh;
  38532. poleTargetMesh?: AbstractMesh;
  38533. poleTargetBone?: Bone;
  38534. poleTargetLocalOffset?: Vector3;
  38535. poleAngle?: number;
  38536. bendAxis?: Vector3;
  38537. maxAngle?: number;
  38538. slerpAmount?: number;
  38539. });
  38540. private _setMaxAngle;
  38541. /**
  38542. * Force the controller to update the bones
  38543. */
  38544. update(): void;
  38545. }
  38546. }
  38547. declare module "babylonjs/Bones/boneLookController" {
  38548. import { Vector3 } from "babylonjs/Maths/math.vector";
  38549. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38550. import { Bone } from "babylonjs/Bones/bone";
  38551. import { Space } from "babylonjs/Maths/math.axis";
  38552. /**
  38553. * Class used to make a bone look toward a point in space
  38554. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  38555. */
  38556. export class BoneLookController {
  38557. private static _tmpVecs;
  38558. private static _tmpQuat;
  38559. private static _tmpMats;
  38560. /**
  38561. * The target Vector3 that the bone will look at
  38562. */
  38563. target: Vector3;
  38564. /**
  38565. * The mesh that the bone is attached to
  38566. */
  38567. mesh: AbstractMesh;
  38568. /**
  38569. * The bone that will be looking to the target
  38570. */
  38571. bone: Bone;
  38572. /**
  38573. * The up axis of the coordinate system that is used when the bone is rotated
  38574. */
  38575. upAxis: Vector3;
  38576. /**
  38577. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  38578. */
  38579. upAxisSpace: Space;
  38580. /**
  38581. * Used to make an adjustment to the yaw of the bone
  38582. */
  38583. adjustYaw: number;
  38584. /**
  38585. * Used to make an adjustment to the pitch of the bone
  38586. */
  38587. adjustPitch: number;
  38588. /**
  38589. * Used to make an adjustment to the roll of the bone
  38590. */
  38591. adjustRoll: number;
  38592. /**
  38593. * 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)
  38594. */
  38595. slerpAmount: number;
  38596. private _minYaw;
  38597. private _maxYaw;
  38598. private _minPitch;
  38599. private _maxPitch;
  38600. private _minYawSin;
  38601. private _minYawCos;
  38602. private _maxYawSin;
  38603. private _maxYawCos;
  38604. private _midYawConstraint;
  38605. private _minPitchTan;
  38606. private _maxPitchTan;
  38607. private _boneQuat;
  38608. private _slerping;
  38609. private _transformYawPitch;
  38610. private _transformYawPitchInv;
  38611. private _firstFrameSkipped;
  38612. private _yawRange;
  38613. private _fowardAxis;
  38614. /**
  38615. * Gets or sets the minimum yaw angle that the bone can look to
  38616. */
  38617. minYaw: number;
  38618. /**
  38619. * Gets or sets the maximum yaw angle that the bone can look to
  38620. */
  38621. maxYaw: number;
  38622. /**
  38623. * Gets or sets the minimum pitch angle that the bone can look to
  38624. */
  38625. minPitch: number;
  38626. /**
  38627. * Gets or sets the maximum pitch angle that the bone can look to
  38628. */
  38629. maxPitch: number;
  38630. /**
  38631. * Create a BoneLookController
  38632. * @param mesh the mesh that the bone belongs to
  38633. * @param bone the bone that will be looking to the target
  38634. * @param target the target Vector3 to look at
  38635. * @param options optional settings:
  38636. * * maxYaw: the maximum angle the bone will yaw to
  38637. * * minYaw: the minimum angle the bone will yaw to
  38638. * * maxPitch: the maximum angle the bone will pitch to
  38639. * * minPitch: the minimum angle the bone will yaw to
  38640. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  38641. * * upAxis: the up axis of the coordinate system
  38642. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  38643. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  38644. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  38645. * * adjustYaw: used to make an adjustment to the yaw of the bone
  38646. * * adjustPitch: used to make an adjustment to the pitch of the bone
  38647. * * adjustRoll: used to make an adjustment to the roll of the bone
  38648. **/
  38649. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  38650. maxYaw?: number;
  38651. minYaw?: number;
  38652. maxPitch?: number;
  38653. minPitch?: number;
  38654. slerpAmount?: number;
  38655. upAxis?: Vector3;
  38656. upAxisSpace?: Space;
  38657. yawAxis?: Vector3;
  38658. pitchAxis?: Vector3;
  38659. adjustYaw?: number;
  38660. adjustPitch?: number;
  38661. adjustRoll?: number;
  38662. });
  38663. /**
  38664. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  38665. */
  38666. update(): void;
  38667. private _getAngleDiff;
  38668. private _getAngleBetween;
  38669. private _isAngleBetween;
  38670. }
  38671. }
  38672. declare module "babylonjs/Bones/index" {
  38673. export * from "babylonjs/Bones/bone";
  38674. export * from "babylonjs/Bones/boneIKController";
  38675. export * from "babylonjs/Bones/boneLookController";
  38676. export * from "babylonjs/Bones/skeleton";
  38677. }
  38678. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  38679. import { Nullable } from "babylonjs/types";
  38680. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  38681. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38682. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  38683. /**
  38684. * Manage the gamepad inputs to control an arc rotate camera.
  38685. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38686. */
  38687. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  38688. /**
  38689. * Defines the camera the input is attached to.
  38690. */
  38691. camera: ArcRotateCamera;
  38692. /**
  38693. * Defines the gamepad the input is gathering event from.
  38694. */
  38695. gamepad: Nullable<Gamepad>;
  38696. /**
  38697. * Defines the gamepad rotation sensiblity.
  38698. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  38699. */
  38700. gamepadRotationSensibility: number;
  38701. /**
  38702. * Defines the gamepad move sensiblity.
  38703. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  38704. */
  38705. gamepadMoveSensibility: number;
  38706. private _yAxisScale;
  38707. /**
  38708. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  38709. */
  38710. invertYAxis: boolean;
  38711. private _onGamepadConnectedObserver;
  38712. private _onGamepadDisconnectedObserver;
  38713. /**
  38714. * Attach the input controls to a specific dom element to get the input from.
  38715. * @param element Defines the element the controls should be listened from
  38716. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38717. */
  38718. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38719. /**
  38720. * Detach the current controls from the specified dom element.
  38721. * @param element Defines the element to stop listening the inputs from
  38722. */
  38723. detachControl(element: Nullable<HTMLElement>): void;
  38724. /**
  38725. * Update the current camera state depending on the inputs that have been used this frame.
  38726. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  38727. */
  38728. checkInputs(): void;
  38729. /**
  38730. * Gets the class name of the current intput.
  38731. * @returns the class name
  38732. */
  38733. getClassName(): string;
  38734. /**
  38735. * Get the friendly name associated with the input class.
  38736. * @returns the input friendly name
  38737. */
  38738. getSimpleName(): string;
  38739. }
  38740. }
  38741. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  38742. import { Nullable } from "babylonjs/types";
  38743. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  38744. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38745. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  38746. interface ArcRotateCameraInputsManager {
  38747. /**
  38748. * Add orientation input support to the input manager.
  38749. * @returns the current input manager
  38750. */
  38751. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  38752. }
  38753. }
  38754. /**
  38755. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  38756. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38757. */
  38758. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  38759. /**
  38760. * Defines the camera the input is attached to.
  38761. */
  38762. camera: ArcRotateCamera;
  38763. /**
  38764. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  38765. */
  38766. alphaCorrection: number;
  38767. /**
  38768. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  38769. */
  38770. gammaCorrection: number;
  38771. private _alpha;
  38772. private _gamma;
  38773. private _dirty;
  38774. private _deviceOrientationHandler;
  38775. /**
  38776. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  38777. */
  38778. constructor();
  38779. /**
  38780. * Attach the input controls to a specific dom element to get the input from.
  38781. * @param element Defines the element the controls should be listened from
  38782. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38783. */
  38784. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38785. /** @hidden */
  38786. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  38787. /**
  38788. * Update the current camera state depending on the inputs that have been used this frame.
  38789. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  38790. */
  38791. checkInputs(): void;
  38792. /**
  38793. * Detach the current controls from the specified dom element.
  38794. * @param element Defines the element to stop listening the inputs from
  38795. */
  38796. detachControl(element: Nullable<HTMLElement>): void;
  38797. /**
  38798. * Gets the class name of the current intput.
  38799. * @returns the class name
  38800. */
  38801. getClassName(): string;
  38802. /**
  38803. * Get the friendly name associated with the input class.
  38804. * @returns the input friendly name
  38805. */
  38806. getSimpleName(): string;
  38807. }
  38808. }
  38809. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  38810. import { Nullable } from "babylonjs/types";
  38811. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38812. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  38813. /**
  38814. * Listen to mouse events to control the camera.
  38815. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38816. */
  38817. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  38818. /**
  38819. * Defines the camera the input is attached to.
  38820. */
  38821. camera: FlyCamera;
  38822. /**
  38823. * Defines if touch is enabled. (Default is true.)
  38824. */
  38825. touchEnabled: boolean;
  38826. /**
  38827. * Defines the buttons associated with the input to handle camera rotation.
  38828. */
  38829. buttons: number[];
  38830. /**
  38831. * Assign buttons for Yaw control.
  38832. */
  38833. buttonsYaw: number[];
  38834. /**
  38835. * Assign buttons for Pitch control.
  38836. */
  38837. buttonsPitch: number[];
  38838. /**
  38839. * Assign buttons for Roll control.
  38840. */
  38841. buttonsRoll: number[];
  38842. /**
  38843. * Detect if any button is being pressed while mouse is moved.
  38844. * -1 = Mouse locked.
  38845. * 0 = Left button.
  38846. * 1 = Middle Button.
  38847. * 2 = Right Button.
  38848. */
  38849. activeButton: number;
  38850. /**
  38851. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  38852. * Higher values reduce its sensitivity.
  38853. */
  38854. angularSensibility: number;
  38855. private _mousemoveCallback;
  38856. private _observer;
  38857. private _rollObserver;
  38858. private previousPosition;
  38859. private noPreventDefault;
  38860. private element;
  38861. /**
  38862. * Listen to mouse events to control the camera.
  38863. * @param touchEnabled Define if touch is enabled. (Default is true.)
  38864. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38865. */
  38866. constructor(touchEnabled?: boolean);
  38867. /**
  38868. * Attach the mouse control to the HTML DOM element.
  38869. * @param element Defines the element that listens to the input events.
  38870. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  38871. */
  38872. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38873. /**
  38874. * Detach the current controls from the specified dom element.
  38875. * @param element Defines the element to stop listening the inputs from
  38876. */
  38877. detachControl(element: Nullable<HTMLElement>): void;
  38878. /**
  38879. * Gets the class name of the current input.
  38880. * @returns the class name.
  38881. */
  38882. getClassName(): string;
  38883. /**
  38884. * Get the friendly name associated with the input class.
  38885. * @returns the input's friendly name.
  38886. */
  38887. getSimpleName(): string;
  38888. private _pointerInput;
  38889. private _onMouseMove;
  38890. /**
  38891. * Rotate camera by mouse offset.
  38892. */
  38893. private rotateCamera;
  38894. }
  38895. }
  38896. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  38897. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  38898. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  38899. /**
  38900. * Default Inputs manager for the FlyCamera.
  38901. * It groups all the default supported inputs for ease of use.
  38902. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38903. */
  38904. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  38905. /**
  38906. * Instantiates a new FlyCameraInputsManager.
  38907. * @param camera Defines the camera the inputs belong to.
  38908. */
  38909. constructor(camera: FlyCamera);
  38910. /**
  38911. * Add keyboard input support to the input manager.
  38912. * @returns the new FlyCameraKeyboardMoveInput().
  38913. */
  38914. addKeyboard(): FlyCameraInputsManager;
  38915. /**
  38916. * Add mouse input support to the input manager.
  38917. * @param touchEnabled Enable touch screen support.
  38918. * @returns the new FlyCameraMouseInput().
  38919. */
  38920. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  38921. }
  38922. }
  38923. declare module "babylonjs/Cameras/flyCamera" {
  38924. import { Scene } from "babylonjs/scene";
  38925. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  38926. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38927. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  38928. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  38929. /**
  38930. * This is a flying camera, designed for 3D movement and rotation in all directions,
  38931. * such as in a 3D Space Shooter or a Flight Simulator.
  38932. */
  38933. export class FlyCamera extends TargetCamera {
  38934. /**
  38935. * Define the collision ellipsoid of the camera.
  38936. * This is helpful for simulating a camera body, like a player's body.
  38937. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  38938. */
  38939. ellipsoid: Vector3;
  38940. /**
  38941. * Define an offset for the position of the ellipsoid around the camera.
  38942. * This can be helpful if the camera is attached away from the player's body center,
  38943. * such as at its head.
  38944. */
  38945. ellipsoidOffset: Vector3;
  38946. /**
  38947. * Enable or disable collisions of the camera with the rest of the scene objects.
  38948. */
  38949. checkCollisions: boolean;
  38950. /**
  38951. * Enable or disable gravity on the camera.
  38952. */
  38953. applyGravity: boolean;
  38954. /**
  38955. * Define the current direction the camera is moving to.
  38956. */
  38957. cameraDirection: Vector3;
  38958. /**
  38959. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  38960. * This overrides and empties cameraRotation.
  38961. */
  38962. rotationQuaternion: Quaternion;
  38963. /**
  38964. * Track Roll to maintain the wanted Rolling when looking around.
  38965. */
  38966. _trackRoll: number;
  38967. /**
  38968. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  38969. */
  38970. rollCorrect: number;
  38971. /**
  38972. * Mimic a banked turn, Rolling the camera when Yawing.
  38973. * It's recommended to use rollCorrect = 10 for faster banking correction.
  38974. */
  38975. bankedTurn: boolean;
  38976. /**
  38977. * Limit in radians for how much Roll banking will add. (Default: 90°)
  38978. */
  38979. bankedTurnLimit: number;
  38980. /**
  38981. * Value of 0 disables the banked Roll.
  38982. * Value of 1 is equal to the Yaw angle in radians.
  38983. */
  38984. bankedTurnMultiplier: number;
  38985. /**
  38986. * The inputs manager loads all the input sources, such as keyboard and mouse.
  38987. */
  38988. inputs: FlyCameraInputsManager;
  38989. /**
  38990. * Gets the input sensibility for mouse input.
  38991. * Higher values reduce sensitivity.
  38992. */
  38993. /**
  38994. * Sets the input sensibility for a mouse input.
  38995. * Higher values reduce sensitivity.
  38996. */
  38997. angularSensibility: number;
  38998. /**
  38999. * Get the keys for camera movement forward.
  39000. */
  39001. /**
  39002. * Set the keys for camera movement forward.
  39003. */
  39004. keysForward: number[];
  39005. /**
  39006. * Get the keys for camera movement backward.
  39007. */
  39008. keysBackward: number[];
  39009. /**
  39010. * Get the keys for camera movement up.
  39011. */
  39012. /**
  39013. * Set the keys for camera movement up.
  39014. */
  39015. keysUp: number[];
  39016. /**
  39017. * Get the keys for camera movement down.
  39018. */
  39019. /**
  39020. * Set the keys for camera movement down.
  39021. */
  39022. keysDown: number[];
  39023. /**
  39024. * Get the keys for camera movement left.
  39025. */
  39026. /**
  39027. * Set the keys for camera movement left.
  39028. */
  39029. keysLeft: number[];
  39030. /**
  39031. * Set the keys for camera movement right.
  39032. */
  39033. /**
  39034. * Set the keys for camera movement right.
  39035. */
  39036. keysRight: number[];
  39037. /**
  39038. * Event raised when the camera collides with a mesh in the scene.
  39039. */
  39040. onCollide: (collidedMesh: AbstractMesh) => void;
  39041. private _collider;
  39042. private _needMoveForGravity;
  39043. private _oldPosition;
  39044. private _diffPosition;
  39045. private _newPosition;
  39046. /** @hidden */
  39047. _localDirection: Vector3;
  39048. /** @hidden */
  39049. _transformedDirection: Vector3;
  39050. /**
  39051. * Instantiates a FlyCamera.
  39052. * This is a flying camera, designed for 3D movement and rotation in all directions,
  39053. * such as in a 3D Space Shooter or a Flight Simulator.
  39054. * @param name Define the name of the camera in the scene.
  39055. * @param position Define the starting position of the camera in the scene.
  39056. * @param scene Define the scene the camera belongs to.
  39057. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  39058. */
  39059. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  39060. /**
  39061. * Attach a control to the HTML DOM element.
  39062. * @param element Defines the element that listens to the input events.
  39063. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  39064. */
  39065. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39066. /**
  39067. * Detach a control from the HTML DOM element.
  39068. * The camera will stop reacting to that input.
  39069. * @param element Defines the element that listens to the input events.
  39070. */
  39071. detachControl(element: HTMLElement): void;
  39072. private _collisionMask;
  39073. /**
  39074. * Get the mask that the camera ignores in collision events.
  39075. */
  39076. /**
  39077. * Set the mask that the camera ignores in collision events.
  39078. */
  39079. collisionMask: number;
  39080. /** @hidden */
  39081. _collideWithWorld(displacement: Vector3): void;
  39082. /** @hidden */
  39083. private _onCollisionPositionChange;
  39084. /** @hidden */
  39085. _checkInputs(): void;
  39086. /** @hidden */
  39087. _decideIfNeedsToMove(): boolean;
  39088. /** @hidden */
  39089. _updatePosition(): void;
  39090. /**
  39091. * Restore the Roll to its target value at the rate specified.
  39092. * @param rate - Higher means slower restoring.
  39093. * @hidden
  39094. */
  39095. restoreRoll(rate: number): void;
  39096. /**
  39097. * Destroy the camera and release the current resources held by it.
  39098. */
  39099. dispose(): void;
  39100. /**
  39101. * Get the current object class name.
  39102. * @returns the class name.
  39103. */
  39104. getClassName(): string;
  39105. }
  39106. }
  39107. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  39108. import { Nullable } from "babylonjs/types";
  39109. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39110. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  39111. /**
  39112. * Listen to keyboard events to control the camera.
  39113. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39114. */
  39115. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  39116. /**
  39117. * Defines the camera the input is attached to.
  39118. */
  39119. camera: FlyCamera;
  39120. /**
  39121. * The list of keyboard keys used to control the forward move of the camera.
  39122. */
  39123. keysForward: number[];
  39124. /**
  39125. * The list of keyboard keys used to control the backward move of the camera.
  39126. */
  39127. keysBackward: number[];
  39128. /**
  39129. * The list of keyboard keys used to control the forward move of the camera.
  39130. */
  39131. keysUp: number[];
  39132. /**
  39133. * The list of keyboard keys used to control the backward move of the camera.
  39134. */
  39135. keysDown: number[];
  39136. /**
  39137. * The list of keyboard keys used to control the right strafe move of the camera.
  39138. */
  39139. keysRight: number[];
  39140. /**
  39141. * The list of keyboard keys used to control the left strafe move of the camera.
  39142. */
  39143. keysLeft: number[];
  39144. private _keys;
  39145. private _onCanvasBlurObserver;
  39146. private _onKeyboardObserver;
  39147. private _engine;
  39148. private _scene;
  39149. /**
  39150. * Attach the input controls to a specific dom element to get the input from.
  39151. * @param element Defines the element the controls should be listened from
  39152. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39153. */
  39154. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39155. /**
  39156. * Detach the current controls from the specified dom element.
  39157. * @param element Defines the element to stop listening the inputs from
  39158. */
  39159. detachControl(element: Nullable<HTMLElement>): void;
  39160. /**
  39161. * Gets the class name of the current intput.
  39162. * @returns the class name
  39163. */
  39164. getClassName(): string;
  39165. /** @hidden */
  39166. _onLostFocus(e: FocusEvent): void;
  39167. /**
  39168. * Get the friendly name associated with the input class.
  39169. * @returns the input friendly name
  39170. */
  39171. getSimpleName(): string;
  39172. /**
  39173. * Update the current camera state depending on the inputs that have been used this frame.
  39174. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39175. */
  39176. checkInputs(): void;
  39177. }
  39178. }
  39179. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  39180. import { Nullable } from "babylonjs/types";
  39181. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39182. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39183. /**
  39184. * Manage the mouse wheel inputs to control a follow camera.
  39185. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39186. */
  39187. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  39188. /**
  39189. * Defines the camera the input is attached to.
  39190. */
  39191. camera: FollowCamera;
  39192. /**
  39193. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  39194. */
  39195. axisControlRadius: boolean;
  39196. /**
  39197. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  39198. */
  39199. axisControlHeight: boolean;
  39200. /**
  39201. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  39202. */
  39203. axisControlRotation: boolean;
  39204. /**
  39205. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  39206. * relation to mouseWheel events.
  39207. */
  39208. wheelPrecision: number;
  39209. /**
  39210. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  39211. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  39212. */
  39213. wheelDeltaPercentage: number;
  39214. private _wheel;
  39215. private _observer;
  39216. /**
  39217. * Attach the input controls to a specific dom element to get the input from.
  39218. * @param element Defines the element the controls should be listened from
  39219. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39220. */
  39221. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39222. /**
  39223. * Detach the current controls from the specified dom element.
  39224. * @param element Defines the element to stop listening the inputs from
  39225. */
  39226. detachControl(element: Nullable<HTMLElement>): void;
  39227. /**
  39228. * Gets the class name of the current intput.
  39229. * @returns the class name
  39230. */
  39231. getClassName(): string;
  39232. /**
  39233. * Get the friendly name associated with the input class.
  39234. * @returns the input friendly name
  39235. */
  39236. getSimpleName(): string;
  39237. }
  39238. }
  39239. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  39240. import { Nullable } from "babylonjs/types";
  39241. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39242. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  39243. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  39244. /**
  39245. * Manage the pointers inputs to control an follow camera.
  39246. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39247. */
  39248. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  39249. /**
  39250. * Defines the camera the input is attached to.
  39251. */
  39252. camera: FollowCamera;
  39253. /**
  39254. * Gets the class name of the current input.
  39255. * @returns the class name
  39256. */
  39257. getClassName(): string;
  39258. /**
  39259. * Defines the pointer angular sensibility along the X axis or how fast is
  39260. * the camera rotating.
  39261. * A negative number will reverse the axis direction.
  39262. */
  39263. angularSensibilityX: number;
  39264. /**
  39265. * Defines the pointer angular sensibility along the Y axis or how fast is
  39266. * the camera rotating.
  39267. * A negative number will reverse the axis direction.
  39268. */
  39269. angularSensibilityY: number;
  39270. /**
  39271. * Defines the pointer pinch precision or how fast is the camera zooming.
  39272. * A negative number will reverse the axis direction.
  39273. */
  39274. pinchPrecision: number;
  39275. /**
  39276. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  39277. * from 0.
  39278. * It defines the percentage of current camera.radius to use as delta when
  39279. * pinch zoom is used.
  39280. */
  39281. pinchDeltaPercentage: number;
  39282. /**
  39283. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  39284. */
  39285. axisXControlRadius: boolean;
  39286. /**
  39287. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  39288. */
  39289. axisXControlHeight: boolean;
  39290. /**
  39291. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  39292. */
  39293. axisXControlRotation: boolean;
  39294. /**
  39295. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  39296. */
  39297. axisYControlRadius: boolean;
  39298. /**
  39299. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  39300. */
  39301. axisYControlHeight: boolean;
  39302. /**
  39303. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  39304. */
  39305. axisYControlRotation: boolean;
  39306. /**
  39307. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  39308. */
  39309. axisPinchControlRadius: boolean;
  39310. /**
  39311. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  39312. */
  39313. axisPinchControlHeight: boolean;
  39314. /**
  39315. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  39316. */
  39317. axisPinchControlRotation: boolean;
  39318. /**
  39319. * Log error messages if basic misconfiguration has occurred.
  39320. */
  39321. warningEnable: boolean;
  39322. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  39323. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  39324. private _warningCounter;
  39325. private _warning;
  39326. }
  39327. }
  39328. declare module "babylonjs/Cameras/followCameraInputsManager" {
  39329. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  39330. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39331. /**
  39332. * Default Inputs manager for the FollowCamera.
  39333. * It groups all the default supported inputs for ease of use.
  39334. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39335. */
  39336. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  39337. /**
  39338. * Instantiates a new FollowCameraInputsManager.
  39339. * @param camera Defines the camera the inputs belong to
  39340. */
  39341. constructor(camera: FollowCamera);
  39342. /**
  39343. * Add keyboard input support to the input manager.
  39344. * @returns the current input manager
  39345. */
  39346. addKeyboard(): FollowCameraInputsManager;
  39347. /**
  39348. * Add mouse wheel input support to the input manager.
  39349. * @returns the current input manager
  39350. */
  39351. addMouseWheel(): FollowCameraInputsManager;
  39352. /**
  39353. * Add pointers input support to the input manager.
  39354. * @returns the current input manager
  39355. */
  39356. addPointers(): FollowCameraInputsManager;
  39357. /**
  39358. * Add orientation input support to the input manager.
  39359. * @returns the current input manager
  39360. */
  39361. addVRDeviceOrientation(): FollowCameraInputsManager;
  39362. }
  39363. }
  39364. declare module "babylonjs/Cameras/followCamera" {
  39365. import { Nullable } from "babylonjs/types";
  39366. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  39367. import { Scene } from "babylonjs/scene";
  39368. import { Vector3 } from "babylonjs/Maths/math.vector";
  39369. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  39370. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  39371. /**
  39372. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  39373. * an arc rotate version arcFollowCamera are available.
  39374. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39375. */
  39376. export class FollowCamera extends TargetCamera {
  39377. /**
  39378. * Distance the follow camera should follow an object at
  39379. */
  39380. radius: number;
  39381. /**
  39382. * Minimum allowed distance of the camera to the axis of rotation
  39383. * (The camera can not get closer).
  39384. * This can help limiting how the Camera is able to move in the scene.
  39385. */
  39386. lowerRadiusLimit: Nullable<number>;
  39387. /**
  39388. * Maximum allowed distance of the camera to the axis of rotation
  39389. * (The camera can not get further).
  39390. * This can help limiting how the Camera is able to move in the scene.
  39391. */
  39392. upperRadiusLimit: Nullable<number>;
  39393. /**
  39394. * Define a rotation offset between the camera and the object it follows
  39395. */
  39396. rotationOffset: number;
  39397. /**
  39398. * Minimum allowed angle to camera position relative to target object.
  39399. * This can help limiting how the Camera is able to move in the scene.
  39400. */
  39401. lowerRotationOffsetLimit: Nullable<number>;
  39402. /**
  39403. * Maximum allowed angle to camera position relative to target object.
  39404. * This can help limiting how the Camera is able to move in the scene.
  39405. */
  39406. upperRotationOffsetLimit: Nullable<number>;
  39407. /**
  39408. * Define a height offset between the camera and the object it follows.
  39409. * It can help following an object from the top (like a car chaing a plane)
  39410. */
  39411. heightOffset: number;
  39412. /**
  39413. * Minimum allowed height of camera position relative to target object.
  39414. * This can help limiting how the Camera is able to move in the scene.
  39415. */
  39416. lowerHeightOffsetLimit: Nullable<number>;
  39417. /**
  39418. * Maximum allowed height of camera position relative to target object.
  39419. * This can help limiting how the Camera is able to move in the scene.
  39420. */
  39421. upperHeightOffsetLimit: Nullable<number>;
  39422. /**
  39423. * Define how fast the camera can accelerate to follow it s target.
  39424. */
  39425. cameraAcceleration: number;
  39426. /**
  39427. * Define the speed limit of the camera following an object.
  39428. */
  39429. maxCameraSpeed: number;
  39430. /**
  39431. * Define the target of the camera.
  39432. */
  39433. lockedTarget: Nullable<AbstractMesh>;
  39434. /**
  39435. * Defines the input associated with the camera.
  39436. */
  39437. inputs: FollowCameraInputsManager;
  39438. /**
  39439. * Instantiates the follow camera.
  39440. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39441. * @param name Define the name of the camera in the scene
  39442. * @param position Define the position of the camera
  39443. * @param scene Define the scene the camera belong to
  39444. * @param lockedTarget Define the target of the camera
  39445. */
  39446. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  39447. private _follow;
  39448. /**
  39449. * Attached controls to the current camera.
  39450. * @param element Defines the element the controls should be listened from
  39451. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39452. */
  39453. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39454. /**
  39455. * Detach the current controls from the camera.
  39456. * The camera will stop reacting to inputs.
  39457. * @param element Defines the element to stop listening the inputs from
  39458. */
  39459. detachControl(element: HTMLElement): void;
  39460. /** @hidden */
  39461. _checkInputs(): void;
  39462. private _checkLimits;
  39463. /**
  39464. * Gets the camera class name.
  39465. * @returns the class name
  39466. */
  39467. getClassName(): string;
  39468. }
  39469. /**
  39470. * Arc Rotate version of the follow camera.
  39471. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  39472. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39473. */
  39474. export class ArcFollowCamera extends TargetCamera {
  39475. /** The longitudinal angle of the camera */
  39476. alpha: number;
  39477. /** The latitudinal angle of the camera */
  39478. beta: number;
  39479. /** The radius of the camera from its target */
  39480. radius: number;
  39481. /** Define the camera target (the messh it should follow) */
  39482. target: Nullable<AbstractMesh>;
  39483. private _cartesianCoordinates;
  39484. /**
  39485. * Instantiates a new ArcFollowCamera
  39486. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39487. * @param name Define the name of the camera
  39488. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  39489. * @param beta Define the rotation angle of the camera around the elevation axis
  39490. * @param radius Define the radius of the camera from its target point
  39491. * @param target Define the target of the camera
  39492. * @param scene Define the scene the camera belongs to
  39493. */
  39494. constructor(name: string,
  39495. /** The longitudinal angle of the camera */
  39496. alpha: number,
  39497. /** The latitudinal angle of the camera */
  39498. beta: number,
  39499. /** The radius of the camera from its target */
  39500. radius: number,
  39501. /** Define the camera target (the messh it should follow) */
  39502. target: Nullable<AbstractMesh>, scene: Scene);
  39503. private _follow;
  39504. /** @hidden */
  39505. _checkInputs(): void;
  39506. /**
  39507. * Returns the class name of the object.
  39508. * It is mostly used internally for serialization purposes.
  39509. */
  39510. getClassName(): string;
  39511. }
  39512. }
  39513. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  39514. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39515. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39516. import { Nullable } from "babylonjs/types";
  39517. /**
  39518. * Manage the keyboard inputs to control the movement of a follow camera.
  39519. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39520. */
  39521. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  39522. /**
  39523. * Defines the camera the input is attached to.
  39524. */
  39525. camera: FollowCamera;
  39526. /**
  39527. * Defines the list of key codes associated with the up action (increase heightOffset)
  39528. */
  39529. keysHeightOffsetIncr: number[];
  39530. /**
  39531. * Defines the list of key codes associated with the down action (decrease heightOffset)
  39532. */
  39533. keysHeightOffsetDecr: number[];
  39534. /**
  39535. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  39536. */
  39537. keysHeightOffsetModifierAlt: boolean;
  39538. /**
  39539. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  39540. */
  39541. keysHeightOffsetModifierCtrl: boolean;
  39542. /**
  39543. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  39544. */
  39545. keysHeightOffsetModifierShift: boolean;
  39546. /**
  39547. * Defines the list of key codes associated with the left action (increase rotationOffset)
  39548. */
  39549. keysRotationOffsetIncr: number[];
  39550. /**
  39551. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  39552. */
  39553. keysRotationOffsetDecr: number[];
  39554. /**
  39555. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  39556. */
  39557. keysRotationOffsetModifierAlt: boolean;
  39558. /**
  39559. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  39560. */
  39561. keysRotationOffsetModifierCtrl: boolean;
  39562. /**
  39563. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  39564. */
  39565. keysRotationOffsetModifierShift: boolean;
  39566. /**
  39567. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  39568. */
  39569. keysRadiusIncr: number[];
  39570. /**
  39571. * Defines the list of key codes associated with the zoom-out action (increase radius)
  39572. */
  39573. keysRadiusDecr: number[];
  39574. /**
  39575. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  39576. */
  39577. keysRadiusModifierAlt: boolean;
  39578. /**
  39579. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  39580. */
  39581. keysRadiusModifierCtrl: boolean;
  39582. /**
  39583. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  39584. */
  39585. keysRadiusModifierShift: boolean;
  39586. /**
  39587. * Defines the rate of change of heightOffset.
  39588. */
  39589. heightSensibility: number;
  39590. /**
  39591. * Defines the rate of change of rotationOffset.
  39592. */
  39593. rotationSensibility: number;
  39594. /**
  39595. * Defines the rate of change of radius.
  39596. */
  39597. radiusSensibility: number;
  39598. private _keys;
  39599. private _ctrlPressed;
  39600. private _altPressed;
  39601. private _shiftPressed;
  39602. private _onCanvasBlurObserver;
  39603. private _onKeyboardObserver;
  39604. private _engine;
  39605. private _scene;
  39606. /**
  39607. * Attach the input controls to a specific dom element to get the input from.
  39608. * @param element Defines the element the controls should be listened from
  39609. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39610. */
  39611. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39612. /**
  39613. * Detach the current controls from the specified dom element.
  39614. * @param element Defines the element to stop listening the inputs from
  39615. */
  39616. detachControl(element: Nullable<HTMLElement>): void;
  39617. /**
  39618. * Update the current camera state depending on the inputs that have been used this frame.
  39619. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39620. */
  39621. checkInputs(): void;
  39622. /**
  39623. * Gets the class name of the current input.
  39624. * @returns the class name
  39625. */
  39626. getClassName(): string;
  39627. /**
  39628. * Get the friendly name associated with the input class.
  39629. * @returns the input friendly name
  39630. */
  39631. getSimpleName(): string;
  39632. /**
  39633. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39634. * allow modification of the heightOffset value.
  39635. */
  39636. private _modifierHeightOffset;
  39637. /**
  39638. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39639. * allow modification of the rotationOffset value.
  39640. */
  39641. private _modifierRotationOffset;
  39642. /**
  39643. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39644. * allow modification of the radius value.
  39645. */
  39646. private _modifierRadius;
  39647. }
  39648. }
  39649. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  39650. import { Nullable } from "babylonjs/types";
  39651. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39652. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39653. import { Observable } from "babylonjs/Misc/observable";
  39654. module "babylonjs/Cameras/freeCameraInputsManager" {
  39655. interface FreeCameraInputsManager {
  39656. /**
  39657. * @hidden
  39658. */
  39659. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  39660. /**
  39661. * Add orientation input support to the input manager.
  39662. * @returns the current input manager
  39663. */
  39664. addDeviceOrientation(): FreeCameraInputsManager;
  39665. }
  39666. }
  39667. /**
  39668. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  39669. * Screen rotation is taken into account.
  39670. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39671. */
  39672. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  39673. private _camera;
  39674. private _screenOrientationAngle;
  39675. private _constantTranform;
  39676. private _screenQuaternion;
  39677. private _alpha;
  39678. private _beta;
  39679. private _gamma;
  39680. /**
  39681. * Can be used to detect if a device orientation sensor is availible on a device
  39682. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  39683. * @returns a promise that will resolve on orientation change
  39684. */
  39685. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  39686. /**
  39687. * @hidden
  39688. */
  39689. _onDeviceOrientationChangedObservable: Observable<void>;
  39690. /**
  39691. * Instantiates a new input
  39692. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39693. */
  39694. constructor();
  39695. /**
  39696. * Define the camera controlled by the input.
  39697. */
  39698. camera: FreeCamera;
  39699. /**
  39700. * Attach the input controls to a specific dom element to get the input from.
  39701. * @param element Defines the element the controls should be listened from
  39702. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39703. */
  39704. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39705. private _orientationChanged;
  39706. private _deviceOrientation;
  39707. /**
  39708. * Detach the current controls from the specified dom element.
  39709. * @param element Defines the element to stop listening the inputs from
  39710. */
  39711. detachControl(element: Nullable<HTMLElement>): void;
  39712. /**
  39713. * Update the current camera state depending on the inputs that have been used this frame.
  39714. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39715. */
  39716. checkInputs(): void;
  39717. /**
  39718. * Gets the class name of the current intput.
  39719. * @returns the class name
  39720. */
  39721. getClassName(): string;
  39722. /**
  39723. * Get the friendly name associated with the input class.
  39724. * @returns the input friendly name
  39725. */
  39726. getSimpleName(): string;
  39727. }
  39728. }
  39729. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  39730. import { Nullable } from "babylonjs/types";
  39731. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39732. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39733. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  39734. /**
  39735. * Manage the gamepad inputs to control a free camera.
  39736. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39737. */
  39738. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  39739. /**
  39740. * Define the camera the input is attached to.
  39741. */
  39742. camera: FreeCamera;
  39743. /**
  39744. * Define the Gamepad controlling the input
  39745. */
  39746. gamepad: Nullable<Gamepad>;
  39747. /**
  39748. * Defines the gamepad rotation sensiblity.
  39749. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  39750. */
  39751. gamepadAngularSensibility: number;
  39752. /**
  39753. * Defines the gamepad move sensiblity.
  39754. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  39755. */
  39756. gamepadMoveSensibility: number;
  39757. private _yAxisScale;
  39758. /**
  39759. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  39760. */
  39761. invertYAxis: boolean;
  39762. private _onGamepadConnectedObserver;
  39763. private _onGamepadDisconnectedObserver;
  39764. private _cameraTransform;
  39765. private _deltaTransform;
  39766. private _vector3;
  39767. private _vector2;
  39768. /**
  39769. * Attach the input controls to a specific dom element to get the input from.
  39770. * @param element Defines the element the controls should be listened from
  39771. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39772. */
  39773. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39774. /**
  39775. * Detach the current controls from the specified dom element.
  39776. * @param element Defines the element to stop listening the inputs from
  39777. */
  39778. detachControl(element: Nullable<HTMLElement>): void;
  39779. /**
  39780. * Update the current camera state depending on the inputs that have been used this frame.
  39781. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39782. */
  39783. checkInputs(): void;
  39784. /**
  39785. * Gets the class name of the current intput.
  39786. * @returns the class name
  39787. */
  39788. getClassName(): string;
  39789. /**
  39790. * Get the friendly name associated with the input class.
  39791. * @returns the input friendly name
  39792. */
  39793. getSimpleName(): string;
  39794. }
  39795. }
  39796. declare module "babylonjs/Misc/virtualJoystick" {
  39797. import { Nullable } from "babylonjs/types";
  39798. import { Vector3 } from "babylonjs/Maths/math.vector";
  39799. /**
  39800. * Defines the potential axis of a Joystick
  39801. */
  39802. export enum JoystickAxis {
  39803. /** X axis */
  39804. X = 0,
  39805. /** Y axis */
  39806. Y = 1,
  39807. /** Z axis */
  39808. Z = 2
  39809. }
  39810. /**
  39811. * Class used to define virtual joystick (used in touch mode)
  39812. */
  39813. export class VirtualJoystick {
  39814. /**
  39815. * Gets or sets a boolean indicating that left and right values must be inverted
  39816. */
  39817. reverseLeftRight: boolean;
  39818. /**
  39819. * Gets or sets a boolean indicating that up and down values must be inverted
  39820. */
  39821. reverseUpDown: boolean;
  39822. /**
  39823. * Gets the offset value for the position (ie. the change of the position value)
  39824. */
  39825. deltaPosition: Vector3;
  39826. /**
  39827. * Gets a boolean indicating if the virtual joystick was pressed
  39828. */
  39829. pressed: boolean;
  39830. /**
  39831. * Canvas the virtual joystick will render onto, default z-index of this is 5
  39832. */
  39833. static Canvas: Nullable<HTMLCanvasElement>;
  39834. private static _globalJoystickIndex;
  39835. private static vjCanvasContext;
  39836. private static vjCanvasWidth;
  39837. private static vjCanvasHeight;
  39838. private static halfWidth;
  39839. private _action;
  39840. private _axisTargetedByLeftAndRight;
  39841. private _axisTargetedByUpAndDown;
  39842. private _joystickSensibility;
  39843. private _inversedSensibility;
  39844. private _joystickPointerID;
  39845. private _joystickColor;
  39846. private _joystickPointerPos;
  39847. private _joystickPreviousPointerPos;
  39848. private _joystickPointerStartPos;
  39849. private _deltaJoystickVector;
  39850. private _leftJoystick;
  39851. private _touches;
  39852. private _onPointerDownHandlerRef;
  39853. private _onPointerMoveHandlerRef;
  39854. private _onPointerUpHandlerRef;
  39855. private _onResize;
  39856. /**
  39857. * Creates a new virtual joystick
  39858. * @param leftJoystick defines that the joystick is for left hand (false by default)
  39859. */
  39860. constructor(leftJoystick?: boolean);
  39861. /**
  39862. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  39863. * @param newJoystickSensibility defines the new sensibility
  39864. */
  39865. setJoystickSensibility(newJoystickSensibility: number): void;
  39866. private _onPointerDown;
  39867. private _onPointerMove;
  39868. private _onPointerUp;
  39869. /**
  39870. * Change the color of the virtual joystick
  39871. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  39872. */
  39873. setJoystickColor(newColor: string): void;
  39874. /**
  39875. * Defines a callback to call when the joystick is touched
  39876. * @param action defines the callback
  39877. */
  39878. setActionOnTouch(action: () => any): void;
  39879. /**
  39880. * Defines which axis you'd like to control for left & right
  39881. * @param axis defines the axis to use
  39882. */
  39883. setAxisForLeftRight(axis: JoystickAxis): void;
  39884. /**
  39885. * Defines which axis you'd like to control for up & down
  39886. * @param axis defines the axis to use
  39887. */
  39888. setAxisForUpDown(axis: JoystickAxis): void;
  39889. private _drawVirtualJoystick;
  39890. /**
  39891. * Release internal HTML canvas
  39892. */
  39893. releaseCanvas(): void;
  39894. }
  39895. }
  39896. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  39897. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  39898. import { Nullable } from "babylonjs/types";
  39899. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39900. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39901. module "babylonjs/Cameras/freeCameraInputsManager" {
  39902. interface FreeCameraInputsManager {
  39903. /**
  39904. * Add virtual joystick input support to the input manager.
  39905. * @returns the current input manager
  39906. */
  39907. addVirtualJoystick(): FreeCameraInputsManager;
  39908. }
  39909. }
  39910. /**
  39911. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  39912. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39913. */
  39914. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  39915. /**
  39916. * Defines the camera the input is attached to.
  39917. */
  39918. camera: FreeCamera;
  39919. private _leftjoystick;
  39920. private _rightjoystick;
  39921. /**
  39922. * Gets the left stick of the virtual joystick.
  39923. * @returns The virtual Joystick
  39924. */
  39925. getLeftJoystick(): VirtualJoystick;
  39926. /**
  39927. * Gets the right stick of the virtual joystick.
  39928. * @returns The virtual Joystick
  39929. */
  39930. getRightJoystick(): VirtualJoystick;
  39931. /**
  39932. * Update the current camera state depending on the inputs that have been used this frame.
  39933. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39934. */
  39935. checkInputs(): void;
  39936. /**
  39937. * Attach the input controls to a specific dom element to get the input from.
  39938. * @param element Defines the element the controls should be listened from
  39939. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39940. */
  39941. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39942. /**
  39943. * Detach the current controls from the specified dom element.
  39944. * @param element Defines the element to stop listening the inputs from
  39945. */
  39946. detachControl(element: Nullable<HTMLElement>): void;
  39947. /**
  39948. * Gets the class name of the current intput.
  39949. * @returns the class name
  39950. */
  39951. getClassName(): string;
  39952. /**
  39953. * Get the friendly name associated with the input class.
  39954. * @returns the input friendly name
  39955. */
  39956. getSimpleName(): string;
  39957. }
  39958. }
  39959. declare module "babylonjs/Cameras/Inputs/index" {
  39960. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  39961. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  39962. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  39963. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  39964. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  39965. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  39966. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  39967. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  39968. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  39969. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  39970. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  39971. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  39972. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  39973. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  39974. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  39975. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  39976. }
  39977. declare module "babylonjs/Cameras/touchCamera" {
  39978. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39979. import { Scene } from "babylonjs/scene";
  39980. import { Vector3 } from "babylonjs/Maths/math.vector";
  39981. /**
  39982. * This represents a FPS type of camera controlled by touch.
  39983. * This is like a universal camera minus the Gamepad controls.
  39984. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  39985. */
  39986. export class TouchCamera extends FreeCamera {
  39987. /**
  39988. * Defines the touch sensibility for rotation.
  39989. * The higher the faster.
  39990. */
  39991. touchAngularSensibility: number;
  39992. /**
  39993. * Defines the touch sensibility for move.
  39994. * The higher the faster.
  39995. */
  39996. touchMoveSensibility: number;
  39997. /**
  39998. * Instantiates a new touch camera.
  39999. * This represents a FPS type of camera controlled by touch.
  40000. * This is like a universal camera minus the Gamepad controls.
  40001. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40002. * @param name Define the name of the camera in the scene
  40003. * @param position Define the start position of the camera in the scene
  40004. * @param scene Define the scene the camera belongs to
  40005. */
  40006. constructor(name: string, position: Vector3, scene: Scene);
  40007. /**
  40008. * Gets the current object class name.
  40009. * @return the class name
  40010. */
  40011. getClassName(): string;
  40012. /** @hidden */
  40013. _setupInputs(): void;
  40014. }
  40015. }
  40016. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  40017. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40018. import { Scene } from "babylonjs/scene";
  40019. import { Vector3 } from "babylonjs/Maths/math.vector";
  40020. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  40021. import { Axis } from "babylonjs/Maths/math.axis";
  40022. /**
  40023. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  40024. * being tilted forward or back and left or right.
  40025. */
  40026. export class DeviceOrientationCamera extends FreeCamera {
  40027. private _initialQuaternion;
  40028. private _quaternionCache;
  40029. private _tmpDragQuaternion;
  40030. private _disablePointerInputWhenUsingDeviceOrientation;
  40031. /**
  40032. * Creates a new device orientation camera
  40033. * @param name The name of the camera
  40034. * @param position The start position camera
  40035. * @param scene The scene the camera belongs to
  40036. */
  40037. constructor(name: string, position: Vector3, scene: Scene);
  40038. /**
  40039. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  40040. */
  40041. disablePointerInputWhenUsingDeviceOrientation: boolean;
  40042. private _dragFactor;
  40043. /**
  40044. * Enabled turning on the y axis when the orientation sensor is active
  40045. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  40046. */
  40047. enableHorizontalDragging(dragFactor?: number): void;
  40048. /**
  40049. * Gets the current instance class name ("DeviceOrientationCamera").
  40050. * This helps avoiding instanceof at run time.
  40051. * @returns the class name
  40052. */
  40053. getClassName(): string;
  40054. /**
  40055. * @hidden
  40056. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  40057. */
  40058. _checkInputs(): void;
  40059. /**
  40060. * Reset the camera to its default orientation on the specified axis only.
  40061. * @param axis The axis to reset
  40062. */
  40063. resetToCurrentRotation(axis?: Axis): void;
  40064. }
  40065. }
  40066. declare module "babylonjs/Gamepads/xboxGamepad" {
  40067. import { Observable } from "babylonjs/Misc/observable";
  40068. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40069. /**
  40070. * Defines supported buttons for XBox360 compatible gamepads
  40071. */
  40072. export enum Xbox360Button {
  40073. /** A */
  40074. A = 0,
  40075. /** B */
  40076. B = 1,
  40077. /** X */
  40078. X = 2,
  40079. /** Y */
  40080. Y = 3,
  40081. /** Start */
  40082. Start = 4,
  40083. /** Back */
  40084. Back = 5,
  40085. /** Left button */
  40086. LB = 6,
  40087. /** Right button */
  40088. RB = 7,
  40089. /** Left stick */
  40090. LeftStick = 8,
  40091. /** Right stick */
  40092. RightStick = 9
  40093. }
  40094. /** Defines values for XBox360 DPad */
  40095. export enum Xbox360Dpad {
  40096. /** Up */
  40097. Up = 0,
  40098. /** Down */
  40099. Down = 1,
  40100. /** Left */
  40101. Left = 2,
  40102. /** Right */
  40103. Right = 3
  40104. }
  40105. /**
  40106. * Defines a XBox360 gamepad
  40107. */
  40108. export class Xbox360Pad extends Gamepad {
  40109. private _leftTrigger;
  40110. private _rightTrigger;
  40111. private _onlefttriggerchanged;
  40112. private _onrighttriggerchanged;
  40113. private _onbuttondown;
  40114. private _onbuttonup;
  40115. private _ondpaddown;
  40116. private _ondpadup;
  40117. /** Observable raised when a button is pressed */
  40118. onButtonDownObservable: Observable<Xbox360Button>;
  40119. /** Observable raised when a button is released */
  40120. onButtonUpObservable: Observable<Xbox360Button>;
  40121. /** Observable raised when a pad is pressed */
  40122. onPadDownObservable: Observable<Xbox360Dpad>;
  40123. /** Observable raised when a pad is released */
  40124. onPadUpObservable: Observable<Xbox360Dpad>;
  40125. private _buttonA;
  40126. private _buttonB;
  40127. private _buttonX;
  40128. private _buttonY;
  40129. private _buttonBack;
  40130. private _buttonStart;
  40131. private _buttonLB;
  40132. private _buttonRB;
  40133. private _buttonLeftStick;
  40134. private _buttonRightStick;
  40135. private _dPadUp;
  40136. private _dPadDown;
  40137. private _dPadLeft;
  40138. private _dPadRight;
  40139. private _isXboxOnePad;
  40140. /**
  40141. * Creates a new XBox360 gamepad object
  40142. * @param id defines the id of this gamepad
  40143. * @param index defines its index
  40144. * @param gamepad defines the internal HTML gamepad object
  40145. * @param xboxOne defines if it is a XBox One gamepad
  40146. */
  40147. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  40148. /**
  40149. * Defines the callback to call when left trigger is pressed
  40150. * @param callback defines the callback to use
  40151. */
  40152. onlefttriggerchanged(callback: (value: number) => void): void;
  40153. /**
  40154. * Defines the callback to call when right trigger is pressed
  40155. * @param callback defines the callback to use
  40156. */
  40157. onrighttriggerchanged(callback: (value: number) => void): void;
  40158. /**
  40159. * Gets the left trigger value
  40160. */
  40161. /**
  40162. * Sets the left trigger value
  40163. */
  40164. leftTrigger: number;
  40165. /**
  40166. * Gets the right trigger value
  40167. */
  40168. /**
  40169. * Sets the right trigger value
  40170. */
  40171. rightTrigger: number;
  40172. /**
  40173. * Defines the callback to call when a button is pressed
  40174. * @param callback defines the callback to use
  40175. */
  40176. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  40177. /**
  40178. * Defines the callback to call when a button is released
  40179. * @param callback defines the callback to use
  40180. */
  40181. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  40182. /**
  40183. * Defines the callback to call when a pad is pressed
  40184. * @param callback defines the callback to use
  40185. */
  40186. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  40187. /**
  40188. * Defines the callback to call when a pad is released
  40189. * @param callback defines the callback to use
  40190. */
  40191. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  40192. private _setButtonValue;
  40193. private _setDPadValue;
  40194. /**
  40195. * Gets the value of the `A` button
  40196. */
  40197. /**
  40198. * Sets the value of the `A` button
  40199. */
  40200. buttonA: number;
  40201. /**
  40202. * Gets the value of the `B` button
  40203. */
  40204. /**
  40205. * Sets the value of the `B` button
  40206. */
  40207. buttonB: number;
  40208. /**
  40209. * Gets the value of the `X` button
  40210. */
  40211. /**
  40212. * Sets the value of the `X` button
  40213. */
  40214. buttonX: number;
  40215. /**
  40216. * Gets the value of the `Y` button
  40217. */
  40218. /**
  40219. * Sets the value of the `Y` button
  40220. */
  40221. buttonY: number;
  40222. /**
  40223. * Gets the value of the `Start` button
  40224. */
  40225. /**
  40226. * Sets the value of the `Start` button
  40227. */
  40228. buttonStart: number;
  40229. /**
  40230. * Gets the value of the `Back` button
  40231. */
  40232. /**
  40233. * Sets the value of the `Back` button
  40234. */
  40235. buttonBack: number;
  40236. /**
  40237. * Gets the value of the `Left` button
  40238. */
  40239. /**
  40240. * Sets the value of the `Left` button
  40241. */
  40242. buttonLB: number;
  40243. /**
  40244. * Gets the value of the `Right` button
  40245. */
  40246. /**
  40247. * Sets the value of the `Right` button
  40248. */
  40249. buttonRB: number;
  40250. /**
  40251. * Gets the value of the Left joystick
  40252. */
  40253. /**
  40254. * Sets the value of the Left joystick
  40255. */
  40256. buttonLeftStick: number;
  40257. /**
  40258. * Gets the value of the Right joystick
  40259. */
  40260. /**
  40261. * Sets the value of the Right joystick
  40262. */
  40263. buttonRightStick: number;
  40264. /**
  40265. * Gets the value of D-pad up
  40266. */
  40267. /**
  40268. * Sets the value of D-pad up
  40269. */
  40270. dPadUp: number;
  40271. /**
  40272. * Gets the value of D-pad down
  40273. */
  40274. /**
  40275. * Sets the value of D-pad down
  40276. */
  40277. dPadDown: number;
  40278. /**
  40279. * Gets the value of D-pad left
  40280. */
  40281. /**
  40282. * Sets the value of D-pad left
  40283. */
  40284. dPadLeft: number;
  40285. /**
  40286. * Gets the value of D-pad right
  40287. */
  40288. /**
  40289. * Sets the value of D-pad right
  40290. */
  40291. dPadRight: number;
  40292. /**
  40293. * Force the gamepad to synchronize with device values
  40294. */
  40295. update(): void;
  40296. /**
  40297. * Disposes the gamepad
  40298. */
  40299. dispose(): void;
  40300. }
  40301. }
  40302. declare module "babylonjs/Gamepads/dualShockGamepad" {
  40303. import { Observable } from "babylonjs/Misc/observable";
  40304. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40305. /**
  40306. * Defines supported buttons for DualShock compatible gamepads
  40307. */
  40308. export enum DualShockButton {
  40309. /** Cross */
  40310. Cross = 0,
  40311. /** Circle */
  40312. Circle = 1,
  40313. /** Square */
  40314. Square = 2,
  40315. /** Triangle */
  40316. Triangle = 3,
  40317. /** Options */
  40318. Options = 4,
  40319. /** Share */
  40320. Share = 5,
  40321. /** L1 */
  40322. L1 = 6,
  40323. /** R1 */
  40324. R1 = 7,
  40325. /** Left stick */
  40326. LeftStick = 8,
  40327. /** Right stick */
  40328. RightStick = 9
  40329. }
  40330. /** Defines values for DualShock DPad */
  40331. export enum DualShockDpad {
  40332. /** Up */
  40333. Up = 0,
  40334. /** Down */
  40335. Down = 1,
  40336. /** Left */
  40337. Left = 2,
  40338. /** Right */
  40339. Right = 3
  40340. }
  40341. /**
  40342. * Defines a DualShock gamepad
  40343. */
  40344. export class DualShockPad extends Gamepad {
  40345. private _leftTrigger;
  40346. private _rightTrigger;
  40347. private _onlefttriggerchanged;
  40348. private _onrighttriggerchanged;
  40349. private _onbuttondown;
  40350. private _onbuttonup;
  40351. private _ondpaddown;
  40352. private _ondpadup;
  40353. /** Observable raised when a button is pressed */
  40354. onButtonDownObservable: Observable<DualShockButton>;
  40355. /** Observable raised when a button is released */
  40356. onButtonUpObservable: Observable<DualShockButton>;
  40357. /** Observable raised when a pad is pressed */
  40358. onPadDownObservable: Observable<DualShockDpad>;
  40359. /** Observable raised when a pad is released */
  40360. onPadUpObservable: Observable<DualShockDpad>;
  40361. private _buttonCross;
  40362. private _buttonCircle;
  40363. private _buttonSquare;
  40364. private _buttonTriangle;
  40365. private _buttonShare;
  40366. private _buttonOptions;
  40367. private _buttonL1;
  40368. private _buttonR1;
  40369. private _buttonLeftStick;
  40370. private _buttonRightStick;
  40371. private _dPadUp;
  40372. private _dPadDown;
  40373. private _dPadLeft;
  40374. private _dPadRight;
  40375. /**
  40376. * Creates a new DualShock gamepad object
  40377. * @param id defines the id of this gamepad
  40378. * @param index defines its index
  40379. * @param gamepad defines the internal HTML gamepad object
  40380. */
  40381. constructor(id: string, index: number, gamepad: any);
  40382. /**
  40383. * Defines the callback to call when left trigger is pressed
  40384. * @param callback defines the callback to use
  40385. */
  40386. onlefttriggerchanged(callback: (value: number) => void): void;
  40387. /**
  40388. * Defines the callback to call when right trigger is pressed
  40389. * @param callback defines the callback to use
  40390. */
  40391. onrighttriggerchanged(callback: (value: number) => void): void;
  40392. /**
  40393. * Gets the left trigger value
  40394. */
  40395. /**
  40396. * Sets the left trigger value
  40397. */
  40398. leftTrigger: number;
  40399. /**
  40400. * Gets the right trigger value
  40401. */
  40402. /**
  40403. * Sets the right trigger value
  40404. */
  40405. rightTrigger: number;
  40406. /**
  40407. * Defines the callback to call when a button is pressed
  40408. * @param callback defines the callback to use
  40409. */
  40410. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  40411. /**
  40412. * Defines the callback to call when a button is released
  40413. * @param callback defines the callback to use
  40414. */
  40415. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  40416. /**
  40417. * Defines the callback to call when a pad is pressed
  40418. * @param callback defines the callback to use
  40419. */
  40420. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  40421. /**
  40422. * Defines the callback to call when a pad is released
  40423. * @param callback defines the callback to use
  40424. */
  40425. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  40426. private _setButtonValue;
  40427. private _setDPadValue;
  40428. /**
  40429. * Gets the value of the `Cross` button
  40430. */
  40431. /**
  40432. * Sets the value of the `Cross` button
  40433. */
  40434. buttonCross: number;
  40435. /**
  40436. * Gets the value of the `Circle` button
  40437. */
  40438. /**
  40439. * Sets the value of the `Circle` button
  40440. */
  40441. buttonCircle: number;
  40442. /**
  40443. * Gets the value of the `Square` button
  40444. */
  40445. /**
  40446. * Sets the value of the `Square` button
  40447. */
  40448. buttonSquare: number;
  40449. /**
  40450. * Gets the value of the `Triangle` button
  40451. */
  40452. /**
  40453. * Sets the value of the `Triangle` button
  40454. */
  40455. buttonTriangle: number;
  40456. /**
  40457. * Gets the value of the `Options` button
  40458. */
  40459. /**
  40460. * Sets the value of the `Options` button
  40461. */
  40462. buttonOptions: number;
  40463. /**
  40464. * Gets the value of the `Share` button
  40465. */
  40466. /**
  40467. * Sets the value of the `Share` button
  40468. */
  40469. buttonShare: number;
  40470. /**
  40471. * Gets the value of the `L1` button
  40472. */
  40473. /**
  40474. * Sets the value of the `L1` button
  40475. */
  40476. buttonL1: number;
  40477. /**
  40478. * Gets the value of the `R1` button
  40479. */
  40480. /**
  40481. * Sets the value of the `R1` button
  40482. */
  40483. buttonR1: number;
  40484. /**
  40485. * Gets the value of the Left joystick
  40486. */
  40487. /**
  40488. * Sets the value of the Left joystick
  40489. */
  40490. buttonLeftStick: number;
  40491. /**
  40492. * Gets the value of the Right joystick
  40493. */
  40494. /**
  40495. * Sets the value of the Right joystick
  40496. */
  40497. buttonRightStick: number;
  40498. /**
  40499. * Gets the value of D-pad up
  40500. */
  40501. /**
  40502. * Sets the value of D-pad up
  40503. */
  40504. dPadUp: number;
  40505. /**
  40506. * Gets the value of D-pad down
  40507. */
  40508. /**
  40509. * Sets the value of D-pad down
  40510. */
  40511. dPadDown: number;
  40512. /**
  40513. * Gets the value of D-pad left
  40514. */
  40515. /**
  40516. * Sets the value of D-pad left
  40517. */
  40518. dPadLeft: number;
  40519. /**
  40520. * Gets the value of D-pad right
  40521. */
  40522. /**
  40523. * Sets the value of D-pad right
  40524. */
  40525. dPadRight: number;
  40526. /**
  40527. * Force the gamepad to synchronize with device values
  40528. */
  40529. update(): void;
  40530. /**
  40531. * Disposes the gamepad
  40532. */
  40533. dispose(): void;
  40534. }
  40535. }
  40536. declare module "babylonjs/Gamepads/gamepadManager" {
  40537. import { Observable } from "babylonjs/Misc/observable";
  40538. import { Nullable } from "babylonjs/types";
  40539. import { Scene } from "babylonjs/scene";
  40540. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40541. /**
  40542. * Manager for handling gamepads
  40543. */
  40544. export class GamepadManager {
  40545. private _scene?;
  40546. private _babylonGamepads;
  40547. private _oneGamepadConnected;
  40548. /** @hidden */
  40549. _isMonitoring: boolean;
  40550. private _gamepadEventSupported;
  40551. private _gamepadSupport;
  40552. /**
  40553. * observable to be triggered when the gamepad controller has been connected
  40554. */
  40555. onGamepadConnectedObservable: Observable<Gamepad>;
  40556. /**
  40557. * observable to be triggered when the gamepad controller has been disconnected
  40558. */
  40559. onGamepadDisconnectedObservable: Observable<Gamepad>;
  40560. private _onGamepadConnectedEvent;
  40561. private _onGamepadDisconnectedEvent;
  40562. /**
  40563. * Initializes the gamepad manager
  40564. * @param _scene BabylonJS scene
  40565. */
  40566. constructor(_scene?: Scene | undefined);
  40567. /**
  40568. * The gamepads in the game pad manager
  40569. */
  40570. readonly gamepads: Gamepad[];
  40571. /**
  40572. * Get the gamepad controllers based on type
  40573. * @param type The type of gamepad controller
  40574. * @returns Nullable gamepad
  40575. */
  40576. getGamepadByType(type?: number): Nullable<Gamepad>;
  40577. /**
  40578. * Disposes the gamepad manager
  40579. */
  40580. dispose(): void;
  40581. private _addNewGamepad;
  40582. private _startMonitoringGamepads;
  40583. private _stopMonitoringGamepads;
  40584. /** @hidden */
  40585. _checkGamepadsStatus(): void;
  40586. private _updateGamepadObjects;
  40587. }
  40588. }
  40589. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  40590. import { Nullable } from "babylonjs/types";
  40591. import { Scene } from "babylonjs/scene";
  40592. import { ISceneComponent } from "babylonjs/sceneComponent";
  40593. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  40594. module "babylonjs/scene" {
  40595. interface Scene {
  40596. /** @hidden */
  40597. _gamepadManager: Nullable<GamepadManager>;
  40598. /**
  40599. * Gets the gamepad manager associated with the scene
  40600. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  40601. */
  40602. gamepadManager: GamepadManager;
  40603. }
  40604. }
  40605. module "babylonjs/Cameras/freeCameraInputsManager" {
  40606. /**
  40607. * Interface representing a free camera inputs manager
  40608. */
  40609. interface FreeCameraInputsManager {
  40610. /**
  40611. * Adds gamepad input support to the FreeCameraInputsManager.
  40612. * @returns the FreeCameraInputsManager
  40613. */
  40614. addGamepad(): FreeCameraInputsManager;
  40615. }
  40616. }
  40617. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  40618. /**
  40619. * Interface representing an arc rotate camera inputs manager
  40620. */
  40621. interface ArcRotateCameraInputsManager {
  40622. /**
  40623. * Adds gamepad input support to the ArcRotateCamera InputManager.
  40624. * @returns the camera inputs manager
  40625. */
  40626. addGamepad(): ArcRotateCameraInputsManager;
  40627. }
  40628. }
  40629. /**
  40630. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  40631. */
  40632. export class GamepadSystemSceneComponent implements ISceneComponent {
  40633. /**
  40634. * The component name helpfull to identify the component in the list of scene components.
  40635. */
  40636. readonly name: string;
  40637. /**
  40638. * The scene the component belongs to.
  40639. */
  40640. scene: Scene;
  40641. /**
  40642. * Creates a new instance of the component for the given scene
  40643. * @param scene Defines the scene to register the component in
  40644. */
  40645. constructor(scene: Scene);
  40646. /**
  40647. * Registers the component in a given scene
  40648. */
  40649. register(): void;
  40650. /**
  40651. * Rebuilds the elements related to this component in case of
  40652. * context lost for instance.
  40653. */
  40654. rebuild(): void;
  40655. /**
  40656. * Disposes the component and the associated ressources
  40657. */
  40658. dispose(): void;
  40659. private _beforeCameraUpdate;
  40660. }
  40661. }
  40662. declare module "babylonjs/Cameras/universalCamera" {
  40663. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  40664. import { Scene } from "babylonjs/scene";
  40665. import { Vector3 } from "babylonjs/Maths/math.vector";
  40666. import "babylonjs/Gamepads/gamepadSceneComponent";
  40667. /**
  40668. * 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,
  40669. * which still works and will still be found in many Playgrounds.
  40670. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40671. */
  40672. export class UniversalCamera extends TouchCamera {
  40673. /**
  40674. * Defines the gamepad rotation sensiblity.
  40675. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  40676. */
  40677. gamepadAngularSensibility: number;
  40678. /**
  40679. * Defines the gamepad move sensiblity.
  40680. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  40681. */
  40682. gamepadMoveSensibility: number;
  40683. /**
  40684. * 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,
  40685. * which still works and will still be found in many Playgrounds.
  40686. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40687. * @param name Define the name of the camera in the scene
  40688. * @param position Define the start position of the camera in the scene
  40689. * @param scene Define the scene the camera belongs to
  40690. */
  40691. constructor(name: string, position: Vector3, scene: Scene);
  40692. /**
  40693. * Gets the current object class name.
  40694. * @return the class name
  40695. */
  40696. getClassName(): string;
  40697. }
  40698. }
  40699. declare module "babylonjs/Cameras/gamepadCamera" {
  40700. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  40701. import { Scene } from "babylonjs/scene";
  40702. import { Vector3 } from "babylonjs/Maths/math.vector";
  40703. /**
  40704. * This represents a FPS type of camera. This is only here for back compat purpose.
  40705. * Please use the UniversalCamera instead as both are identical.
  40706. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40707. */
  40708. export class GamepadCamera extends UniversalCamera {
  40709. /**
  40710. * Instantiates a new Gamepad Camera
  40711. * This represents a FPS type of camera. This is only here for back compat purpose.
  40712. * Please use the UniversalCamera instead as both are identical.
  40713. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40714. * @param name Define the name of the camera in the scene
  40715. * @param position Define the start position of the camera in the scene
  40716. * @param scene Define the scene the camera belongs to
  40717. */
  40718. constructor(name: string, position: Vector3, scene: Scene);
  40719. /**
  40720. * Gets the current object class name.
  40721. * @return the class name
  40722. */
  40723. getClassName(): string;
  40724. }
  40725. }
  40726. declare module "babylonjs/Shaders/pass.fragment" {
  40727. /** @hidden */
  40728. export var passPixelShader: {
  40729. name: string;
  40730. shader: string;
  40731. };
  40732. }
  40733. declare module "babylonjs/Shaders/passCube.fragment" {
  40734. /** @hidden */
  40735. export var passCubePixelShader: {
  40736. name: string;
  40737. shader: string;
  40738. };
  40739. }
  40740. declare module "babylonjs/PostProcesses/passPostProcess" {
  40741. import { Nullable } from "babylonjs/types";
  40742. import { Camera } from "babylonjs/Cameras/camera";
  40743. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  40744. import { Engine } from "babylonjs/Engines/engine";
  40745. import "babylonjs/Shaders/pass.fragment";
  40746. import "babylonjs/Shaders/passCube.fragment";
  40747. /**
  40748. * PassPostProcess which produces an output the same as it's input
  40749. */
  40750. export class PassPostProcess extends PostProcess {
  40751. /**
  40752. * Creates the PassPostProcess
  40753. * @param name The name of the effect.
  40754. * @param options The required width/height ratio to downsize to before computing the render pass.
  40755. * @param camera The camera to apply the render pass to.
  40756. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  40757. * @param engine The engine which the post process will be applied. (default: current engine)
  40758. * @param reusable If the post process can be reused on the same frame. (default: false)
  40759. * @param textureType The type of texture to be used when performing the post processing.
  40760. * @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)
  40761. */
  40762. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  40763. }
  40764. /**
  40765. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  40766. */
  40767. export class PassCubePostProcess extends PostProcess {
  40768. private _face;
  40769. /**
  40770. * Gets or sets the cube face to display.
  40771. * * 0 is +X
  40772. * * 1 is -X
  40773. * * 2 is +Y
  40774. * * 3 is -Y
  40775. * * 4 is +Z
  40776. * * 5 is -Z
  40777. */
  40778. face: number;
  40779. /**
  40780. * Creates the PassCubePostProcess
  40781. * @param name The name of the effect.
  40782. * @param options The required width/height ratio to downsize to before computing the render pass.
  40783. * @param camera The camera to apply the render pass to.
  40784. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  40785. * @param engine The engine which the post process will be applied. (default: current engine)
  40786. * @param reusable If the post process can be reused on the same frame. (default: false)
  40787. * @param textureType The type of texture to be used when performing the post processing.
  40788. * @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)
  40789. */
  40790. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  40791. }
  40792. }
  40793. declare module "babylonjs/Shaders/anaglyph.fragment" {
  40794. /** @hidden */
  40795. export var anaglyphPixelShader: {
  40796. name: string;
  40797. shader: string;
  40798. };
  40799. }
  40800. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  40801. import { Engine } from "babylonjs/Engines/engine";
  40802. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  40803. import { Camera } from "babylonjs/Cameras/camera";
  40804. import "babylonjs/Shaders/anaglyph.fragment";
  40805. /**
  40806. * Postprocess used to generate anaglyphic rendering
  40807. */
  40808. export class AnaglyphPostProcess extends PostProcess {
  40809. private _passedProcess;
  40810. /**
  40811. * Creates a new AnaglyphPostProcess
  40812. * @param name defines postprocess name
  40813. * @param options defines creation options or target ratio scale
  40814. * @param rigCameras defines cameras using this postprocess
  40815. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  40816. * @param engine defines hosting engine
  40817. * @param reusable defines if the postprocess will be reused multiple times per frame
  40818. */
  40819. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  40820. }
  40821. }
  40822. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  40823. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  40824. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  40825. import { Scene } from "babylonjs/scene";
  40826. import { Vector3 } from "babylonjs/Maths/math.vector";
  40827. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40828. /**
  40829. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  40830. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40831. */
  40832. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  40833. /**
  40834. * Creates a new AnaglyphArcRotateCamera
  40835. * @param name defines camera name
  40836. * @param alpha defines alpha angle (in radians)
  40837. * @param beta defines beta angle (in radians)
  40838. * @param radius defines radius
  40839. * @param target defines camera target
  40840. * @param interaxialDistance defines distance between each color axis
  40841. * @param scene defines the hosting scene
  40842. */
  40843. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  40844. /**
  40845. * Gets camera class name
  40846. * @returns AnaglyphArcRotateCamera
  40847. */
  40848. getClassName(): string;
  40849. }
  40850. }
  40851. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  40852. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40853. import { Scene } from "babylonjs/scene";
  40854. import { Vector3 } from "babylonjs/Maths/math.vector";
  40855. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40856. /**
  40857. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  40858. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40859. */
  40860. export class AnaglyphFreeCamera extends FreeCamera {
  40861. /**
  40862. * Creates a new AnaglyphFreeCamera
  40863. * @param name defines camera name
  40864. * @param position defines initial position
  40865. * @param interaxialDistance defines distance between each color axis
  40866. * @param scene defines the hosting scene
  40867. */
  40868. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  40869. /**
  40870. * Gets camera class name
  40871. * @returns AnaglyphFreeCamera
  40872. */
  40873. getClassName(): string;
  40874. }
  40875. }
  40876. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  40877. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  40878. import { Scene } from "babylonjs/scene";
  40879. import { Vector3 } from "babylonjs/Maths/math.vector";
  40880. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40881. /**
  40882. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  40883. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40884. */
  40885. export class AnaglyphGamepadCamera extends GamepadCamera {
  40886. /**
  40887. * Creates a new AnaglyphGamepadCamera
  40888. * @param name defines camera name
  40889. * @param position defines initial position
  40890. * @param interaxialDistance defines distance between each color axis
  40891. * @param scene defines the hosting scene
  40892. */
  40893. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  40894. /**
  40895. * Gets camera class name
  40896. * @returns AnaglyphGamepadCamera
  40897. */
  40898. getClassName(): string;
  40899. }
  40900. }
  40901. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  40902. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  40903. import { Scene } from "babylonjs/scene";
  40904. import { Vector3 } from "babylonjs/Maths/math.vector";
  40905. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  40906. /**
  40907. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  40908. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  40909. */
  40910. export class AnaglyphUniversalCamera extends UniversalCamera {
  40911. /**
  40912. * Creates a new AnaglyphUniversalCamera
  40913. * @param name defines camera name
  40914. * @param position defines initial position
  40915. * @param interaxialDistance defines distance between each color axis
  40916. * @param scene defines the hosting scene
  40917. */
  40918. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  40919. /**
  40920. * Gets camera class name
  40921. * @returns AnaglyphUniversalCamera
  40922. */
  40923. getClassName(): string;
  40924. }
  40925. }
  40926. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  40927. /** @hidden */
  40928. export var stereoscopicInterlacePixelShader: {
  40929. name: string;
  40930. shader: string;
  40931. };
  40932. }
  40933. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  40934. import { Camera } from "babylonjs/Cameras/camera";
  40935. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40936. import { Engine } from "babylonjs/Engines/engine";
  40937. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  40938. /**
  40939. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  40940. */
  40941. export class StereoscopicInterlacePostProcess extends PostProcess {
  40942. private _stepSize;
  40943. private _passedProcess;
  40944. /**
  40945. * Initializes a StereoscopicInterlacePostProcess
  40946. * @param name The name of the effect.
  40947. * @param rigCameras The rig cameras to be appled to the post process
  40948. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  40949. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  40950. * @param engine The engine which the post process will be applied. (default: current engine)
  40951. * @param reusable If the post process can be reused on the same frame. (default: false)
  40952. */
  40953. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  40954. }
  40955. }
  40956. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  40957. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  40958. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  40959. import { Scene } from "babylonjs/scene";
  40960. import { Vector3 } from "babylonjs/Maths/math.vector";
  40961. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  40962. /**
  40963. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  40964. * @see http://doc.babylonjs.com/features/cameras
  40965. */
  40966. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  40967. /**
  40968. * Creates a new StereoscopicArcRotateCamera
  40969. * @param name defines camera name
  40970. * @param alpha defines alpha angle (in radians)
  40971. * @param beta defines beta angle (in radians)
  40972. * @param radius defines radius
  40973. * @param target defines camera target
  40974. * @param interaxialDistance defines distance between each color axis
  40975. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  40976. * @param scene defines the hosting scene
  40977. */
  40978. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  40979. /**
  40980. * Gets camera class name
  40981. * @returns StereoscopicArcRotateCamera
  40982. */
  40983. getClassName(): string;
  40984. }
  40985. }
  40986. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  40987. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40988. import { Scene } from "babylonjs/scene";
  40989. import { Vector3 } from "babylonjs/Maths/math.vector";
  40990. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  40991. /**
  40992. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  40993. * @see http://doc.babylonjs.com/features/cameras
  40994. */
  40995. export class StereoscopicFreeCamera extends FreeCamera {
  40996. /**
  40997. * Creates a new StereoscopicFreeCamera
  40998. * @param name defines camera name
  40999. * @param position defines initial position
  41000. * @param interaxialDistance defines distance between each color axis
  41001. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41002. * @param scene defines the hosting scene
  41003. */
  41004. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41005. /**
  41006. * Gets camera class name
  41007. * @returns StereoscopicFreeCamera
  41008. */
  41009. getClassName(): string;
  41010. }
  41011. }
  41012. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  41013. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  41014. import { Scene } from "babylonjs/scene";
  41015. import { Vector3 } from "babylonjs/Maths/math.vector";
  41016. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41017. /**
  41018. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  41019. * @see http://doc.babylonjs.com/features/cameras
  41020. */
  41021. export class StereoscopicGamepadCamera extends GamepadCamera {
  41022. /**
  41023. * Creates a new StereoscopicGamepadCamera
  41024. * @param name defines camera name
  41025. * @param position defines initial position
  41026. * @param interaxialDistance defines distance between each color axis
  41027. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41028. * @param scene defines the hosting scene
  41029. */
  41030. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41031. /**
  41032. * Gets camera class name
  41033. * @returns StereoscopicGamepadCamera
  41034. */
  41035. getClassName(): string;
  41036. }
  41037. }
  41038. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  41039. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  41040. import { Scene } from "babylonjs/scene";
  41041. import { Vector3 } from "babylonjs/Maths/math.vector";
  41042. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41043. /**
  41044. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  41045. * @see http://doc.babylonjs.com/features/cameras
  41046. */
  41047. export class StereoscopicUniversalCamera extends UniversalCamera {
  41048. /**
  41049. * Creates a new StereoscopicUniversalCamera
  41050. * @param name defines camera name
  41051. * @param position defines initial position
  41052. * @param interaxialDistance defines distance between each color axis
  41053. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41054. * @param scene defines the hosting scene
  41055. */
  41056. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41057. /**
  41058. * Gets camera class name
  41059. * @returns StereoscopicUniversalCamera
  41060. */
  41061. getClassName(): string;
  41062. }
  41063. }
  41064. declare module "babylonjs/Cameras/Stereoscopic/index" {
  41065. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  41066. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  41067. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  41068. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  41069. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  41070. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  41071. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  41072. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  41073. }
  41074. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  41075. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  41076. import { Scene } from "babylonjs/scene";
  41077. import { Vector3 } from "babylonjs/Maths/math.vector";
  41078. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  41079. /**
  41080. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  41081. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  41082. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  41083. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  41084. */
  41085. export class VirtualJoysticksCamera extends FreeCamera {
  41086. /**
  41087. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  41088. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  41089. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  41090. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  41091. * @param name Define the name of the camera in the scene
  41092. * @param position Define the start position of the camera in the scene
  41093. * @param scene Define the scene the camera belongs to
  41094. */
  41095. constructor(name: string, position: Vector3, scene: Scene);
  41096. /**
  41097. * Gets the current object class name.
  41098. * @return the class name
  41099. */
  41100. getClassName(): string;
  41101. }
  41102. }
  41103. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  41104. import { Matrix } from "babylonjs/Maths/math.vector";
  41105. /**
  41106. * This represents all the required metrics to create a VR camera.
  41107. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  41108. */
  41109. export class VRCameraMetrics {
  41110. /**
  41111. * Define the horizontal resolution off the screen.
  41112. */
  41113. hResolution: number;
  41114. /**
  41115. * Define the vertical resolution off the screen.
  41116. */
  41117. vResolution: number;
  41118. /**
  41119. * Define the horizontal screen size.
  41120. */
  41121. hScreenSize: number;
  41122. /**
  41123. * Define the vertical screen size.
  41124. */
  41125. vScreenSize: number;
  41126. /**
  41127. * Define the vertical screen center position.
  41128. */
  41129. vScreenCenter: number;
  41130. /**
  41131. * Define the distance of the eyes to the screen.
  41132. */
  41133. eyeToScreenDistance: number;
  41134. /**
  41135. * Define the distance between both lenses
  41136. */
  41137. lensSeparationDistance: number;
  41138. /**
  41139. * Define the distance between both viewer's eyes.
  41140. */
  41141. interpupillaryDistance: number;
  41142. /**
  41143. * Define the distortion factor of the VR postprocess.
  41144. * Please, touch with care.
  41145. */
  41146. distortionK: number[];
  41147. /**
  41148. * Define the chromatic aberration correction factors for the VR post process.
  41149. */
  41150. chromaAbCorrection: number[];
  41151. /**
  41152. * Define the scale factor of the post process.
  41153. * The smaller the better but the slower.
  41154. */
  41155. postProcessScaleFactor: number;
  41156. /**
  41157. * Define an offset for the lens center.
  41158. */
  41159. lensCenterOffset: number;
  41160. /**
  41161. * Define if the current vr camera should compensate the distortion of the lense or not.
  41162. */
  41163. compensateDistortion: boolean;
  41164. /**
  41165. * Defines if multiview should be enabled when rendering (Default: false)
  41166. */
  41167. multiviewEnabled: boolean;
  41168. /**
  41169. * Gets the rendering aspect ratio based on the provided resolutions.
  41170. */
  41171. readonly aspectRatio: number;
  41172. /**
  41173. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  41174. */
  41175. readonly aspectRatioFov: number;
  41176. /**
  41177. * @hidden
  41178. */
  41179. readonly leftHMatrix: Matrix;
  41180. /**
  41181. * @hidden
  41182. */
  41183. readonly rightHMatrix: Matrix;
  41184. /**
  41185. * @hidden
  41186. */
  41187. readonly leftPreViewMatrix: Matrix;
  41188. /**
  41189. * @hidden
  41190. */
  41191. readonly rightPreViewMatrix: Matrix;
  41192. /**
  41193. * Get the default VRMetrics based on the most generic setup.
  41194. * @returns the default vr metrics
  41195. */
  41196. static GetDefault(): VRCameraMetrics;
  41197. }
  41198. }
  41199. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  41200. /** @hidden */
  41201. export var vrDistortionCorrectionPixelShader: {
  41202. name: string;
  41203. shader: string;
  41204. };
  41205. }
  41206. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  41207. import { Camera } from "babylonjs/Cameras/camera";
  41208. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41209. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  41210. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  41211. /**
  41212. * VRDistortionCorrectionPostProcess used for mobile VR
  41213. */
  41214. export class VRDistortionCorrectionPostProcess extends PostProcess {
  41215. private _isRightEye;
  41216. private _distortionFactors;
  41217. private _postProcessScaleFactor;
  41218. private _lensCenterOffset;
  41219. private _scaleIn;
  41220. private _scaleFactor;
  41221. private _lensCenter;
  41222. /**
  41223. * Initializes the VRDistortionCorrectionPostProcess
  41224. * @param name The name of the effect.
  41225. * @param camera The camera to apply the render pass to.
  41226. * @param isRightEye If this is for the right eye distortion
  41227. * @param vrMetrics All the required metrics for the VR camera
  41228. */
  41229. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  41230. }
  41231. }
  41232. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  41233. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  41234. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  41235. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41236. import { Scene } from "babylonjs/scene";
  41237. import { Vector3 } from "babylonjs/Maths/math.vector";
  41238. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  41239. import "babylonjs/Cameras/RigModes/vrRigMode";
  41240. /**
  41241. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  41242. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41243. */
  41244. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  41245. /**
  41246. * Creates a new VRDeviceOrientationArcRotateCamera
  41247. * @param name defines camera name
  41248. * @param alpha defines the camera rotation along the logitudinal axis
  41249. * @param beta defines the camera rotation along the latitudinal axis
  41250. * @param radius defines the camera distance from its target
  41251. * @param target defines the camera target
  41252. * @param scene defines the scene the camera belongs to
  41253. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41254. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41255. */
  41256. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41257. /**
  41258. * Gets camera class name
  41259. * @returns VRDeviceOrientationArcRotateCamera
  41260. */
  41261. getClassName(): string;
  41262. }
  41263. }
  41264. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  41265. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  41266. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41267. import { Scene } from "babylonjs/scene";
  41268. import { Vector3 } from "babylonjs/Maths/math.vector";
  41269. import "babylonjs/Cameras/RigModes/vrRigMode";
  41270. /**
  41271. * Camera used to simulate VR rendering (based on FreeCamera)
  41272. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41273. */
  41274. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  41275. /**
  41276. * Creates a new VRDeviceOrientationFreeCamera
  41277. * @param name defines camera name
  41278. * @param position defines the start position of the camera
  41279. * @param scene defines the scene the camera belongs to
  41280. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41281. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41282. */
  41283. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41284. /**
  41285. * Gets camera class name
  41286. * @returns VRDeviceOrientationFreeCamera
  41287. */
  41288. getClassName(): string;
  41289. }
  41290. }
  41291. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  41292. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  41293. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41294. import { Scene } from "babylonjs/scene";
  41295. import { Vector3 } from "babylonjs/Maths/math.vector";
  41296. import "babylonjs/Gamepads/gamepadSceneComponent";
  41297. /**
  41298. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  41299. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41300. */
  41301. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  41302. /**
  41303. * Creates a new VRDeviceOrientationGamepadCamera
  41304. * @param name defines camera name
  41305. * @param position defines the start position of the camera
  41306. * @param scene defines the scene the camera belongs to
  41307. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41308. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41309. */
  41310. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41311. /**
  41312. * Gets camera class name
  41313. * @returns VRDeviceOrientationGamepadCamera
  41314. */
  41315. getClassName(): string;
  41316. }
  41317. }
  41318. declare module "babylonjs/Materials/pushMaterial" {
  41319. import { Nullable } from "babylonjs/types";
  41320. import { Scene } from "babylonjs/scene";
  41321. import { Matrix } from "babylonjs/Maths/math.vector";
  41322. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  41323. import { Mesh } from "babylonjs/Meshes/mesh";
  41324. import { Material } from "babylonjs/Materials/material";
  41325. import { Effect } from "babylonjs/Materials/effect";
  41326. /**
  41327. * Base class of materials working in push mode in babylon JS
  41328. * @hidden
  41329. */
  41330. export class PushMaterial extends Material {
  41331. protected _activeEffect: Effect;
  41332. protected _normalMatrix: Matrix;
  41333. /**
  41334. * Gets or sets a boolean indicating that the material is allowed to do shader hot swapping.
  41335. * This means that the material can keep using a previous shader while a new one is being compiled.
  41336. * This is mostly used when shader parallel compilation is supported (true by default)
  41337. */
  41338. allowShaderHotSwapping: boolean;
  41339. constructor(name: string, scene: Scene);
  41340. getEffect(): Effect;
  41341. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  41342. /**
  41343. * Binds the given world matrix to the active effect
  41344. *
  41345. * @param world the matrix to bind
  41346. */
  41347. bindOnlyWorldMatrix(world: Matrix): void;
  41348. /**
  41349. * Binds the given normal matrix to the active effect
  41350. *
  41351. * @param normalMatrix the matrix to bind
  41352. */
  41353. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  41354. bind(world: Matrix, mesh?: Mesh): void;
  41355. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  41356. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  41357. }
  41358. }
  41359. declare module "babylonjs/Materials/materialFlags" {
  41360. /**
  41361. * This groups all the flags used to control the materials channel.
  41362. */
  41363. export class MaterialFlags {
  41364. private static _DiffuseTextureEnabled;
  41365. /**
  41366. * Are diffuse textures enabled in the application.
  41367. */
  41368. static DiffuseTextureEnabled: boolean;
  41369. private static _AmbientTextureEnabled;
  41370. /**
  41371. * Are ambient textures enabled in the application.
  41372. */
  41373. static AmbientTextureEnabled: boolean;
  41374. private static _OpacityTextureEnabled;
  41375. /**
  41376. * Are opacity textures enabled in the application.
  41377. */
  41378. static OpacityTextureEnabled: boolean;
  41379. private static _ReflectionTextureEnabled;
  41380. /**
  41381. * Are reflection textures enabled in the application.
  41382. */
  41383. static ReflectionTextureEnabled: boolean;
  41384. private static _EmissiveTextureEnabled;
  41385. /**
  41386. * Are emissive textures enabled in the application.
  41387. */
  41388. static EmissiveTextureEnabled: boolean;
  41389. private static _SpecularTextureEnabled;
  41390. /**
  41391. * Are specular textures enabled in the application.
  41392. */
  41393. static SpecularTextureEnabled: boolean;
  41394. private static _BumpTextureEnabled;
  41395. /**
  41396. * Are bump textures enabled in the application.
  41397. */
  41398. static BumpTextureEnabled: boolean;
  41399. private static _LightmapTextureEnabled;
  41400. /**
  41401. * Are lightmap textures enabled in the application.
  41402. */
  41403. static LightmapTextureEnabled: boolean;
  41404. private static _RefractionTextureEnabled;
  41405. /**
  41406. * Are refraction textures enabled in the application.
  41407. */
  41408. static RefractionTextureEnabled: boolean;
  41409. private static _ColorGradingTextureEnabled;
  41410. /**
  41411. * Are color grading textures enabled in the application.
  41412. */
  41413. static ColorGradingTextureEnabled: boolean;
  41414. private static _FresnelEnabled;
  41415. /**
  41416. * Are fresnels enabled in the application.
  41417. */
  41418. static FresnelEnabled: boolean;
  41419. private static _ClearCoatTextureEnabled;
  41420. /**
  41421. * Are clear coat textures enabled in the application.
  41422. */
  41423. static ClearCoatTextureEnabled: boolean;
  41424. private static _ClearCoatBumpTextureEnabled;
  41425. /**
  41426. * Are clear coat bump textures enabled in the application.
  41427. */
  41428. static ClearCoatBumpTextureEnabled: boolean;
  41429. private static _ClearCoatTintTextureEnabled;
  41430. /**
  41431. * Are clear coat tint textures enabled in the application.
  41432. */
  41433. static ClearCoatTintTextureEnabled: boolean;
  41434. private static _SheenTextureEnabled;
  41435. /**
  41436. * Are sheen textures enabled in the application.
  41437. */
  41438. static SheenTextureEnabled: boolean;
  41439. private static _AnisotropicTextureEnabled;
  41440. /**
  41441. * Are anisotropic textures enabled in the application.
  41442. */
  41443. static AnisotropicTextureEnabled: boolean;
  41444. private static _ThicknessTextureEnabled;
  41445. /**
  41446. * Are thickness textures enabled in the application.
  41447. */
  41448. static ThicknessTextureEnabled: boolean;
  41449. }
  41450. }
  41451. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  41452. /** @hidden */
  41453. export var defaultFragmentDeclaration: {
  41454. name: string;
  41455. shader: string;
  41456. };
  41457. }
  41458. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  41459. /** @hidden */
  41460. export var defaultUboDeclaration: {
  41461. name: string;
  41462. shader: string;
  41463. };
  41464. }
  41465. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  41466. /** @hidden */
  41467. export var lightFragmentDeclaration: {
  41468. name: string;
  41469. shader: string;
  41470. };
  41471. }
  41472. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  41473. /** @hidden */
  41474. export var lightUboDeclaration: {
  41475. name: string;
  41476. shader: string;
  41477. };
  41478. }
  41479. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  41480. /** @hidden */
  41481. export var lightsFragmentFunctions: {
  41482. name: string;
  41483. shader: string;
  41484. };
  41485. }
  41486. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  41487. /** @hidden */
  41488. export var shadowsFragmentFunctions: {
  41489. name: string;
  41490. shader: string;
  41491. };
  41492. }
  41493. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  41494. /** @hidden */
  41495. export var fresnelFunction: {
  41496. name: string;
  41497. shader: string;
  41498. };
  41499. }
  41500. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  41501. /** @hidden */
  41502. export var reflectionFunction: {
  41503. name: string;
  41504. shader: string;
  41505. };
  41506. }
  41507. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  41508. /** @hidden */
  41509. export var bumpFragmentFunctions: {
  41510. name: string;
  41511. shader: string;
  41512. };
  41513. }
  41514. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  41515. /** @hidden */
  41516. export var logDepthDeclaration: {
  41517. name: string;
  41518. shader: string;
  41519. };
  41520. }
  41521. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  41522. /** @hidden */
  41523. export var bumpFragment: {
  41524. name: string;
  41525. shader: string;
  41526. };
  41527. }
  41528. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  41529. /** @hidden */
  41530. export var depthPrePass: {
  41531. name: string;
  41532. shader: string;
  41533. };
  41534. }
  41535. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  41536. /** @hidden */
  41537. export var lightFragment: {
  41538. name: string;
  41539. shader: string;
  41540. };
  41541. }
  41542. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  41543. /** @hidden */
  41544. export var logDepthFragment: {
  41545. name: string;
  41546. shader: string;
  41547. };
  41548. }
  41549. declare module "babylonjs/Shaders/default.fragment" {
  41550. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  41551. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  41552. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41553. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  41554. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  41555. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  41556. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  41557. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  41558. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  41559. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  41560. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  41561. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  41562. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  41563. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  41564. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  41565. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  41566. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  41567. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  41568. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  41569. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  41570. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  41571. /** @hidden */
  41572. export var defaultPixelShader: {
  41573. name: string;
  41574. shader: string;
  41575. };
  41576. }
  41577. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  41578. /** @hidden */
  41579. export var defaultVertexDeclaration: {
  41580. name: string;
  41581. shader: string;
  41582. };
  41583. }
  41584. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  41585. /** @hidden */
  41586. export var bumpVertexDeclaration: {
  41587. name: string;
  41588. shader: string;
  41589. };
  41590. }
  41591. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  41592. /** @hidden */
  41593. export var bumpVertex: {
  41594. name: string;
  41595. shader: string;
  41596. };
  41597. }
  41598. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  41599. /** @hidden */
  41600. export var fogVertex: {
  41601. name: string;
  41602. shader: string;
  41603. };
  41604. }
  41605. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  41606. /** @hidden */
  41607. export var shadowsVertex: {
  41608. name: string;
  41609. shader: string;
  41610. };
  41611. }
  41612. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  41613. /** @hidden */
  41614. export var pointCloudVertex: {
  41615. name: string;
  41616. shader: string;
  41617. };
  41618. }
  41619. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  41620. /** @hidden */
  41621. export var logDepthVertex: {
  41622. name: string;
  41623. shader: string;
  41624. };
  41625. }
  41626. declare module "babylonjs/Shaders/default.vertex" {
  41627. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  41628. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  41629. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41630. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  41631. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  41632. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  41633. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  41634. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  41635. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  41636. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  41637. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  41638. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  41639. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  41640. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  41641. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  41642. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  41643. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  41644. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  41645. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  41646. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  41647. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  41648. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  41649. /** @hidden */
  41650. export var defaultVertexShader: {
  41651. name: string;
  41652. shader: string;
  41653. };
  41654. }
  41655. declare module "babylonjs/Materials/standardMaterial" {
  41656. import { SmartArray } from "babylonjs/Misc/smartArray";
  41657. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  41658. import { Nullable } from "babylonjs/types";
  41659. import { Scene } from "babylonjs/scene";
  41660. import { Matrix } from "babylonjs/Maths/math.vector";
  41661. import { Color3 } from "babylonjs/Maths/math.color";
  41662. import { SubMesh } from "babylonjs/Meshes/subMesh";
  41663. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  41664. import { Mesh } from "babylonjs/Meshes/mesh";
  41665. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  41666. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  41667. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  41668. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  41669. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  41670. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  41671. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  41672. import "babylonjs/Shaders/default.fragment";
  41673. import "babylonjs/Shaders/default.vertex";
  41674. /** @hidden */
  41675. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  41676. MAINUV1: boolean;
  41677. MAINUV2: boolean;
  41678. DIFFUSE: boolean;
  41679. DIFFUSEDIRECTUV: number;
  41680. AMBIENT: boolean;
  41681. AMBIENTDIRECTUV: number;
  41682. OPACITY: boolean;
  41683. OPACITYDIRECTUV: number;
  41684. OPACITYRGB: boolean;
  41685. REFLECTION: boolean;
  41686. EMISSIVE: boolean;
  41687. EMISSIVEDIRECTUV: number;
  41688. SPECULAR: boolean;
  41689. SPECULARDIRECTUV: number;
  41690. BUMP: boolean;
  41691. BUMPDIRECTUV: number;
  41692. PARALLAX: boolean;
  41693. PARALLAXOCCLUSION: boolean;
  41694. SPECULAROVERALPHA: boolean;
  41695. CLIPPLANE: boolean;
  41696. CLIPPLANE2: boolean;
  41697. CLIPPLANE3: boolean;
  41698. CLIPPLANE4: boolean;
  41699. ALPHATEST: boolean;
  41700. DEPTHPREPASS: boolean;
  41701. ALPHAFROMDIFFUSE: boolean;
  41702. POINTSIZE: boolean;
  41703. FOG: boolean;
  41704. SPECULARTERM: boolean;
  41705. DIFFUSEFRESNEL: boolean;
  41706. OPACITYFRESNEL: boolean;
  41707. REFLECTIONFRESNEL: boolean;
  41708. REFRACTIONFRESNEL: boolean;
  41709. EMISSIVEFRESNEL: boolean;
  41710. FRESNEL: boolean;
  41711. NORMAL: boolean;
  41712. UV1: boolean;
  41713. UV2: boolean;
  41714. VERTEXCOLOR: boolean;
  41715. VERTEXALPHA: boolean;
  41716. NUM_BONE_INFLUENCERS: number;
  41717. BonesPerMesh: number;
  41718. BONETEXTURE: boolean;
  41719. INSTANCES: boolean;
  41720. GLOSSINESS: boolean;
  41721. ROUGHNESS: boolean;
  41722. EMISSIVEASILLUMINATION: boolean;
  41723. LINKEMISSIVEWITHDIFFUSE: boolean;
  41724. REFLECTIONFRESNELFROMSPECULAR: boolean;
  41725. LIGHTMAP: boolean;
  41726. LIGHTMAPDIRECTUV: number;
  41727. OBJECTSPACE_NORMALMAP: boolean;
  41728. USELIGHTMAPASSHADOWMAP: boolean;
  41729. REFLECTIONMAP_3D: boolean;
  41730. REFLECTIONMAP_SPHERICAL: boolean;
  41731. REFLECTIONMAP_PLANAR: boolean;
  41732. REFLECTIONMAP_CUBIC: boolean;
  41733. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  41734. REFLECTIONMAP_PROJECTION: boolean;
  41735. REFLECTIONMAP_SKYBOX: boolean;
  41736. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  41737. REFLECTIONMAP_EXPLICIT: boolean;
  41738. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  41739. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  41740. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  41741. INVERTCUBICMAP: boolean;
  41742. LOGARITHMICDEPTH: boolean;
  41743. REFRACTION: boolean;
  41744. REFRACTIONMAP_3D: boolean;
  41745. REFLECTIONOVERALPHA: boolean;
  41746. TWOSIDEDLIGHTING: boolean;
  41747. SHADOWFLOAT: boolean;
  41748. MORPHTARGETS: boolean;
  41749. MORPHTARGETS_NORMAL: boolean;
  41750. MORPHTARGETS_TANGENT: boolean;
  41751. MORPHTARGETS_UV: boolean;
  41752. NUM_MORPH_INFLUENCERS: number;
  41753. NONUNIFORMSCALING: boolean;
  41754. PREMULTIPLYALPHA: boolean;
  41755. IMAGEPROCESSING: boolean;
  41756. VIGNETTE: boolean;
  41757. VIGNETTEBLENDMODEMULTIPLY: boolean;
  41758. VIGNETTEBLENDMODEOPAQUE: boolean;
  41759. TONEMAPPING: boolean;
  41760. TONEMAPPING_ACES: boolean;
  41761. CONTRAST: boolean;
  41762. COLORCURVES: boolean;
  41763. COLORGRADING: boolean;
  41764. COLORGRADING3D: boolean;
  41765. SAMPLER3DGREENDEPTH: boolean;
  41766. SAMPLER3DBGRMAP: boolean;
  41767. IMAGEPROCESSINGPOSTPROCESS: boolean;
  41768. MULTIVIEW: boolean;
  41769. /**
  41770. * If the reflection texture on this material is in linear color space
  41771. * @hidden
  41772. */
  41773. IS_REFLECTION_LINEAR: boolean;
  41774. /**
  41775. * If the refraction texture on this material is in linear color space
  41776. * @hidden
  41777. */
  41778. IS_REFRACTION_LINEAR: boolean;
  41779. EXPOSURE: boolean;
  41780. constructor();
  41781. setReflectionMode(modeToEnable: string): void;
  41782. }
  41783. /**
  41784. * This is the default material used in Babylon. It is the best trade off between quality
  41785. * and performances.
  41786. * @see http://doc.babylonjs.com/babylon101/materials
  41787. */
  41788. export class StandardMaterial extends PushMaterial {
  41789. private _diffuseTexture;
  41790. /**
  41791. * The basic texture of the material as viewed under a light.
  41792. */
  41793. diffuseTexture: Nullable<BaseTexture>;
  41794. private _ambientTexture;
  41795. /**
  41796. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  41797. */
  41798. ambientTexture: Nullable<BaseTexture>;
  41799. private _opacityTexture;
  41800. /**
  41801. * Define the transparency of the material from a texture.
  41802. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  41803. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  41804. */
  41805. opacityTexture: Nullable<BaseTexture>;
  41806. private _reflectionTexture;
  41807. /**
  41808. * Define the texture used to display the reflection.
  41809. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41810. */
  41811. reflectionTexture: Nullable<BaseTexture>;
  41812. private _emissiveTexture;
  41813. /**
  41814. * Define texture of the material as if self lit.
  41815. * This will be mixed in the final result even in the absence of light.
  41816. */
  41817. emissiveTexture: Nullable<BaseTexture>;
  41818. private _specularTexture;
  41819. /**
  41820. * Define how the color and intensity of the highlight given by the light in the material.
  41821. */
  41822. specularTexture: Nullable<BaseTexture>;
  41823. private _bumpTexture;
  41824. /**
  41825. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  41826. * 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.
  41827. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  41828. */
  41829. bumpTexture: Nullable<BaseTexture>;
  41830. private _lightmapTexture;
  41831. /**
  41832. * Complex lighting can be computationally expensive to compute at runtime.
  41833. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  41834. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  41835. */
  41836. lightmapTexture: Nullable<BaseTexture>;
  41837. private _refractionTexture;
  41838. /**
  41839. * Define the texture used to display the refraction.
  41840. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41841. */
  41842. refractionTexture: Nullable<BaseTexture>;
  41843. /**
  41844. * The color of the material lit by the environmental background lighting.
  41845. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  41846. */
  41847. ambientColor: Color3;
  41848. /**
  41849. * The basic color of the material as viewed under a light.
  41850. */
  41851. diffuseColor: Color3;
  41852. /**
  41853. * Define how the color and intensity of the highlight given by the light in the material.
  41854. */
  41855. specularColor: Color3;
  41856. /**
  41857. * Define the color of the material as if self lit.
  41858. * This will be mixed in the final result even in the absence of light.
  41859. */
  41860. emissiveColor: Color3;
  41861. /**
  41862. * Defines how sharp are the highlights in the material.
  41863. * The bigger the value the sharper giving a more glossy feeling to the result.
  41864. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  41865. */
  41866. specularPower: number;
  41867. private _useAlphaFromDiffuseTexture;
  41868. /**
  41869. * Does the transparency come from the diffuse texture alpha channel.
  41870. */
  41871. useAlphaFromDiffuseTexture: boolean;
  41872. private _useEmissiveAsIllumination;
  41873. /**
  41874. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  41875. */
  41876. useEmissiveAsIllumination: boolean;
  41877. private _linkEmissiveWithDiffuse;
  41878. /**
  41879. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  41880. * the emissive level when the final color is close to one.
  41881. */
  41882. linkEmissiveWithDiffuse: boolean;
  41883. private _useSpecularOverAlpha;
  41884. /**
  41885. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  41886. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  41887. */
  41888. useSpecularOverAlpha: boolean;
  41889. private _useReflectionOverAlpha;
  41890. /**
  41891. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  41892. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  41893. */
  41894. useReflectionOverAlpha: boolean;
  41895. private _disableLighting;
  41896. /**
  41897. * Does lights from the scene impacts this material.
  41898. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  41899. */
  41900. disableLighting: boolean;
  41901. private _useObjectSpaceNormalMap;
  41902. /**
  41903. * Allows using an object space normal map (instead of tangent space).
  41904. */
  41905. useObjectSpaceNormalMap: boolean;
  41906. private _useParallax;
  41907. /**
  41908. * Is parallax enabled or not.
  41909. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  41910. */
  41911. useParallax: boolean;
  41912. private _useParallaxOcclusion;
  41913. /**
  41914. * Is parallax occlusion enabled or not.
  41915. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  41916. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  41917. */
  41918. useParallaxOcclusion: boolean;
  41919. /**
  41920. * 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.
  41921. */
  41922. parallaxScaleBias: number;
  41923. private _roughness;
  41924. /**
  41925. * Helps to define how blurry the reflections should appears in the material.
  41926. */
  41927. roughness: number;
  41928. /**
  41929. * In case of refraction, define the value of the index of refraction.
  41930. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41931. */
  41932. indexOfRefraction: number;
  41933. /**
  41934. * Invert the refraction texture alongside the y axis.
  41935. * It can be useful with procedural textures or probe for instance.
  41936. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  41937. */
  41938. invertRefractionY: boolean;
  41939. /**
  41940. * Defines the alpha limits in alpha test mode.
  41941. */
  41942. alphaCutOff: number;
  41943. private _useLightmapAsShadowmap;
  41944. /**
  41945. * In case of light mapping, define whether the map contains light or shadow informations.
  41946. */
  41947. useLightmapAsShadowmap: boolean;
  41948. private _diffuseFresnelParameters;
  41949. /**
  41950. * Define the diffuse fresnel parameters of the material.
  41951. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41952. */
  41953. diffuseFresnelParameters: FresnelParameters;
  41954. private _opacityFresnelParameters;
  41955. /**
  41956. * Define the opacity fresnel parameters of the material.
  41957. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41958. */
  41959. opacityFresnelParameters: FresnelParameters;
  41960. private _reflectionFresnelParameters;
  41961. /**
  41962. * Define the reflection fresnel parameters of the material.
  41963. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41964. */
  41965. reflectionFresnelParameters: FresnelParameters;
  41966. private _refractionFresnelParameters;
  41967. /**
  41968. * Define the refraction fresnel parameters of the material.
  41969. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41970. */
  41971. refractionFresnelParameters: FresnelParameters;
  41972. private _emissiveFresnelParameters;
  41973. /**
  41974. * Define the emissive fresnel parameters of the material.
  41975. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41976. */
  41977. emissiveFresnelParameters: FresnelParameters;
  41978. private _useReflectionFresnelFromSpecular;
  41979. /**
  41980. * If true automatically deducts the fresnels values from the material specularity.
  41981. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  41982. */
  41983. useReflectionFresnelFromSpecular: boolean;
  41984. private _useGlossinessFromSpecularMapAlpha;
  41985. /**
  41986. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  41987. */
  41988. useGlossinessFromSpecularMapAlpha: boolean;
  41989. private _maxSimultaneousLights;
  41990. /**
  41991. * Defines the maximum number of lights that can be used in the material
  41992. */
  41993. maxSimultaneousLights: number;
  41994. private _invertNormalMapX;
  41995. /**
  41996. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  41997. */
  41998. invertNormalMapX: boolean;
  41999. private _invertNormalMapY;
  42000. /**
  42001. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  42002. */
  42003. invertNormalMapY: boolean;
  42004. private _twoSidedLighting;
  42005. /**
  42006. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  42007. */
  42008. twoSidedLighting: boolean;
  42009. /**
  42010. * Default configuration related to image processing available in the standard Material.
  42011. */
  42012. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  42013. /**
  42014. * Gets the image processing configuration used either in this material.
  42015. */
  42016. /**
  42017. * Sets the Default image processing configuration used either in the this material.
  42018. *
  42019. * If sets to null, the scene one is in use.
  42020. */
  42021. imageProcessingConfiguration: ImageProcessingConfiguration;
  42022. /**
  42023. * Keep track of the image processing observer to allow dispose and replace.
  42024. */
  42025. private _imageProcessingObserver;
  42026. /**
  42027. * Attaches a new image processing configuration to the Standard Material.
  42028. * @param configuration
  42029. */
  42030. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  42031. /**
  42032. * Gets wether the color curves effect is enabled.
  42033. */
  42034. /**
  42035. * Sets wether the color curves effect is enabled.
  42036. */
  42037. cameraColorCurvesEnabled: boolean;
  42038. /**
  42039. * Gets wether the color grading effect is enabled.
  42040. */
  42041. /**
  42042. * Gets wether the color grading effect is enabled.
  42043. */
  42044. cameraColorGradingEnabled: boolean;
  42045. /**
  42046. * Gets wether tonemapping is enabled or not.
  42047. */
  42048. /**
  42049. * Sets wether tonemapping is enabled or not
  42050. */
  42051. cameraToneMappingEnabled: boolean;
  42052. /**
  42053. * The camera exposure used on this material.
  42054. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  42055. * This corresponds to a photographic exposure.
  42056. */
  42057. /**
  42058. * The camera exposure used on this material.
  42059. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  42060. * This corresponds to a photographic exposure.
  42061. */
  42062. cameraExposure: number;
  42063. /**
  42064. * Gets The camera contrast used on this material.
  42065. */
  42066. /**
  42067. * Sets The camera contrast used on this material.
  42068. */
  42069. cameraContrast: number;
  42070. /**
  42071. * Gets the Color Grading 2D Lookup Texture.
  42072. */
  42073. /**
  42074. * Sets the Color Grading 2D Lookup Texture.
  42075. */
  42076. cameraColorGradingTexture: Nullable<BaseTexture>;
  42077. /**
  42078. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  42079. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  42080. * 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;
  42081. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  42082. */
  42083. /**
  42084. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  42085. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  42086. * 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;
  42087. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  42088. */
  42089. cameraColorCurves: Nullable<ColorCurves>;
  42090. /**
  42091. * Custom callback helping to override the default shader used in the material.
  42092. */
  42093. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: StandardMaterialDefines) => string;
  42094. protected _renderTargets: SmartArray<RenderTargetTexture>;
  42095. protected _worldViewProjectionMatrix: Matrix;
  42096. protected _globalAmbientColor: Color3;
  42097. protected _useLogarithmicDepth: boolean;
  42098. protected _rebuildInParallel: boolean;
  42099. /**
  42100. * Instantiates a new standard material.
  42101. * This is the default material used in Babylon. It is the best trade off between quality
  42102. * and performances.
  42103. * @see http://doc.babylonjs.com/babylon101/materials
  42104. * @param name Define the name of the material in the scene
  42105. * @param scene Define the scene the material belong to
  42106. */
  42107. constructor(name: string, scene: Scene);
  42108. /**
  42109. * Gets a boolean indicating that current material needs to register RTT
  42110. */
  42111. readonly hasRenderTargetTextures: boolean;
  42112. /**
  42113. * Gets the current class name of the material e.g. "StandardMaterial"
  42114. * Mainly use in serialization.
  42115. * @returns the class name
  42116. */
  42117. getClassName(): string;
  42118. /**
  42119. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  42120. * You can try switching to logarithmic depth.
  42121. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  42122. */
  42123. useLogarithmicDepth: boolean;
  42124. /**
  42125. * Specifies if the material will require alpha blending
  42126. * @returns a boolean specifying if alpha blending is needed
  42127. */
  42128. needAlphaBlending(): boolean;
  42129. /**
  42130. * Specifies if this material should be rendered in alpha test mode
  42131. * @returns a boolean specifying if an alpha test is needed.
  42132. */
  42133. needAlphaTesting(): boolean;
  42134. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  42135. /**
  42136. * Get the texture used for alpha test purpose.
  42137. * @returns the diffuse texture in case of the standard material.
  42138. */
  42139. getAlphaTestTexture(): Nullable<BaseTexture>;
  42140. /**
  42141. * Get if the submesh is ready to be used and all its information available.
  42142. * Child classes can use it to update shaders
  42143. * @param mesh defines the mesh to check
  42144. * @param subMesh defines which submesh to check
  42145. * @param useInstances specifies that instances should be used
  42146. * @returns a boolean indicating that the submesh is ready or not
  42147. */
  42148. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  42149. /**
  42150. * Builds the material UBO layouts.
  42151. * Used internally during the effect preparation.
  42152. */
  42153. buildUniformLayout(): void;
  42154. /**
  42155. * Unbinds the material from the mesh
  42156. */
  42157. unbind(): void;
  42158. /**
  42159. * Binds the submesh to this material by preparing the effect and shader to draw
  42160. * @param world defines the world transformation matrix
  42161. * @param mesh defines the mesh containing the submesh
  42162. * @param subMesh defines the submesh to bind the material to
  42163. */
  42164. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  42165. /**
  42166. * Get the list of animatables in the material.
  42167. * @returns the list of animatables object used in the material
  42168. */
  42169. getAnimatables(): IAnimatable[];
  42170. /**
  42171. * Gets the active textures from the material
  42172. * @returns an array of textures
  42173. */
  42174. getActiveTextures(): BaseTexture[];
  42175. /**
  42176. * Specifies if the material uses a texture
  42177. * @param texture defines the texture to check against the material
  42178. * @returns a boolean specifying if the material uses the texture
  42179. */
  42180. hasTexture(texture: BaseTexture): boolean;
  42181. /**
  42182. * Disposes the material
  42183. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  42184. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  42185. */
  42186. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  42187. /**
  42188. * Makes a duplicate of the material, and gives it a new name
  42189. * @param name defines the new name for the duplicated material
  42190. * @returns the cloned material
  42191. */
  42192. clone(name: string): StandardMaterial;
  42193. /**
  42194. * Serializes this material in a JSON representation
  42195. * @returns the serialized material object
  42196. */
  42197. serialize(): any;
  42198. /**
  42199. * Creates a standard material from parsed material data
  42200. * @param source defines the JSON representation of the material
  42201. * @param scene defines the hosting scene
  42202. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  42203. * @returns a new standard material
  42204. */
  42205. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  42206. /**
  42207. * Are diffuse textures enabled in the application.
  42208. */
  42209. static DiffuseTextureEnabled: boolean;
  42210. /**
  42211. * Are ambient textures enabled in the application.
  42212. */
  42213. static AmbientTextureEnabled: boolean;
  42214. /**
  42215. * Are opacity textures enabled in the application.
  42216. */
  42217. static OpacityTextureEnabled: boolean;
  42218. /**
  42219. * Are reflection textures enabled in the application.
  42220. */
  42221. static ReflectionTextureEnabled: boolean;
  42222. /**
  42223. * Are emissive textures enabled in the application.
  42224. */
  42225. static EmissiveTextureEnabled: boolean;
  42226. /**
  42227. * Are specular textures enabled in the application.
  42228. */
  42229. static SpecularTextureEnabled: boolean;
  42230. /**
  42231. * Are bump textures enabled in the application.
  42232. */
  42233. static BumpTextureEnabled: boolean;
  42234. /**
  42235. * Are lightmap textures enabled in the application.
  42236. */
  42237. static LightmapTextureEnabled: boolean;
  42238. /**
  42239. * Are refraction textures enabled in the application.
  42240. */
  42241. static RefractionTextureEnabled: boolean;
  42242. /**
  42243. * Are color grading textures enabled in the application.
  42244. */
  42245. static ColorGradingTextureEnabled: boolean;
  42246. /**
  42247. * Are fresnels enabled in the application.
  42248. */
  42249. static FresnelEnabled: boolean;
  42250. }
  42251. }
  42252. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  42253. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  42254. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  42255. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  42256. /** @hidden */
  42257. export var imageProcessingPixelShader: {
  42258. name: string;
  42259. shader: string;
  42260. };
  42261. }
  42262. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  42263. import { Nullable } from "babylonjs/types";
  42264. import { Color4 } from "babylonjs/Maths/math.color";
  42265. import { Camera } from "babylonjs/Cameras/camera";
  42266. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42267. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  42268. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  42269. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  42270. import { Engine } from "babylonjs/Engines/engine";
  42271. import "babylonjs/Shaders/imageProcessing.fragment";
  42272. import "babylonjs/Shaders/postprocess.vertex";
  42273. /**
  42274. * ImageProcessingPostProcess
  42275. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  42276. */
  42277. export class ImageProcessingPostProcess extends PostProcess {
  42278. /**
  42279. * Default configuration related to image processing available in the PBR Material.
  42280. */
  42281. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  42282. /**
  42283. * Gets the image processing configuration used either in this material.
  42284. */
  42285. /**
  42286. * Sets the Default image processing configuration used either in the this material.
  42287. *
  42288. * If sets to null, the scene one is in use.
  42289. */
  42290. imageProcessingConfiguration: ImageProcessingConfiguration;
  42291. /**
  42292. * Keep track of the image processing observer to allow dispose and replace.
  42293. */
  42294. private _imageProcessingObserver;
  42295. /**
  42296. * Attaches a new image processing configuration to the PBR Material.
  42297. * @param configuration
  42298. */
  42299. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  42300. /**
  42301. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  42302. */
  42303. /**
  42304. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  42305. */
  42306. colorCurves: Nullable<ColorCurves>;
  42307. /**
  42308. * Gets wether the color curves effect is enabled.
  42309. */
  42310. /**
  42311. * Sets wether the color curves effect is enabled.
  42312. */
  42313. colorCurvesEnabled: boolean;
  42314. /**
  42315. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  42316. */
  42317. /**
  42318. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  42319. */
  42320. colorGradingTexture: Nullable<BaseTexture>;
  42321. /**
  42322. * Gets wether the color grading effect is enabled.
  42323. */
  42324. /**
  42325. * Gets wether the color grading effect is enabled.
  42326. */
  42327. colorGradingEnabled: boolean;
  42328. /**
  42329. * Gets exposure used in the effect.
  42330. */
  42331. /**
  42332. * Sets exposure used in the effect.
  42333. */
  42334. exposure: number;
  42335. /**
  42336. * Gets wether tonemapping is enabled or not.
  42337. */
  42338. /**
  42339. * Sets wether tonemapping is enabled or not
  42340. */
  42341. toneMappingEnabled: boolean;
  42342. /**
  42343. * Gets the type of tone mapping effect.
  42344. */
  42345. /**
  42346. * Sets the type of tone mapping effect.
  42347. */
  42348. toneMappingType: number;
  42349. /**
  42350. * Gets contrast used in the effect.
  42351. */
  42352. /**
  42353. * Sets contrast used in the effect.
  42354. */
  42355. contrast: number;
  42356. /**
  42357. * Gets Vignette stretch size.
  42358. */
  42359. /**
  42360. * Sets Vignette stretch size.
  42361. */
  42362. vignetteStretch: number;
  42363. /**
  42364. * Gets Vignette centre X Offset.
  42365. */
  42366. /**
  42367. * Sets Vignette centre X Offset.
  42368. */
  42369. vignetteCentreX: number;
  42370. /**
  42371. * Gets Vignette centre Y Offset.
  42372. */
  42373. /**
  42374. * Sets Vignette centre Y Offset.
  42375. */
  42376. vignetteCentreY: number;
  42377. /**
  42378. * Gets Vignette weight or intensity of the vignette effect.
  42379. */
  42380. /**
  42381. * Sets Vignette weight or intensity of the vignette effect.
  42382. */
  42383. vignetteWeight: number;
  42384. /**
  42385. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  42386. * if vignetteEnabled is set to true.
  42387. */
  42388. /**
  42389. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  42390. * if vignetteEnabled is set to true.
  42391. */
  42392. vignetteColor: Color4;
  42393. /**
  42394. * Gets Camera field of view used by the Vignette effect.
  42395. */
  42396. /**
  42397. * Sets Camera field of view used by the Vignette effect.
  42398. */
  42399. vignetteCameraFov: number;
  42400. /**
  42401. * Gets the vignette blend mode allowing different kind of effect.
  42402. */
  42403. /**
  42404. * Sets the vignette blend mode allowing different kind of effect.
  42405. */
  42406. vignetteBlendMode: number;
  42407. /**
  42408. * Gets wether the vignette effect is enabled.
  42409. */
  42410. /**
  42411. * Sets wether the vignette effect is enabled.
  42412. */
  42413. vignetteEnabled: boolean;
  42414. private _fromLinearSpace;
  42415. /**
  42416. * Gets wether the input of the processing is in Gamma or Linear Space.
  42417. */
  42418. /**
  42419. * Sets wether the input of the processing is in Gamma or Linear Space.
  42420. */
  42421. fromLinearSpace: boolean;
  42422. /**
  42423. * Defines cache preventing GC.
  42424. */
  42425. private _defines;
  42426. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  42427. /**
  42428. * "ImageProcessingPostProcess"
  42429. * @returns "ImageProcessingPostProcess"
  42430. */
  42431. getClassName(): string;
  42432. protected _updateParameters(): void;
  42433. dispose(camera?: Camera): void;
  42434. }
  42435. }
  42436. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  42437. import { Scene } from "babylonjs/scene";
  42438. import { Color3 } from "babylonjs/Maths/math.color";
  42439. import { Mesh } from "babylonjs/Meshes/mesh";
  42440. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  42441. import { Nullable } from "babylonjs/types";
  42442. /**
  42443. * Class containing static functions to help procedurally build meshes
  42444. */
  42445. export class GroundBuilder {
  42446. /**
  42447. * Creates a ground mesh
  42448. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  42449. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  42450. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  42451. * @param name defines the name of the mesh
  42452. * @param options defines the options used to create the mesh
  42453. * @param scene defines the hosting scene
  42454. * @returns the ground mesh
  42455. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  42456. */
  42457. static CreateGround(name: string, options: {
  42458. width?: number;
  42459. height?: number;
  42460. subdivisions?: number;
  42461. subdivisionsX?: number;
  42462. subdivisionsY?: number;
  42463. updatable?: boolean;
  42464. }, scene: any): Mesh;
  42465. /**
  42466. * Creates a tiled ground mesh
  42467. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  42468. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  42469. * * 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
  42470. * * 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
  42471. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42472. * @param name defines the name of the mesh
  42473. * @param options defines the options used to create the mesh
  42474. * @param scene defines the hosting scene
  42475. * @returns the tiled ground mesh
  42476. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  42477. */
  42478. static CreateTiledGround(name: string, options: {
  42479. xmin: number;
  42480. zmin: number;
  42481. xmax: number;
  42482. zmax: number;
  42483. subdivisions?: {
  42484. w: number;
  42485. h: number;
  42486. };
  42487. precision?: {
  42488. w: number;
  42489. h: number;
  42490. };
  42491. updatable?: boolean;
  42492. }, scene?: Nullable<Scene>): Mesh;
  42493. /**
  42494. * Creates a ground mesh from a height map
  42495. * * The parameter `url` sets the URL of the height map image resource.
  42496. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  42497. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  42498. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  42499. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  42500. * * 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.
  42501. * * 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).
  42502. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  42503. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42504. * @param name defines the name of the mesh
  42505. * @param url defines the url to the height map
  42506. * @param options defines the options used to create the mesh
  42507. * @param scene defines the hosting scene
  42508. * @returns the ground mesh
  42509. * @see https://doc.babylonjs.com/babylon101/height_map
  42510. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  42511. */
  42512. static CreateGroundFromHeightMap(name: string, url: string, options: {
  42513. width?: number;
  42514. height?: number;
  42515. subdivisions?: number;
  42516. minHeight?: number;
  42517. maxHeight?: number;
  42518. colorFilter?: Color3;
  42519. alphaFilter?: number;
  42520. updatable?: boolean;
  42521. onReady?: (mesh: GroundMesh) => void;
  42522. }, scene?: Nullable<Scene>): GroundMesh;
  42523. }
  42524. }
  42525. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  42526. import { Vector4 } from "babylonjs/Maths/math.vector";
  42527. import { Mesh } from "babylonjs/Meshes/mesh";
  42528. /**
  42529. * Class containing static functions to help procedurally build meshes
  42530. */
  42531. export class TorusBuilder {
  42532. /**
  42533. * Creates a torus mesh
  42534. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  42535. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  42536. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  42537. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  42538. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  42539. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42540. * @param name defines the name of the mesh
  42541. * @param options defines the options used to create the mesh
  42542. * @param scene defines the hosting scene
  42543. * @returns the torus mesh
  42544. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  42545. */
  42546. static CreateTorus(name: string, options: {
  42547. diameter?: number;
  42548. thickness?: number;
  42549. tessellation?: number;
  42550. updatable?: boolean;
  42551. sideOrientation?: number;
  42552. frontUVs?: Vector4;
  42553. backUVs?: Vector4;
  42554. }, scene: any): Mesh;
  42555. }
  42556. }
  42557. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  42558. import { Vector4 } from "babylonjs/Maths/math.vector";
  42559. import { Color4 } from "babylonjs/Maths/math.color";
  42560. import { Mesh } from "babylonjs/Meshes/mesh";
  42561. /**
  42562. * Class containing static functions to help procedurally build meshes
  42563. */
  42564. export class CylinderBuilder {
  42565. /**
  42566. * Creates a cylinder or a cone mesh
  42567. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  42568. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  42569. * * 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.
  42570. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  42571. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  42572. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  42573. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  42574. * * 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).
  42575. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  42576. * * 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).
  42577. * * 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
  42578. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  42579. * * 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
  42580. * * 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.
  42581. * * If `enclose` is false, a ring surface is one element.
  42582. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  42583. * * 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
  42584. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  42585. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  42586. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42587. * @param name defines the name of the mesh
  42588. * @param options defines the options used to create the mesh
  42589. * @param scene defines the hosting scene
  42590. * @returns the cylinder mesh
  42591. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  42592. */
  42593. static CreateCylinder(name: string, options: {
  42594. height?: number;
  42595. diameterTop?: number;
  42596. diameterBottom?: number;
  42597. diameter?: number;
  42598. tessellation?: number;
  42599. subdivisions?: number;
  42600. arc?: number;
  42601. faceColors?: Color4[];
  42602. faceUV?: Vector4[];
  42603. updatable?: boolean;
  42604. hasRings?: boolean;
  42605. enclose?: boolean;
  42606. cap?: number;
  42607. sideOrientation?: number;
  42608. frontUVs?: Vector4;
  42609. backUVs?: Vector4;
  42610. }, scene: any): Mesh;
  42611. }
  42612. }
  42613. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  42614. import { Observable } from "babylonjs/Misc/observable";
  42615. import { Nullable } from "babylonjs/types";
  42616. import { Camera } from "babylonjs/Cameras/camera";
  42617. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  42618. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  42619. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  42620. import { Scene } from "babylonjs/scene";
  42621. import { Vector3 } from "babylonjs/Maths/math.vector";
  42622. import { Color3 } from "babylonjs/Maths/math.color";
  42623. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  42624. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42625. import { Mesh } from "babylonjs/Meshes/mesh";
  42626. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  42627. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  42628. import "babylonjs/Meshes/Builders/groundBuilder";
  42629. import "babylonjs/Meshes/Builders/torusBuilder";
  42630. import "babylonjs/Meshes/Builders/cylinderBuilder";
  42631. import "babylonjs/Gamepads/gamepadSceneComponent";
  42632. import "babylonjs/Animations/animatable";
  42633. /**
  42634. * Options to modify the vr teleportation behavior.
  42635. */
  42636. export interface VRTeleportationOptions {
  42637. /**
  42638. * The name of the mesh which should be used as the teleportation floor. (default: null)
  42639. */
  42640. floorMeshName?: string;
  42641. /**
  42642. * A list of meshes to be used as the teleportation floor. (default: empty)
  42643. */
  42644. floorMeshes?: Mesh[];
  42645. }
  42646. /**
  42647. * Options to modify the vr experience helper's behavior.
  42648. */
  42649. export interface VRExperienceHelperOptions extends WebVROptions {
  42650. /**
  42651. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  42652. */
  42653. createDeviceOrientationCamera?: boolean;
  42654. /**
  42655. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  42656. */
  42657. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  42658. /**
  42659. * Uses the main button on the controller to toggle the laser casted. (default: true)
  42660. */
  42661. laserToggle?: boolean;
  42662. /**
  42663. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  42664. */
  42665. floorMeshes?: Mesh[];
  42666. /**
  42667. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  42668. */
  42669. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  42670. }
  42671. /**
  42672. * Event containing information after VR has been entered
  42673. */
  42674. export class OnAfterEnteringVRObservableEvent {
  42675. /**
  42676. * If entering vr was successful
  42677. */
  42678. success: boolean;
  42679. }
  42680. /**
  42681. * Helps to quickly add VR support to an existing scene.
  42682. * See http://doc.babylonjs.com/how_to/webvr_helper
  42683. */
  42684. export class VRExperienceHelper {
  42685. /** Options to modify the vr experience helper's behavior. */
  42686. webVROptions: VRExperienceHelperOptions;
  42687. private _scene;
  42688. private _position;
  42689. private _btnVR;
  42690. private _btnVRDisplayed;
  42691. private _webVRsupported;
  42692. private _webVRready;
  42693. private _webVRrequesting;
  42694. private _webVRpresenting;
  42695. private _hasEnteredVR;
  42696. private _fullscreenVRpresenting;
  42697. private _canvas;
  42698. private _webVRCamera;
  42699. private _vrDeviceOrientationCamera;
  42700. private _deviceOrientationCamera;
  42701. private _existingCamera;
  42702. private _onKeyDown;
  42703. private _onVrDisplayPresentChange;
  42704. private _onVRDisplayChanged;
  42705. private _onVRRequestPresentStart;
  42706. private _onVRRequestPresentComplete;
  42707. /**
  42708. * 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)
  42709. */
  42710. enableGazeEvenWhenNoPointerLock: boolean;
  42711. /**
  42712. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  42713. */
  42714. exitVROnDoubleTap: boolean;
  42715. /**
  42716. * Observable raised right before entering VR.
  42717. */
  42718. onEnteringVRObservable: Observable<VRExperienceHelper>;
  42719. /**
  42720. * Observable raised when entering VR has completed.
  42721. */
  42722. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  42723. /**
  42724. * Observable raised when exiting VR.
  42725. */
  42726. onExitingVRObservable: Observable<VRExperienceHelper>;
  42727. /**
  42728. * Observable raised when controller mesh is loaded.
  42729. */
  42730. onControllerMeshLoadedObservable: Observable<WebVRController>;
  42731. /** Return this.onEnteringVRObservable
  42732. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  42733. */
  42734. readonly onEnteringVR: Observable<VRExperienceHelper>;
  42735. /** Return this.onExitingVRObservable
  42736. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  42737. */
  42738. readonly onExitingVR: Observable<VRExperienceHelper>;
  42739. /** Return this.onControllerMeshLoadedObservable
  42740. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  42741. */
  42742. readonly onControllerMeshLoaded: Observable<WebVRController>;
  42743. private _rayLength;
  42744. private _useCustomVRButton;
  42745. private _teleportationRequested;
  42746. private _teleportActive;
  42747. private _floorMeshName;
  42748. private _floorMeshesCollection;
  42749. private _rotationAllowed;
  42750. private _teleportBackwardsVector;
  42751. private _teleportationTarget;
  42752. private _isDefaultTeleportationTarget;
  42753. private _postProcessMove;
  42754. private _teleportationFillColor;
  42755. private _teleportationBorderColor;
  42756. private _rotationAngle;
  42757. private _haloCenter;
  42758. private _cameraGazer;
  42759. private _padSensibilityUp;
  42760. private _padSensibilityDown;
  42761. private _leftController;
  42762. private _rightController;
  42763. /**
  42764. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  42765. */
  42766. onNewMeshSelected: Observable<AbstractMesh>;
  42767. /**
  42768. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  42769. * This observable will provide the mesh and the controller used to select the mesh
  42770. */
  42771. onMeshSelectedWithController: Observable<{
  42772. mesh: AbstractMesh;
  42773. controller: WebVRController;
  42774. }>;
  42775. /**
  42776. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  42777. */
  42778. onNewMeshPicked: Observable<PickingInfo>;
  42779. private _circleEase;
  42780. /**
  42781. * Observable raised before camera teleportation
  42782. */
  42783. onBeforeCameraTeleport: Observable<Vector3>;
  42784. /**
  42785. * Observable raised after camera teleportation
  42786. */
  42787. onAfterCameraTeleport: Observable<Vector3>;
  42788. /**
  42789. * Observable raised when current selected mesh gets unselected
  42790. */
  42791. onSelectedMeshUnselected: Observable<AbstractMesh>;
  42792. private _raySelectionPredicate;
  42793. /**
  42794. * To be optionaly changed by user to define custom ray selection
  42795. */
  42796. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  42797. /**
  42798. * To be optionaly changed by user to define custom selection logic (after ray selection)
  42799. */
  42800. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  42801. /**
  42802. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  42803. */
  42804. teleportationEnabled: boolean;
  42805. private _defaultHeight;
  42806. private _teleportationInitialized;
  42807. private _interactionsEnabled;
  42808. private _interactionsRequested;
  42809. private _displayGaze;
  42810. private _displayLaserPointer;
  42811. /**
  42812. * The mesh used to display where the user is going to teleport.
  42813. */
  42814. /**
  42815. * Sets the mesh to be used to display where the user is going to teleport.
  42816. */
  42817. teleportationTarget: Mesh;
  42818. /**
  42819. * 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
  42820. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  42821. * See http://doc.babylonjs.com/resources/baking_transformations
  42822. */
  42823. gazeTrackerMesh: Mesh;
  42824. /**
  42825. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  42826. */
  42827. updateGazeTrackerScale: boolean;
  42828. /**
  42829. * If the gaze trackers color should be updated when selecting meshes
  42830. */
  42831. updateGazeTrackerColor: boolean;
  42832. /**
  42833. * If the controller laser color should be updated when selecting meshes
  42834. */
  42835. updateControllerLaserColor: boolean;
  42836. /**
  42837. * The gaze tracking mesh corresponding to the left controller
  42838. */
  42839. readonly leftControllerGazeTrackerMesh: Nullable<Mesh>;
  42840. /**
  42841. * The gaze tracking mesh corresponding to the right controller
  42842. */
  42843. readonly rightControllerGazeTrackerMesh: Nullable<Mesh>;
  42844. /**
  42845. * If the ray of the gaze should be displayed.
  42846. */
  42847. /**
  42848. * Sets if the ray of the gaze should be displayed.
  42849. */
  42850. displayGaze: boolean;
  42851. /**
  42852. * If the ray of the LaserPointer should be displayed.
  42853. */
  42854. /**
  42855. * Sets if the ray of the LaserPointer should be displayed.
  42856. */
  42857. displayLaserPointer: boolean;
  42858. /**
  42859. * The deviceOrientationCamera used as the camera when not in VR.
  42860. */
  42861. readonly deviceOrientationCamera: Nullable<DeviceOrientationCamera>;
  42862. /**
  42863. * Based on the current WebVR support, returns the current VR camera used.
  42864. */
  42865. readonly currentVRCamera: Nullable<Camera>;
  42866. /**
  42867. * The webVRCamera which is used when in VR.
  42868. */
  42869. readonly webVRCamera: WebVRFreeCamera;
  42870. /**
  42871. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  42872. */
  42873. readonly vrDeviceOrientationCamera: Nullable<VRDeviceOrientationFreeCamera>;
  42874. /**
  42875. * The html button that is used to trigger entering into VR.
  42876. */
  42877. readonly vrButton: Nullable<HTMLButtonElement>;
  42878. private readonly _teleportationRequestInitiated;
  42879. /**
  42880. * Defines wether or not Pointer lock should be requested when switching to
  42881. * full screen.
  42882. */
  42883. requestPointerLockOnFullScreen: boolean;
  42884. /**
  42885. * Instantiates a VRExperienceHelper.
  42886. * Helps to quickly add VR support to an existing scene.
  42887. * @param scene The scene the VRExperienceHelper belongs to.
  42888. * @param webVROptions Options to modify the vr experience helper's behavior.
  42889. */
  42890. constructor(scene: Scene,
  42891. /** Options to modify the vr experience helper's behavior. */
  42892. webVROptions?: VRExperienceHelperOptions);
  42893. private _onDefaultMeshLoaded;
  42894. private _onResize;
  42895. private _onFullscreenChange;
  42896. /**
  42897. * Gets a value indicating if we are currently in VR mode.
  42898. */
  42899. readonly isInVRMode: boolean;
  42900. private onVrDisplayPresentChange;
  42901. private onVRDisplayChanged;
  42902. private moveButtonToBottomRight;
  42903. private displayVRButton;
  42904. private updateButtonVisibility;
  42905. private _cachedAngularSensibility;
  42906. /**
  42907. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  42908. * Otherwise, will use the fullscreen API.
  42909. */
  42910. enterVR(): void;
  42911. /**
  42912. * Attempt to exit VR, or fullscreen.
  42913. */
  42914. exitVR(): void;
  42915. /**
  42916. * The position of the vr experience helper.
  42917. */
  42918. /**
  42919. * Sets the position of the vr experience helper.
  42920. */
  42921. position: Vector3;
  42922. /**
  42923. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  42924. */
  42925. enableInteractions(): void;
  42926. private readonly _noControllerIsActive;
  42927. private beforeRender;
  42928. private _isTeleportationFloor;
  42929. /**
  42930. * Adds a floor mesh to be used for teleportation.
  42931. * @param floorMesh the mesh to be used for teleportation.
  42932. */
  42933. addFloorMesh(floorMesh: Mesh): void;
  42934. /**
  42935. * Removes a floor mesh from being used for teleportation.
  42936. * @param floorMesh the mesh to be removed.
  42937. */
  42938. removeFloorMesh(floorMesh: Mesh): void;
  42939. /**
  42940. * Enables interactions and teleportation using the VR controllers and gaze.
  42941. * @param vrTeleportationOptions options to modify teleportation behavior.
  42942. */
  42943. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  42944. private _onNewGamepadConnected;
  42945. private _tryEnableInteractionOnController;
  42946. private _onNewGamepadDisconnected;
  42947. private _enableInteractionOnController;
  42948. private _checkTeleportWithRay;
  42949. private _checkRotate;
  42950. private _checkTeleportBackwards;
  42951. private _enableTeleportationOnController;
  42952. private _createTeleportationCircles;
  42953. private _displayTeleportationTarget;
  42954. private _hideTeleportationTarget;
  42955. private _rotateCamera;
  42956. private _moveTeleportationSelectorTo;
  42957. private _workingVector;
  42958. private _workingQuaternion;
  42959. private _workingMatrix;
  42960. /**
  42961. * Teleports the users feet to the desired location
  42962. * @param location The location where the user's feet should be placed
  42963. */
  42964. teleportCamera(location: Vector3): void;
  42965. private _convertNormalToDirectionOfRay;
  42966. private _castRayAndSelectObject;
  42967. private _notifySelectedMeshUnselected;
  42968. /**
  42969. * Sets the color of the laser ray from the vr controllers.
  42970. * @param color new color for the ray.
  42971. */
  42972. changeLaserColor(color: Color3): void;
  42973. /**
  42974. * Sets the color of the ray from the vr headsets gaze.
  42975. * @param color new color for the ray.
  42976. */
  42977. changeGazeColor(color: Color3): void;
  42978. /**
  42979. * Exits VR and disposes of the vr experience helper
  42980. */
  42981. dispose(): void;
  42982. /**
  42983. * Gets the name of the VRExperienceHelper class
  42984. * @returns "VRExperienceHelper"
  42985. */
  42986. getClassName(): string;
  42987. }
  42988. }
  42989. declare module "babylonjs/Cameras/VR/index" {
  42990. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  42991. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  42992. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  42993. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  42994. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  42995. export * from "babylonjs/Cameras/VR/webVRCamera";
  42996. }
  42997. declare module "babylonjs/Cameras/XR/webXRTypes" {
  42998. import { Nullable } from "babylonjs/types";
  42999. import { IDisposable } from "babylonjs/scene";
  43000. /**
  43001. * States of the webXR experience
  43002. */
  43003. export enum WebXRState {
  43004. /**
  43005. * Transitioning to being in XR mode
  43006. */
  43007. ENTERING_XR = 0,
  43008. /**
  43009. * Transitioning to non XR mode
  43010. */
  43011. EXITING_XR = 1,
  43012. /**
  43013. * In XR mode and presenting
  43014. */
  43015. IN_XR = 2,
  43016. /**
  43017. * Not entered XR mode
  43018. */
  43019. NOT_IN_XR = 3
  43020. }
  43021. /**
  43022. * Abstraction of the XR render target
  43023. */
  43024. export interface WebXRRenderTarget extends IDisposable {
  43025. /**
  43026. * xrpresent context of the canvas which can be used to display/mirror xr content
  43027. */
  43028. canvasContext: WebGLRenderingContext;
  43029. /**
  43030. * xr layer for the canvas
  43031. */
  43032. xrLayer: Nullable<XRWebGLLayer>;
  43033. /**
  43034. * Initializes the xr layer for the session
  43035. * @param xrSession xr session
  43036. * @returns a promise that will resolve once the XR Layer has been created
  43037. */
  43038. initializeXRLayerAsync(xrSession: XRSession): Promise<void>;
  43039. }
  43040. }
  43041. declare module "babylonjs/Cameras/XR/webXRManagedOutputCanvas" {
  43042. import { Nullable } from "babylonjs/types";
  43043. import { Observable } from "babylonjs/Misc/observable";
  43044. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  43045. import { WebXRState, WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43046. /**
  43047. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  43048. */
  43049. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  43050. private _engine;
  43051. private _canvas;
  43052. /**
  43053. * xrpresent context of the canvas which can be used to display/mirror xr content
  43054. */
  43055. canvasContext: WebGLRenderingContext;
  43056. /**
  43057. * xr layer for the canvas
  43058. */
  43059. xrLayer: Nullable<XRWebGLLayer>;
  43060. /**
  43061. * Initializes the xr layer for the session
  43062. * @param xrSession xr session
  43063. * @returns a promise that will resolve once the XR Layer has been created
  43064. */
  43065. initializeXRLayerAsync(xrSession: any): any;
  43066. /**
  43067. * Initializes the canvas to be added/removed upon entering/exiting xr
  43068. * @param engine the Babylon engine
  43069. * @param canvas The canvas to be added/removed (If not specified a full screen canvas will be created)
  43070. * @param onStateChangedObservable the mechanism by which the canvas will be added/removed based on XR state
  43071. */
  43072. constructor(engine: ThinEngine, canvas?: HTMLCanvasElement, onStateChangedObservable?: Observable<WebXRState>);
  43073. /**
  43074. * Disposes of the object
  43075. */
  43076. dispose(): void;
  43077. private _setManagedOutputCanvas;
  43078. private _addCanvas;
  43079. private _removeCanvas;
  43080. }
  43081. }
  43082. declare module "babylonjs/Cameras/XR/webXRSessionManager" {
  43083. import { Observable } from "babylonjs/Misc/observable";
  43084. import { Nullable } from "babylonjs/types";
  43085. import { IDisposable, Scene } from "babylonjs/scene";
  43086. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  43087. import { WebXRRenderTarget, WebXRState } from "babylonjs/Cameras/XR/webXRTypes";
  43088. /**
  43089. * Manages an XRSession to work with Babylon's engine
  43090. * @see https://doc.babylonjs.com/how_to/webxr
  43091. */
  43092. export class WebXRSessionManager implements IDisposable {
  43093. private scene;
  43094. /**
  43095. * Fires every time a new xrFrame arrives which can be used to update the camera
  43096. */
  43097. onXRFrameObservable: Observable<any>;
  43098. /**
  43099. * Fires when the xr session is ended either by the device or manually done
  43100. */
  43101. onXRSessionEnded: Observable<any>;
  43102. /**
  43103. * Underlying xr session
  43104. */
  43105. session: XRSession;
  43106. /**
  43107. * Type of reference space used when creating the session
  43108. */
  43109. referenceSpace: XRReferenceSpace;
  43110. /**
  43111. * Current XR frame
  43112. */
  43113. currentFrame: Nullable<XRFrame>;
  43114. private _xrNavigator;
  43115. private baseLayer;
  43116. private _rttProvider;
  43117. private _sessionEnded;
  43118. /**
  43119. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  43120. * @param scene The scene which the session should be created for
  43121. */
  43122. constructor(scene: Scene);
  43123. /**
  43124. * Initializes the manager
  43125. * After initialization enterXR can be called to start an XR session
  43126. * @returns Promise which resolves after it is initialized
  43127. */
  43128. initializeAsync(): Promise<void>;
  43129. /**
  43130. * Initializes an xr session
  43131. * @param xrSessionMode mode to initialize
  43132. * @returns a promise which will resolve once the session has been initialized
  43133. */
  43134. initializeSessionAsync(xrSessionMode: XRSessionMode): any;
  43135. /**
  43136. * Sets the reference space on the xr session
  43137. * @param referenceSpace space to set
  43138. * @returns a promise that will resolve once the reference space has been set
  43139. */
  43140. setReferenceSpaceAsync(referenceSpace: XRReferenceSpaceType): Promise<void>;
  43141. /**
  43142. * Updates the render state of the session
  43143. * @param state state to set
  43144. * @returns a promise that resolves once the render state has been updated
  43145. */
  43146. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  43147. /**
  43148. * Starts rendering to the xr layer
  43149. * @returns a promise that will resolve once rendering has started
  43150. */
  43151. startRenderingToXRAsync(): Promise<void>;
  43152. /**
  43153. * Gets the correct render target texture to be rendered this frame for this eye
  43154. * @param eye the eye for which to get the render target
  43155. * @returns the render target for the specified eye
  43156. */
  43157. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  43158. /**
  43159. * Stops the xrSession and restores the renderloop
  43160. * @returns Promise which resolves after it exits XR
  43161. */
  43162. exitXRAsync(): Promise<void>;
  43163. /**
  43164. * Checks if a session would be supported for the creation options specified
  43165. * @param sessionMode session mode to check if supported eg. immersive-vr
  43166. * @returns true if supported
  43167. */
  43168. supportsSessionAsync(sessionMode: XRSessionMode): any;
  43169. /**
  43170. * Creates a WebXRRenderTarget object for the XR session
  43171. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  43172. * @returns a WebXR render target to which the session can render
  43173. */
  43174. getWebXRRenderTarget(onStateChangedObservable?: Observable<WebXRState>): WebXRRenderTarget;
  43175. /**
  43176. * @hidden
  43177. * Converts the render layer of xrSession to a render target
  43178. * @param session session to create render target for
  43179. * @param scene scene the new render target should be created for
  43180. */
  43181. static _CreateRenderTargetTextureFromSession(session: XRSession, scene: Scene, baseLayer: XRWebGLLayer): RenderTargetTexture;
  43182. /**
  43183. * Disposes of the session manager
  43184. */
  43185. dispose(): void;
  43186. }
  43187. }
  43188. declare module "babylonjs/Cameras/XR/webXRCamera" {
  43189. import { Scene } from "babylonjs/scene";
  43190. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  43191. import { WebXRSessionManager } from "babylonjs/Cameras/XR/webXRSessionManager";
  43192. /**
  43193. * WebXR Camera which holds the views for the xrSession
  43194. * @see https://doc.babylonjs.com/how_to/webxr
  43195. */
  43196. export class WebXRCamera extends FreeCamera {
  43197. private static _TmpMatrix;
  43198. /**
  43199. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  43200. * @param name the name of the camera
  43201. * @param scene the scene to add the camera to
  43202. */
  43203. constructor(name: string, scene: Scene);
  43204. private _updateNumberOfRigCameras;
  43205. /** @hidden */
  43206. _updateForDualEyeDebugging(): void;
  43207. /**
  43208. * Updates the cameras position from the current pose information of the XR session
  43209. * @param xrSessionManager the session containing pose information
  43210. * @returns true if the camera has been updated, false if the session did not contain pose or frame data
  43211. */
  43212. updateFromXRSessionManager(xrSessionManager: WebXRSessionManager): boolean;
  43213. }
  43214. }
  43215. declare module "babylonjs/Cameras/XR/webXRExperienceHelper" {
  43216. import { Observable } from "babylonjs/Misc/observable";
  43217. import { IDisposable, Scene } from "babylonjs/scene";
  43218. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  43219. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43220. import { WebXRSessionManager } from "babylonjs/Cameras/XR/webXRSessionManager";
  43221. import { WebXRCamera } from "babylonjs/Cameras/XR/webXRCamera";
  43222. import { WebXRState, WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43223. /**
  43224. * Base set of functionality needed to create an XR experince (WebXRSessionManager, Camera, StateManagement, etc.)
  43225. * @see https://doc.babylonjs.com/how_to/webxr
  43226. */
  43227. export class WebXRExperienceHelper implements IDisposable {
  43228. private scene;
  43229. /**
  43230. * Container which stores the xr camera and controllers as children. This can be used to move the camera/user as the camera's position is updated by the xr device
  43231. */
  43232. container: AbstractMesh;
  43233. /**
  43234. * Camera used to render xr content
  43235. */
  43236. camera: WebXRCamera;
  43237. /**
  43238. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  43239. */
  43240. state: WebXRState;
  43241. private _setState;
  43242. private static _TmpVector;
  43243. /**
  43244. * Fires when the state of the experience helper has changed
  43245. */
  43246. onStateChangedObservable: Observable<WebXRState>;
  43247. /** Session manager used to keep track of xr session */
  43248. sessionManager: WebXRSessionManager;
  43249. private _nonVRCamera;
  43250. private _originalSceneAutoClear;
  43251. private _supported;
  43252. /**
  43253. * Creates the experience helper
  43254. * @param scene the scene to attach the experience helper to
  43255. * @returns a promise for the experience helper
  43256. */
  43257. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  43258. /**
  43259. * Creates a WebXRExperienceHelper
  43260. * @param scene The scene the helper should be created in
  43261. */
  43262. private constructor();
  43263. /**
  43264. * Exits XR mode and returns the scene to its original state
  43265. * @returns promise that resolves after xr mode has exited
  43266. */
  43267. exitXRAsync(): Promise<void>;
  43268. /**
  43269. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  43270. * @param sessionCreationOptions options for the XR session
  43271. * @param referenceSpaceType frame of reference of the XR session
  43272. * @param renderTarget the output canvas that will be used to enter XR mode
  43273. * @returns promise that resolves after xr mode has entered
  43274. */
  43275. enterXRAsync(sessionCreationOptions: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget: WebXRRenderTarget): any;
  43276. /**
  43277. * Updates the global position of the camera by moving the camera's container
  43278. * This should be used instead of modifying the camera's position as it will be overwritten by an xrSessions's update frame
  43279. * @param position The desired global position of the camera
  43280. */
  43281. setPositionOfCameraUsingContainer(position: Vector3): void;
  43282. /**
  43283. * Rotates the xr camera by rotating the camera's container around the camera's position
  43284. * This should be used instead of modifying the camera's rotation as it will be overwritten by an xrSessions's update frame
  43285. * @param rotation the desired quaternion rotation to apply to the camera
  43286. */
  43287. rotateCameraByQuaternionUsingContainer(rotation: Quaternion): void;
  43288. /**
  43289. * Disposes of the experience helper
  43290. */
  43291. dispose(): void;
  43292. }
  43293. }
  43294. declare module "babylonjs/Cameras/XR/webXREnterExitUI" {
  43295. import { Nullable } from "babylonjs/types";
  43296. import { Observable } from "babylonjs/Misc/observable";
  43297. import { IDisposable, Scene } from "babylonjs/scene";
  43298. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  43299. import { WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43300. /**
  43301. * Button which can be used to enter a different mode of XR
  43302. */
  43303. export class WebXREnterExitUIButton {
  43304. /** button element */
  43305. element: HTMLElement;
  43306. /** XR initialization options for the button */
  43307. sessionMode: XRSessionMode;
  43308. /** Reference space type */
  43309. referenceSpaceType: XRReferenceSpaceType;
  43310. /**
  43311. * Creates a WebXREnterExitUIButton
  43312. * @param element button element
  43313. * @param sessionMode XR initialization session mode
  43314. * @param referenceSpaceType the type of reference space to be used
  43315. */
  43316. constructor(
  43317. /** button element */
  43318. element: HTMLElement,
  43319. /** XR initialization options for the button */
  43320. sessionMode: XRSessionMode,
  43321. /** Reference space type */
  43322. referenceSpaceType: XRReferenceSpaceType);
  43323. /**
  43324. * Overwritable function which can be used to update the button's visuals when the state changes
  43325. * @param activeButton the current active button in the UI
  43326. */
  43327. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  43328. }
  43329. /**
  43330. * Options to create the webXR UI
  43331. */
  43332. export class WebXREnterExitUIOptions {
  43333. /**
  43334. * Context to enter xr with
  43335. */
  43336. renderTarget?: Nullable<WebXRRenderTarget>;
  43337. /**
  43338. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  43339. */
  43340. customButtons?: Array<WebXREnterExitUIButton>;
  43341. }
  43342. /**
  43343. * UI to allow the user to enter/exit XR mode
  43344. */
  43345. export class WebXREnterExitUI implements IDisposable {
  43346. private scene;
  43347. private _overlay;
  43348. private _buttons;
  43349. private _activeButton;
  43350. /**
  43351. * Fired every time the active button is changed.
  43352. *
  43353. * When xr is entered via a button that launches xr that button will be the callback parameter
  43354. *
  43355. * When exiting xr the callback parameter will be null)
  43356. */
  43357. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  43358. /**
  43359. * Creates UI to allow the user to enter/exit XR mode
  43360. * @param scene the scene to add the ui to
  43361. * @param helper the xr experience helper to enter/exit xr with
  43362. * @param options options to configure the UI
  43363. * @returns the created ui
  43364. */
  43365. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  43366. private constructor();
  43367. private _updateButtons;
  43368. /**
  43369. * Disposes of the object
  43370. */
  43371. dispose(): void;
  43372. }
  43373. }
  43374. declare module "babylonjs/Cameras/XR/webXRController" {
  43375. import { Nullable } from "babylonjs/types";
  43376. import { Observable } from "babylonjs/Misc/observable";
  43377. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43378. import { Ray } from "babylonjs/Culling/ray";
  43379. import { Scene } from "babylonjs/scene";
  43380. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43381. /**
  43382. * Represents an XR input
  43383. */
  43384. export class WebXRController {
  43385. private scene;
  43386. /** The underlying input source for the controller */
  43387. inputSource: XRInputSource;
  43388. private parentContainer;
  43389. /**
  43390. * 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
  43391. */
  43392. grip?: AbstractMesh;
  43393. /**
  43394. * Pointer which can be used to select objects or attach a visible laser to
  43395. */
  43396. pointer: AbstractMesh;
  43397. private _gamepadMode;
  43398. /**
  43399. * If available, this is the gamepad object related to this controller.
  43400. * Using this object it is possible to get click events and trackpad changes of the
  43401. * webxr controller that is currently being used.
  43402. */
  43403. gamepadController?: WebVRController;
  43404. /**
  43405. * Event that fires when the controller is removed/disposed
  43406. */
  43407. onDisposeObservable: Observable<{}>;
  43408. private _tmpMatrix;
  43409. private _tmpQuaternion;
  43410. private _tmpVector;
  43411. /**
  43412. * Creates the controller
  43413. * @see https://doc.babylonjs.com/how_to/webxr
  43414. * @param scene the scene which the controller should be associated to
  43415. * @param inputSource the underlying input source for the controller
  43416. * @param parentContainer parent that the controller meshes should be children of
  43417. */
  43418. constructor(scene: Scene,
  43419. /** The underlying input source for the controller */
  43420. inputSource: XRInputSource, parentContainer?: Nullable<AbstractMesh>);
  43421. /**
  43422. * Updates the controller pose based on the given XRFrame
  43423. * @param xrFrame xr frame to update the pose with
  43424. * @param referenceSpace reference space to use
  43425. */
  43426. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  43427. /**
  43428. * Gets a world space ray coming from the controller
  43429. * @param result the resulting ray
  43430. */
  43431. getWorldPointerRayToRef(result: Ray): void;
  43432. /**
  43433. * Get the scene associated with this controller
  43434. * @returns the scene object
  43435. */
  43436. getScene(): Scene;
  43437. /**
  43438. * Disposes of the object
  43439. */
  43440. dispose(): void;
  43441. }
  43442. }
  43443. declare module "babylonjs/Cameras/XR/webXRInput" {
  43444. import { Observable } from "babylonjs/Misc/observable";
  43445. import { IDisposable } from "babylonjs/scene";
  43446. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  43447. import { WebXRController } from "babylonjs/Cameras/XR/webXRController";
  43448. /**
  43449. * XR input used to track XR inputs such as controllers/rays
  43450. */
  43451. export class WebXRInput implements IDisposable {
  43452. /**
  43453. * Base experience the input listens to
  43454. */
  43455. baseExperience: WebXRExperienceHelper;
  43456. /**
  43457. * XR controllers being tracked
  43458. */
  43459. controllers: Array<WebXRController>;
  43460. private _frameObserver;
  43461. private _stateObserver;
  43462. /**
  43463. * Event when a controller has been connected/added
  43464. */
  43465. onControllerAddedObservable: Observable<WebXRController>;
  43466. /**
  43467. * Event when a controller has been removed/disconnected
  43468. */
  43469. onControllerRemovedObservable: Observable<WebXRController>;
  43470. /**
  43471. * Initializes the WebXRInput
  43472. * @param baseExperience experience helper which the input should be created for
  43473. */
  43474. constructor(
  43475. /**
  43476. * Base experience the input listens to
  43477. */
  43478. baseExperience: WebXRExperienceHelper);
  43479. private _onInputSourcesChange;
  43480. private _addAndRemoveControllers;
  43481. /**
  43482. * Disposes of the object
  43483. */
  43484. dispose(): void;
  43485. }
  43486. }
  43487. declare module "babylonjs/Cameras/XR/webXRControllerTeleportation" {
  43488. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43489. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  43490. /**
  43491. * Enables teleportation
  43492. */
  43493. export class WebXRControllerTeleportation {
  43494. private _teleportationFillColor;
  43495. private _teleportationBorderColor;
  43496. private _tmpRay;
  43497. private _tmpVector;
  43498. /**
  43499. * Creates a WebXRControllerTeleportation
  43500. * @param input input manager to add teleportation to
  43501. * @param floorMeshes floormeshes which can be teleported to
  43502. */
  43503. constructor(input: WebXRInput, floorMeshes?: Array<AbstractMesh>);
  43504. }
  43505. }
  43506. declare module "babylonjs/Cameras/XR/webXRControllerPointerSelection" {
  43507. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  43508. /**
  43509. * Handles pointer input automatically for the pointer of XR controllers
  43510. */
  43511. export class WebXRControllerPointerSelection {
  43512. private static _idCounter;
  43513. private _tmpRay;
  43514. /**
  43515. * Creates a WebXRControllerPointerSelection
  43516. * @param input input manager to setup pointer selection
  43517. */
  43518. constructor(input: WebXRInput);
  43519. private _convertNormalToDirectionOfRay;
  43520. private _updatePointerDistance;
  43521. }
  43522. }
  43523. declare module "babylonjs/Loading/sceneLoader" {
  43524. import { Observable } from "babylonjs/Misc/observable";
  43525. import { Nullable } from "babylonjs/types";
  43526. import { Scene } from "babylonjs/scene";
  43527. import { Engine } from "babylonjs/Engines/engine";
  43528. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43529. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  43530. import { AssetContainer } from "babylonjs/assetContainer";
  43531. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  43532. import { Skeleton } from "babylonjs/Bones/skeleton";
  43533. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  43534. import { WebRequest } from "babylonjs/Misc/webRequest";
  43535. /**
  43536. * Class used to represent data loading progression
  43537. */
  43538. export class SceneLoaderProgressEvent {
  43539. /** defines if data length to load can be evaluated */
  43540. readonly lengthComputable: boolean;
  43541. /** defines the loaded data length */
  43542. readonly loaded: number;
  43543. /** defines the data length to load */
  43544. readonly total: number;
  43545. /**
  43546. * Create a new progress event
  43547. * @param lengthComputable defines if data length to load can be evaluated
  43548. * @param loaded defines the loaded data length
  43549. * @param total defines the data length to load
  43550. */
  43551. constructor(
  43552. /** defines if data length to load can be evaluated */
  43553. lengthComputable: boolean,
  43554. /** defines the loaded data length */
  43555. loaded: number,
  43556. /** defines the data length to load */
  43557. total: number);
  43558. /**
  43559. * Creates a new SceneLoaderProgressEvent from a ProgressEvent
  43560. * @param event defines the source event
  43561. * @returns a new SceneLoaderProgressEvent
  43562. */
  43563. static FromProgressEvent(event: ProgressEvent): SceneLoaderProgressEvent;
  43564. }
  43565. /**
  43566. * Interface used by SceneLoader plugins to define supported file extensions
  43567. */
  43568. export interface ISceneLoaderPluginExtensions {
  43569. /**
  43570. * Defines the list of supported extensions
  43571. */
  43572. [extension: string]: {
  43573. isBinary: boolean;
  43574. };
  43575. }
  43576. /**
  43577. * Interface used by SceneLoader plugin factory
  43578. */
  43579. export interface ISceneLoaderPluginFactory {
  43580. /**
  43581. * Defines the name of the factory
  43582. */
  43583. name: string;
  43584. /**
  43585. * Function called to create a new plugin
  43586. * @return the new plugin
  43587. */
  43588. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  43589. /**
  43590. * The callback that returns true if the data can be directly loaded.
  43591. * @param data string containing the file data
  43592. * @returns if the data can be loaded directly
  43593. */
  43594. canDirectLoad?(data: string): boolean;
  43595. }
  43596. /**
  43597. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  43598. */
  43599. export interface ISceneLoaderPluginBase {
  43600. /**
  43601. * The friendly name of this plugin.
  43602. */
  43603. name: string;
  43604. /**
  43605. * The file extensions supported by this plugin.
  43606. */
  43607. extensions: string | ISceneLoaderPluginExtensions;
  43608. /**
  43609. * The callback called when loading from a url.
  43610. * @param scene scene loading this url
  43611. * @param url url to load
  43612. * @param onSuccess callback called when the file successfully loads
  43613. * @param onProgress callback called while file is loading (if the server supports this mode)
  43614. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  43615. * @param onError callback called when the file fails to load
  43616. * @returns a file request object
  43617. */
  43618. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  43619. /**
  43620. * The callback called when loading from a file object.
  43621. * @param scene scene loading this file
  43622. * @param file defines the file to load
  43623. * @param onSuccess defines the callback to call when data is loaded
  43624. * @param onProgress defines the callback to call during loading process
  43625. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  43626. * @param onError defines the callback to call when an error occurs
  43627. * @returns a file request object
  43628. */
  43629. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  43630. /**
  43631. * The callback that returns true if the data can be directly loaded.
  43632. * @param data string containing the file data
  43633. * @returns if the data can be loaded directly
  43634. */
  43635. canDirectLoad?(data: string): boolean;
  43636. /**
  43637. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  43638. * @param scene scene loading this data
  43639. * @param data string containing the data
  43640. * @returns data to pass to the plugin
  43641. */
  43642. directLoad?(scene: Scene, data: string): any;
  43643. /**
  43644. * The callback that allows custom handling of the root url based on the response url.
  43645. * @param rootUrl the original root url
  43646. * @param responseURL the response url if available
  43647. * @returns the new root url
  43648. */
  43649. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  43650. }
  43651. /**
  43652. * Interface used to define a SceneLoader plugin
  43653. */
  43654. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  43655. /**
  43656. * Import meshes into a scene.
  43657. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43658. * @param scene The scene to import into
  43659. * @param data The data to import
  43660. * @param rootUrl The root url for scene and resources
  43661. * @param meshes The meshes array to import into
  43662. * @param particleSystems The particle systems array to import into
  43663. * @param skeletons The skeletons array to import into
  43664. * @param onError The callback when import fails
  43665. * @returns True if successful or false otherwise
  43666. */
  43667. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  43668. /**
  43669. * Load into a scene.
  43670. * @param scene The scene to load into
  43671. * @param data The data to import
  43672. * @param rootUrl The root url for scene and resources
  43673. * @param onError The callback when import fails
  43674. * @returns True if successful or false otherwise
  43675. */
  43676. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  43677. /**
  43678. * Load into an asset container.
  43679. * @param scene The scene to load into
  43680. * @param data The data to import
  43681. * @param rootUrl The root url for scene and resources
  43682. * @param onError The callback when import fails
  43683. * @returns The loaded asset container
  43684. */
  43685. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  43686. }
  43687. /**
  43688. * Interface used to define an async SceneLoader plugin
  43689. */
  43690. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  43691. /**
  43692. * Import meshes into a scene.
  43693. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43694. * @param scene The scene to import into
  43695. * @param data The data to import
  43696. * @param rootUrl The root url for scene and resources
  43697. * @param onProgress The callback when the load progresses
  43698. * @param fileName Defines the name of the file to load
  43699. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  43700. */
  43701. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  43702. meshes: AbstractMesh[];
  43703. particleSystems: IParticleSystem[];
  43704. skeletons: Skeleton[];
  43705. animationGroups: AnimationGroup[];
  43706. }>;
  43707. /**
  43708. * Load into a scene.
  43709. * @param scene The scene to load into
  43710. * @param data The data to import
  43711. * @param rootUrl The root url for scene and resources
  43712. * @param onProgress The callback when the load progresses
  43713. * @param fileName Defines the name of the file to load
  43714. * @returns Nothing
  43715. */
  43716. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  43717. /**
  43718. * Load into an asset container.
  43719. * @param scene The scene to load into
  43720. * @param data The data to import
  43721. * @param rootUrl The root url for scene and resources
  43722. * @param onProgress The callback when the load progresses
  43723. * @param fileName Defines the name of the file to load
  43724. * @returns The loaded asset container
  43725. */
  43726. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  43727. }
  43728. /**
  43729. * Class used to load scene from various file formats using registered plugins
  43730. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  43731. */
  43732. export class SceneLoader {
  43733. /**
  43734. * No logging while loading
  43735. */
  43736. static readonly NO_LOGGING: number;
  43737. /**
  43738. * Minimal logging while loading
  43739. */
  43740. static readonly MINIMAL_LOGGING: number;
  43741. /**
  43742. * Summary logging while loading
  43743. */
  43744. static readonly SUMMARY_LOGGING: number;
  43745. /**
  43746. * Detailled logging while loading
  43747. */
  43748. static readonly DETAILED_LOGGING: number;
  43749. /**
  43750. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  43751. */
  43752. static ForceFullSceneLoadingForIncremental: boolean;
  43753. /**
  43754. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  43755. */
  43756. static ShowLoadingScreen: boolean;
  43757. /**
  43758. * Defines the current logging level (while loading the scene)
  43759. * @ignorenaming
  43760. */
  43761. static loggingLevel: number;
  43762. /**
  43763. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  43764. */
  43765. static CleanBoneMatrixWeights: boolean;
  43766. /**
  43767. * Event raised when a plugin is used to load a scene
  43768. */
  43769. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  43770. private static _registeredPlugins;
  43771. private static _getDefaultPlugin;
  43772. private static _getPluginForExtension;
  43773. private static _getPluginForDirectLoad;
  43774. private static _getPluginForFilename;
  43775. private static _getDirectLoad;
  43776. private static _loadData;
  43777. private static _getFileInfo;
  43778. /**
  43779. * Gets a plugin that can load the given extension
  43780. * @param extension defines the extension to load
  43781. * @returns a plugin or null if none works
  43782. */
  43783. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  43784. /**
  43785. * Gets a boolean indicating that the given extension can be loaded
  43786. * @param extension defines the extension to load
  43787. * @returns true if the extension is supported
  43788. */
  43789. static IsPluginForExtensionAvailable(extension: string): boolean;
  43790. /**
  43791. * Adds a new plugin to the list of registered plugins
  43792. * @param plugin defines the plugin to add
  43793. */
  43794. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  43795. /**
  43796. * Import meshes into a scene
  43797. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43798. * @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)
  43799. * @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)
  43800. * @param scene the instance of BABYLON.Scene to append to
  43801. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  43802. * @param onProgress a callback with a progress event for each file being loaded
  43803. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43804. * @param pluginExtension the extension used to determine the plugin
  43805. * @returns The loaded plugin
  43806. */
  43807. static ImportMesh(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], animationGroups: AnimationGroup[]) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  43808. /**
  43809. * Import meshes into a scene
  43810. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43811. * @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)
  43812. * @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)
  43813. * @param scene the instance of BABYLON.Scene to append to
  43814. * @param onProgress a callback with a progress event for each file being loaded
  43815. * @param pluginExtension the extension used to determine the plugin
  43816. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  43817. */
  43818. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  43819. meshes: AbstractMesh[];
  43820. particleSystems: IParticleSystem[];
  43821. skeletons: Skeleton[];
  43822. animationGroups: AnimationGroup[];
  43823. }>;
  43824. /**
  43825. * Load a scene
  43826. * @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)
  43827. * @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)
  43828. * @param engine is the instance of BABYLON.Engine to use to create the scene
  43829. * @param onSuccess a callback with the scene when import succeeds
  43830. * @param onProgress a callback with a progress event for each file being loaded
  43831. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43832. * @param pluginExtension the extension used to determine the plugin
  43833. * @returns The loaded plugin
  43834. */
  43835. static Load(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  43836. /**
  43837. * Load a scene
  43838. * @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)
  43839. * @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)
  43840. * @param engine is the instance of BABYLON.Engine to use to create the scene
  43841. * @param onProgress a callback with a progress event for each file being loaded
  43842. * @param pluginExtension the extension used to determine the plugin
  43843. * @returns The loaded scene
  43844. */
  43845. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  43846. /**
  43847. * Append a scene
  43848. * @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)
  43849. * @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)
  43850. * @param scene is the instance of BABYLON.Scene to append to
  43851. * @param onSuccess a callback with the scene when import succeeds
  43852. * @param onProgress a callback with a progress event for each file being loaded
  43853. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43854. * @param pluginExtension the extension used to determine the plugin
  43855. * @returns The loaded plugin
  43856. */
  43857. static Append(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  43858. /**
  43859. * Append a scene
  43860. * @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)
  43861. * @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)
  43862. * @param scene is the instance of BABYLON.Scene to append to
  43863. * @param onProgress a callback with a progress event for each file being loaded
  43864. * @param pluginExtension the extension used to determine the plugin
  43865. * @returns The given scene
  43866. */
  43867. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  43868. /**
  43869. * Load a scene into an asset container
  43870. * @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)
  43871. * @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)
  43872. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  43873. * @param onSuccess a callback with the scene when import succeeds
  43874. * @param onProgress a callback with a progress event for each file being loaded
  43875. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  43876. * @param pluginExtension the extension used to determine the plugin
  43877. * @returns The loaded plugin
  43878. */
  43879. static LoadAssetContainer(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(assets: AssetContainer) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  43880. /**
  43881. * Load a scene into an asset container
  43882. * @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)
  43883. * @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)
  43884. * @param scene is the instance of Scene to append to
  43885. * @param onProgress a callback with a progress event for each file being loaded
  43886. * @param pluginExtension the extension used to determine the plugin
  43887. * @returns The loaded asset container
  43888. */
  43889. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  43890. }
  43891. }
  43892. declare module "babylonjs/Gamepads/Controllers/genericController" {
  43893. import { Scene } from "babylonjs/scene";
  43894. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43895. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43896. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  43897. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  43898. /**
  43899. * Generic Controller
  43900. */
  43901. export class GenericController extends WebVRController {
  43902. /**
  43903. * Base Url for the controller model.
  43904. */
  43905. static readonly MODEL_BASE_URL: string;
  43906. /**
  43907. * File name for the controller model.
  43908. */
  43909. static readonly MODEL_FILENAME: string;
  43910. /**
  43911. * Creates a new GenericController from a gamepad
  43912. * @param vrGamepad the gamepad that the controller should be created from
  43913. */
  43914. constructor(vrGamepad: any);
  43915. /**
  43916. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  43917. * @param scene scene in which to add meshes
  43918. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  43919. */
  43920. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  43921. /**
  43922. * Called once for each button that changed state since the last frame
  43923. * @param buttonIdx Which button index changed
  43924. * @param state New state of the button
  43925. * @param changes Which properties on the state changed since last frame
  43926. */
  43927. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  43928. }
  43929. }
  43930. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  43931. import { Observable } from "babylonjs/Misc/observable";
  43932. import { Scene } from "babylonjs/scene";
  43933. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43934. import { Ray } from "babylonjs/Culling/ray";
  43935. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43936. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  43937. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  43938. /**
  43939. * Defines the WindowsMotionController object that the state of the windows motion controller
  43940. */
  43941. export class WindowsMotionController extends WebVRController {
  43942. /**
  43943. * The base url used to load the left and right controller models
  43944. */
  43945. static MODEL_BASE_URL: string;
  43946. /**
  43947. * The name of the left controller model file
  43948. */
  43949. static MODEL_LEFT_FILENAME: string;
  43950. /**
  43951. * The name of the right controller model file
  43952. */
  43953. static MODEL_RIGHT_FILENAME: string;
  43954. /**
  43955. * The controller name prefix for this controller type
  43956. */
  43957. static readonly GAMEPAD_ID_PREFIX: string;
  43958. /**
  43959. * The controller id pattern for this controller type
  43960. */
  43961. private static readonly GAMEPAD_ID_PATTERN;
  43962. private _loadedMeshInfo;
  43963. private readonly _mapping;
  43964. /**
  43965. * Fired when the trackpad on this controller is clicked
  43966. */
  43967. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  43968. /**
  43969. * Fired when the trackpad on this controller is modified
  43970. */
  43971. onTrackpadValuesChangedObservable: Observable<StickValues>;
  43972. /**
  43973. * The current x and y values of this controller's trackpad
  43974. */
  43975. trackpad: StickValues;
  43976. /**
  43977. * Creates a new WindowsMotionController from a gamepad
  43978. * @param vrGamepad the gamepad that the controller should be created from
  43979. */
  43980. constructor(vrGamepad: any);
  43981. /**
  43982. * Fired when the trigger on this controller is modified
  43983. */
  43984. readonly onTriggerButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43985. /**
  43986. * Fired when the menu button on this controller is modified
  43987. */
  43988. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43989. /**
  43990. * Fired when the grip button on this controller is modified
  43991. */
  43992. readonly onGripButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43993. /**
  43994. * Fired when the thumbstick button on this controller is modified
  43995. */
  43996. readonly onThumbstickButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  43997. /**
  43998. * Fired when the touchpad button on this controller is modified
  43999. */
  44000. readonly onTouchpadButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44001. /**
  44002. * Fired when the touchpad values on this controller are modified
  44003. */
  44004. readonly onTouchpadValuesChangedObservable: Observable<StickValues>;
  44005. private _updateTrackpad;
  44006. /**
  44007. * Called once per frame by the engine.
  44008. */
  44009. update(): void;
  44010. /**
  44011. * Called once for each button that changed state since the last frame
  44012. * @param buttonIdx Which button index changed
  44013. * @param state New state of the button
  44014. * @param changes Which properties on the state changed since last frame
  44015. */
  44016. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44017. /**
  44018. * Moves the buttons on the controller mesh based on their current state
  44019. * @param buttonName the name of the button to move
  44020. * @param buttonValue the value of the button which determines the buttons new position
  44021. */
  44022. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  44023. /**
  44024. * Moves the axis on the controller mesh based on its current state
  44025. * @param axis the index of the axis
  44026. * @param axisValue the value of the axis which determines the meshes new position
  44027. * @hidden
  44028. */
  44029. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  44030. /**
  44031. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44032. * @param scene scene in which to add meshes
  44033. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44034. */
  44035. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  44036. /**
  44037. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  44038. * can be transformed by button presses and axes values, based on this._mapping.
  44039. *
  44040. * @param scene scene in which the meshes exist
  44041. * @param meshes list of meshes that make up the controller model to process
  44042. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  44043. */
  44044. private processModel;
  44045. private createMeshInfo;
  44046. /**
  44047. * Gets the ray of the controller in the direction the controller is pointing
  44048. * @param length the length the resulting ray should be
  44049. * @returns a ray in the direction the controller is pointing
  44050. */
  44051. getForwardRay(length?: number): Ray;
  44052. /**
  44053. * Disposes of the controller
  44054. */
  44055. dispose(): void;
  44056. }
  44057. }
  44058. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  44059. import { Observable } from "babylonjs/Misc/observable";
  44060. import { Scene } from "babylonjs/scene";
  44061. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44062. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44063. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44064. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44065. /**
  44066. * Oculus Touch Controller
  44067. */
  44068. export class OculusTouchController extends WebVRController {
  44069. /**
  44070. * Base Url for the controller model.
  44071. */
  44072. static MODEL_BASE_URL: string;
  44073. /**
  44074. * File name for the left controller model.
  44075. */
  44076. static MODEL_LEFT_FILENAME: string;
  44077. /**
  44078. * File name for the right controller model.
  44079. */
  44080. static MODEL_RIGHT_FILENAME: string;
  44081. /**
  44082. * Base Url for the Quest controller model.
  44083. */
  44084. static QUEST_MODEL_BASE_URL: string;
  44085. /**
  44086. * @hidden
  44087. * If the controllers are running on a device that needs the updated Quest controller models
  44088. */
  44089. static _IsQuest: boolean;
  44090. /**
  44091. * Fired when the secondary trigger on this controller is modified
  44092. */
  44093. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  44094. /**
  44095. * Fired when the thumb rest on this controller is modified
  44096. */
  44097. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  44098. /**
  44099. * Creates a new OculusTouchController from a gamepad
  44100. * @param vrGamepad the gamepad that the controller should be created from
  44101. */
  44102. constructor(vrGamepad: any);
  44103. /**
  44104. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44105. * @param scene scene in which to add meshes
  44106. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44107. */
  44108. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  44109. /**
  44110. * Fired when the A button on this controller is modified
  44111. */
  44112. readonly onAButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44113. /**
  44114. * Fired when the B button on this controller is modified
  44115. */
  44116. readonly onBButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44117. /**
  44118. * Fired when the X button on this controller is modified
  44119. */
  44120. readonly onXButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44121. /**
  44122. * Fired when the Y button on this controller is modified
  44123. */
  44124. readonly onYButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44125. /**
  44126. * Called once for each button that changed state since the last frame
  44127. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  44128. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  44129. * 2) secondary trigger (same)
  44130. * 3) A (right) X (left), touch, pressed = value
  44131. * 4) B / Y
  44132. * 5) thumb rest
  44133. * @param buttonIdx Which button index changed
  44134. * @param state New state of the button
  44135. * @param changes Which properties on the state changed since last frame
  44136. */
  44137. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44138. }
  44139. }
  44140. declare module "babylonjs/Gamepads/Controllers/viveController" {
  44141. import { Scene } from "babylonjs/scene";
  44142. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44143. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44144. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44145. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44146. import { Observable } from "babylonjs/Misc/observable";
  44147. /**
  44148. * Vive Controller
  44149. */
  44150. export class ViveController extends WebVRController {
  44151. /**
  44152. * Base Url for the controller model.
  44153. */
  44154. static MODEL_BASE_URL: string;
  44155. /**
  44156. * File name for the controller model.
  44157. */
  44158. static MODEL_FILENAME: string;
  44159. /**
  44160. * Creates a new ViveController from a gamepad
  44161. * @param vrGamepad the gamepad that the controller should be created from
  44162. */
  44163. constructor(vrGamepad: any);
  44164. /**
  44165. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44166. * @param scene scene in which to add meshes
  44167. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44168. */
  44169. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  44170. /**
  44171. * Fired when the left button on this controller is modified
  44172. */
  44173. readonly onLeftButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44174. /**
  44175. * Fired when the right button on this controller is modified
  44176. */
  44177. readonly onRightButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44178. /**
  44179. * Fired when the menu button on this controller is modified
  44180. */
  44181. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44182. /**
  44183. * Called once for each button that changed state since the last frame
  44184. * Vive mapping:
  44185. * 0: touchpad
  44186. * 1: trigger
  44187. * 2: left AND right buttons
  44188. * 3: menu button
  44189. * @param buttonIdx Which button index changed
  44190. * @param state New state of the button
  44191. * @param changes Which properties on the state changed since last frame
  44192. */
  44193. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44194. }
  44195. }
  44196. declare module "babylonjs/Cameras/XR/webXRControllerModelLoader" {
  44197. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  44198. /**
  44199. * Loads a controller model and adds it as a child of the WebXRControllers grip when the controller is created
  44200. */
  44201. export class WebXRControllerModelLoader {
  44202. /**
  44203. * Creates the WebXRControllerModelLoader
  44204. * @param input xr input that creates the controllers
  44205. */
  44206. constructor(input: WebXRInput);
  44207. }
  44208. }
  44209. declare module "babylonjs/Cameras/XR/index" {
  44210. export * from "babylonjs/Cameras/XR/webXRCamera";
  44211. export * from "babylonjs/Cameras/XR/webXREnterExitUI";
  44212. export * from "babylonjs/Cameras/XR/webXRExperienceHelper";
  44213. export * from "babylonjs/Cameras/XR/webXRInput";
  44214. export * from "babylonjs/Cameras/XR/webXRControllerTeleportation";
  44215. export * from "babylonjs/Cameras/XR/webXRControllerPointerSelection";
  44216. export * from "babylonjs/Cameras/XR/webXRControllerModelLoader";
  44217. export * from "babylonjs/Cameras/XR/webXRController";
  44218. export * from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  44219. export * from "babylonjs/Cameras/XR/webXRTypes";
  44220. export * from "babylonjs/Cameras/XR/webXRSessionManager";
  44221. }
  44222. declare module "babylonjs/Cameras/RigModes/index" {
  44223. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  44224. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  44225. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  44226. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  44227. }
  44228. declare module "babylonjs/Cameras/index" {
  44229. export * from "babylonjs/Cameras/Inputs/index";
  44230. export * from "babylonjs/Cameras/cameraInputsManager";
  44231. export * from "babylonjs/Cameras/camera";
  44232. export * from "babylonjs/Cameras/targetCamera";
  44233. export * from "babylonjs/Cameras/freeCamera";
  44234. export * from "babylonjs/Cameras/freeCameraInputsManager";
  44235. export * from "babylonjs/Cameras/touchCamera";
  44236. export * from "babylonjs/Cameras/arcRotateCamera";
  44237. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44238. export * from "babylonjs/Cameras/deviceOrientationCamera";
  44239. export * from "babylonjs/Cameras/flyCamera";
  44240. export * from "babylonjs/Cameras/flyCameraInputsManager";
  44241. export * from "babylonjs/Cameras/followCamera";
  44242. export * from "babylonjs/Cameras/followCameraInputsManager";
  44243. export * from "babylonjs/Cameras/gamepadCamera";
  44244. export * from "babylonjs/Cameras/Stereoscopic/index";
  44245. export * from "babylonjs/Cameras/universalCamera";
  44246. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  44247. export * from "babylonjs/Cameras/VR/index";
  44248. export * from "babylonjs/Cameras/XR/index";
  44249. export * from "babylonjs/Cameras/RigModes/index";
  44250. }
  44251. declare module "babylonjs/Collisions/index" {
  44252. export * from "babylonjs/Collisions/collider";
  44253. export * from "babylonjs/Collisions/collisionCoordinator";
  44254. export * from "babylonjs/Collisions/pickingInfo";
  44255. export * from "babylonjs/Collisions/intersectionInfo";
  44256. export * from "babylonjs/Collisions/meshCollisionData";
  44257. }
  44258. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  44259. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  44260. import { Vector3 } from "babylonjs/Maths/math.vector";
  44261. import { Ray } from "babylonjs/Culling/ray";
  44262. import { Plane } from "babylonjs/Maths/math.plane";
  44263. /**
  44264. * Contains an array of blocks representing the octree
  44265. */
  44266. export interface IOctreeContainer<T> {
  44267. /**
  44268. * Blocks within the octree
  44269. */
  44270. blocks: Array<OctreeBlock<T>>;
  44271. }
  44272. /**
  44273. * Class used to store a cell in an octree
  44274. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44275. */
  44276. export class OctreeBlock<T> {
  44277. /**
  44278. * Gets the content of the current block
  44279. */
  44280. entries: T[];
  44281. /**
  44282. * Gets the list of block children
  44283. */
  44284. blocks: Array<OctreeBlock<T>>;
  44285. private _depth;
  44286. private _maxDepth;
  44287. private _capacity;
  44288. private _minPoint;
  44289. private _maxPoint;
  44290. private _boundingVectors;
  44291. private _creationFunc;
  44292. /**
  44293. * Creates a new block
  44294. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  44295. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  44296. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  44297. * @param depth defines the current depth of this block in the octree
  44298. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  44299. * @param creationFunc defines a callback to call when an element is added to the block
  44300. */
  44301. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  44302. /**
  44303. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  44304. */
  44305. readonly capacity: number;
  44306. /**
  44307. * Gets the minimum vector (in world space) of the block's bounding box
  44308. */
  44309. readonly minPoint: Vector3;
  44310. /**
  44311. * Gets the maximum vector (in world space) of the block's bounding box
  44312. */
  44313. readonly maxPoint: Vector3;
  44314. /**
  44315. * Add a new element to this block
  44316. * @param entry defines the element to add
  44317. */
  44318. addEntry(entry: T): void;
  44319. /**
  44320. * Remove an element from this block
  44321. * @param entry defines the element to remove
  44322. */
  44323. removeEntry(entry: T): void;
  44324. /**
  44325. * Add an array of elements to this block
  44326. * @param entries defines the array of elements to add
  44327. */
  44328. addEntries(entries: T[]): void;
  44329. /**
  44330. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  44331. * @param frustumPlanes defines the frustum planes to test
  44332. * @param selection defines the array to store current content if selection is positive
  44333. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44334. */
  44335. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  44336. /**
  44337. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  44338. * @param sphereCenter defines the bounding sphere center
  44339. * @param sphereRadius defines the bounding sphere radius
  44340. * @param selection defines the array to store current content if selection is positive
  44341. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44342. */
  44343. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  44344. /**
  44345. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  44346. * @param ray defines the ray to test with
  44347. * @param selection defines the array to store current content if selection is positive
  44348. */
  44349. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  44350. /**
  44351. * Subdivide the content into child blocks (this block will then be empty)
  44352. */
  44353. createInnerBlocks(): void;
  44354. /**
  44355. * @hidden
  44356. */
  44357. 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;
  44358. }
  44359. }
  44360. declare module "babylonjs/Culling/Octrees/octree" {
  44361. import { SmartArray } from "babylonjs/Misc/smartArray";
  44362. import { Vector3 } from "babylonjs/Maths/math.vector";
  44363. import { SubMesh } from "babylonjs/Meshes/subMesh";
  44364. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44365. import { Ray } from "babylonjs/Culling/ray";
  44366. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  44367. import { Plane } from "babylonjs/Maths/math.plane";
  44368. /**
  44369. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  44370. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44371. */
  44372. export class Octree<T> {
  44373. /** 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.) */
  44374. maxDepth: number;
  44375. /**
  44376. * Blocks within the octree containing objects
  44377. */
  44378. blocks: Array<OctreeBlock<T>>;
  44379. /**
  44380. * Content stored in the octree
  44381. */
  44382. dynamicContent: T[];
  44383. private _maxBlockCapacity;
  44384. private _selectionContent;
  44385. private _creationFunc;
  44386. /**
  44387. * Creates a octree
  44388. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44389. * @param creationFunc function to be used to instatiate the octree
  44390. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  44391. * @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.)
  44392. */
  44393. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  44394. /** 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.) */
  44395. maxDepth?: number);
  44396. /**
  44397. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  44398. * @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);
  44399. * @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);
  44400. * @param entries meshes to be added to the octree blocks
  44401. */
  44402. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  44403. /**
  44404. * Adds a mesh to the octree
  44405. * @param entry Mesh to add to the octree
  44406. */
  44407. addMesh(entry: T): void;
  44408. /**
  44409. * Remove an element from the octree
  44410. * @param entry defines the element to remove
  44411. */
  44412. removeMesh(entry: T): void;
  44413. /**
  44414. * Selects an array of meshes within the frustum
  44415. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  44416. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  44417. * @returns array of meshes within the frustum
  44418. */
  44419. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  44420. /**
  44421. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  44422. * @param sphereCenter defines the bounding sphere center
  44423. * @param sphereRadius defines the bounding sphere radius
  44424. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44425. * @returns an array of objects that intersect the sphere
  44426. */
  44427. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  44428. /**
  44429. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  44430. * @param ray defines the ray to test with
  44431. * @returns array of intersected objects
  44432. */
  44433. intersectsRay(ray: Ray): SmartArray<T>;
  44434. /**
  44435. * Adds a mesh into the octree block if it intersects the block
  44436. */
  44437. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  44438. /**
  44439. * Adds a submesh into the octree block if it intersects the block
  44440. */
  44441. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  44442. }
  44443. }
  44444. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  44445. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  44446. import { Scene } from "babylonjs/scene";
  44447. import { SubMesh } from "babylonjs/Meshes/subMesh";
  44448. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44449. import { Ray } from "babylonjs/Culling/ray";
  44450. import { Octree } from "babylonjs/Culling/Octrees/octree";
  44451. import { Collider } from "babylonjs/Collisions/collider";
  44452. module "babylonjs/scene" {
  44453. interface Scene {
  44454. /**
  44455. * @hidden
  44456. * Backing Filed
  44457. */
  44458. _selectionOctree: Octree<AbstractMesh>;
  44459. /**
  44460. * Gets the octree used to boost mesh selection (picking)
  44461. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44462. */
  44463. selectionOctree: Octree<AbstractMesh>;
  44464. /**
  44465. * Creates or updates the octree used to boost selection (picking)
  44466. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44467. * @param maxCapacity defines the maximum capacity per leaf
  44468. * @param maxDepth defines the maximum depth of the octree
  44469. * @returns an octree of AbstractMesh
  44470. */
  44471. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  44472. }
  44473. }
  44474. module "babylonjs/Meshes/abstractMesh" {
  44475. interface AbstractMesh {
  44476. /**
  44477. * @hidden
  44478. * Backing Field
  44479. */
  44480. _submeshesOctree: Octree<SubMesh>;
  44481. /**
  44482. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  44483. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  44484. * @param maxCapacity defines the maximum size of each block (64 by default)
  44485. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  44486. * @returns the new octree
  44487. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  44488. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44489. */
  44490. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  44491. }
  44492. }
  44493. /**
  44494. * Defines the octree scene component responsible to manage any octrees
  44495. * in a given scene.
  44496. */
  44497. export class OctreeSceneComponent {
  44498. /**
  44499. * The component name help to identify the component in the list of scene components.
  44500. */
  44501. readonly name: string;
  44502. /**
  44503. * The scene the component belongs to.
  44504. */
  44505. scene: Scene;
  44506. /**
  44507. * Indicates if the meshes have been checked to make sure they are isEnabled()
  44508. */
  44509. readonly checksIsEnabled: boolean;
  44510. /**
  44511. * Creates a new instance of the component for the given scene
  44512. * @param scene Defines the scene to register the component in
  44513. */
  44514. constructor(scene: Scene);
  44515. /**
  44516. * Registers the component in a given scene
  44517. */
  44518. register(): void;
  44519. /**
  44520. * Return the list of active meshes
  44521. * @returns the list of active meshes
  44522. */
  44523. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  44524. /**
  44525. * Return the list of active sub meshes
  44526. * @param mesh The mesh to get the candidates sub meshes from
  44527. * @returns the list of active sub meshes
  44528. */
  44529. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  44530. private _tempRay;
  44531. /**
  44532. * Return the list of sub meshes intersecting with a given local ray
  44533. * @param mesh defines the mesh to find the submesh for
  44534. * @param localRay defines the ray in local space
  44535. * @returns the list of intersecting sub meshes
  44536. */
  44537. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  44538. /**
  44539. * Return the list of sub meshes colliding with a collider
  44540. * @param mesh defines the mesh to find the submesh for
  44541. * @param collider defines the collider to evaluate the collision against
  44542. * @returns the list of colliding sub meshes
  44543. */
  44544. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  44545. /**
  44546. * Rebuilds the elements related to this component in case of
  44547. * context lost for instance.
  44548. */
  44549. rebuild(): void;
  44550. /**
  44551. * Disposes the component and the associated ressources.
  44552. */
  44553. dispose(): void;
  44554. }
  44555. }
  44556. declare module "babylonjs/Culling/Octrees/index" {
  44557. export * from "babylonjs/Culling/Octrees/octree";
  44558. export * from "babylonjs/Culling/Octrees/octreeBlock";
  44559. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  44560. }
  44561. declare module "babylonjs/Culling/index" {
  44562. export * from "babylonjs/Culling/boundingBox";
  44563. export * from "babylonjs/Culling/boundingInfo";
  44564. export * from "babylonjs/Culling/boundingSphere";
  44565. export * from "babylonjs/Culling/Octrees/index";
  44566. export * from "babylonjs/Culling/ray";
  44567. }
  44568. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  44569. import { IDisposable, Scene } from "babylonjs/scene";
  44570. import { Nullable } from "babylonjs/types";
  44571. import { Observable } from "babylonjs/Misc/observable";
  44572. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44573. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  44574. import { Camera } from "babylonjs/Cameras/camera";
  44575. /**
  44576. * Renders a layer on top of an existing scene
  44577. */
  44578. export class UtilityLayerRenderer implements IDisposable {
  44579. /** the original scene that will be rendered on top of */
  44580. originalScene: Scene;
  44581. private _pointerCaptures;
  44582. private _lastPointerEvents;
  44583. private static _DefaultUtilityLayer;
  44584. private static _DefaultKeepDepthUtilityLayer;
  44585. private _sharedGizmoLight;
  44586. private _renderCamera;
  44587. /**
  44588. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  44589. * @returns the camera that is used when rendering the utility layer
  44590. */
  44591. getRenderCamera(): Nullable<Camera>;
  44592. /**
  44593. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  44594. * @param cam the camera that should be used when rendering the utility layer
  44595. */
  44596. setRenderCamera(cam: Nullable<Camera>): void;
  44597. /**
  44598. * @hidden
  44599. * Light which used by gizmos to get light shading
  44600. */
  44601. _getSharedGizmoLight(): HemisphericLight;
  44602. /**
  44603. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  44604. */
  44605. pickUtilitySceneFirst: boolean;
  44606. /**
  44607. * 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)
  44608. */
  44609. static readonly DefaultUtilityLayer: UtilityLayerRenderer;
  44610. /**
  44611. * 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)
  44612. */
  44613. static readonly DefaultKeepDepthUtilityLayer: UtilityLayerRenderer;
  44614. /**
  44615. * The scene that is rendered on top of the original scene
  44616. */
  44617. utilityLayerScene: Scene;
  44618. /**
  44619. * If the utility layer should automatically be rendered on top of existing scene
  44620. */
  44621. shouldRender: boolean;
  44622. /**
  44623. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  44624. */
  44625. onlyCheckPointerDownEvents: boolean;
  44626. /**
  44627. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  44628. */
  44629. processAllEvents: boolean;
  44630. /**
  44631. * Observable raised when the pointer move from the utility layer scene to the main scene
  44632. */
  44633. onPointerOutObservable: Observable<number>;
  44634. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  44635. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  44636. private _afterRenderObserver;
  44637. private _sceneDisposeObserver;
  44638. private _originalPointerObserver;
  44639. /**
  44640. * Instantiates a UtilityLayerRenderer
  44641. * @param originalScene the original scene that will be rendered on top of
  44642. * @param handleEvents boolean indicating if the utility layer should handle events
  44643. */
  44644. constructor(
  44645. /** the original scene that will be rendered on top of */
  44646. originalScene: Scene, handleEvents?: boolean);
  44647. private _notifyObservers;
  44648. /**
  44649. * Renders the utility layers scene on top of the original scene
  44650. */
  44651. render(): void;
  44652. /**
  44653. * Disposes of the renderer
  44654. */
  44655. dispose(): void;
  44656. private _updateCamera;
  44657. }
  44658. }
  44659. declare module "babylonjs/Gizmos/gizmo" {
  44660. import { Nullable } from "babylonjs/types";
  44661. import { IDisposable } from "babylonjs/scene";
  44662. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44663. import { Mesh } from "babylonjs/Meshes/mesh";
  44664. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44665. /**
  44666. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  44667. */
  44668. export class Gizmo implements IDisposable {
  44669. /** The utility layer the gizmo will be added to */
  44670. gizmoLayer: UtilityLayerRenderer;
  44671. /**
  44672. * The root mesh of the gizmo
  44673. */
  44674. _rootMesh: Mesh;
  44675. private _attachedMesh;
  44676. /**
  44677. * Ratio for the scale of the gizmo (Default: 1)
  44678. */
  44679. scaleRatio: number;
  44680. /**
  44681. * If a custom mesh has been set (Default: false)
  44682. */
  44683. protected _customMeshSet: boolean;
  44684. /**
  44685. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  44686. * * When set, interactions will be enabled
  44687. */
  44688. attachedMesh: Nullable<AbstractMesh>;
  44689. /**
  44690. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  44691. * @param mesh The mesh to replace the default mesh of the gizmo
  44692. */
  44693. setCustomMesh(mesh: Mesh): void;
  44694. /**
  44695. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  44696. */
  44697. updateGizmoRotationToMatchAttachedMesh: boolean;
  44698. /**
  44699. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  44700. */
  44701. updateGizmoPositionToMatchAttachedMesh: boolean;
  44702. /**
  44703. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  44704. */
  44705. updateScale: boolean;
  44706. protected _interactionsEnabled: boolean;
  44707. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  44708. private _beforeRenderObserver;
  44709. private _tempVector;
  44710. /**
  44711. * Creates a gizmo
  44712. * @param gizmoLayer The utility layer the gizmo will be added to
  44713. */
  44714. constructor(
  44715. /** The utility layer the gizmo will be added to */
  44716. gizmoLayer?: UtilityLayerRenderer);
  44717. /**
  44718. * Updates the gizmo to match the attached mesh's position/rotation
  44719. */
  44720. protected _update(): void;
  44721. /**
  44722. * Disposes of the gizmo
  44723. */
  44724. dispose(): void;
  44725. }
  44726. }
  44727. declare module "babylonjs/Gizmos/planeDragGizmo" {
  44728. import { Observable } from "babylonjs/Misc/observable";
  44729. import { Nullable } from "babylonjs/types";
  44730. import { Vector3 } from "babylonjs/Maths/math.vector";
  44731. import { Color3 } from "babylonjs/Maths/math.color";
  44732. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44733. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44734. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  44735. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  44736. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44737. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  44738. import { Scene } from "babylonjs/scene";
  44739. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  44740. /**
  44741. * Single plane drag gizmo
  44742. */
  44743. export class PlaneDragGizmo extends Gizmo {
  44744. /**
  44745. * Drag behavior responsible for the gizmos dragging interactions
  44746. */
  44747. dragBehavior: PointerDragBehavior;
  44748. private _pointerObserver;
  44749. /**
  44750. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  44751. */
  44752. snapDistance: number;
  44753. /**
  44754. * Event that fires each time the gizmo snaps to a new location.
  44755. * * snapDistance is the the change in distance
  44756. */
  44757. onSnapObservable: Observable<{
  44758. snapDistance: number;
  44759. }>;
  44760. private _plane;
  44761. private _coloredMaterial;
  44762. private _hoverMaterial;
  44763. private _isEnabled;
  44764. private _parent;
  44765. /** @hidden */
  44766. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  44767. /** @hidden */
  44768. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  44769. /**
  44770. * Creates a PlaneDragGizmo
  44771. * @param gizmoLayer The utility layer the gizmo will be added to
  44772. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  44773. * @param color The color of the gizmo
  44774. */
  44775. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  44776. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  44777. /**
  44778. * If the gizmo is enabled
  44779. */
  44780. isEnabled: boolean;
  44781. /**
  44782. * Disposes of the gizmo
  44783. */
  44784. dispose(): void;
  44785. }
  44786. }
  44787. declare module "babylonjs/Gizmos/positionGizmo" {
  44788. import { Observable } from "babylonjs/Misc/observable";
  44789. import { Nullable } from "babylonjs/types";
  44790. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44791. import { Mesh } from "babylonjs/Meshes/mesh";
  44792. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  44793. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  44794. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  44795. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44796. /**
  44797. * Gizmo that enables dragging a mesh along 3 axis
  44798. */
  44799. export class PositionGizmo extends Gizmo {
  44800. /**
  44801. * Internal gizmo used for interactions on the x axis
  44802. */
  44803. xGizmo: AxisDragGizmo;
  44804. /**
  44805. * Internal gizmo used for interactions on the y axis
  44806. */
  44807. yGizmo: AxisDragGizmo;
  44808. /**
  44809. * Internal gizmo used for interactions on the z axis
  44810. */
  44811. zGizmo: AxisDragGizmo;
  44812. /**
  44813. * Internal gizmo used for interactions on the yz plane
  44814. */
  44815. xPlaneGizmo: PlaneDragGizmo;
  44816. /**
  44817. * Internal gizmo used for interactions on the xz plane
  44818. */
  44819. yPlaneGizmo: PlaneDragGizmo;
  44820. /**
  44821. * Internal gizmo used for interactions on the xy plane
  44822. */
  44823. zPlaneGizmo: PlaneDragGizmo;
  44824. /**
  44825. * private variables
  44826. */
  44827. private _meshAttached;
  44828. private _updateGizmoRotationToMatchAttachedMesh;
  44829. private _snapDistance;
  44830. private _scaleRatio;
  44831. /** Fires an event when any of it's sub gizmos are dragged */
  44832. onDragStartObservable: Observable<unknown>;
  44833. /** Fires an event when any of it's sub gizmos are released from dragging */
  44834. onDragEndObservable: Observable<unknown>;
  44835. /**
  44836. * If set to true, planar drag is enabled
  44837. */
  44838. private _planarGizmoEnabled;
  44839. attachedMesh: Nullable<AbstractMesh>;
  44840. /**
  44841. * Creates a PositionGizmo
  44842. * @param gizmoLayer The utility layer the gizmo will be added to
  44843. */
  44844. constructor(gizmoLayer?: UtilityLayerRenderer);
  44845. /**
  44846. * If the planar drag gizmo is enabled
  44847. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  44848. */
  44849. planarGizmoEnabled: boolean;
  44850. updateGizmoRotationToMatchAttachedMesh: boolean;
  44851. /**
  44852. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  44853. */
  44854. snapDistance: number;
  44855. /**
  44856. * Ratio for the scale of the gizmo (Default: 1)
  44857. */
  44858. scaleRatio: number;
  44859. /**
  44860. * Disposes of the gizmo
  44861. */
  44862. dispose(): void;
  44863. /**
  44864. * CustomMeshes are not supported by this gizmo
  44865. * @param mesh The mesh to replace the default mesh of the gizmo
  44866. */
  44867. setCustomMesh(mesh: Mesh): void;
  44868. }
  44869. }
  44870. declare module "babylonjs/Gizmos/axisDragGizmo" {
  44871. import { Observable } from "babylonjs/Misc/observable";
  44872. import { Nullable } from "babylonjs/types";
  44873. import { Vector3 } from "babylonjs/Maths/math.vector";
  44874. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44875. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44876. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  44877. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  44878. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44879. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  44880. import { Scene } from "babylonjs/scene";
  44881. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  44882. import { Color3 } from "babylonjs/Maths/math.color";
  44883. /**
  44884. * Single axis drag gizmo
  44885. */
  44886. export class AxisDragGizmo extends Gizmo {
  44887. /**
  44888. * Drag behavior responsible for the gizmos dragging interactions
  44889. */
  44890. dragBehavior: PointerDragBehavior;
  44891. private _pointerObserver;
  44892. /**
  44893. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  44894. */
  44895. snapDistance: number;
  44896. /**
  44897. * Event that fires each time the gizmo snaps to a new location.
  44898. * * snapDistance is the the change in distance
  44899. */
  44900. onSnapObservable: Observable<{
  44901. snapDistance: number;
  44902. }>;
  44903. private _isEnabled;
  44904. private _parent;
  44905. private _arrow;
  44906. private _coloredMaterial;
  44907. private _hoverMaterial;
  44908. /** @hidden */
  44909. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  44910. /** @hidden */
  44911. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  44912. /**
  44913. * Creates an AxisDragGizmo
  44914. * @param gizmoLayer The utility layer the gizmo will be added to
  44915. * @param dragAxis The axis which the gizmo will be able to drag on
  44916. * @param color The color of the gizmo
  44917. */
  44918. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  44919. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  44920. /**
  44921. * If the gizmo is enabled
  44922. */
  44923. isEnabled: boolean;
  44924. /**
  44925. * Disposes of the gizmo
  44926. */
  44927. dispose(): void;
  44928. }
  44929. }
  44930. declare module "babylonjs/Debug/axesViewer" {
  44931. import { Vector3 } from "babylonjs/Maths/math.vector";
  44932. import { Nullable } from "babylonjs/types";
  44933. import { Scene } from "babylonjs/scene";
  44934. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44935. /**
  44936. * The Axes viewer will show 3 axes in a specific point in space
  44937. */
  44938. export class AxesViewer {
  44939. private _xAxis;
  44940. private _yAxis;
  44941. private _zAxis;
  44942. private _scaleLinesFactor;
  44943. private _instanced;
  44944. /**
  44945. * Gets the hosting scene
  44946. */
  44947. scene: Scene;
  44948. /**
  44949. * Gets or sets a number used to scale line length
  44950. */
  44951. scaleLines: number;
  44952. /** Gets the node hierarchy used to render x-axis */
  44953. readonly xAxis: TransformNode;
  44954. /** Gets the node hierarchy used to render y-axis */
  44955. readonly yAxis: TransformNode;
  44956. /** Gets the node hierarchy used to render z-axis */
  44957. readonly zAxis: TransformNode;
  44958. /**
  44959. * Creates a new AxesViewer
  44960. * @param scene defines the hosting scene
  44961. * @param scaleLines defines a number used to scale line length (1 by default)
  44962. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  44963. * @param xAxis defines the node hierarchy used to render the x-axis
  44964. * @param yAxis defines the node hierarchy used to render the y-axis
  44965. * @param zAxis defines the node hierarchy used to render the z-axis
  44966. */
  44967. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  44968. /**
  44969. * Force the viewer to update
  44970. * @param position defines the position of the viewer
  44971. * @param xaxis defines the x axis of the viewer
  44972. * @param yaxis defines the y axis of the viewer
  44973. * @param zaxis defines the z axis of the viewer
  44974. */
  44975. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  44976. /**
  44977. * Creates an instance of this axes viewer.
  44978. * @returns a new axes viewer with instanced meshes
  44979. */
  44980. createInstance(): AxesViewer;
  44981. /** Releases resources */
  44982. dispose(): void;
  44983. private static _SetRenderingGroupId;
  44984. }
  44985. }
  44986. declare module "babylonjs/Debug/boneAxesViewer" {
  44987. import { Nullable } from "babylonjs/types";
  44988. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  44989. import { Vector3 } from "babylonjs/Maths/math.vector";
  44990. import { Mesh } from "babylonjs/Meshes/mesh";
  44991. import { Bone } from "babylonjs/Bones/bone";
  44992. import { Scene } from "babylonjs/scene";
  44993. /**
  44994. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  44995. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  44996. */
  44997. export class BoneAxesViewer extends AxesViewer {
  44998. /**
  44999. * Gets or sets the target mesh where to display the axes viewer
  45000. */
  45001. mesh: Nullable<Mesh>;
  45002. /**
  45003. * Gets or sets the target bone where to display the axes viewer
  45004. */
  45005. bone: Nullable<Bone>;
  45006. /** Gets current position */
  45007. pos: Vector3;
  45008. /** Gets direction of X axis */
  45009. xaxis: Vector3;
  45010. /** Gets direction of Y axis */
  45011. yaxis: Vector3;
  45012. /** Gets direction of Z axis */
  45013. zaxis: Vector3;
  45014. /**
  45015. * Creates a new BoneAxesViewer
  45016. * @param scene defines the hosting scene
  45017. * @param bone defines the target bone
  45018. * @param mesh defines the target mesh
  45019. * @param scaleLines defines a scaling factor for line length (1 by default)
  45020. */
  45021. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  45022. /**
  45023. * Force the viewer to update
  45024. */
  45025. update(): void;
  45026. /** Releases resources */
  45027. dispose(): void;
  45028. }
  45029. }
  45030. declare module "babylonjs/Debug/debugLayer" {
  45031. import { Scene } from "babylonjs/scene";
  45032. /**
  45033. * Interface used to define scene explorer extensibility option
  45034. */
  45035. export interface IExplorerExtensibilityOption {
  45036. /**
  45037. * Define the option label
  45038. */
  45039. label: string;
  45040. /**
  45041. * Defines the action to execute on click
  45042. */
  45043. action: (entity: any) => void;
  45044. }
  45045. /**
  45046. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  45047. */
  45048. export interface IExplorerExtensibilityGroup {
  45049. /**
  45050. * Defines a predicate to test if a given type mut be extended
  45051. */
  45052. predicate: (entity: any) => boolean;
  45053. /**
  45054. * Gets the list of options added to a type
  45055. */
  45056. entries: IExplorerExtensibilityOption[];
  45057. }
  45058. /**
  45059. * Interface used to define the options to use to create the Inspector
  45060. */
  45061. export interface IInspectorOptions {
  45062. /**
  45063. * Display in overlay mode (default: false)
  45064. */
  45065. overlay?: boolean;
  45066. /**
  45067. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  45068. */
  45069. globalRoot?: HTMLElement;
  45070. /**
  45071. * Display the Scene explorer
  45072. */
  45073. showExplorer?: boolean;
  45074. /**
  45075. * Display the property inspector
  45076. */
  45077. showInspector?: boolean;
  45078. /**
  45079. * Display in embed mode (both panes on the right)
  45080. */
  45081. embedMode?: boolean;
  45082. /**
  45083. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  45084. */
  45085. handleResize?: boolean;
  45086. /**
  45087. * Allow the panes to popup (default: true)
  45088. */
  45089. enablePopup?: boolean;
  45090. /**
  45091. * Allow the panes to be closed by users (default: true)
  45092. */
  45093. enableClose?: boolean;
  45094. /**
  45095. * Optional list of extensibility entries
  45096. */
  45097. explorerExtensibility?: IExplorerExtensibilityGroup[];
  45098. /**
  45099. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  45100. */
  45101. inspectorURL?: string;
  45102. }
  45103. module "babylonjs/scene" {
  45104. interface Scene {
  45105. /**
  45106. * @hidden
  45107. * Backing field
  45108. */
  45109. _debugLayer: DebugLayer;
  45110. /**
  45111. * Gets the debug layer (aka Inspector) associated with the scene
  45112. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45113. */
  45114. debugLayer: DebugLayer;
  45115. }
  45116. }
  45117. /**
  45118. * The debug layer (aka Inspector) is the go to tool in order to better understand
  45119. * what is happening in your scene
  45120. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45121. */
  45122. export class DebugLayer {
  45123. /**
  45124. * Define the url to get the inspector script from.
  45125. * By default it uses the babylonjs CDN.
  45126. * @ignoreNaming
  45127. */
  45128. static InspectorURL: string;
  45129. private _scene;
  45130. private BJSINSPECTOR;
  45131. private _onPropertyChangedObservable?;
  45132. /**
  45133. * Observable triggered when a property is changed through the inspector.
  45134. */
  45135. readonly onPropertyChangedObservable: any;
  45136. /**
  45137. * Instantiates a new debug layer.
  45138. * The debug layer (aka Inspector) is the go to tool in order to better understand
  45139. * what is happening in your scene
  45140. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45141. * @param scene Defines the scene to inspect
  45142. */
  45143. constructor(scene: Scene);
  45144. /** Creates the inspector window. */
  45145. private _createInspector;
  45146. /**
  45147. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  45148. * @param entity defines the entity to select
  45149. * @param lineContainerTitle defines the specific block to highlight
  45150. */
  45151. select(entity: any, lineContainerTitle?: string): void;
  45152. /** Get the inspector from bundle or global */
  45153. private _getGlobalInspector;
  45154. /**
  45155. * Get if the inspector is visible or not.
  45156. * @returns true if visible otherwise, false
  45157. */
  45158. isVisible(): boolean;
  45159. /**
  45160. * Hide the inspector and close its window.
  45161. */
  45162. hide(): void;
  45163. /**
  45164. * Launch the debugLayer.
  45165. * @param config Define the configuration of the inspector
  45166. * @return a promise fulfilled when the debug layer is visible
  45167. */
  45168. show(config?: IInspectorOptions): Promise<DebugLayer>;
  45169. }
  45170. }
  45171. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  45172. import { Nullable } from "babylonjs/types";
  45173. import { Scene } from "babylonjs/scene";
  45174. import { Vector4 } from "babylonjs/Maths/math.vector";
  45175. import { Color4 } from "babylonjs/Maths/math.color";
  45176. import { Mesh } from "babylonjs/Meshes/mesh";
  45177. /**
  45178. * Class containing static functions to help procedurally build meshes
  45179. */
  45180. export class BoxBuilder {
  45181. /**
  45182. * Creates a box mesh
  45183. * * The parameter `size` sets the size (float) of each box side (default 1)
  45184. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  45185. * * 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)
  45186. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  45187. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  45188. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  45189. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45190. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  45191. * @param name defines the name of the mesh
  45192. * @param options defines the options used to create the mesh
  45193. * @param scene defines the hosting scene
  45194. * @returns the box mesh
  45195. */
  45196. static CreateBox(name: string, options: {
  45197. size?: number;
  45198. width?: number;
  45199. height?: number;
  45200. depth?: number;
  45201. faceUV?: Vector4[];
  45202. faceColors?: Color4[];
  45203. sideOrientation?: number;
  45204. frontUVs?: Vector4;
  45205. backUVs?: Vector4;
  45206. wrap?: boolean;
  45207. topBaseAt?: number;
  45208. bottomBaseAt?: number;
  45209. updatable?: boolean;
  45210. }, scene?: Nullable<Scene>): Mesh;
  45211. }
  45212. }
  45213. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  45214. import { Vector4 } from "babylonjs/Maths/math.vector";
  45215. import { Mesh } from "babylonjs/Meshes/mesh";
  45216. import { Scene } from "babylonjs/scene";
  45217. import { Nullable } from "babylonjs/types";
  45218. /**
  45219. * Class containing static functions to help procedurally build meshes
  45220. */
  45221. export class SphereBuilder {
  45222. /**
  45223. * Creates a sphere mesh
  45224. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  45225. * * 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`)
  45226. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  45227. * * 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
  45228. * * 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)
  45229. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  45230. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  45231. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45232. * @param name defines the name of the mesh
  45233. * @param options defines the options used to create the mesh
  45234. * @param scene defines the hosting scene
  45235. * @returns the sphere mesh
  45236. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  45237. */
  45238. static CreateSphere(name: string, options: {
  45239. segments?: number;
  45240. diameter?: number;
  45241. diameterX?: number;
  45242. diameterY?: number;
  45243. diameterZ?: number;
  45244. arc?: number;
  45245. slice?: number;
  45246. sideOrientation?: number;
  45247. frontUVs?: Vector4;
  45248. backUVs?: Vector4;
  45249. updatable?: boolean;
  45250. }, scene?: Nullable<Scene>): Mesh;
  45251. }
  45252. }
  45253. declare module "babylonjs/Debug/physicsViewer" {
  45254. import { Nullable } from "babylonjs/types";
  45255. import { Scene } from "babylonjs/scene";
  45256. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45257. import { Mesh } from "babylonjs/Meshes/mesh";
  45258. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  45259. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  45260. /**
  45261. * Used to show the physics impostor around the specific mesh
  45262. */
  45263. export class PhysicsViewer {
  45264. /** @hidden */
  45265. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  45266. /** @hidden */
  45267. protected _meshes: Array<Nullable<AbstractMesh>>;
  45268. /** @hidden */
  45269. protected _scene: Nullable<Scene>;
  45270. /** @hidden */
  45271. protected _numMeshes: number;
  45272. /** @hidden */
  45273. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  45274. private _renderFunction;
  45275. private _utilityLayer;
  45276. private _debugBoxMesh;
  45277. private _debugSphereMesh;
  45278. private _debugCylinderMesh;
  45279. private _debugMaterial;
  45280. private _debugMeshMeshes;
  45281. /**
  45282. * Creates a new PhysicsViewer
  45283. * @param scene defines the hosting scene
  45284. */
  45285. constructor(scene: Scene);
  45286. /** @hidden */
  45287. protected _updateDebugMeshes(): void;
  45288. /**
  45289. * Renders a specified physic impostor
  45290. * @param impostor defines the impostor to render
  45291. * @param targetMesh defines the mesh represented by the impostor
  45292. * @returns the new debug mesh used to render the impostor
  45293. */
  45294. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  45295. /**
  45296. * Hides a specified physic impostor
  45297. * @param impostor defines the impostor to hide
  45298. */
  45299. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  45300. private _getDebugMaterial;
  45301. private _getDebugBoxMesh;
  45302. private _getDebugSphereMesh;
  45303. private _getDebugCylinderMesh;
  45304. private _getDebugMeshMesh;
  45305. private _getDebugMesh;
  45306. /** Releases all resources */
  45307. dispose(): void;
  45308. }
  45309. }
  45310. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  45311. import { Vector3 } from "babylonjs/Maths/math.vector";
  45312. import { Color4 } from "babylonjs/Maths/math.color";
  45313. import { Nullable } from "babylonjs/types";
  45314. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  45315. import { Scene } from "babylonjs/scene";
  45316. /**
  45317. * Class containing static functions to help procedurally build meshes
  45318. */
  45319. export class LinesBuilder {
  45320. /**
  45321. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  45322. * * 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
  45323. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  45324. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  45325. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  45326. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  45327. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  45328. * * 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
  45329. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  45330. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45331. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  45332. * @param name defines the name of the new line system
  45333. * @param options defines the options used to create the line system
  45334. * @param scene defines the hosting scene
  45335. * @returns a new line system mesh
  45336. */
  45337. static CreateLineSystem(name: string, options: {
  45338. lines: Vector3[][];
  45339. updatable?: boolean;
  45340. instance?: Nullable<LinesMesh>;
  45341. colors?: Nullable<Color4[][]>;
  45342. useVertexAlpha?: boolean;
  45343. }, scene: Nullable<Scene>): LinesMesh;
  45344. /**
  45345. * Creates a line mesh
  45346. * 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
  45347. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  45348. * * The parameter `points` is an array successive Vector3
  45349. * * 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
  45350. * * The optional parameter `colors` is an array of successive Color4, one per line point
  45351. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  45352. * * When updating an instance, remember that only point positions can change, not the number of points
  45353. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45354. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  45355. * @param name defines the name of the new line system
  45356. * @param options defines the options used to create the line system
  45357. * @param scene defines the hosting scene
  45358. * @returns a new line mesh
  45359. */
  45360. static CreateLines(name: string, options: {
  45361. points: Vector3[];
  45362. updatable?: boolean;
  45363. instance?: Nullable<LinesMesh>;
  45364. colors?: Color4[];
  45365. useVertexAlpha?: boolean;
  45366. }, scene?: Nullable<Scene>): LinesMesh;
  45367. /**
  45368. * Creates a dashed line mesh
  45369. * * 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
  45370. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  45371. * * The parameter `points` is an array successive Vector3
  45372. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  45373. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  45374. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  45375. * * 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
  45376. * * When updating an instance, remember that only point positions can change, not the number of points
  45377. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45378. * @param name defines the name of the mesh
  45379. * @param options defines the options used to create the mesh
  45380. * @param scene defines the hosting scene
  45381. * @returns the dashed line mesh
  45382. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  45383. */
  45384. static CreateDashedLines(name: string, options: {
  45385. points: Vector3[];
  45386. dashSize?: number;
  45387. gapSize?: number;
  45388. dashNb?: number;
  45389. updatable?: boolean;
  45390. instance?: LinesMesh;
  45391. }, scene?: Nullable<Scene>): LinesMesh;
  45392. }
  45393. }
  45394. declare module "babylonjs/Debug/rayHelper" {
  45395. import { Nullable } from "babylonjs/types";
  45396. import { Ray } from "babylonjs/Culling/ray";
  45397. import { Vector3 } from "babylonjs/Maths/math.vector";
  45398. import { Color3 } from "babylonjs/Maths/math.color";
  45399. import { Scene } from "babylonjs/scene";
  45400. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45401. import "babylonjs/Meshes/Builders/linesBuilder";
  45402. /**
  45403. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  45404. * in order to better appreciate the issue one might have.
  45405. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  45406. */
  45407. export class RayHelper {
  45408. /**
  45409. * Defines the ray we are currently tryin to visualize.
  45410. */
  45411. ray: Nullable<Ray>;
  45412. private _renderPoints;
  45413. private _renderLine;
  45414. private _renderFunction;
  45415. private _scene;
  45416. private _updateToMeshFunction;
  45417. private _attachedToMesh;
  45418. private _meshSpaceDirection;
  45419. private _meshSpaceOrigin;
  45420. /**
  45421. * Helper function to create a colored helper in a scene in one line.
  45422. * @param ray Defines the ray we are currently tryin to visualize
  45423. * @param scene Defines the scene the ray is used in
  45424. * @param color Defines the color we want to see the ray in
  45425. * @returns The newly created ray helper.
  45426. */
  45427. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  45428. /**
  45429. * Instantiate a new ray helper.
  45430. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  45431. * in order to better appreciate the issue one might have.
  45432. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  45433. * @param ray Defines the ray we are currently tryin to visualize
  45434. */
  45435. constructor(ray: Ray);
  45436. /**
  45437. * Shows the ray we are willing to debug.
  45438. * @param scene Defines the scene the ray needs to be rendered in
  45439. * @param color Defines the color the ray needs to be rendered in
  45440. */
  45441. show(scene: Scene, color?: Color3): void;
  45442. /**
  45443. * Hides the ray we are debugging.
  45444. */
  45445. hide(): void;
  45446. private _render;
  45447. /**
  45448. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  45449. * @param mesh Defines the mesh we want the helper attached to
  45450. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  45451. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  45452. * @param length Defines the length of the ray
  45453. */
  45454. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  45455. /**
  45456. * Detach the ray helper from the mesh it has previously been attached to.
  45457. */
  45458. detachFromMesh(): void;
  45459. private _updateToMesh;
  45460. /**
  45461. * Dispose the helper and release its associated resources.
  45462. */
  45463. dispose(): void;
  45464. }
  45465. }
  45466. declare module "babylonjs/Debug/skeletonViewer" {
  45467. import { Color3 } from "babylonjs/Maths/math.color";
  45468. import { Scene } from "babylonjs/scene";
  45469. import { Nullable } from "babylonjs/types";
  45470. import { Skeleton } from "babylonjs/Bones/skeleton";
  45471. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45472. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  45473. /**
  45474. * Class used to render a debug view of a given skeleton
  45475. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  45476. */
  45477. export class SkeletonViewer {
  45478. /** defines the skeleton to render */
  45479. skeleton: Skeleton;
  45480. /** defines the mesh attached to the skeleton */
  45481. mesh: AbstractMesh;
  45482. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  45483. autoUpdateBonesMatrices: boolean;
  45484. /** defines the rendering group id to use with the viewer */
  45485. renderingGroupId: number;
  45486. /** Gets or sets the color used to render the skeleton */
  45487. color: Color3;
  45488. private _scene;
  45489. private _debugLines;
  45490. private _debugMesh;
  45491. private _isEnabled;
  45492. private _renderFunction;
  45493. private _utilityLayer;
  45494. /**
  45495. * Returns the mesh used to render the bones
  45496. */
  45497. readonly debugMesh: Nullable<LinesMesh>;
  45498. /**
  45499. * Creates a new SkeletonViewer
  45500. * @param skeleton defines the skeleton to render
  45501. * @param mesh defines the mesh attached to the skeleton
  45502. * @param scene defines the hosting scene
  45503. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  45504. * @param renderingGroupId defines the rendering group id to use with the viewer
  45505. */
  45506. constructor(
  45507. /** defines the skeleton to render */
  45508. skeleton: Skeleton,
  45509. /** defines the mesh attached to the skeleton */
  45510. mesh: AbstractMesh, scene: Scene,
  45511. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  45512. autoUpdateBonesMatrices?: boolean,
  45513. /** defines the rendering group id to use with the viewer */
  45514. renderingGroupId?: number);
  45515. /** Gets or sets a boolean indicating if the viewer is enabled */
  45516. isEnabled: boolean;
  45517. private _getBonePosition;
  45518. private _getLinesForBonesWithLength;
  45519. private _getLinesForBonesNoLength;
  45520. /** Update the viewer to sync with current skeleton state */
  45521. update(): void;
  45522. /** Release associated resources */
  45523. dispose(): void;
  45524. }
  45525. }
  45526. declare module "babylonjs/Debug/index" {
  45527. export * from "babylonjs/Debug/axesViewer";
  45528. export * from "babylonjs/Debug/boneAxesViewer";
  45529. export * from "babylonjs/Debug/debugLayer";
  45530. export * from "babylonjs/Debug/physicsViewer";
  45531. export * from "babylonjs/Debug/rayHelper";
  45532. export * from "babylonjs/Debug/skeletonViewer";
  45533. }
  45534. declare module "babylonjs/Engines/nullEngine" {
  45535. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  45536. import { Scene } from "babylonjs/scene";
  45537. import { Engine } from "babylonjs/Engines/engine";
  45538. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  45539. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  45540. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  45541. import { Effect } from "babylonjs/Materials/effect";
  45542. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  45543. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  45544. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  45545. /**
  45546. * Options to create the null engine
  45547. */
  45548. export class NullEngineOptions {
  45549. /**
  45550. * Render width (Default: 512)
  45551. */
  45552. renderWidth: number;
  45553. /**
  45554. * Render height (Default: 256)
  45555. */
  45556. renderHeight: number;
  45557. /**
  45558. * Texture size (Default: 512)
  45559. */
  45560. textureSize: number;
  45561. /**
  45562. * If delta time between frames should be constant
  45563. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45564. */
  45565. deterministicLockstep: boolean;
  45566. /**
  45567. * Maximum about of steps between frames (Default: 4)
  45568. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45569. */
  45570. lockstepMaxSteps: number;
  45571. }
  45572. /**
  45573. * The null engine class provides support for headless version of babylon.js.
  45574. * This can be used in server side scenario or for testing purposes
  45575. */
  45576. export class NullEngine extends Engine {
  45577. private _options;
  45578. /**
  45579. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  45580. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45581. * @returns true if engine is in deterministic lock step mode
  45582. */
  45583. isDeterministicLockStep(): boolean;
  45584. /**
  45585. * Gets the max steps when engine is running in deterministic lock step
  45586. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45587. * @returns the max steps
  45588. */
  45589. getLockstepMaxSteps(): number;
  45590. /**
  45591. * Gets the current hardware scaling level.
  45592. * By default the hardware scaling level is computed from the window device ratio.
  45593. * 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.
  45594. * @returns a number indicating the current hardware scaling level
  45595. */
  45596. getHardwareScalingLevel(): number;
  45597. constructor(options?: NullEngineOptions);
  45598. /**
  45599. * Creates a vertex buffer
  45600. * @param vertices the data for the vertex buffer
  45601. * @returns the new WebGL static buffer
  45602. */
  45603. createVertexBuffer(vertices: FloatArray): DataBuffer;
  45604. /**
  45605. * Creates a new index buffer
  45606. * @param indices defines the content of the index buffer
  45607. * @param updatable defines if the index buffer must be updatable
  45608. * @returns a new webGL buffer
  45609. */
  45610. createIndexBuffer(indices: IndicesArray): DataBuffer;
  45611. /**
  45612. * Clear the current render buffer or the current render target (if any is set up)
  45613. * @param color defines the color to use
  45614. * @param backBuffer defines if the back buffer must be cleared
  45615. * @param depth defines if the depth buffer must be cleared
  45616. * @param stencil defines if the stencil buffer must be cleared
  45617. */
  45618. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  45619. /**
  45620. * Gets the current render width
  45621. * @param useScreen defines if screen size must be used (or the current render target if any)
  45622. * @returns a number defining the current render width
  45623. */
  45624. getRenderWidth(useScreen?: boolean): number;
  45625. /**
  45626. * Gets the current render height
  45627. * @param useScreen defines if screen size must be used (or the current render target if any)
  45628. * @returns a number defining the current render height
  45629. */
  45630. getRenderHeight(useScreen?: boolean): number;
  45631. /**
  45632. * Set the WebGL's viewport
  45633. * @param viewport defines the viewport element to be used
  45634. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  45635. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  45636. */
  45637. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  45638. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  45639. /**
  45640. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  45641. * @param pipelineContext defines the pipeline context to use
  45642. * @param uniformsNames defines the list of uniform names
  45643. * @returns an array of webGL uniform locations
  45644. */
  45645. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  45646. /**
  45647. * Gets the lsit of active attributes for a given webGL program
  45648. * @param pipelineContext defines the pipeline context to use
  45649. * @param attributesNames defines the list of attribute names to get
  45650. * @returns an array of indices indicating the offset of each attribute
  45651. */
  45652. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  45653. /**
  45654. * Binds an effect to the webGL context
  45655. * @param effect defines the effect to bind
  45656. */
  45657. bindSamplers(effect: Effect): void;
  45658. /**
  45659. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  45660. * @param effect defines the effect to activate
  45661. */
  45662. enableEffect(effect: Effect): void;
  45663. /**
  45664. * Set various states to the webGL context
  45665. * @param culling defines backface culling state
  45666. * @param zOffset defines the value to apply to zOffset (0 by default)
  45667. * @param force defines if states must be applied even if cache is up to date
  45668. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  45669. */
  45670. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  45671. /**
  45672. * Set the value of an uniform to an array of int32
  45673. * @param uniform defines the webGL uniform location where to store the value
  45674. * @param array defines the array of int32 to store
  45675. */
  45676. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  45677. /**
  45678. * Set the value of an uniform to an array of int32 (stored as vec2)
  45679. * @param uniform defines the webGL uniform location where to store the value
  45680. * @param array defines the array of int32 to store
  45681. */
  45682. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  45683. /**
  45684. * Set the value of an uniform to an array of int32 (stored as vec3)
  45685. * @param uniform defines the webGL uniform location where to store the value
  45686. * @param array defines the array of int32 to store
  45687. */
  45688. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  45689. /**
  45690. * Set the value of an uniform to an array of int32 (stored as vec4)
  45691. * @param uniform defines the webGL uniform location where to store the value
  45692. * @param array defines the array of int32 to store
  45693. */
  45694. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  45695. /**
  45696. * Set the value of an uniform to an array of float32
  45697. * @param uniform defines the webGL uniform location where to store the value
  45698. * @param array defines the array of float32 to store
  45699. */
  45700. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  45701. /**
  45702. * Set the value of an uniform to an array of float32 (stored as vec2)
  45703. * @param uniform defines the webGL uniform location where to store the value
  45704. * @param array defines the array of float32 to store
  45705. */
  45706. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  45707. /**
  45708. * Set the value of an uniform to an array of float32 (stored as vec3)
  45709. * @param uniform defines the webGL uniform location where to store the value
  45710. * @param array defines the array of float32 to store
  45711. */
  45712. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  45713. /**
  45714. * Set the value of an uniform to an array of float32 (stored as vec4)
  45715. * @param uniform defines the webGL uniform location where to store the value
  45716. * @param array defines the array of float32 to store
  45717. */
  45718. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  45719. /**
  45720. * Set the value of an uniform to an array of number
  45721. * @param uniform defines the webGL uniform location where to store the value
  45722. * @param array defines the array of number to store
  45723. */
  45724. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  45725. /**
  45726. * Set the value of an uniform to an array of number (stored as vec2)
  45727. * @param uniform defines the webGL uniform location where to store the value
  45728. * @param array defines the array of number to store
  45729. */
  45730. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  45731. /**
  45732. * Set the value of an uniform to an array of number (stored as vec3)
  45733. * @param uniform defines the webGL uniform location where to store the value
  45734. * @param array defines the array of number to store
  45735. */
  45736. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  45737. /**
  45738. * Set the value of an uniform to an array of number (stored as vec4)
  45739. * @param uniform defines the webGL uniform location where to store the value
  45740. * @param array defines the array of number to store
  45741. */
  45742. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  45743. /**
  45744. * Set the value of an uniform to an array of float32 (stored as matrices)
  45745. * @param uniform defines the webGL uniform location where to store the value
  45746. * @param matrices defines the array of float32 to store
  45747. */
  45748. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  45749. /**
  45750. * Set the value of an uniform to a matrix (3x3)
  45751. * @param uniform defines the webGL uniform location where to store the value
  45752. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  45753. */
  45754. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  45755. /**
  45756. * Set the value of an uniform to a matrix (2x2)
  45757. * @param uniform defines the webGL uniform location where to store the value
  45758. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  45759. */
  45760. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  45761. /**
  45762. * Set the value of an uniform to a number (float)
  45763. * @param uniform defines the webGL uniform location where to store the value
  45764. * @param value defines the float number to store
  45765. */
  45766. setFloat(uniform: WebGLUniformLocation, value: number): void;
  45767. /**
  45768. * Set the value of an uniform to a vec2
  45769. * @param uniform defines the webGL uniform location where to store the value
  45770. * @param x defines the 1st component of the value
  45771. * @param y defines the 2nd component of the value
  45772. */
  45773. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  45774. /**
  45775. * Set the value of an uniform to a vec3
  45776. * @param uniform defines the webGL uniform location where to store the value
  45777. * @param x defines the 1st component of the value
  45778. * @param y defines the 2nd component of the value
  45779. * @param z defines the 3rd component of the value
  45780. */
  45781. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  45782. /**
  45783. * Set the value of an uniform to a boolean
  45784. * @param uniform defines the webGL uniform location where to store the value
  45785. * @param bool defines the boolean to store
  45786. */
  45787. setBool(uniform: WebGLUniformLocation, bool: number): void;
  45788. /**
  45789. * Set the value of an uniform to a vec4
  45790. * @param uniform defines the webGL uniform location where to store the value
  45791. * @param x defines the 1st component of the value
  45792. * @param y defines the 2nd component of the value
  45793. * @param z defines the 3rd component of the value
  45794. * @param w defines the 4th component of the value
  45795. */
  45796. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  45797. /**
  45798. * Sets the current alpha mode
  45799. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  45800. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  45801. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  45802. */
  45803. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  45804. /**
  45805. * Bind webGl buffers directly to the webGL context
  45806. * @param vertexBuffers defines the vertex buffer to bind
  45807. * @param indexBuffer defines the index buffer to bind
  45808. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  45809. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  45810. * @param effect defines the effect associated with the vertex buffer
  45811. */
  45812. bindBuffers(vertexBuffers: {
  45813. [key: string]: VertexBuffer;
  45814. }, indexBuffer: DataBuffer, effect: Effect): void;
  45815. /**
  45816. * Force the entire cache to be cleared
  45817. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  45818. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  45819. */
  45820. wipeCaches(bruteForce?: boolean): void;
  45821. /**
  45822. * Send a draw order
  45823. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  45824. * @param indexStart defines the starting index
  45825. * @param indexCount defines the number of index to draw
  45826. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  45827. */
  45828. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  45829. /**
  45830. * Draw a list of indexed primitives
  45831. * @param fillMode defines the primitive to use
  45832. * @param indexStart defines the starting index
  45833. * @param indexCount defines the number of index to draw
  45834. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  45835. */
  45836. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  45837. /**
  45838. * Draw a list of unindexed primitives
  45839. * @param fillMode defines the primitive to use
  45840. * @param verticesStart defines the index of first vertex to draw
  45841. * @param verticesCount defines the count of vertices to draw
  45842. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  45843. */
  45844. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  45845. /** @hidden */
  45846. _createTexture(): WebGLTexture;
  45847. /** @hidden */
  45848. _releaseTexture(texture: InternalTexture): void;
  45849. /**
  45850. * Usually called from Texture.ts.
  45851. * Passed information to create a WebGLTexture
  45852. * @param urlArg defines a value which contains one of the following:
  45853. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  45854. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  45855. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  45856. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  45857. * @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)
  45858. * @param scene needed for loading to the correct scene
  45859. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  45860. * @param onLoad optional callback to be called upon successful completion
  45861. * @param onError optional callback to be called upon failure
  45862. * @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
  45863. * @param fallBack an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  45864. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  45865. * @param forcedExtension defines the extension to use to pick the right loader
  45866. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  45867. * @returns a InternalTexture for assignment back into BABYLON.Texture
  45868. */
  45869. createTexture(urlArg: string, noMipmap: boolean, invertY: boolean, scene: Scene, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<ArrayBuffer | HTMLImageElement>, fallBack?: InternalTexture, format?: number): InternalTexture;
  45870. /**
  45871. * Creates a new render target texture
  45872. * @param size defines the size of the texture
  45873. * @param options defines the options used to create the texture
  45874. * @returns a new render target texture stored in an InternalTexture
  45875. */
  45876. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  45877. /**
  45878. * Update the sampling mode of a given texture
  45879. * @param samplingMode defines the required sampling mode
  45880. * @param texture defines the texture to update
  45881. */
  45882. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  45883. /**
  45884. * Binds the frame buffer to the specified texture.
  45885. * @param texture The texture to render to or null for the default canvas
  45886. * @param faceIndex The face of the texture to render to in case of cube texture
  45887. * @param requiredWidth The width of the target to render to
  45888. * @param requiredHeight The height of the target to render to
  45889. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  45890. * @param depthStencilTexture The depth stencil texture to use to render
  45891. * @param lodLevel defines le lod level to bind to the frame buffer
  45892. */
  45893. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  45894. /**
  45895. * Unbind the current render target texture from the webGL context
  45896. * @param texture defines the render target texture to unbind
  45897. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  45898. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  45899. */
  45900. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  45901. /**
  45902. * Creates a dynamic vertex buffer
  45903. * @param vertices the data for the dynamic vertex buffer
  45904. * @returns the new WebGL dynamic buffer
  45905. */
  45906. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  45907. /**
  45908. * Update the content of a dynamic texture
  45909. * @param texture defines the texture to update
  45910. * @param canvas defines the canvas containing the source
  45911. * @param invertY defines if data must be stored with Y axis inverted
  45912. * @param premulAlpha defines if alpha is stored as premultiplied
  45913. * @param format defines the format of the data
  45914. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  45915. */
  45916. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  45917. /**
  45918. * Gets a boolean indicating if all created effects are ready
  45919. * @returns true if all effects are ready
  45920. */
  45921. areAllEffectsReady(): boolean;
  45922. /**
  45923. * @hidden
  45924. * Get the current error code of the webGL context
  45925. * @returns the error code
  45926. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  45927. */
  45928. getError(): number;
  45929. /** @hidden */
  45930. _getUnpackAlignement(): number;
  45931. /** @hidden */
  45932. _unpackFlipY(value: boolean): void;
  45933. /**
  45934. * Update a dynamic index buffer
  45935. * @param indexBuffer defines the target index buffer
  45936. * @param indices defines the data to update
  45937. * @param offset defines the offset in the target index buffer where update should start
  45938. */
  45939. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  45940. /**
  45941. * Updates a dynamic vertex buffer.
  45942. * @param vertexBuffer the vertex buffer to update
  45943. * @param vertices the data used to update the vertex buffer
  45944. * @param byteOffset the byte offset of the data (optional)
  45945. * @param byteLength the byte length of the data (optional)
  45946. */
  45947. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  45948. /** @hidden */
  45949. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  45950. /** @hidden */
  45951. _bindTexture(channel: number, texture: InternalTexture): void;
  45952. protected _deleteBuffer(buffer: WebGLBuffer): void;
  45953. /**
  45954. * 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
  45955. */
  45956. releaseEffects(): void;
  45957. displayLoadingUI(): void;
  45958. hideLoadingUI(): void;
  45959. /** @hidden */
  45960. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  45961. /** @hidden */
  45962. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  45963. /** @hidden */
  45964. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  45965. /** @hidden */
  45966. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  45967. }
  45968. }
  45969. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  45970. import { Nullable, int } from "babylonjs/types";
  45971. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  45972. /** @hidden */
  45973. export class _OcclusionDataStorage {
  45974. /** @hidden */
  45975. occlusionInternalRetryCounter: number;
  45976. /** @hidden */
  45977. isOcclusionQueryInProgress: boolean;
  45978. /** @hidden */
  45979. isOccluded: boolean;
  45980. /** @hidden */
  45981. occlusionRetryCount: number;
  45982. /** @hidden */
  45983. occlusionType: number;
  45984. /** @hidden */
  45985. occlusionQueryAlgorithmType: number;
  45986. }
  45987. module "babylonjs/Engines/engine" {
  45988. interface Engine {
  45989. /**
  45990. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  45991. * @return the new query
  45992. */
  45993. createQuery(): WebGLQuery;
  45994. /**
  45995. * Delete and release a webGL query
  45996. * @param query defines the query to delete
  45997. * @return the current engine
  45998. */
  45999. deleteQuery(query: WebGLQuery): Engine;
  46000. /**
  46001. * Check if a given query has resolved and got its value
  46002. * @param query defines the query to check
  46003. * @returns true if the query got its value
  46004. */
  46005. isQueryResultAvailable(query: WebGLQuery): boolean;
  46006. /**
  46007. * Gets the value of a given query
  46008. * @param query defines the query to check
  46009. * @returns the value of the query
  46010. */
  46011. getQueryResult(query: WebGLQuery): number;
  46012. /**
  46013. * Initiates an occlusion query
  46014. * @param algorithmType defines the algorithm to use
  46015. * @param query defines the query to use
  46016. * @returns the current engine
  46017. * @see http://doc.babylonjs.com/features/occlusionquery
  46018. */
  46019. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  46020. /**
  46021. * Ends an occlusion query
  46022. * @see http://doc.babylonjs.com/features/occlusionquery
  46023. * @param algorithmType defines the algorithm to use
  46024. * @returns the current engine
  46025. */
  46026. endOcclusionQuery(algorithmType: number): Engine;
  46027. /**
  46028. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  46029. * Please note that only one query can be issued at a time
  46030. * @returns a time token used to track the time span
  46031. */
  46032. startTimeQuery(): Nullable<_TimeToken>;
  46033. /**
  46034. * Ends a time query
  46035. * @param token defines the token used to measure the time span
  46036. * @returns the time spent (in ns)
  46037. */
  46038. endTimeQuery(token: _TimeToken): int;
  46039. /** @hidden */
  46040. _currentNonTimestampToken: Nullable<_TimeToken>;
  46041. /** @hidden */
  46042. _createTimeQuery(): WebGLQuery;
  46043. /** @hidden */
  46044. _deleteTimeQuery(query: WebGLQuery): void;
  46045. /** @hidden */
  46046. _getGlAlgorithmType(algorithmType: number): number;
  46047. /** @hidden */
  46048. _getTimeQueryResult(query: WebGLQuery): any;
  46049. /** @hidden */
  46050. _getTimeQueryAvailability(query: WebGLQuery): any;
  46051. }
  46052. }
  46053. module "babylonjs/Meshes/abstractMesh" {
  46054. interface AbstractMesh {
  46055. /**
  46056. * Backing filed
  46057. * @hidden
  46058. */
  46059. __occlusionDataStorage: _OcclusionDataStorage;
  46060. /**
  46061. * Access property
  46062. * @hidden
  46063. */
  46064. _occlusionDataStorage: _OcclusionDataStorage;
  46065. /**
  46066. * 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.
  46067. * The default value is -1 which means don't break the query and wait till the result
  46068. * @see http://doc.babylonjs.com/features/occlusionquery
  46069. */
  46070. occlusionRetryCount: number;
  46071. /**
  46072. * 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:
  46073. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  46074. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  46075. * * 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.
  46076. * @see http://doc.babylonjs.com/features/occlusionquery
  46077. */
  46078. occlusionType: number;
  46079. /**
  46080. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  46081. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  46082. * * 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.
  46083. * @see http://doc.babylonjs.com/features/occlusionquery
  46084. */
  46085. occlusionQueryAlgorithmType: number;
  46086. /**
  46087. * 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
  46088. * @see http://doc.babylonjs.com/features/occlusionquery
  46089. */
  46090. isOccluded: boolean;
  46091. /**
  46092. * Flag to check the progress status of the query
  46093. * @see http://doc.babylonjs.com/features/occlusionquery
  46094. */
  46095. isOcclusionQueryInProgress: boolean;
  46096. }
  46097. }
  46098. }
  46099. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  46100. import { Nullable } from "babylonjs/types";
  46101. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  46102. /** @hidden */
  46103. export var _forceTransformFeedbackToBundle: boolean;
  46104. module "babylonjs/Engines/engine" {
  46105. interface Engine {
  46106. /**
  46107. * Creates a webGL transform feedback object
  46108. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  46109. * @returns the webGL transform feedback object
  46110. */
  46111. createTransformFeedback(): WebGLTransformFeedback;
  46112. /**
  46113. * Delete a webGL transform feedback object
  46114. * @param value defines the webGL transform feedback object to delete
  46115. */
  46116. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  46117. /**
  46118. * Bind a webGL transform feedback object to the webgl context
  46119. * @param value defines the webGL transform feedback object to bind
  46120. */
  46121. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  46122. /**
  46123. * Begins a transform feedback operation
  46124. * @param usePoints defines if points or triangles must be used
  46125. */
  46126. beginTransformFeedback(usePoints: boolean): void;
  46127. /**
  46128. * Ends a transform feedback operation
  46129. */
  46130. endTransformFeedback(): void;
  46131. /**
  46132. * Specify the varyings to use with transform feedback
  46133. * @param program defines the associated webGL program
  46134. * @param value defines the list of strings representing the varying names
  46135. */
  46136. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  46137. /**
  46138. * Bind a webGL buffer for a transform feedback operation
  46139. * @param value defines the webGL buffer to bind
  46140. */
  46141. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  46142. }
  46143. }
  46144. }
  46145. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  46146. import { Scene } from "babylonjs/scene";
  46147. import { Engine } from "babylonjs/Engines/engine";
  46148. import { Texture } from "babylonjs/Materials/Textures/texture";
  46149. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  46150. import "babylonjs/Engines/Extensions/engine.multiRender";
  46151. /**
  46152. * Creation options of the multi render target texture.
  46153. */
  46154. export interface IMultiRenderTargetOptions {
  46155. /**
  46156. * Define if the texture needs to create mip maps after render.
  46157. */
  46158. generateMipMaps?: boolean;
  46159. /**
  46160. * Define the types of all the draw buffers we want to create
  46161. */
  46162. types?: number[];
  46163. /**
  46164. * Define the sampling modes of all the draw buffers we want to create
  46165. */
  46166. samplingModes?: number[];
  46167. /**
  46168. * Define if a depth buffer is required
  46169. */
  46170. generateDepthBuffer?: boolean;
  46171. /**
  46172. * Define if a stencil buffer is required
  46173. */
  46174. generateStencilBuffer?: boolean;
  46175. /**
  46176. * Define if a depth texture is required instead of a depth buffer
  46177. */
  46178. generateDepthTexture?: boolean;
  46179. /**
  46180. * Define the number of desired draw buffers
  46181. */
  46182. textureCount?: number;
  46183. /**
  46184. * Define if aspect ratio should be adapted to the texture or stay the scene one
  46185. */
  46186. doNotChangeAspectRatio?: boolean;
  46187. /**
  46188. * Define the default type of the buffers we are creating
  46189. */
  46190. defaultType?: number;
  46191. }
  46192. /**
  46193. * A multi render target, like a render target provides the ability to render to a texture.
  46194. * Unlike the render target, it can render to several draw buffers in one draw.
  46195. * This is specially interesting in deferred rendering or for any effects requiring more than
  46196. * just one color from a single pass.
  46197. */
  46198. export class MultiRenderTarget extends RenderTargetTexture {
  46199. private _internalTextures;
  46200. private _textures;
  46201. private _multiRenderTargetOptions;
  46202. /**
  46203. * Get if draw buffers are currently supported by the used hardware and browser.
  46204. */
  46205. readonly isSupported: boolean;
  46206. /**
  46207. * Get the list of textures generated by the multi render target.
  46208. */
  46209. readonly textures: Texture[];
  46210. /**
  46211. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  46212. */
  46213. readonly depthTexture: Texture;
  46214. /**
  46215. * Set the wrapping mode on U of all the textures we are rendering to.
  46216. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  46217. */
  46218. wrapU: number;
  46219. /**
  46220. * Set the wrapping mode on V of all the textures we are rendering to.
  46221. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  46222. */
  46223. wrapV: number;
  46224. /**
  46225. * Instantiate a new multi render target texture.
  46226. * A multi render target, like a render target provides the ability to render to a texture.
  46227. * Unlike the render target, it can render to several draw buffers in one draw.
  46228. * This is specially interesting in deferred rendering or for any effects requiring more than
  46229. * just one color from a single pass.
  46230. * @param name Define the name of the texture
  46231. * @param size Define the size of the buffers to render to
  46232. * @param count Define the number of target we are rendering into
  46233. * @param scene Define the scene the texture belongs to
  46234. * @param options Define the options used to create the multi render target
  46235. */
  46236. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  46237. /** @hidden */
  46238. _rebuild(): void;
  46239. private _createInternalTextures;
  46240. private _createTextures;
  46241. /**
  46242. * Define the number of samples used if MSAA is enabled.
  46243. */
  46244. samples: number;
  46245. /**
  46246. * Resize all the textures in the multi render target.
  46247. * Be carrefull as it will recreate all the data in the new texture.
  46248. * @param size Define the new size
  46249. */
  46250. resize(size: any): void;
  46251. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  46252. /**
  46253. * Dispose the render targets and their associated resources
  46254. */
  46255. dispose(): void;
  46256. /**
  46257. * Release all the underlying texture used as draw buffers.
  46258. */
  46259. releaseInternalTextures(): void;
  46260. }
  46261. }
  46262. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  46263. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  46264. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  46265. import { Nullable } from "babylonjs/types";
  46266. module "babylonjs/Engines/thinEngine" {
  46267. interface ThinEngine {
  46268. /**
  46269. * Unbind a list of render target textures from the webGL context
  46270. * This is used only when drawBuffer extension or webGL2 are active
  46271. * @param textures defines the render target textures to unbind
  46272. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  46273. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  46274. */
  46275. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  46276. /**
  46277. * Create a multi render target texture
  46278. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  46279. * @param size defines the size of the texture
  46280. * @param options defines the creation options
  46281. * @returns the cube texture as an InternalTexture
  46282. */
  46283. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  46284. /**
  46285. * Update the sample count for a given multiple render target texture
  46286. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  46287. * @param textures defines the textures to update
  46288. * @param samples defines the sample count to set
  46289. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  46290. */
  46291. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  46292. }
  46293. }
  46294. }
  46295. declare module "babylonjs/Engines/Extensions/index" {
  46296. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  46297. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  46298. export * from "babylonjs/Engines/Extensions/engine.multiview";
  46299. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  46300. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  46301. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  46302. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  46303. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  46304. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  46305. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  46306. export * from "babylonjs/Engines/Extensions/engine.webVR";
  46307. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  46308. }
  46309. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  46310. import { Nullable } from "babylonjs/types";
  46311. /**
  46312. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  46313. */
  46314. export interface CubeMapInfo {
  46315. /**
  46316. * The pixel array for the front face.
  46317. * This is stored in format, left to right, up to down format.
  46318. */
  46319. front: Nullable<ArrayBufferView>;
  46320. /**
  46321. * The pixel array for the back face.
  46322. * This is stored in format, left to right, up to down format.
  46323. */
  46324. back: Nullable<ArrayBufferView>;
  46325. /**
  46326. * The pixel array for the left face.
  46327. * This is stored in format, left to right, up to down format.
  46328. */
  46329. left: Nullable<ArrayBufferView>;
  46330. /**
  46331. * The pixel array for the right face.
  46332. * This is stored in format, left to right, up to down format.
  46333. */
  46334. right: Nullable<ArrayBufferView>;
  46335. /**
  46336. * The pixel array for the up face.
  46337. * This is stored in format, left to right, up to down format.
  46338. */
  46339. up: Nullable<ArrayBufferView>;
  46340. /**
  46341. * The pixel array for the down face.
  46342. * This is stored in format, left to right, up to down format.
  46343. */
  46344. down: Nullable<ArrayBufferView>;
  46345. /**
  46346. * The size of the cubemap stored.
  46347. *
  46348. * Each faces will be size * size pixels.
  46349. */
  46350. size: number;
  46351. /**
  46352. * The format of the texture.
  46353. *
  46354. * RGBA, RGB.
  46355. */
  46356. format: number;
  46357. /**
  46358. * The type of the texture data.
  46359. *
  46360. * UNSIGNED_INT, FLOAT.
  46361. */
  46362. type: number;
  46363. /**
  46364. * Specifies whether the texture is in gamma space.
  46365. */
  46366. gammaSpace: boolean;
  46367. }
  46368. /**
  46369. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  46370. */
  46371. export class PanoramaToCubeMapTools {
  46372. private static FACE_FRONT;
  46373. private static FACE_BACK;
  46374. private static FACE_RIGHT;
  46375. private static FACE_LEFT;
  46376. private static FACE_DOWN;
  46377. private static FACE_UP;
  46378. /**
  46379. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  46380. *
  46381. * @param float32Array The source data.
  46382. * @param inputWidth The width of the input panorama.
  46383. * @param inputHeight The height of the input panorama.
  46384. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  46385. * @return The cubemap data
  46386. */
  46387. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  46388. private static CreateCubemapTexture;
  46389. private static CalcProjectionSpherical;
  46390. }
  46391. }
  46392. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  46393. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46394. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  46395. import { Nullable } from "babylonjs/types";
  46396. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  46397. /**
  46398. * Helper class dealing with the extraction of spherical polynomial dataArray
  46399. * from a cube map.
  46400. */
  46401. export class CubeMapToSphericalPolynomialTools {
  46402. private static FileFaces;
  46403. /**
  46404. * Converts a texture to the according Spherical Polynomial data.
  46405. * This extracts the first 3 orders only as they are the only one used in the lighting.
  46406. *
  46407. * @param texture The texture to extract the information from.
  46408. * @return The Spherical Polynomial data.
  46409. */
  46410. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  46411. /**
  46412. * Converts a cubemap to the according Spherical Polynomial data.
  46413. * This extracts the first 3 orders only as they are the only one used in the lighting.
  46414. *
  46415. * @param cubeInfo The Cube map to extract the information from.
  46416. * @return The Spherical Polynomial data.
  46417. */
  46418. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  46419. }
  46420. }
  46421. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  46422. import { Nullable } from "babylonjs/types";
  46423. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46424. module "babylonjs/Materials/Textures/baseTexture" {
  46425. interface BaseTexture {
  46426. /**
  46427. * Get the polynomial representation of the texture data.
  46428. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  46429. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  46430. */
  46431. sphericalPolynomial: Nullable<SphericalPolynomial>;
  46432. }
  46433. }
  46434. }
  46435. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  46436. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  46437. /** @hidden */
  46438. export var rgbdEncodePixelShader: {
  46439. name: string;
  46440. shader: string;
  46441. };
  46442. }
  46443. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  46444. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  46445. /** @hidden */
  46446. export var rgbdDecodePixelShader: {
  46447. name: string;
  46448. shader: string;
  46449. };
  46450. }
  46451. declare module "babylonjs/Misc/environmentTextureTools" {
  46452. import { Nullable } from "babylonjs/types";
  46453. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46454. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  46455. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  46456. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  46457. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  46458. import "babylonjs/Shaders/rgbdEncode.fragment";
  46459. import "babylonjs/Shaders/rgbdDecode.fragment";
  46460. /**
  46461. * Raw texture data and descriptor sufficient for WebGL texture upload
  46462. */
  46463. export interface EnvironmentTextureInfo {
  46464. /**
  46465. * Version of the environment map
  46466. */
  46467. version: number;
  46468. /**
  46469. * Width of image
  46470. */
  46471. width: number;
  46472. /**
  46473. * Irradiance information stored in the file.
  46474. */
  46475. irradiance: any;
  46476. /**
  46477. * Specular information stored in the file.
  46478. */
  46479. specular: any;
  46480. }
  46481. /**
  46482. * Defines One Image in the file. It requires only the position in the file
  46483. * as well as the length.
  46484. */
  46485. interface BufferImageData {
  46486. /**
  46487. * Length of the image data.
  46488. */
  46489. length: number;
  46490. /**
  46491. * Position of the data from the null terminator delimiting the end of the JSON.
  46492. */
  46493. position: number;
  46494. }
  46495. /**
  46496. * Defines the specular data enclosed in the file.
  46497. * This corresponds to the version 1 of the data.
  46498. */
  46499. export interface EnvironmentTextureSpecularInfoV1 {
  46500. /**
  46501. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  46502. */
  46503. specularDataPosition?: number;
  46504. /**
  46505. * This contains all the images data needed to reconstruct the cubemap.
  46506. */
  46507. mipmaps: Array<BufferImageData>;
  46508. /**
  46509. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  46510. */
  46511. lodGenerationScale: number;
  46512. }
  46513. /**
  46514. * Sets of helpers addressing the serialization and deserialization of environment texture
  46515. * stored in a BabylonJS env file.
  46516. * Those files are usually stored as .env files.
  46517. */
  46518. export class EnvironmentTextureTools {
  46519. /**
  46520. * Magic number identifying the env file.
  46521. */
  46522. private static _MagicBytes;
  46523. /**
  46524. * Gets the environment info from an env file.
  46525. * @param data The array buffer containing the .env bytes.
  46526. * @returns the environment file info (the json header) if successfully parsed.
  46527. */
  46528. static GetEnvInfo(data: ArrayBuffer): Nullable<EnvironmentTextureInfo>;
  46529. /**
  46530. * Creates an environment texture from a loaded cube texture.
  46531. * @param texture defines the cube texture to convert in env file
  46532. * @return a promise containing the environment data if succesfull.
  46533. */
  46534. static CreateEnvTextureAsync(texture: CubeTexture): Promise<ArrayBuffer>;
  46535. /**
  46536. * Creates a JSON representation of the spherical data.
  46537. * @param texture defines the texture containing the polynomials
  46538. * @return the JSON representation of the spherical info
  46539. */
  46540. private static _CreateEnvTextureIrradiance;
  46541. /**
  46542. * Creates the ArrayBufferViews used for initializing environment texture image data.
  46543. * @param arrayBuffer the underlying ArrayBuffer to which the views refer
  46544. * @param info parameters that determine what views will be created for accessing the underlying buffer
  46545. * @return the views described by info providing access to the underlying buffer
  46546. */
  46547. static CreateImageDataArrayBufferViews(arrayBuffer: any, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  46548. /**
  46549. * Uploads the texture info contained in the env file to the GPU.
  46550. * @param texture defines the internal texture to upload to
  46551. * @param arrayBuffer defines the buffer cotaining the data to load
  46552. * @param info defines the texture info retrieved through the GetEnvInfo method
  46553. * @returns a promise
  46554. */
  46555. static UploadEnvLevelsAsync(texture: InternalTexture, arrayBuffer: any, info: EnvironmentTextureInfo): Promise<void>;
  46556. private static _OnImageReadyAsync;
  46557. /**
  46558. * Uploads the levels of image data to the GPU.
  46559. * @param texture defines the internal texture to upload to
  46560. * @param imageData defines the array buffer views of image data [mipmap][face]
  46561. * @returns a promise
  46562. */
  46563. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  46564. /**
  46565. * Uploads spherical polynomials information to the texture.
  46566. * @param texture defines the texture we are trying to upload the information to
  46567. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  46568. */
  46569. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  46570. /** @hidden */
  46571. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  46572. }
  46573. }
  46574. declare module "babylonjs/Maths/math.vertexFormat" {
  46575. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  46576. /**
  46577. * Contains position and normal vectors for a vertex
  46578. */
  46579. export class PositionNormalVertex {
  46580. /** the position of the vertex (defaut: 0,0,0) */
  46581. position: Vector3;
  46582. /** the normal of the vertex (defaut: 0,1,0) */
  46583. normal: Vector3;
  46584. /**
  46585. * Creates a PositionNormalVertex
  46586. * @param position the position of the vertex (defaut: 0,0,0)
  46587. * @param normal the normal of the vertex (defaut: 0,1,0)
  46588. */
  46589. constructor(
  46590. /** the position of the vertex (defaut: 0,0,0) */
  46591. position?: Vector3,
  46592. /** the normal of the vertex (defaut: 0,1,0) */
  46593. normal?: Vector3);
  46594. /**
  46595. * Clones the PositionNormalVertex
  46596. * @returns the cloned PositionNormalVertex
  46597. */
  46598. clone(): PositionNormalVertex;
  46599. }
  46600. /**
  46601. * Contains position, normal and uv vectors for a vertex
  46602. */
  46603. export class PositionNormalTextureVertex {
  46604. /** the position of the vertex (defaut: 0,0,0) */
  46605. position: Vector3;
  46606. /** the normal of the vertex (defaut: 0,1,0) */
  46607. normal: Vector3;
  46608. /** the uv of the vertex (default: 0,0) */
  46609. uv: Vector2;
  46610. /**
  46611. * Creates a PositionNormalTextureVertex
  46612. * @param position the position of the vertex (defaut: 0,0,0)
  46613. * @param normal the normal of the vertex (defaut: 0,1,0)
  46614. * @param uv the uv of the vertex (default: 0,0)
  46615. */
  46616. constructor(
  46617. /** the position of the vertex (defaut: 0,0,0) */
  46618. position?: Vector3,
  46619. /** the normal of the vertex (defaut: 0,1,0) */
  46620. normal?: Vector3,
  46621. /** the uv of the vertex (default: 0,0) */
  46622. uv?: Vector2);
  46623. /**
  46624. * Clones the PositionNormalTextureVertex
  46625. * @returns the cloned PositionNormalTextureVertex
  46626. */
  46627. clone(): PositionNormalTextureVertex;
  46628. }
  46629. }
  46630. declare module "babylonjs/Maths/math" {
  46631. export * from "babylonjs/Maths/math.axis";
  46632. export * from "babylonjs/Maths/math.color";
  46633. export * from "babylonjs/Maths/math.constants";
  46634. export * from "babylonjs/Maths/math.frustum";
  46635. export * from "babylonjs/Maths/math.path";
  46636. export * from "babylonjs/Maths/math.plane";
  46637. export * from "babylonjs/Maths/math.size";
  46638. export * from "babylonjs/Maths/math.vector";
  46639. export * from "babylonjs/Maths/math.vertexFormat";
  46640. export * from "babylonjs/Maths/math.viewport";
  46641. }
  46642. declare module "babylonjs/Engines/Native/nativeShaderProcessor" {
  46643. import { WebGL2ShaderProcessor } from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  46644. /** @hidden */
  46645. export class NativeShaderProcessor extends WebGL2ShaderProcessor {
  46646. private _genericAttributeLocation;
  46647. private _varyingLocationCount;
  46648. private _varyingLocationMap;
  46649. private _replacements;
  46650. private _textureCount;
  46651. private _uniforms;
  46652. lineProcessor(line: string): string;
  46653. attributeProcessor(attribute: string): string;
  46654. varyingProcessor(varying: string, isFragment: boolean): string;
  46655. uniformProcessor(uniform: string): string;
  46656. preProcessor(code: string, defines: string[], isFragment: boolean): string;
  46657. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  46658. }
  46659. }
  46660. declare module "babylonjs/Engines/nativeEngine" {
  46661. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  46662. import { Engine } from "babylonjs/Engines/engine";
  46663. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  46664. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  46665. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  46666. import { Effect } from "babylonjs/Materials/effect";
  46667. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  46668. import { Color4, Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  46669. import { Scene } from "babylonjs/scene";
  46670. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  46671. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  46672. /**
  46673. * Container for accessors for natively-stored mesh data buffers.
  46674. */
  46675. class NativeDataBuffer extends DataBuffer {
  46676. /**
  46677. * Accessor value used to identify/retrieve a natively-stored index buffer.
  46678. */
  46679. nativeIndexBuffer?: any;
  46680. /**
  46681. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  46682. */
  46683. nativeVertexBuffer?: any;
  46684. }
  46685. /** @hidden */
  46686. class NativeTexture extends InternalTexture {
  46687. getInternalTexture(): InternalTexture;
  46688. getViewCount(): number;
  46689. }
  46690. /** @hidden */
  46691. export class NativeEngine extends Engine {
  46692. private readonly _native;
  46693. getHardwareScalingLevel(): number;
  46694. constructor();
  46695. /**
  46696. * Can be used to override the current requestAnimationFrame requester.
  46697. * @hidden
  46698. */
  46699. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  46700. /**
  46701. * Override default engine behavior.
  46702. * @param color
  46703. * @param backBuffer
  46704. * @param depth
  46705. * @param stencil
  46706. */
  46707. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  46708. clear(color: Color4, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  46709. createIndexBuffer(indices: IndicesArray): NativeDataBuffer;
  46710. createVertexBuffer(data: DataArray): NativeDataBuffer;
  46711. recordVertexArrayObject(vertexBuffers: {
  46712. [key: string]: VertexBuffer;
  46713. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  46714. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  46715. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  46716. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  46717. /**
  46718. * Draw a list of indexed primitives
  46719. * @param fillMode defines the primitive to use
  46720. * @param indexStart defines the starting index
  46721. * @param indexCount defines the number of index to draw
  46722. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46723. */
  46724. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  46725. /**
  46726. * Draw a list of unindexed primitives
  46727. * @param fillMode defines the primitive to use
  46728. * @param verticesStart defines the index of first vertex to draw
  46729. * @param verticesCount defines the count of vertices to draw
  46730. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46731. */
  46732. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  46733. createPipelineContext(): IPipelineContext;
  46734. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  46735. /** @hidden */
  46736. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  46737. /** @hidden */
  46738. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  46739. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  46740. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  46741. protected _setProgram(program: WebGLProgram): void;
  46742. _releaseEffect(effect: Effect): void;
  46743. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  46744. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  46745. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  46746. bindSamplers(effect: Effect): void;
  46747. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  46748. getRenderWidth(useScreen?: boolean): number;
  46749. getRenderHeight(useScreen?: boolean): number;
  46750. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  46751. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  46752. /**
  46753. * Set the z offset to apply to current rendering
  46754. * @param value defines the offset to apply
  46755. */
  46756. setZOffset(value: number): void;
  46757. /**
  46758. * Gets the current value of the zOffset
  46759. * @returns the current zOffset state
  46760. */
  46761. getZOffset(): number;
  46762. /**
  46763. * Enable or disable depth buffering
  46764. * @param enable defines the state to set
  46765. */
  46766. setDepthBuffer(enable: boolean): void;
  46767. /**
  46768. * Gets a boolean indicating if depth writing is enabled
  46769. * @returns the current depth writing state
  46770. */
  46771. getDepthWrite(): boolean;
  46772. /**
  46773. * Enable or disable depth writing
  46774. * @param enable defines the state to set
  46775. */
  46776. setDepthWrite(enable: boolean): void;
  46777. /**
  46778. * Enable or disable color writing
  46779. * @param enable defines the state to set
  46780. */
  46781. setColorWrite(enable: boolean): void;
  46782. /**
  46783. * Gets a boolean indicating if color writing is enabled
  46784. * @returns the current color writing state
  46785. */
  46786. getColorWrite(): boolean;
  46787. /**
  46788. * Sets alpha constants used by some alpha blending modes
  46789. * @param r defines the red component
  46790. * @param g defines the green component
  46791. * @param b defines the blue component
  46792. * @param a defines the alpha component
  46793. */
  46794. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  46795. /**
  46796. * Sets the current alpha mode
  46797. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  46798. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  46799. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  46800. */
  46801. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  46802. /**
  46803. * Gets the current alpha mode
  46804. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  46805. * @returns the current alpha mode
  46806. */
  46807. getAlphaMode(): number;
  46808. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  46809. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  46810. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  46811. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  46812. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  46813. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  46814. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  46815. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  46816. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  46817. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  46818. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  46819. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  46820. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  46821. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  46822. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  46823. setFloat(uniform: WebGLUniformLocation, value: number): void;
  46824. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  46825. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  46826. setBool(uniform: WebGLUniformLocation, bool: number): void;
  46827. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  46828. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  46829. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  46830. wipeCaches(bruteForce?: boolean): void;
  46831. _createTexture(): WebGLTexture;
  46832. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  46833. /**
  46834. * Usually called from BABYLON.Texture.ts.
  46835. * Passed information to create a WebGLTexture
  46836. * @param urlArg defines a value which contains one of the following:
  46837. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  46838. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  46839. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  46840. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  46841. * @param invertY when true, image is flipped when loaded. You probably want true. Ignored for compressed textures. Must be flipped in the file
  46842. * @param scene needed for loading to the correct scene
  46843. * @param samplingMode mode with should be used sample / access the texture (Default: BABYLON.Texture.TRILINEAR_SAMPLINGMODE)
  46844. * @param onLoad optional callback to be called upon successful completion
  46845. * @param onError optional callback to be called upon failure
  46846. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), or a Blob
  46847. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  46848. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  46849. * @param forcedExtension defines the extension to use to pick the right loader
  46850. * @returns a InternalTexture for assignment back into BABYLON.Texture
  46851. */
  46852. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<Scene>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | Blob>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>): InternalTexture;
  46853. /**
  46854. * Creates a cube texture
  46855. * @param rootUrl defines the url where the files to load is located
  46856. * @param scene defines the current scene
  46857. * @param files defines the list of files to load (1 per face)
  46858. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  46859. * @param onLoad defines an optional callback raised when the texture is loaded
  46860. * @param onError defines an optional callback raised if there is an issue to load the texture
  46861. * @param format defines the format of the data
  46862. * @param forcedExtension defines the extension to use to pick the right loader
  46863. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  46864. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  46865. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  46866. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  46867. * @returns the cube texture as an InternalTexture
  46868. */
  46869. 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;
  46870. private _getSamplingFilter;
  46871. private static _GetNativeTextureFormat;
  46872. createRenderTargetTexture(size: number | {
  46873. width: number;
  46874. height: number;
  46875. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  46876. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  46877. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  46878. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  46879. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  46880. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  46881. /**
  46882. * Updates a dynamic vertex buffer.
  46883. * @param vertexBuffer the vertex buffer to update
  46884. * @param data the data used to update the vertex buffer
  46885. * @param byteOffset the byte offset of the data (optional)
  46886. * @param byteLength the byte length of the data (optional)
  46887. */
  46888. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  46889. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  46890. private _updateAnisotropicLevel;
  46891. private _getAddressMode;
  46892. /** @hidden */
  46893. _bindTexture(channel: number, texture: InternalTexture): void;
  46894. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  46895. releaseEffects(): void;
  46896. /** @hidden */
  46897. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46898. /** @hidden */
  46899. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46900. /** @hidden */
  46901. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46902. /** @hidden */
  46903. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  46904. }
  46905. }
  46906. declare module "babylonjs/Engines/index" {
  46907. export * from "babylonjs/Engines/constants";
  46908. export * from "babylonjs/Engines/engineCapabilities";
  46909. export * from "babylonjs/Engines/instancingAttributeInfo";
  46910. export * from "babylonjs/Engines/thinEngine";
  46911. export * from "babylonjs/Engines/engine";
  46912. export * from "babylonjs/Engines/engineStore";
  46913. export * from "babylonjs/Engines/nullEngine";
  46914. export * from "babylonjs/Engines/Extensions/index";
  46915. export * from "babylonjs/Engines/IPipelineContext";
  46916. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  46917. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  46918. export * from "babylonjs/Engines/nativeEngine";
  46919. }
  46920. declare module "babylonjs/Events/clipboardEvents" {
  46921. /**
  46922. * Gather the list of clipboard event types as constants.
  46923. */
  46924. export class ClipboardEventTypes {
  46925. /**
  46926. * The clipboard event is fired when a copy command is active (pressed).
  46927. */
  46928. static readonly COPY: number;
  46929. /**
  46930. * The clipboard event is fired when a cut command is active (pressed).
  46931. */
  46932. static readonly CUT: number;
  46933. /**
  46934. * The clipboard event is fired when a paste command is active (pressed).
  46935. */
  46936. static readonly PASTE: number;
  46937. }
  46938. /**
  46939. * This class is used to store clipboard related info for the onClipboardObservable event.
  46940. */
  46941. export class ClipboardInfo {
  46942. /**
  46943. * Defines the type of event (BABYLON.ClipboardEventTypes)
  46944. */
  46945. type: number;
  46946. /**
  46947. * Defines the related dom event
  46948. */
  46949. event: ClipboardEvent;
  46950. /**
  46951. *Creates an instance of ClipboardInfo.
  46952. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  46953. * @param event Defines the related dom event
  46954. */
  46955. constructor(
  46956. /**
  46957. * Defines the type of event (BABYLON.ClipboardEventTypes)
  46958. */
  46959. type: number,
  46960. /**
  46961. * Defines the related dom event
  46962. */
  46963. event: ClipboardEvent);
  46964. /**
  46965. * Get the clipboard event's type from the keycode.
  46966. * @param keyCode Defines the keyCode for the current keyboard event.
  46967. * @return {number}
  46968. */
  46969. static GetTypeFromCharacter(keyCode: number): number;
  46970. }
  46971. }
  46972. declare module "babylonjs/Events/index" {
  46973. export * from "babylonjs/Events/keyboardEvents";
  46974. export * from "babylonjs/Events/pointerEvents";
  46975. export * from "babylonjs/Events/clipboardEvents";
  46976. }
  46977. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  46978. import { Scene } from "babylonjs/scene";
  46979. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46980. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  46981. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  46982. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  46983. /**
  46984. * Google Daydream controller
  46985. */
  46986. export class DaydreamController extends WebVRController {
  46987. /**
  46988. * Base Url for the controller model.
  46989. */
  46990. static MODEL_BASE_URL: string;
  46991. /**
  46992. * File name for the controller model.
  46993. */
  46994. static MODEL_FILENAME: string;
  46995. /**
  46996. * Gamepad Id prefix used to identify Daydream Controller.
  46997. */
  46998. static readonly GAMEPAD_ID_PREFIX: string;
  46999. /**
  47000. * Creates a new DaydreamController from a gamepad
  47001. * @param vrGamepad the gamepad that the controller should be created from
  47002. */
  47003. constructor(vrGamepad: any);
  47004. /**
  47005. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  47006. * @param scene scene in which to add meshes
  47007. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  47008. */
  47009. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  47010. /**
  47011. * Called once for each button that changed state since the last frame
  47012. * @param buttonIdx Which button index changed
  47013. * @param state New state of the button
  47014. * @param changes Which properties on the state changed since last frame
  47015. */
  47016. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  47017. }
  47018. }
  47019. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  47020. import { Scene } from "babylonjs/scene";
  47021. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47022. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  47023. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  47024. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  47025. /**
  47026. * Gear VR Controller
  47027. */
  47028. export class GearVRController extends WebVRController {
  47029. /**
  47030. * Base Url for the controller model.
  47031. */
  47032. static MODEL_BASE_URL: string;
  47033. /**
  47034. * File name for the controller model.
  47035. */
  47036. static MODEL_FILENAME: string;
  47037. /**
  47038. * Gamepad Id prefix used to identify this controller.
  47039. */
  47040. static readonly GAMEPAD_ID_PREFIX: string;
  47041. private readonly _buttonIndexToObservableNameMap;
  47042. /**
  47043. * Creates a new GearVRController from a gamepad
  47044. * @param vrGamepad the gamepad that the controller should be created from
  47045. */
  47046. constructor(vrGamepad: any);
  47047. /**
  47048. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  47049. * @param scene scene in which to add meshes
  47050. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  47051. */
  47052. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  47053. /**
  47054. * Called once for each button that changed state since the last frame
  47055. * @param buttonIdx Which button index changed
  47056. * @param state New state of the button
  47057. * @param changes Which properties on the state changed since last frame
  47058. */
  47059. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  47060. }
  47061. }
  47062. declare module "babylonjs/Gamepads/Controllers/index" {
  47063. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  47064. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  47065. export * from "babylonjs/Gamepads/Controllers/genericController";
  47066. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  47067. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  47068. export * from "babylonjs/Gamepads/Controllers/viveController";
  47069. export * from "babylonjs/Gamepads/Controllers/webVRController";
  47070. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  47071. }
  47072. declare module "babylonjs/Gamepads/index" {
  47073. export * from "babylonjs/Gamepads/Controllers/index";
  47074. export * from "babylonjs/Gamepads/gamepad";
  47075. export * from "babylonjs/Gamepads/gamepadManager";
  47076. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  47077. export * from "babylonjs/Gamepads/xboxGamepad";
  47078. export * from "babylonjs/Gamepads/dualShockGamepad";
  47079. }
  47080. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  47081. import { Scene } from "babylonjs/scene";
  47082. import { Vector4 } from "babylonjs/Maths/math.vector";
  47083. import { Color4 } from "babylonjs/Maths/math.color";
  47084. import { Mesh } from "babylonjs/Meshes/mesh";
  47085. import { Nullable } from "babylonjs/types";
  47086. /**
  47087. * Class containing static functions to help procedurally build meshes
  47088. */
  47089. export class PolyhedronBuilder {
  47090. /**
  47091. * Creates a polyhedron mesh
  47092. * * 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
  47093. * * The parameter `size` (positive float, default 1) sets the polygon size
  47094. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  47095. * * 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`
  47096. * * 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
  47097. * * 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)`)
  47098. * * 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
  47099. * * 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
  47100. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  47101. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  47102. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  47103. * @param name defines the name of the mesh
  47104. * @param options defines the options used to create the mesh
  47105. * @param scene defines the hosting scene
  47106. * @returns the polyhedron mesh
  47107. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  47108. */
  47109. static CreatePolyhedron(name: string, options: {
  47110. type?: number;
  47111. size?: number;
  47112. sizeX?: number;
  47113. sizeY?: number;
  47114. sizeZ?: number;
  47115. custom?: any;
  47116. faceUV?: Vector4[];
  47117. faceColors?: Color4[];
  47118. flat?: boolean;
  47119. updatable?: boolean;
  47120. sideOrientation?: number;
  47121. frontUVs?: Vector4;
  47122. backUVs?: Vector4;
  47123. }, scene?: Nullable<Scene>): Mesh;
  47124. }
  47125. }
  47126. declare module "babylonjs/Gizmos/scaleGizmo" {
  47127. import { Observable } from "babylonjs/Misc/observable";
  47128. import { Nullable } from "babylonjs/types";
  47129. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47130. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47131. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  47132. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47133. /**
  47134. * Gizmo that enables scaling a mesh along 3 axis
  47135. */
  47136. export class ScaleGizmo extends Gizmo {
  47137. /**
  47138. * Internal gizmo used for interactions on the x axis
  47139. */
  47140. xGizmo: AxisScaleGizmo;
  47141. /**
  47142. * Internal gizmo used for interactions on the y axis
  47143. */
  47144. yGizmo: AxisScaleGizmo;
  47145. /**
  47146. * Internal gizmo used for interactions on the z axis
  47147. */
  47148. zGizmo: AxisScaleGizmo;
  47149. /**
  47150. * Internal gizmo used to scale all axis equally
  47151. */
  47152. uniformScaleGizmo: AxisScaleGizmo;
  47153. private _meshAttached;
  47154. private _updateGizmoRotationToMatchAttachedMesh;
  47155. private _snapDistance;
  47156. private _scaleRatio;
  47157. private _uniformScalingMesh;
  47158. private _octahedron;
  47159. /** Fires an event when any of it's sub gizmos are dragged */
  47160. onDragStartObservable: Observable<unknown>;
  47161. /** Fires an event when any of it's sub gizmos are released from dragging */
  47162. onDragEndObservable: Observable<unknown>;
  47163. attachedMesh: Nullable<AbstractMesh>;
  47164. /**
  47165. * Creates a ScaleGizmo
  47166. * @param gizmoLayer The utility layer the gizmo will be added to
  47167. */
  47168. constructor(gizmoLayer?: UtilityLayerRenderer);
  47169. updateGizmoRotationToMatchAttachedMesh: boolean;
  47170. /**
  47171. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47172. */
  47173. snapDistance: number;
  47174. /**
  47175. * Ratio for the scale of the gizmo (Default: 1)
  47176. */
  47177. scaleRatio: number;
  47178. /**
  47179. * Disposes of the gizmo
  47180. */
  47181. dispose(): void;
  47182. }
  47183. }
  47184. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  47185. import { Observable } from "babylonjs/Misc/observable";
  47186. import { Nullable } from "babylonjs/types";
  47187. import { Vector3 } from "babylonjs/Maths/math.vector";
  47188. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47189. import { Mesh } from "babylonjs/Meshes/mesh";
  47190. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  47191. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47192. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47193. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  47194. import { Color3 } from "babylonjs/Maths/math.color";
  47195. /**
  47196. * Single axis scale gizmo
  47197. */
  47198. export class AxisScaleGizmo extends Gizmo {
  47199. /**
  47200. * Drag behavior responsible for the gizmos dragging interactions
  47201. */
  47202. dragBehavior: PointerDragBehavior;
  47203. private _pointerObserver;
  47204. /**
  47205. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47206. */
  47207. snapDistance: number;
  47208. /**
  47209. * Event that fires each time the gizmo snaps to a new location.
  47210. * * snapDistance is the the change in distance
  47211. */
  47212. onSnapObservable: Observable<{
  47213. snapDistance: number;
  47214. }>;
  47215. /**
  47216. * If the scaling operation should be done on all axis (default: false)
  47217. */
  47218. uniformScaling: boolean;
  47219. private _isEnabled;
  47220. private _parent;
  47221. private _arrow;
  47222. private _coloredMaterial;
  47223. private _hoverMaterial;
  47224. /**
  47225. * Creates an AxisScaleGizmo
  47226. * @param gizmoLayer The utility layer the gizmo will be added to
  47227. * @param dragAxis The axis which the gizmo will be able to scale on
  47228. * @param color The color of the gizmo
  47229. */
  47230. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  47231. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47232. /**
  47233. * If the gizmo is enabled
  47234. */
  47235. isEnabled: boolean;
  47236. /**
  47237. * Disposes of the gizmo
  47238. */
  47239. dispose(): void;
  47240. /**
  47241. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  47242. * @param mesh The mesh to replace the default mesh of the gizmo
  47243. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  47244. */
  47245. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  47246. }
  47247. }
  47248. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  47249. import { Observable } from "babylonjs/Misc/observable";
  47250. import { Nullable } from "babylonjs/types";
  47251. import { Vector3 } from "babylonjs/Maths/math.vector";
  47252. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47253. import { Mesh } from "babylonjs/Meshes/mesh";
  47254. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47255. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47256. import { Color3 } from "babylonjs/Maths/math.color";
  47257. import "babylonjs/Meshes/Builders/boxBuilder";
  47258. /**
  47259. * Bounding box gizmo
  47260. */
  47261. export class BoundingBoxGizmo extends Gizmo {
  47262. private _lineBoundingBox;
  47263. private _rotateSpheresParent;
  47264. private _scaleBoxesParent;
  47265. private _boundingDimensions;
  47266. private _renderObserver;
  47267. private _pointerObserver;
  47268. private _scaleDragSpeed;
  47269. private _tmpQuaternion;
  47270. private _tmpVector;
  47271. private _tmpRotationMatrix;
  47272. /**
  47273. * 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)
  47274. */
  47275. ignoreChildren: boolean;
  47276. /**
  47277. * 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)
  47278. */
  47279. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  47280. /**
  47281. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  47282. */
  47283. rotationSphereSize: number;
  47284. /**
  47285. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  47286. */
  47287. scaleBoxSize: number;
  47288. /**
  47289. * 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)
  47290. */
  47291. fixedDragMeshScreenSize: boolean;
  47292. /**
  47293. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  47294. */
  47295. fixedDragMeshScreenSizeDistanceFactor: number;
  47296. /**
  47297. * Fired when a rotation sphere or scale box is dragged
  47298. */
  47299. onDragStartObservable: Observable<{}>;
  47300. /**
  47301. * Fired when a scale box is dragged
  47302. */
  47303. onScaleBoxDragObservable: Observable<{}>;
  47304. /**
  47305. * Fired when a scale box drag is ended
  47306. */
  47307. onScaleBoxDragEndObservable: Observable<{}>;
  47308. /**
  47309. * Fired when a rotation sphere is dragged
  47310. */
  47311. onRotationSphereDragObservable: Observable<{}>;
  47312. /**
  47313. * Fired when a rotation sphere drag is ended
  47314. */
  47315. onRotationSphereDragEndObservable: Observable<{}>;
  47316. /**
  47317. * 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)
  47318. */
  47319. scalePivot: Nullable<Vector3>;
  47320. /**
  47321. * Mesh used as a pivot to rotate the attached mesh
  47322. */
  47323. private _anchorMesh;
  47324. private _existingMeshScale;
  47325. private _dragMesh;
  47326. private pointerDragBehavior;
  47327. private coloredMaterial;
  47328. private hoverColoredMaterial;
  47329. /**
  47330. * Sets the color of the bounding box gizmo
  47331. * @param color the color to set
  47332. */
  47333. setColor(color: Color3): void;
  47334. /**
  47335. * Creates an BoundingBoxGizmo
  47336. * @param gizmoLayer The utility layer the gizmo will be added to
  47337. * @param color The color of the gizmo
  47338. */
  47339. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  47340. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47341. private _selectNode;
  47342. /**
  47343. * Updates the bounding box information for the Gizmo
  47344. */
  47345. updateBoundingBox(): void;
  47346. private _updateRotationSpheres;
  47347. private _updateScaleBoxes;
  47348. /**
  47349. * Enables rotation on the specified axis and disables rotation on the others
  47350. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  47351. */
  47352. setEnabledRotationAxis(axis: string): void;
  47353. /**
  47354. * Enables/disables scaling
  47355. * @param enable if scaling should be enabled
  47356. */
  47357. setEnabledScaling(enable: boolean): void;
  47358. private _updateDummy;
  47359. /**
  47360. * Enables a pointer drag behavior on the bounding box of the gizmo
  47361. */
  47362. enableDragBehavior(): void;
  47363. /**
  47364. * Disposes of the gizmo
  47365. */
  47366. dispose(): void;
  47367. /**
  47368. * 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)
  47369. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  47370. * @returns the bounding box mesh with the passed in mesh as a child
  47371. */
  47372. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  47373. /**
  47374. * CustomMeshes are not supported by this gizmo
  47375. * @param mesh The mesh to replace the default mesh of the gizmo
  47376. */
  47377. setCustomMesh(mesh: Mesh): void;
  47378. }
  47379. }
  47380. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  47381. import { Observable } from "babylonjs/Misc/observable";
  47382. import { Nullable } from "babylonjs/types";
  47383. import { Vector3 } from "babylonjs/Maths/math.vector";
  47384. import { Color3 } from "babylonjs/Maths/math.color";
  47385. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47386. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  47387. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47388. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47389. import "babylonjs/Meshes/Builders/linesBuilder";
  47390. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  47391. /**
  47392. * Single plane rotation gizmo
  47393. */
  47394. export class PlaneRotationGizmo extends Gizmo {
  47395. /**
  47396. * Drag behavior responsible for the gizmos dragging interactions
  47397. */
  47398. dragBehavior: PointerDragBehavior;
  47399. private _pointerObserver;
  47400. /**
  47401. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  47402. */
  47403. snapDistance: number;
  47404. /**
  47405. * Event that fires each time the gizmo snaps to a new location.
  47406. * * snapDistance is the the change in distance
  47407. */
  47408. onSnapObservable: Observable<{
  47409. snapDistance: number;
  47410. }>;
  47411. private _isEnabled;
  47412. private _parent;
  47413. /**
  47414. * Creates a PlaneRotationGizmo
  47415. * @param gizmoLayer The utility layer the gizmo will be added to
  47416. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  47417. * @param color The color of the gizmo
  47418. * @param tessellation Amount of tessellation to be used when creating rotation circles
  47419. * @param useEulerRotation Use and update Euler angle instead of quaternion
  47420. */
  47421. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  47422. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47423. /**
  47424. * If the gizmo is enabled
  47425. */
  47426. isEnabled: boolean;
  47427. /**
  47428. * Disposes of the gizmo
  47429. */
  47430. dispose(): void;
  47431. }
  47432. }
  47433. declare module "babylonjs/Gizmos/rotationGizmo" {
  47434. import { Observable } from "babylonjs/Misc/observable";
  47435. import { Nullable } from "babylonjs/types";
  47436. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47437. import { Mesh } from "babylonjs/Meshes/mesh";
  47438. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47439. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  47440. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47441. /**
  47442. * Gizmo that enables rotating a mesh along 3 axis
  47443. */
  47444. export class RotationGizmo extends Gizmo {
  47445. /**
  47446. * Internal gizmo used for interactions on the x axis
  47447. */
  47448. xGizmo: PlaneRotationGizmo;
  47449. /**
  47450. * Internal gizmo used for interactions on the y axis
  47451. */
  47452. yGizmo: PlaneRotationGizmo;
  47453. /**
  47454. * Internal gizmo used for interactions on the z axis
  47455. */
  47456. zGizmo: PlaneRotationGizmo;
  47457. /** Fires an event when any of it's sub gizmos are dragged */
  47458. onDragStartObservable: Observable<unknown>;
  47459. /** Fires an event when any of it's sub gizmos are released from dragging */
  47460. onDragEndObservable: Observable<unknown>;
  47461. private _meshAttached;
  47462. attachedMesh: Nullable<AbstractMesh>;
  47463. /**
  47464. * Creates a RotationGizmo
  47465. * @param gizmoLayer The utility layer the gizmo will be added to
  47466. * @param tessellation Amount of tessellation to be used when creating rotation circles
  47467. * @param useEulerRotation Use and update Euler angle instead of quaternion
  47468. */
  47469. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  47470. updateGizmoRotationToMatchAttachedMesh: boolean;
  47471. /**
  47472. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47473. */
  47474. snapDistance: number;
  47475. /**
  47476. * Ratio for the scale of the gizmo (Default: 1)
  47477. */
  47478. scaleRatio: number;
  47479. /**
  47480. * Disposes of the gizmo
  47481. */
  47482. dispose(): void;
  47483. /**
  47484. * CustomMeshes are not supported by this gizmo
  47485. * @param mesh The mesh to replace the default mesh of the gizmo
  47486. */
  47487. setCustomMesh(mesh: Mesh): void;
  47488. }
  47489. }
  47490. declare module "babylonjs/Gizmos/gizmoManager" {
  47491. import { Observable } from "babylonjs/Misc/observable";
  47492. import { Nullable } from "babylonjs/types";
  47493. import { Scene, IDisposable } from "babylonjs/scene";
  47494. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47495. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47496. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  47497. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  47498. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  47499. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  47500. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  47501. /**
  47502. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  47503. */
  47504. export class GizmoManager implements IDisposable {
  47505. private scene;
  47506. /**
  47507. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  47508. */
  47509. gizmos: {
  47510. positionGizmo: Nullable<PositionGizmo>;
  47511. rotationGizmo: Nullable<RotationGizmo>;
  47512. scaleGizmo: Nullable<ScaleGizmo>;
  47513. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  47514. };
  47515. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  47516. clearGizmoOnEmptyPointerEvent: boolean;
  47517. /** Fires an event when the manager is attached to a mesh */
  47518. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  47519. private _gizmosEnabled;
  47520. private _pointerObserver;
  47521. private _attachedMesh;
  47522. private _boundingBoxColor;
  47523. private _defaultUtilityLayer;
  47524. private _defaultKeepDepthUtilityLayer;
  47525. /**
  47526. * When bounding box gizmo is enabled, this can be used to track drag/end events
  47527. */
  47528. boundingBoxDragBehavior: SixDofDragBehavior;
  47529. /**
  47530. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  47531. */
  47532. attachableMeshes: Nullable<Array<AbstractMesh>>;
  47533. /**
  47534. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  47535. */
  47536. usePointerToAttachGizmos: boolean;
  47537. /**
  47538. * Utility layer that the bounding box gizmo belongs to
  47539. */
  47540. readonly keepDepthUtilityLayer: UtilityLayerRenderer;
  47541. /**
  47542. * Utility layer that all gizmos besides bounding box belong to
  47543. */
  47544. readonly utilityLayer: UtilityLayerRenderer;
  47545. /**
  47546. * Instatiates a gizmo manager
  47547. * @param scene the scene to overlay the gizmos on top of
  47548. */
  47549. constructor(scene: Scene);
  47550. /**
  47551. * Attaches a set of gizmos to the specified mesh
  47552. * @param mesh The mesh the gizmo's should be attached to
  47553. */
  47554. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  47555. /**
  47556. * If the position gizmo is enabled
  47557. */
  47558. positionGizmoEnabled: boolean;
  47559. /**
  47560. * If the rotation gizmo is enabled
  47561. */
  47562. rotationGizmoEnabled: boolean;
  47563. /**
  47564. * If the scale gizmo is enabled
  47565. */
  47566. scaleGizmoEnabled: boolean;
  47567. /**
  47568. * If the boundingBox gizmo is enabled
  47569. */
  47570. boundingBoxGizmoEnabled: boolean;
  47571. /**
  47572. * Disposes of the gizmo manager
  47573. */
  47574. dispose(): void;
  47575. }
  47576. }
  47577. declare module "babylonjs/Lights/directionalLight" {
  47578. import { Camera } from "babylonjs/Cameras/camera";
  47579. import { Scene } from "babylonjs/scene";
  47580. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  47581. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47582. import { Light } from "babylonjs/Lights/light";
  47583. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  47584. import { Effect } from "babylonjs/Materials/effect";
  47585. /**
  47586. * A directional light is defined by a direction (what a surprise!).
  47587. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  47588. * 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.
  47589. * Documentation: https://doc.babylonjs.com/babylon101/lights
  47590. */
  47591. export class DirectionalLight extends ShadowLight {
  47592. private _shadowFrustumSize;
  47593. /**
  47594. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  47595. */
  47596. /**
  47597. * Specifies a fix frustum size for the shadow generation.
  47598. */
  47599. shadowFrustumSize: number;
  47600. private _shadowOrthoScale;
  47601. /**
  47602. * Gets the shadow projection scale against the optimal computed one.
  47603. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  47604. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  47605. */
  47606. /**
  47607. * Sets the shadow projection scale against the optimal computed one.
  47608. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  47609. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  47610. */
  47611. shadowOrthoScale: number;
  47612. /**
  47613. * Automatically compute the projection matrix to best fit (including all the casters)
  47614. * on each frame.
  47615. */
  47616. autoUpdateExtends: boolean;
  47617. private _orthoLeft;
  47618. private _orthoRight;
  47619. private _orthoTop;
  47620. private _orthoBottom;
  47621. /**
  47622. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  47623. * The directional light is emitted from everywhere in the given direction.
  47624. * It can cast shadows.
  47625. * Documentation : https://doc.babylonjs.com/babylon101/lights
  47626. * @param name The friendly name of the light
  47627. * @param direction The direction of the light
  47628. * @param scene The scene the light belongs to
  47629. */
  47630. constructor(name: string, direction: Vector3, scene: Scene);
  47631. /**
  47632. * Returns the string "DirectionalLight".
  47633. * @return The class name
  47634. */
  47635. getClassName(): string;
  47636. /**
  47637. * Returns the integer 1.
  47638. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  47639. */
  47640. getTypeID(): number;
  47641. /**
  47642. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  47643. * Returns the DirectionalLight Shadow projection matrix.
  47644. */
  47645. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  47646. /**
  47647. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  47648. * Returns the DirectionalLight Shadow projection matrix.
  47649. */
  47650. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  47651. /**
  47652. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  47653. * Returns the DirectionalLight Shadow projection matrix.
  47654. */
  47655. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  47656. protected _buildUniformLayout(): void;
  47657. /**
  47658. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  47659. * @param effect The effect to update
  47660. * @param lightIndex The index of the light in the effect to update
  47661. * @returns The directional light
  47662. */
  47663. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  47664. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  47665. /**
  47666. * Gets the minZ used for shadow according to both the scene and the light.
  47667. *
  47668. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  47669. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  47670. * @param activeCamera The camera we are returning the min for
  47671. * @returns the depth min z
  47672. */
  47673. getDepthMinZ(activeCamera: Camera): number;
  47674. /**
  47675. * Gets the maxZ used for shadow according to both the scene and the light.
  47676. *
  47677. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  47678. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  47679. * @param activeCamera The camera we are returning the max for
  47680. * @returns the depth max z
  47681. */
  47682. getDepthMaxZ(activeCamera: Camera): number;
  47683. /**
  47684. * Prepares the list of defines specific to the light type.
  47685. * @param defines the list of defines
  47686. * @param lightIndex defines the index of the light for the effect
  47687. */
  47688. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  47689. }
  47690. }
  47691. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  47692. import { Mesh } from "babylonjs/Meshes/mesh";
  47693. /**
  47694. * Class containing static functions to help procedurally build meshes
  47695. */
  47696. export class HemisphereBuilder {
  47697. /**
  47698. * Creates a hemisphere mesh
  47699. * @param name defines the name of the mesh
  47700. * @param options defines the options used to create the mesh
  47701. * @param scene defines the hosting scene
  47702. * @returns the hemisphere mesh
  47703. */
  47704. static CreateHemisphere(name: string, options: {
  47705. segments?: number;
  47706. diameter?: number;
  47707. sideOrientation?: number;
  47708. }, scene: any): Mesh;
  47709. }
  47710. }
  47711. declare module "babylonjs/Lights/spotLight" {
  47712. import { Nullable } from "babylonjs/types";
  47713. import { Scene } from "babylonjs/scene";
  47714. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  47715. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47716. import { Effect } from "babylonjs/Materials/effect";
  47717. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47718. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  47719. /**
  47720. * A spot light is defined by a position, a direction, an angle, and an exponent.
  47721. * These values define a cone of light starting from the position, emitting toward the direction.
  47722. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  47723. * and the exponent defines the speed of the decay of the light with distance (reach).
  47724. * Documentation: https://doc.babylonjs.com/babylon101/lights
  47725. */
  47726. export class SpotLight extends ShadowLight {
  47727. private _angle;
  47728. private _innerAngle;
  47729. private _cosHalfAngle;
  47730. private _lightAngleScale;
  47731. private _lightAngleOffset;
  47732. /**
  47733. * Gets the cone angle of the spot light in Radians.
  47734. */
  47735. /**
  47736. * Sets the cone angle of the spot light in Radians.
  47737. */
  47738. angle: number;
  47739. /**
  47740. * Only used in gltf falloff mode, this defines the angle where
  47741. * the directional falloff will start before cutting at angle which could be seen
  47742. * as outer angle.
  47743. */
  47744. /**
  47745. * Only used in gltf falloff mode, this defines the angle where
  47746. * the directional falloff will start before cutting at angle which could be seen
  47747. * as outer angle.
  47748. */
  47749. innerAngle: number;
  47750. private _shadowAngleScale;
  47751. /**
  47752. * Allows scaling the angle of the light for shadow generation only.
  47753. */
  47754. /**
  47755. * Allows scaling the angle of the light for shadow generation only.
  47756. */
  47757. shadowAngleScale: number;
  47758. /**
  47759. * The light decay speed with the distance from the emission spot.
  47760. */
  47761. exponent: number;
  47762. private _projectionTextureMatrix;
  47763. /**
  47764. * Allows reading the projecton texture
  47765. */
  47766. readonly projectionTextureMatrix: Matrix;
  47767. protected _projectionTextureLightNear: number;
  47768. /**
  47769. * Gets the near clip of the Spotlight for texture projection.
  47770. */
  47771. /**
  47772. * Sets the near clip of the Spotlight for texture projection.
  47773. */
  47774. projectionTextureLightNear: number;
  47775. protected _projectionTextureLightFar: number;
  47776. /**
  47777. * Gets the far clip of the Spotlight for texture projection.
  47778. */
  47779. /**
  47780. * Sets the far clip of the Spotlight for texture projection.
  47781. */
  47782. projectionTextureLightFar: number;
  47783. protected _projectionTextureUpDirection: Vector3;
  47784. /**
  47785. * Gets the Up vector of the Spotlight for texture projection.
  47786. */
  47787. /**
  47788. * Sets the Up vector of the Spotlight for texture projection.
  47789. */
  47790. projectionTextureUpDirection: Vector3;
  47791. private _projectionTexture;
  47792. /**
  47793. * Gets the projection texture of the light.
  47794. */
  47795. /**
  47796. * Sets the projection texture of the light.
  47797. */
  47798. projectionTexture: Nullable<BaseTexture>;
  47799. private _projectionTextureViewLightDirty;
  47800. private _projectionTextureProjectionLightDirty;
  47801. private _projectionTextureDirty;
  47802. private _projectionTextureViewTargetVector;
  47803. private _projectionTextureViewLightMatrix;
  47804. private _projectionTextureProjectionLightMatrix;
  47805. private _projectionTextureScalingMatrix;
  47806. /**
  47807. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  47808. * It can cast shadows.
  47809. * Documentation : https://doc.babylonjs.com/babylon101/lights
  47810. * @param name The light friendly name
  47811. * @param position The position of the spot light in the scene
  47812. * @param direction The direction of the light in the scene
  47813. * @param angle The cone angle of the light in Radians
  47814. * @param exponent The light decay speed with the distance from the emission spot
  47815. * @param scene The scene the lights belongs to
  47816. */
  47817. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  47818. /**
  47819. * Returns the string "SpotLight".
  47820. * @returns the class name
  47821. */
  47822. getClassName(): string;
  47823. /**
  47824. * Returns the integer 2.
  47825. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  47826. */
  47827. getTypeID(): number;
  47828. /**
  47829. * Overrides the direction setter to recompute the projection texture view light Matrix.
  47830. */
  47831. protected _setDirection(value: Vector3): void;
  47832. /**
  47833. * Overrides the position setter to recompute the projection texture view light Matrix.
  47834. */
  47835. protected _setPosition(value: Vector3): void;
  47836. /**
  47837. * 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.
  47838. * Returns the SpotLight.
  47839. */
  47840. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  47841. protected _computeProjectionTextureViewLightMatrix(): void;
  47842. protected _computeProjectionTextureProjectionLightMatrix(): void;
  47843. /**
  47844. * Main function for light texture projection matrix computing.
  47845. */
  47846. protected _computeProjectionTextureMatrix(): void;
  47847. protected _buildUniformLayout(): void;
  47848. private _computeAngleValues;
  47849. /**
  47850. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  47851. * @param effect The effect to update
  47852. * @param lightIndex The index of the light in the effect to update
  47853. * @returns The spot light
  47854. */
  47855. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  47856. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  47857. /**
  47858. * Disposes the light and the associated resources.
  47859. */
  47860. dispose(): void;
  47861. /**
  47862. * Prepares the list of defines specific to the light type.
  47863. * @param defines the list of defines
  47864. * @param lightIndex defines the index of the light for the effect
  47865. */
  47866. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  47867. }
  47868. }
  47869. declare module "babylonjs/Gizmos/lightGizmo" {
  47870. import { Nullable } from "babylonjs/types";
  47871. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47872. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47873. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  47874. import { Light } from "babylonjs/Lights/light";
  47875. /**
  47876. * Gizmo that enables viewing a light
  47877. */
  47878. export class LightGizmo extends Gizmo {
  47879. private _lightMesh;
  47880. private _material;
  47881. private cachedPosition;
  47882. private cachedForward;
  47883. /**
  47884. * Creates a LightGizmo
  47885. * @param gizmoLayer The utility layer the gizmo will be added to
  47886. */
  47887. constructor(gizmoLayer?: UtilityLayerRenderer);
  47888. private _light;
  47889. /**
  47890. * The light that the gizmo is attached to
  47891. */
  47892. light: Nullable<Light>;
  47893. /**
  47894. * Gets the material used to render the light gizmo
  47895. */
  47896. readonly material: StandardMaterial;
  47897. /**
  47898. * @hidden
  47899. * Updates the gizmo to match the attached mesh's position/rotation
  47900. */
  47901. protected _update(): void;
  47902. private static _Scale;
  47903. /**
  47904. * Creates the lines for a light mesh
  47905. */
  47906. private static _createLightLines;
  47907. /**
  47908. * Disposes of the light gizmo
  47909. */
  47910. dispose(): void;
  47911. private static _CreateHemisphericLightMesh;
  47912. private static _CreatePointLightMesh;
  47913. private static _CreateSpotLightMesh;
  47914. private static _CreateDirectionalLightMesh;
  47915. }
  47916. }
  47917. declare module "babylonjs/Gizmos/index" {
  47918. export * from "babylonjs/Gizmos/axisDragGizmo";
  47919. export * from "babylonjs/Gizmos/axisScaleGizmo";
  47920. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  47921. export * from "babylonjs/Gizmos/gizmo";
  47922. export * from "babylonjs/Gizmos/gizmoManager";
  47923. export * from "babylonjs/Gizmos/planeRotationGizmo";
  47924. export * from "babylonjs/Gizmos/positionGizmo";
  47925. export * from "babylonjs/Gizmos/rotationGizmo";
  47926. export * from "babylonjs/Gizmos/scaleGizmo";
  47927. export * from "babylonjs/Gizmos/lightGizmo";
  47928. export * from "babylonjs/Gizmos/planeDragGizmo";
  47929. }
  47930. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  47931. /** @hidden */
  47932. export var backgroundFragmentDeclaration: {
  47933. name: string;
  47934. shader: string;
  47935. };
  47936. }
  47937. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  47938. /** @hidden */
  47939. export var backgroundUboDeclaration: {
  47940. name: string;
  47941. shader: string;
  47942. };
  47943. }
  47944. declare module "babylonjs/Shaders/background.fragment" {
  47945. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  47946. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  47947. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  47948. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  47949. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  47950. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  47951. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  47952. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  47953. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  47954. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  47955. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  47956. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  47957. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  47958. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  47959. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  47960. /** @hidden */
  47961. export var backgroundPixelShader: {
  47962. name: string;
  47963. shader: string;
  47964. };
  47965. }
  47966. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  47967. /** @hidden */
  47968. export var backgroundVertexDeclaration: {
  47969. name: string;
  47970. shader: string;
  47971. };
  47972. }
  47973. declare module "babylonjs/Shaders/background.vertex" {
  47974. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  47975. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  47976. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  47977. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  47978. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  47979. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  47980. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  47981. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  47982. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  47983. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  47984. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  47985. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  47986. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  47987. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  47988. /** @hidden */
  47989. export var backgroundVertexShader: {
  47990. name: string;
  47991. shader: string;
  47992. };
  47993. }
  47994. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  47995. import { Nullable, int, float } from "babylonjs/types";
  47996. import { Scene } from "babylonjs/scene";
  47997. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  47998. import { SubMesh } from "babylonjs/Meshes/subMesh";
  47999. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48000. import { Mesh } from "babylonjs/Meshes/mesh";
  48001. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  48002. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  48003. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  48004. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48005. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  48006. import { Color3 } from "babylonjs/Maths/math.color";
  48007. import "babylonjs/Shaders/background.fragment";
  48008. import "babylonjs/Shaders/background.vertex";
  48009. /**
  48010. * Background material used to create an efficient environement around your scene.
  48011. */
  48012. export class BackgroundMaterial extends PushMaterial {
  48013. /**
  48014. * Standard reflectance value at parallel view angle.
  48015. */
  48016. static StandardReflectance0: number;
  48017. /**
  48018. * Standard reflectance value at grazing angle.
  48019. */
  48020. static StandardReflectance90: number;
  48021. protected _primaryColor: Color3;
  48022. /**
  48023. * Key light Color (multiply against the environement texture)
  48024. */
  48025. primaryColor: Color3;
  48026. protected __perceptualColor: Nullable<Color3>;
  48027. /**
  48028. * Experimental Internal Use Only.
  48029. *
  48030. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  48031. * This acts as a helper to set the primary color to a more "human friendly" value.
  48032. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  48033. * output color as close as possible from the chosen value.
  48034. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  48035. * part of lighting setup.)
  48036. */
  48037. _perceptualColor: Nullable<Color3>;
  48038. protected _primaryColorShadowLevel: float;
  48039. /**
  48040. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  48041. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  48042. */
  48043. primaryColorShadowLevel: float;
  48044. protected _primaryColorHighlightLevel: float;
  48045. /**
  48046. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  48047. * The primary color is used at the level chosen to define what the white area would look.
  48048. */
  48049. primaryColorHighlightLevel: float;
  48050. protected _reflectionTexture: Nullable<BaseTexture>;
  48051. /**
  48052. * Reflection Texture used in the material.
  48053. * Should be author in a specific way for the best result (refer to the documentation).
  48054. */
  48055. reflectionTexture: Nullable<BaseTexture>;
  48056. protected _reflectionBlur: float;
  48057. /**
  48058. * Reflection Texture level of blur.
  48059. *
  48060. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  48061. * texture twice.
  48062. */
  48063. reflectionBlur: float;
  48064. protected _diffuseTexture: Nullable<BaseTexture>;
  48065. /**
  48066. * Diffuse Texture used in the material.
  48067. * Should be author in a specific way for the best result (refer to the documentation).
  48068. */
  48069. diffuseTexture: Nullable<BaseTexture>;
  48070. protected _shadowLights: Nullable<IShadowLight[]>;
  48071. /**
  48072. * Specify the list of lights casting shadow on the material.
  48073. * All scene shadow lights will be included if null.
  48074. */
  48075. shadowLights: Nullable<IShadowLight[]>;
  48076. protected _shadowLevel: float;
  48077. /**
  48078. * Helps adjusting the shadow to a softer level if required.
  48079. * 0 means black shadows and 1 means no shadows.
  48080. */
  48081. shadowLevel: float;
  48082. protected _sceneCenter: Vector3;
  48083. /**
  48084. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  48085. * It is usually zero but might be interesting to modify according to your setup.
  48086. */
  48087. sceneCenter: Vector3;
  48088. protected _opacityFresnel: boolean;
  48089. /**
  48090. * This helps specifying that the material is falling off to the sky box at grazing angle.
  48091. * This helps ensuring a nice transition when the camera goes under the ground.
  48092. */
  48093. opacityFresnel: boolean;
  48094. protected _reflectionFresnel: boolean;
  48095. /**
  48096. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  48097. * This helps adding a mirror texture on the ground.
  48098. */
  48099. reflectionFresnel: boolean;
  48100. protected _reflectionFalloffDistance: number;
  48101. /**
  48102. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  48103. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  48104. */
  48105. reflectionFalloffDistance: number;
  48106. protected _reflectionAmount: number;
  48107. /**
  48108. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  48109. */
  48110. reflectionAmount: number;
  48111. protected _reflectionReflectance0: number;
  48112. /**
  48113. * This specifies the weight of the reflection at grazing angle.
  48114. */
  48115. reflectionReflectance0: number;
  48116. protected _reflectionReflectance90: number;
  48117. /**
  48118. * This specifies the weight of the reflection at a perpendicular point of view.
  48119. */
  48120. reflectionReflectance90: number;
  48121. /**
  48122. * Sets the reflection reflectance fresnel values according to the default standard
  48123. * empirically know to work well :-)
  48124. */
  48125. reflectionStandardFresnelWeight: number;
  48126. protected _useRGBColor: boolean;
  48127. /**
  48128. * Helps to directly use the maps channels instead of their level.
  48129. */
  48130. useRGBColor: boolean;
  48131. protected _enableNoise: boolean;
  48132. /**
  48133. * This helps reducing the banding effect that could occur on the background.
  48134. */
  48135. enableNoise: boolean;
  48136. /**
  48137. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  48138. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  48139. * Recommended to be keep at 1.0 except for special cases.
  48140. */
  48141. fovMultiplier: number;
  48142. private _fovMultiplier;
  48143. /**
  48144. * Enable the FOV adjustment feature controlled by fovMultiplier.
  48145. */
  48146. useEquirectangularFOV: boolean;
  48147. private _maxSimultaneousLights;
  48148. /**
  48149. * Number of Simultaneous lights allowed on the material.
  48150. */
  48151. maxSimultaneousLights: int;
  48152. /**
  48153. * Default configuration related to image processing available in the Background Material.
  48154. */
  48155. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  48156. /**
  48157. * Keep track of the image processing observer to allow dispose and replace.
  48158. */
  48159. private _imageProcessingObserver;
  48160. /**
  48161. * Attaches a new image processing configuration to the PBR Material.
  48162. * @param configuration (if null the scene configuration will be use)
  48163. */
  48164. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  48165. /**
  48166. * Gets the image processing configuration used either in this material.
  48167. */
  48168. /**
  48169. * Sets the Default image processing configuration used either in the this material.
  48170. *
  48171. * If sets to null, the scene one is in use.
  48172. */
  48173. imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  48174. /**
  48175. * Gets wether the color curves effect is enabled.
  48176. */
  48177. /**
  48178. * Sets wether the color curves effect is enabled.
  48179. */
  48180. cameraColorCurvesEnabled: boolean;
  48181. /**
  48182. * Gets wether the color grading effect is enabled.
  48183. */
  48184. /**
  48185. * Gets wether the color grading effect is enabled.
  48186. */
  48187. cameraColorGradingEnabled: boolean;
  48188. /**
  48189. * Gets wether tonemapping is enabled or not.
  48190. */
  48191. /**
  48192. * Sets wether tonemapping is enabled or not
  48193. */
  48194. cameraToneMappingEnabled: boolean;
  48195. /**
  48196. * The camera exposure used on this material.
  48197. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  48198. * This corresponds to a photographic exposure.
  48199. */
  48200. /**
  48201. * The camera exposure used on this material.
  48202. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  48203. * This corresponds to a photographic exposure.
  48204. */
  48205. cameraExposure: float;
  48206. /**
  48207. * Gets The camera contrast used on this material.
  48208. */
  48209. /**
  48210. * Sets The camera contrast used on this material.
  48211. */
  48212. cameraContrast: float;
  48213. /**
  48214. * Gets the Color Grading 2D Lookup Texture.
  48215. */
  48216. /**
  48217. * Sets the Color Grading 2D Lookup Texture.
  48218. */
  48219. cameraColorGradingTexture: Nullable<BaseTexture>;
  48220. /**
  48221. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  48222. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  48223. * 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;
  48224. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  48225. */
  48226. /**
  48227. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  48228. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  48229. * 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;
  48230. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  48231. */
  48232. cameraColorCurves: Nullable<ColorCurves>;
  48233. /**
  48234. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  48235. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  48236. */
  48237. switchToBGR: boolean;
  48238. private _renderTargets;
  48239. private _reflectionControls;
  48240. private _white;
  48241. private _primaryShadowColor;
  48242. private _primaryHighlightColor;
  48243. /**
  48244. * Instantiates a Background Material in the given scene
  48245. * @param name The friendly name of the material
  48246. * @param scene The scene to add the material to
  48247. */
  48248. constructor(name: string, scene: Scene);
  48249. /**
  48250. * Gets a boolean indicating that current material needs to register RTT
  48251. */
  48252. readonly hasRenderTargetTextures: boolean;
  48253. /**
  48254. * The entire material has been created in order to prevent overdraw.
  48255. * @returns false
  48256. */
  48257. needAlphaTesting(): boolean;
  48258. /**
  48259. * The entire material has been created in order to prevent overdraw.
  48260. * @returns true if blending is enable
  48261. */
  48262. needAlphaBlending(): boolean;
  48263. /**
  48264. * Checks wether the material is ready to be rendered for a given mesh.
  48265. * @param mesh The mesh to render
  48266. * @param subMesh The submesh to check against
  48267. * @param useInstances Specify wether or not the material is used with instances
  48268. * @returns true if all the dependencies are ready (Textures, Effects...)
  48269. */
  48270. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  48271. /**
  48272. * Compute the primary color according to the chosen perceptual color.
  48273. */
  48274. private _computePrimaryColorFromPerceptualColor;
  48275. /**
  48276. * Compute the highlights and shadow colors according to their chosen levels.
  48277. */
  48278. private _computePrimaryColors;
  48279. /**
  48280. * Build the uniform buffer used in the material.
  48281. */
  48282. buildUniformLayout(): void;
  48283. /**
  48284. * Unbind the material.
  48285. */
  48286. unbind(): void;
  48287. /**
  48288. * Bind only the world matrix to the material.
  48289. * @param world The world matrix to bind.
  48290. */
  48291. bindOnlyWorldMatrix(world: Matrix): void;
  48292. /**
  48293. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  48294. * @param world The world matrix to bind.
  48295. * @param subMesh The submesh to bind for.
  48296. */
  48297. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  48298. /**
  48299. * Checks to see if a texture is used in the material.
  48300. * @param texture - Base texture to use.
  48301. * @returns - Boolean specifying if a texture is used in the material.
  48302. */
  48303. hasTexture(texture: BaseTexture): boolean;
  48304. /**
  48305. * Dispose the material.
  48306. * @param forceDisposeEffect Force disposal of the associated effect.
  48307. * @param forceDisposeTextures Force disposal of the associated textures.
  48308. */
  48309. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  48310. /**
  48311. * Clones the material.
  48312. * @param name The cloned name.
  48313. * @returns The cloned material.
  48314. */
  48315. clone(name: string): BackgroundMaterial;
  48316. /**
  48317. * Serializes the current material to its JSON representation.
  48318. * @returns The JSON representation.
  48319. */
  48320. serialize(): any;
  48321. /**
  48322. * Gets the class name of the material
  48323. * @returns "BackgroundMaterial"
  48324. */
  48325. getClassName(): string;
  48326. /**
  48327. * Parse a JSON input to create back a background material.
  48328. * @param source The JSON data to parse
  48329. * @param scene The scene to create the parsed material in
  48330. * @param rootUrl The root url of the assets the material depends upon
  48331. * @returns the instantiated BackgroundMaterial.
  48332. */
  48333. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  48334. }
  48335. }
  48336. declare module "babylonjs/Helpers/environmentHelper" {
  48337. import { Observable } from "babylonjs/Misc/observable";
  48338. import { Nullable } from "babylonjs/types";
  48339. import { Scene } from "babylonjs/scene";
  48340. import { Vector3 } from "babylonjs/Maths/math.vector";
  48341. import { Color3 } from "babylonjs/Maths/math.color";
  48342. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48343. import { Mesh } from "babylonjs/Meshes/mesh";
  48344. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48345. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  48346. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  48347. import "babylonjs/Meshes/Builders/planeBuilder";
  48348. import "babylonjs/Meshes/Builders/boxBuilder";
  48349. /**
  48350. * Represents the different options available during the creation of
  48351. * a Environment helper.
  48352. *
  48353. * This can control the default ground, skybox and image processing setup of your scene.
  48354. */
  48355. export interface IEnvironmentHelperOptions {
  48356. /**
  48357. * Specifies wether or not to create a ground.
  48358. * True by default.
  48359. */
  48360. createGround: boolean;
  48361. /**
  48362. * Specifies the ground size.
  48363. * 15 by default.
  48364. */
  48365. groundSize: number;
  48366. /**
  48367. * The texture used on the ground for the main color.
  48368. * Comes from the BabylonJS CDN by default.
  48369. *
  48370. * Remarks: Can be either a texture or a url.
  48371. */
  48372. groundTexture: string | BaseTexture;
  48373. /**
  48374. * The color mixed in the ground texture by default.
  48375. * BabylonJS clearColor by default.
  48376. */
  48377. groundColor: Color3;
  48378. /**
  48379. * Specifies the ground opacity.
  48380. * 1 by default.
  48381. */
  48382. groundOpacity: number;
  48383. /**
  48384. * Enables the ground to receive shadows.
  48385. * True by default.
  48386. */
  48387. enableGroundShadow: boolean;
  48388. /**
  48389. * Helps preventing the shadow to be fully black on the ground.
  48390. * 0.5 by default.
  48391. */
  48392. groundShadowLevel: number;
  48393. /**
  48394. * Creates a mirror texture attach to the ground.
  48395. * false by default.
  48396. */
  48397. enableGroundMirror: boolean;
  48398. /**
  48399. * Specifies the ground mirror size ratio.
  48400. * 0.3 by default as the default kernel is 64.
  48401. */
  48402. groundMirrorSizeRatio: number;
  48403. /**
  48404. * Specifies the ground mirror blur kernel size.
  48405. * 64 by default.
  48406. */
  48407. groundMirrorBlurKernel: number;
  48408. /**
  48409. * Specifies the ground mirror visibility amount.
  48410. * 1 by default
  48411. */
  48412. groundMirrorAmount: number;
  48413. /**
  48414. * Specifies the ground mirror reflectance weight.
  48415. * This uses the standard weight of the background material to setup the fresnel effect
  48416. * of the mirror.
  48417. * 1 by default.
  48418. */
  48419. groundMirrorFresnelWeight: number;
  48420. /**
  48421. * Specifies the ground mirror Falloff distance.
  48422. * This can helps reducing the size of the reflection.
  48423. * 0 by Default.
  48424. */
  48425. groundMirrorFallOffDistance: number;
  48426. /**
  48427. * Specifies the ground mirror texture type.
  48428. * Unsigned Int by Default.
  48429. */
  48430. groundMirrorTextureType: number;
  48431. /**
  48432. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  48433. * the shown objects.
  48434. */
  48435. groundYBias: number;
  48436. /**
  48437. * Specifies wether or not to create a skybox.
  48438. * True by default.
  48439. */
  48440. createSkybox: boolean;
  48441. /**
  48442. * Specifies the skybox size.
  48443. * 20 by default.
  48444. */
  48445. skyboxSize: number;
  48446. /**
  48447. * The texture used on the skybox for the main color.
  48448. * Comes from the BabylonJS CDN by default.
  48449. *
  48450. * Remarks: Can be either a texture or a url.
  48451. */
  48452. skyboxTexture: string | BaseTexture;
  48453. /**
  48454. * The color mixed in the skybox texture by default.
  48455. * BabylonJS clearColor by default.
  48456. */
  48457. skyboxColor: Color3;
  48458. /**
  48459. * The background rotation around the Y axis of the scene.
  48460. * This helps aligning the key lights of your scene with the background.
  48461. * 0 by default.
  48462. */
  48463. backgroundYRotation: number;
  48464. /**
  48465. * Compute automatically the size of the elements to best fit with the scene.
  48466. */
  48467. sizeAuto: boolean;
  48468. /**
  48469. * Default position of the rootMesh if autoSize is not true.
  48470. */
  48471. rootPosition: Vector3;
  48472. /**
  48473. * Sets up the image processing in the scene.
  48474. * true by default.
  48475. */
  48476. setupImageProcessing: boolean;
  48477. /**
  48478. * The texture used as your environment texture in the scene.
  48479. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  48480. *
  48481. * Remarks: Can be either a texture or a url.
  48482. */
  48483. environmentTexture: string | BaseTexture;
  48484. /**
  48485. * The value of the exposure to apply to the scene.
  48486. * 0.6 by default if setupImageProcessing is true.
  48487. */
  48488. cameraExposure: number;
  48489. /**
  48490. * The value of the contrast to apply to the scene.
  48491. * 1.6 by default if setupImageProcessing is true.
  48492. */
  48493. cameraContrast: number;
  48494. /**
  48495. * Specifies wether or not tonemapping should be enabled in the scene.
  48496. * true by default if setupImageProcessing is true.
  48497. */
  48498. toneMappingEnabled: boolean;
  48499. }
  48500. /**
  48501. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  48502. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  48503. * It also helps with the default setup of your imageProcessing configuration.
  48504. */
  48505. export class EnvironmentHelper {
  48506. /**
  48507. * Default ground texture URL.
  48508. */
  48509. private static _groundTextureCDNUrl;
  48510. /**
  48511. * Default skybox texture URL.
  48512. */
  48513. private static _skyboxTextureCDNUrl;
  48514. /**
  48515. * Default environment texture URL.
  48516. */
  48517. private static _environmentTextureCDNUrl;
  48518. /**
  48519. * Creates the default options for the helper.
  48520. */
  48521. private static _getDefaultOptions;
  48522. private _rootMesh;
  48523. /**
  48524. * Gets the root mesh created by the helper.
  48525. */
  48526. readonly rootMesh: Mesh;
  48527. private _skybox;
  48528. /**
  48529. * Gets the skybox created by the helper.
  48530. */
  48531. readonly skybox: Nullable<Mesh>;
  48532. private _skyboxTexture;
  48533. /**
  48534. * Gets the skybox texture created by the helper.
  48535. */
  48536. readonly skyboxTexture: Nullable<BaseTexture>;
  48537. private _skyboxMaterial;
  48538. /**
  48539. * Gets the skybox material created by the helper.
  48540. */
  48541. readonly skyboxMaterial: Nullable<BackgroundMaterial>;
  48542. private _ground;
  48543. /**
  48544. * Gets the ground mesh created by the helper.
  48545. */
  48546. readonly ground: Nullable<Mesh>;
  48547. private _groundTexture;
  48548. /**
  48549. * Gets the ground texture created by the helper.
  48550. */
  48551. readonly groundTexture: Nullable<BaseTexture>;
  48552. private _groundMirror;
  48553. /**
  48554. * Gets the ground mirror created by the helper.
  48555. */
  48556. readonly groundMirror: Nullable<MirrorTexture>;
  48557. /**
  48558. * Gets the ground mirror render list to helps pushing the meshes
  48559. * you wish in the ground reflection.
  48560. */
  48561. readonly groundMirrorRenderList: Nullable<AbstractMesh[]>;
  48562. private _groundMaterial;
  48563. /**
  48564. * Gets the ground material created by the helper.
  48565. */
  48566. readonly groundMaterial: Nullable<BackgroundMaterial>;
  48567. /**
  48568. * Stores the creation options.
  48569. */
  48570. private readonly _scene;
  48571. private _options;
  48572. /**
  48573. * This observable will be notified with any error during the creation of the environment,
  48574. * mainly texture creation errors.
  48575. */
  48576. onErrorObservable: Observable<{
  48577. message?: string;
  48578. exception?: any;
  48579. }>;
  48580. /**
  48581. * constructor
  48582. * @param options Defines the options we want to customize the helper
  48583. * @param scene The scene to add the material to
  48584. */
  48585. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  48586. /**
  48587. * Updates the background according to the new options
  48588. * @param options
  48589. */
  48590. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  48591. /**
  48592. * Sets the primary color of all the available elements.
  48593. * @param color the main color to affect to the ground and the background
  48594. */
  48595. setMainColor(color: Color3): void;
  48596. /**
  48597. * Setup the image processing according to the specified options.
  48598. */
  48599. private _setupImageProcessing;
  48600. /**
  48601. * Setup the environment texture according to the specified options.
  48602. */
  48603. private _setupEnvironmentTexture;
  48604. /**
  48605. * Setup the background according to the specified options.
  48606. */
  48607. private _setupBackground;
  48608. /**
  48609. * Get the scene sizes according to the setup.
  48610. */
  48611. private _getSceneSize;
  48612. /**
  48613. * Setup the ground according to the specified options.
  48614. */
  48615. private _setupGround;
  48616. /**
  48617. * Setup the ground material according to the specified options.
  48618. */
  48619. private _setupGroundMaterial;
  48620. /**
  48621. * Setup the ground diffuse texture according to the specified options.
  48622. */
  48623. private _setupGroundDiffuseTexture;
  48624. /**
  48625. * Setup the ground mirror texture according to the specified options.
  48626. */
  48627. private _setupGroundMirrorTexture;
  48628. /**
  48629. * Setup the ground to receive the mirror texture.
  48630. */
  48631. private _setupMirrorInGroundMaterial;
  48632. /**
  48633. * Setup the skybox according to the specified options.
  48634. */
  48635. private _setupSkybox;
  48636. /**
  48637. * Setup the skybox material according to the specified options.
  48638. */
  48639. private _setupSkyboxMaterial;
  48640. /**
  48641. * Setup the skybox reflection texture according to the specified options.
  48642. */
  48643. private _setupSkyboxReflectionTexture;
  48644. private _errorHandler;
  48645. /**
  48646. * Dispose all the elements created by the Helper.
  48647. */
  48648. dispose(): void;
  48649. }
  48650. }
  48651. declare module "babylonjs/Helpers/photoDome" {
  48652. import { Observable } from "babylonjs/Misc/observable";
  48653. import { Nullable } from "babylonjs/types";
  48654. import { Scene } from "babylonjs/scene";
  48655. import { TransformNode } from "babylonjs/Meshes/transformNode";
  48656. import { Mesh } from "babylonjs/Meshes/mesh";
  48657. import { Texture } from "babylonjs/Materials/Textures/texture";
  48658. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  48659. import "babylonjs/Meshes/Builders/sphereBuilder";
  48660. /**
  48661. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  48662. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  48663. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  48664. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  48665. */
  48666. export class PhotoDome extends TransformNode {
  48667. /**
  48668. * Define the image as a Monoscopic panoramic 360 image.
  48669. */
  48670. static readonly MODE_MONOSCOPIC: number;
  48671. /**
  48672. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  48673. */
  48674. static readonly MODE_TOPBOTTOM: number;
  48675. /**
  48676. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  48677. */
  48678. static readonly MODE_SIDEBYSIDE: number;
  48679. private _useDirectMapping;
  48680. /**
  48681. * The texture being displayed on the sphere
  48682. */
  48683. protected _photoTexture: Texture;
  48684. /**
  48685. * Gets or sets the texture being displayed on the sphere
  48686. */
  48687. photoTexture: Texture;
  48688. /**
  48689. * Observable raised when an error occured while loading the 360 image
  48690. */
  48691. onLoadErrorObservable: Observable<string>;
  48692. /**
  48693. * The skybox material
  48694. */
  48695. protected _material: BackgroundMaterial;
  48696. /**
  48697. * The surface used for the skybox
  48698. */
  48699. protected _mesh: Mesh;
  48700. /**
  48701. * Gets the mesh used for the skybox.
  48702. */
  48703. readonly mesh: Mesh;
  48704. /**
  48705. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  48706. * Also see the options.resolution property.
  48707. */
  48708. fovMultiplier: number;
  48709. private _imageMode;
  48710. /**
  48711. * Gets or set the current video mode for the video. It can be:
  48712. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  48713. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  48714. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  48715. */
  48716. imageMode: number;
  48717. /**
  48718. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  48719. * @param name Element's name, child elements will append suffixes for their own names.
  48720. * @param urlsOfPhoto defines the url of the photo to display
  48721. * @param options defines an object containing optional or exposed sub element properties
  48722. * @param onError defines a callback called when an error occured while loading the texture
  48723. */
  48724. constructor(name: string, urlOfPhoto: string, options: {
  48725. resolution?: number;
  48726. size?: number;
  48727. useDirectMapping?: boolean;
  48728. faceForward?: boolean;
  48729. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  48730. private _onBeforeCameraRenderObserver;
  48731. private _changeImageMode;
  48732. /**
  48733. * Releases resources associated with this node.
  48734. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  48735. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  48736. */
  48737. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  48738. }
  48739. }
  48740. declare module "babylonjs/Misc/rgbdTextureTools" {
  48741. import "babylonjs/Shaders/rgbdDecode.fragment";
  48742. import "babylonjs/Engines/Extensions/engine.renderTarget";
  48743. import { Texture } from "babylonjs/Materials/Textures/texture";
  48744. /**
  48745. * Class used to host RGBD texture specific utilities
  48746. */
  48747. export class RGBDTextureTools {
  48748. /**
  48749. * Expand the RGBD Texture from RGBD to Half Float if possible.
  48750. * @param texture the texture to expand.
  48751. */
  48752. static ExpandRGBDTexture(texture: Texture): void;
  48753. }
  48754. }
  48755. declare module "babylonjs/Misc/brdfTextureTools" {
  48756. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48757. import { Scene } from "babylonjs/scene";
  48758. /**
  48759. * Class used to host texture specific utilities
  48760. */
  48761. export class BRDFTextureTools {
  48762. /**
  48763. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  48764. * @param scene defines the hosting scene
  48765. * @returns the environment BRDF texture
  48766. */
  48767. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  48768. private static _environmentBRDFBase64Texture;
  48769. }
  48770. }
  48771. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  48772. import { Nullable } from "babylonjs/types";
  48773. import { Color3 } from "babylonjs/Maths/math.color";
  48774. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48775. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  48776. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  48777. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  48778. import { Engine } from "babylonjs/Engines/engine";
  48779. import { Scene } from "babylonjs/scene";
  48780. /**
  48781. * @hidden
  48782. */
  48783. export interface IMaterialClearCoatDefines {
  48784. CLEARCOAT: boolean;
  48785. CLEARCOAT_DEFAULTIOR: boolean;
  48786. CLEARCOAT_TEXTURE: boolean;
  48787. CLEARCOAT_TEXTUREDIRECTUV: number;
  48788. CLEARCOAT_BUMP: boolean;
  48789. CLEARCOAT_BUMPDIRECTUV: number;
  48790. CLEARCOAT_TINT: boolean;
  48791. CLEARCOAT_TINT_TEXTURE: boolean;
  48792. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  48793. /** @hidden */
  48794. _areTexturesDirty: boolean;
  48795. }
  48796. /**
  48797. * Define the code related to the clear coat parameters of the pbr material.
  48798. */
  48799. export class PBRClearCoatConfiguration {
  48800. /**
  48801. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  48802. * The default fits with a polyurethane material.
  48803. */
  48804. private static readonly _DefaultIndexOfRefraction;
  48805. private _isEnabled;
  48806. /**
  48807. * Defines if the clear coat is enabled in the material.
  48808. */
  48809. isEnabled: boolean;
  48810. /**
  48811. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  48812. */
  48813. intensity: number;
  48814. /**
  48815. * Defines the clear coat layer roughness.
  48816. */
  48817. roughness: number;
  48818. private _indexOfRefraction;
  48819. /**
  48820. * Defines the index of refraction of the clear coat.
  48821. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  48822. * The default fits with a polyurethane material.
  48823. * Changing the default value is more performance intensive.
  48824. */
  48825. indexOfRefraction: number;
  48826. private _texture;
  48827. /**
  48828. * Stores the clear coat values in a texture.
  48829. */
  48830. texture: Nullable<BaseTexture>;
  48831. private _bumpTexture;
  48832. /**
  48833. * Define the clear coat specific bump texture.
  48834. */
  48835. bumpTexture: Nullable<BaseTexture>;
  48836. private _isTintEnabled;
  48837. /**
  48838. * Defines if the clear coat tint is enabled in the material.
  48839. */
  48840. isTintEnabled: boolean;
  48841. /**
  48842. * Defines the clear coat tint of the material.
  48843. * This is only use if tint is enabled
  48844. */
  48845. tintColor: Color3;
  48846. /**
  48847. * Defines the distance at which the tint color should be found in the
  48848. * clear coat media.
  48849. * This is only use if tint is enabled
  48850. */
  48851. tintColorAtDistance: number;
  48852. /**
  48853. * Defines the clear coat layer thickness.
  48854. * This is only use if tint is enabled
  48855. */
  48856. tintThickness: number;
  48857. private _tintTexture;
  48858. /**
  48859. * Stores the clear tint values in a texture.
  48860. * rgb is tint
  48861. * a is a thickness factor
  48862. */
  48863. tintTexture: Nullable<BaseTexture>;
  48864. /** @hidden */
  48865. private _internalMarkAllSubMeshesAsTexturesDirty;
  48866. /** @hidden */
  48867. _markAllSubMeshesAsTexturesDirty(): void;
  48868. /**
  48869. * Instantiate a new istance of clear coat configuration.
  48870. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  48871. */
  48872. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  48873. /**
  48874. * Gets wehter the submesh is ready to be used or not.
  48875. * @param defines the list of "defines" to update.
  48876. * @param scene defines the scene the material belongs to.
  48877. * @param engine defines the engine the material belongs to.
  48878. * @param disableBumpMap defines wether the material disables bump or not.
  48879. * @returns - boolean indicating that the submesh is ready or not.
  48880. */
  48881. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  48882. /**
  48883. * Checks to see if a texture is used in the material.
  48884. * @param defines the list of "defines" to update.
  48885. * @param scene defines the scene to the material belongs to.
  48886. */
  48887. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  48888. /**
  48889. * Binds the material data.
  48890. * @param uniformBuffer defines the Uniform buffer to fill in.
  48891. * @param scene defines the scene the material belongs to.
  48892. * @param engine defines the engine the material belongs to.
  48893. * @param disableBumpMap defines wether the material disables bump or not.
  48894. * @param isFrozen defines wether the material is frozen or not.
  48895. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  48896. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  48897. */
  48898. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  48899. /**
  48900. * Checks to see if a texture is used in the material.
  48901. * @param texture - Base texture to use.
  48902. * @returns - Boolean specifying if a texture is used in the material.
  48903. */
  48904. hasTexture(texture: BaseTexture): boolean;
  48905. /**
  48906. * Returns an array of the actively used textures.
  48907. * @param activeTextures Array of BaseTextures
  48908. */
  48909. getActiveTextures(activeTextures: BaseTexture[]): void;
  48910. /**
  48911. * Returns the animatable textures.
  48912. * @param animatables Array of animatable textures.
  48913. */
  48914. getAnimatables(animatables: IAnimatable[]): void;
  48915. /**
  48916. * Disposes the resources of the material.
  48917. * @param forceDisposeTextures - Forces the disposal of all textures.
  48918. */
  48919. dispose(forceDisposeTextures?: boolean): void;
  48920. /**
  48921. * Get the current class name of the texture useful for serialization or dynamic coding.
  48922. * @returns "PBRClearCoatConfiguration"
  48923. */
  48924. getClassName(): string;
  48925. /**
  48926. * Add fallbacks to the effect fallbacks list.
  48927. * @param defines defines the Base texture to use.
  48928. * @param fallbacks defines the current fallback list.
  48929. * @param currentRank defines the current fallback rank.
  48930. * @returns the new fallback rank.
  48931. */
  48932. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  48933. /**
  48934. * Add the required uniforms to the current list.
  48935. * @param uniforms defines the current uniform list.
  48936. */
  48937. static AddUniforms(uniforms: string[]): void;
  48938. /**
  48939. * Add the required samplers to the current list.
  48940. * @param samplers defines the current sampler list.
  48941. */
  48942. static AddSamplers(samplers: string[]): void;
  48943. /**
  48944. * Add the required uniforms to the current buffer.
  48945. * @param uniformBuffer defines the current uniform buffer.
  48946. */
  48947. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  48948. /**
  48949. * Makes a duplicate of the current configuration into another one.
  48950. * @param clearCoatConfiguration define the config where to copy the info
  48951. */
  48952. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  48953. /**
  48954. * Serializes this clear coat configuration.
  48955. * @returns - An object with the serialized config.
  48956. */
  48957. serialize(): any;
  48958. /**
  48959. * Parses a anisotropy Configuration from a serialized object.
  48960. * @param source - Serialized object.
  48961. * @param scene Defines the scene we are parsing for
  48962. * @param rootUrl Defines the rootUrl to load from
  48963. */
  48964. parse(source: any, scene: Scene, rootUrl: string): void;
  48965. }
  48966. }
  48967. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  48968. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  48969. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48970. import { Vector2 } from "babylonjs/Maths/math.vector";
  48971. import { Scene } from "babylonjs/scene";
  48972. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48973. import { Nullable } from "babylonjs/types";
  48974. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  48975. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  48976. /**
  48977. * @hidden
  48978. */
  48979. export interface IMaterialAnisotropicDefines {
  48980. ANISOTROPIC: boolean;
  48981. ANISOTROPIC_TEXTURE: boolean;
  48982. ANISOTROPIC_TEXTUREDIRECTUV: number;
  48983. MAINUV1: boolean;
  48984. _areTexturesDirty: boolean;
  48985. _needUVs: boolean;
  48986. }
  48987. /**
  48988. * Define the code related to the anisotropic parameters of the pbr material.
  48989. */
  48990. export class PBRAnisotropicConfiguration {
  48991. private _isEnabled;
  48992. /**
  48993. * Defines if the anisotropy is enabled in the material.
  48994. */
  48995. isEnabled: boolean;
  48996. /**
  48997. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  48998. */
  48999. intensity: number;
  49000. /**
  49001. * Defines if the effect is along the tangents, bitangents or in between.
  49002. * By default, the effect is "strectching" the highlights along the tangents.
  49003. */
  49004. direction: Vector2;
  49005. private _texture;
  49006. /**
  49007. * Stores the anisotropy values in a texture.
  49008. * rg is direction (like normal from -1 to 1)
  49009. * b is a intensity
  49010. */
  49011. texture: Nullable<BaseTexture>;
  49012. /** @hidden */
  49013. private _internalMarkAllSubMeshesAsTexturesDirty;
  49014. /** @hidden */
  49015. _markAllSubMeshesAsTexturesDirty(): void;
  49016. /**
  49017. * Instantiate a new istance of anisotropy configuration.
  49018. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49019. */
  49020. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49021. /**
  49022. * Specifies that the submesh is ready to be used.
  49023. * @param defines the list of "defines" to update.
  49024. * @param scene defines the scene the material belongs to.
  49025. * @returns - boolean indicating that the submesh is ready or not.
  49026. */
  49027. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  49028. /**
  49029. * Checks to see if a texture is used in the material.
  49030. * @param defines the list of "defines" to update.
  49031. * @param mesh the mesh we are preparing the defines for.
  49032. * @param scene defines the scene the material belongs to.
  49033. */
  49034. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  49035. /**
  49036. * Binds the material data.
  49037. * @param uniformBuffer defines the Uniform buffer to fill in.
  49038. * @param scene defines the scene the material belongs to.
  49039. * @param isFrozen defines wether the material is frozen or not.
  49040. */
  49041. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  49042. /**
  49043. * Checks to see if a texture is used in the material.
  49044. * @param texture - Base texture to use.
  49045. * @returns - Boolean specifying if a texture is used in the material.
  49046. */
  49047. hasTexture(texture: BaseTexture): boolean;
  49048. /**
  49049. * Returns an array of the actively used textures.
  49050. * @param activeTextures Array of BaseTextures
  49051. */
  49052. getActiveTextures(activeTextures: BaseTexture[]): void;
  49053. /**
  49054. * Returns the animatable textures.
  49055. * @param animatables Array of animatable textures.
  49056. */
  49057. getAnimatables(animatables: IAnimatable[]): void;
  49058. /**
  49059. * Disposes the resources of the material.
  49060. * @param forceDisposeTextures - Forces the disposal of all textures.
  49061. */
  49062. dispose(forceDisposeTextures?: boolean): void;
  49063. /**
  49064. * Get the current class name of the texture useful for serialization or dynamic coding.
  49065. * @returns "PBRAnisotropicConfiguration"
  49066. */
  49067. getClassName(): string;
  49068. /**
  49069. * Add fallbacks to the effect fallbacks list.
  49070. * @param defines defines the Base texture to use.
  49071. * @param fallbacks defines the current fallback list.
  49072. * @param currentRank defines the current fallback rank.
  49073. * @returns the new fallback rank.
  49074. */
  49075. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49076. /**
  49077. * Add the required uniforms to the current list.
  49078. * @param uniforms defines the current uniform list.
  49079. */
  49080. static AddUniforms(uniforms: string[]): void;
  49081. /**
  49082. * Add the required uniforms to the current buffer.
  49083. * @param uniformBuffer defines the current uniform buffer.
  49084. */
  49085. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49086. /**
  49087. * Add the required samplers to the current list.
  49088. * @param samplers defines the current sampler list.
  49089. */
  49090. static AddSamplers(samplers: string[]): void;
  49091. /**
  49092. * Makes a duplicate of the current configuration into another one.
  49093. * @param anisotropicConfiguration define the config where to copy the info
  49094. */
  49095. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  49096. /**
  49097. * Serializes this anisotropy configuration.
  49098. * @returns - An object with the serialized config.
  49099. */
  49100. serialize(): any;
  49101. /**
  49102. * Parses a anisotropy Configuration from a serialized object.
  49103. * @param source - Serialized object.
  49104. * @param scene Defines the scene we are parsing for
  49105. * @param rootUrl Defines the rootUrl to load from
  49106. */
  49107. parse(source: any, scene: Scene, rootUrl: string): void;
  49108. }
  49109. }
  49110. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  49111. import { Scene } from "babylonjs/scene";
  49112. /**
  49113. * @hidden
  49114. */
  49115. export interface IMaterialBRDFDefines {
  49116. BRDF_V_HEIGHT_CORRELATED: boolean;
  49117. MS_BRDF_ENERGY_CONSERVATION: boolean;
  49118. SPHERICAL_HARMONICS: boolean;
  49119. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  49120. /** @hidden */
  49121. _areMiscDirty: boolean;
  49122. }
  49123. /**
  49124. * Define the code related to the BRDF parameters of the pbr material.
  49125. */
  49126. export class PBRBRDFConfiguration {
  49127. /**
  49128. * Default value used for the energy conservation.
  49129. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  49130. */
  49131. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  49132. /**
  49133. * Default value used for the Smith Visibility Height Correlated mode.
  49134. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  49135. */
  49136. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  49137. /**
  49138. * Default value used for the IBL diffuse part.
  49139. * This can help switching back to the polynomials mode globally which is a tiny bit
  49140. * less GPU intensive at the drawback of a lower quality.
  49141. */
  49142. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  49143. /**
  49144. * Default value used for activating energy conservation for the specular workflow.
  49145. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  49146. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  49147. */
  49148. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  49149. private _useEnergyConservation;
  49150. /**
  49151. * Defines if the material uses energy conservation.
  49152. */
  49153. useEnergyConservation: boolean;
  49154. private _useSmithVisibilityHeightCorrelated;
  49155. /**
  49156. * LEGACY Mode set to false
  49157. * Defines if the material uses height smith correlated visibility term.
  49158. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  49159. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  49160. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  49161. * Not relying on height correlated will also disable energy conservation.
  49162. */
  49163. useSmithVisibilityHeightCorrelated: boolean;
  49164. private _useSphericalHarmonics;
  49165. /**
  49166. * LEGACY Mode set to false
  49167. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  49168. * diffuse part of the IBL.
  49169. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  49170. * to the ground truth.
  49171. */
  49172. useSphericalHarmonics: boolean;
  49173. private _useSpecularGlossinessInputEnergyConservation;
  49174. /**
  49175. * Defines if the material uses energy conservation, when the specular workflow is active.
  49176. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  49177. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  49178. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  49179. */
  49180. useSpecularGlossinessInputEnergyConservation: boolean;
  49181. /** @hidden */
  49182. private _internalMarkAllSubMeshesAsMiscDirty;
  49183. /** @hidden */
  49184. _markAllSubMeshesAsMiscDirty(): void;
  49185. /**
  49186. * Instantiate a new istance of clear coat configuration.
  49187. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  49188. */
  49189. constructor(markAllSubMeshesAsMiscDirty: () => void);
  49190. /**
  49191. * Checks to see if a texture is used in the material.
  49192. * @param defines the list of "defines" to update.
  49193. */
  49194. prepareDefines(defines: IMaterialBRDFDefines): void;
  49195. /**
  49196. * Get the current class name of the texture useful for serialization or dynamic coding.
  49197. * @returns "PBRClearCoatConfiguration"
  49198. */
  49199. getClassName(): string;
  49200. /**
  49201. * Makes a duplicate of the current configuration into another one.
  49202. * @param brdfConfiguration define the config where to copy the info
  49203. */
  49204. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  49205. /**
  49206. * Serializes this BRDF configuration.
  49207. * @returns - An object with the serialized config.
  49208. */
  49209. serialize(): any;
  49210. /**
  49211. * Parses a anisotropy Configuration from a serialized object.
  49212. * @param source - Serialized object.
  49213. * @param scene Defines the scene we are parsing for
  49214. * @param rootUrl Defines the rootUrl to load from
  49215. */
  49216. parse(source: any, scene: Scene, rootUrl: string): void;
  49217. }
  49218. }
  49219. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  49220. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49221. import { Color3 } from "babylonjs/Maths/math.color";
  49222. import { Scene } from "babylonjs/scene";
  49223. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49224. import { Nullable } from "babylonjs/types";
  49225. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49226. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49227. /**
  49228. * @hidden
  49229. */
  49230. export interface IMaterialSheenDefines {
  49231. SHEEN: boolean;
  49232. SHEEN_TEXTURE: boolean;
  49233. SHEEN_TEXTUREDIRECTUV: number;
  49234. SHEEN_LINKWITHALBEDO: boolean;
  49235. /** @hidden */
  49236. _areTexturesDirty: boolean;
  49237. }
  49238. /**
  49239. * Define the code related to the Sheen parameters of the pbr material.
  49240. */
  49241. export class PBRSheenConfiguration {
  49242. private _isEnabled;
  49243. /**
  49244. * Defines if the material uses sheen.
  49245. */
  49246. isEnabled: boolean;
  49247. private _linkSheenWithAlbedo;
  49248. /**
  49249. * Defines if the sheen is linked to the sheen color.
  49250. */
  49251. linkSheenWithAlbedo: boolean;
  49252. /**
  49253. * Defines the sheen intensity.
  49254. */
  49255. intensity: number;
  49256. /**
  49257. * Defines the sheen color.
  49258. */
  49259. color: Color3;
  49260. private _texture;
  49261. /**
  49262. * Stores the sheen tint values in a texture.
  49263. * rgb is tint
  49264. * a is a intensity
  49265. */
  49266. texture: Nullable<BaseTexture>;
  49267. /** @hidden */
  49268. private _internalMarkAllSubMeshesAsTexturesDirty;
  49269. /** @hidden */
  49270. _markAllSubMeshesAsTexturesDirty(): void;
  49271. /**
  49272. * Instantiate a new istance of clear coat configuration.
  49273. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49274. */
  49275. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49276. /**
  49277. * Specifies that the submesh is ready to be used.
  49278. * @param defines the list of "defines" to update.
  49279. * @param scene defines the scene the material belongs to.
  49280. * @returns - boolean indicating that the submesh is ready or not.
  49281. */
  49282. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  49283. /**
  49284. * Checks to see if a texture is used in the material.
  49285. * @param defines the list of "defines" to update.
  49286. * @param scene defines the scene the material belongs to.
  49287. */
  49288. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  49289. /**
  49290. * Binds the material data.
  49291. * @param uniformBuffer defines the Uniform buffer to fill in.
  49292. * @param scene defines the scene the material belongs to.
  49293. * @param isFrozen defines wether the material is frozen or not.
  49294. */
  49295. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  49296. /**
  49297. * Checks to see if a texture is used in the material.
  49298. * @param texture - Base texture to use.
  49299. * @returns - Boolean specifying if a texture is used in the material.
  49300. */
  49301. hasTexture(texture: BaseTexture): boolean;
  49302. /**
  49303. * Returns an array of the actively used textures.
  49304. * @param activeTextures Array of BaseTextures
  49305. */
  49306. getActiveTextures(activeTextures: BaseTexture[]): void;
  49307. /**
  49308. * Returns the animatable textures.
  49309. * @param animatables Array of animatable textures.
  49310. */
  49311. getAnimatables(animatables: IAnimatable[]): void;
  49312. /**
  49313. * Disposes the resources of the material.
  49314. * @param forceDisposeTextures - Forces the disposal of all textures.
  49315. */
  49316. dispose(forceDisposeTextures?: boolean): void;
  49317. /**
  49318. * Get the current class name of the texture useful for serialization or dynamic coding.
  49319. * @returns "PBRSheenConfiguration"
  49320. */
  49321. getClassName(): string;
  49322. /**
  49323. * Add fallbacks to the effect fallbacks list.
  49324. * @param defines defines the Base texture to use.
  49325. * @param fallbacks defines the current fallback list.
  49326. * @param currentRank defines the current fallback rank.
  49327. * @returns the new fallback rank.
  49328. */
  49329. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49330. /**
  49331. * Add the required uniforms to the current list.
  49332. * @param uniforms defines the current uniform list.
  49333. */
  49334. static AddUniforms(uniforms: string[]): void;
  49335. /**
  49336. * Add the required uniforms to the current buffer.
  49337. * @param uniformBuffer defines the current uniform buffer.
  49338. */
  49339. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49340. /**
  49341. * Add the required samplers to the current list.
  49342. * @param samplers defines the current sampler list.
  49343. */
  49344. static AddSamplers(samplers: string[]): void;
  49345. /**
  49346. * Makes a duplicate of the current configuration into another one.
  49347. * @param sheenConfiguration define the config where to copy the info
  49348. */
  49349. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  49350. /**
  49351. * Serializes this BRDF configuration.
  49352. * @returns - An object with the serialized config.
  49353. */
  49354. serialize(): any;
  49355. /**
  49356. * Parses a anisotropy Configuration from a serialized object.
  49357. * @param source - Serialized object.
  49358. * @param scene Defines the scene we are parsing for
  49359. * @param rootUrl Defines the rootUrl to load from
  49360. */
  49361. parse(source: any, scene: Scene, rootUrl: string): void;
  49362. }
  49363. }
  49364. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  49365. import { Nullable } from "babylonjs/types";
  49366. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49367. import { Color3 } from "babylonjs/Maths/math.color";
  49368. import { SmartArray } from "babylonjs/Misc/smartArray";
  49369. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49370. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  49371. import { Effect } from "babylonjs/Materials/effect";
  49372. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49373. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49374. import { Engine } from "babylonjs/Engines/engine";
  49375. import { Scene } from "babylonjs/scene";
  49376. /**
  49377. * @hidden
  49378. */
  49379. export interface IMaterialSubSurfaceDefines {
  49380. SUBSURFACE: boolean;
  49381. SS_REFRACTION: boolean;
  49382. SS_TRANSLUCENCY: boolean;
  49383. SS_SCATERRING: boolean;
  49384. SS_THICKNESSANDMASK_TEXTURE: boolean;
  49385. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  49386. SS_REFRACTIONMAP_3D: boolean;
  49387. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  49388. SS_LODINREFRACTIONALPHA: boolean;
  49389. SS_GAMMAREFRACTION: boolean;
  49390. SS_RGBDREFRACTION: boolean;
  49391. SS_LINEARSPECULARREFRACTION: boolean;
  49392. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  49393. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  49394. /** @hidden */
  49395. _areTexturesDirty: boolean;
  49396. }
  49397. /**
  49398. * Define the code related to the sub surface parameters of the pbr material.
  49399. */
  49400. export class PBRSubSurfaceConfiguration {
  49401. private _isRefractionEnabled;
  49402. /**
  49403. * Defines if the refraction is enabled in the material.
  49404. */
  49405. isRefractionEnabled: boolean;
  49406. private _isTranslucencyEnabled;
  49407. /**
  49408. * Defines if the translucency is enabled in the material.
  49409. */
  49410. isTranslucencyEnabled: boolean;
  49411. private _isScatteringEnabled;
  49412. /**
  49413. * Defines the refraction intensity of the material.
  49414. * The refraction when enabled replaces the Diffuse part of the material.
  49415. * The intensity helps transitionning between diffuse and refraction.
  49416. */
  49417. refractionIntensity: number;
  49418. /**
  49419. * Defines the translucency intensity of the material.
  49420. * When translucency has been enabled, this defines how much of the "translucency"
  49421. * is addded to the diffuse part of the material.
  49422. */
  49423. translucencyIntensity: number;
  49424. /**
  49425. * Defines the scattering intensity of the material.
  49426. * When scattering has been enabled, this defines how much of the "scattered light"
  49427. * is addded to the diffuse part of the material.
  49428. */
  49429. scatteringIntensity: number;
  49430. private _thicknessTexture;
  49431. /**
  49432. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  49433. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  49434. * 0 would mean minimumThickness
  49435. * 1 would mean maximumThickness
  49436. * The other channels might be use as a mask to vary the different effects intensity.
  49437. */
  49438. thicknessTexture: Nullable<BaseTexture>;
  49439. private _refractionTexture;
  49440. /**
  49441. * Defines the texture to use for refraction.
  49442. */
  49443. refractionTexture: Nullable<BaseTexture>;
  49444. private _indexOfRefraction;
  49445. /**
  49446. * Defines the index of refraction used in the material.
  49447. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  49448. */
  49449. indexOfRefraction: number;
  49450. private _invertRefractionY;
  49451. /**
  49452. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  49453. */
  49454. invertRefractionY: boolean;
  49455. private _linkRefractionWithTransparency;
  49456. /**
  49457. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  49458. * Materials half opaque for instance using refraction could benefit from this control.
  49459. */
  49460. linkRefractionWithTransparency: boolean;
  49461. /**
  49462. * Defines the minimum thickness stored in the thickness map.
  49463. * If no thickness map is defined, this value will be used to simulate thickness.
  49464. */
  49465. minimumThickness: number;
  49466. /**
  49467. * Defines the maximum thickness stored in the thickness map.
  49468. */
  49469. maximumThickness: number;
  49470. /**
  49471. * Defines the volume tint of the material.
  49472. * This is used for both translucency and scattering.
  49473. */
  49474. tintColor: Color3;
  49475. /**
  49476. * Defines the distance at which the tint color should be found in the media.
  49477. * This is used for refraction only.
  49478. */
  49479. tintColorAtDistance: number;
  49480. /**
  49481. * Defines how far each channel transmit through the media.
  49482. * It is defined as a color to simplify it selection.
  49483. */
  49484. diffusionDistance: Color3;
  49485. private _useMaskFromThicknessTexture;
  49486. /**
  49487. * Stores the intensity of the different subsurface effects in the thickness texture.
  49488. * * the green channel is the translucency intensity.
  49489. * * the blue channel is the scattering intensity.
  49490. * * the alpha channel is the refraction intensity.
  49491. */
  49492. useMaskFromThicknessTexture: boolean;
  49493. /** @hidden */
  49494. private _internalMarkAllSubMeshesAsTexturesDirty;
  49495. /** @hidden */
  49496. _markAllSubMeshesAsTexturesDirty(): void;
  49497. /**
  49498. * Instantiate a new istance of sub surface configuration.
  49499. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49500. */
  49501. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49502. /**
  49503. * Gets wehter the submesh is ready to be used or not.
  49504. * @param defines the list of "defines" to update.
  49505. * @param scene defines the scene the material belongs to.
  49506. * @returns - boolean indicating that the submesh is ready or not.
  49507. */
  49508. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  49509. /**
  49510. * Checks to see if a texture is used in the material.
  49511. * @param defines the list of "defines" to update.
  49512. * @param scene defines the scene to the material belongs to.
  49513. */
  49514. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  49515. /**
  49516. * Binds the material data.
  49517. * @param uniformBuffer defines the Uniform buffer to fill in.
  49518. * @param scene defines the scene the material belongs to.
  49519. * @param engine defines the engine the material belongs to.
  49520. * @param isFrozen defines wether the material is frozen or not.
  49521. * @param lodBasedMicrosurface defines wether the material relies on lod based microsurface or not.
  49522. */
  49523. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean): void;
  49524. /**
  49525. * Unbinds the material from the mesh.
  49526. * @param activeEffect defines the effect that should be unbound from.
  49527. * @returns true if unbound, otherwise false
  49528. */
  49529. unbind(activeEffect: Effect): boolean;
  49530. /**
  49531. * Returns the texture used for refraction or null if none is used.
  49532. * @param scene defines the scene the material belongs to.
  49533. * @returns - Refraction texture if present. If no refraction texture and refraction
  49534. * is linked with transparency, returns environment texture. Otherwise, returns null.
  49535. */
  49536. private _getRefractionTexture;
  49537. /**
  49538. * Returns true if alpha blending should be disabled.
  49539. */
  49540. readonly disableAlphaBlending: boolean;
  49541. /**
  49542. * Fills the list of render target textures.
  49543. * @param renderTargets the list of render targets to update
  49544. */
  49545. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  49546. /**
  49547. * Checks to see if a texture is used in the material.
  49548. * @param texture - Base texture to use.
  49549. * @returns - Boolean specifying if a texture is used in the material.
  49550. */
  49551. hasTexture(texture: BaseTexture): boolean;
  49552. /**
  49553. * Gets a boolean indicating that current material needs to register RTT
  49554. * @returns true if this uses a render target otherwise false.
  49555. */
  49556. hasRenderTargetTextures(): boolean;
  49557. /**
  49558. * Returns an array of the actively used textures.
  49559. * @param activeTextures Array of BaseTextures
  49560. */
  49561. getActiveTextures(activeTextures: BaseTexture[]): void;
  49562. /**
  49563. * Returns the animatable textures.
  49564. * @param animatables Array of animatable textures.
  49565. */
  49566. getAnimatables(animatables: IAnimatable[]): void;
  49567. /**
  49568. * Disposes the resources of the material.
  49569. * @param forceDisposeTextures - Forces the disposal of all textures.
  49570. */
  49571. dispose(forceDisposeTextures?: boolean): void;
  49572. /**
  49573. * Get the current class name of the texture useful for serialization or dynamic coding.
  49574. * @returns "PBRSubSurfaceConfiguration"
  49575. */
  49576. getClassName(): string;
  49577. /**
  49578. * Add fallbacks to the effect fallbacks list.
  49579. * @param defines defines the Base texture to use.
  49580. * @param fallbacks defines the current fallback list.
  49581. * @param currentRank defines the current fallback rank.
  49582. * @returns the new fallback rank.
  49583. */
  49584. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49585. /**
  49586. * Add the required uniforms to the current list.
  49587. * @param uniforms defines the current uniform list.
  49588. */
  49589. static AddUniforms(uniforms: string[]): void;
  49590. /**
  49591. * Add the required samplers to the current list.
  49592. * @param samplers defines the current sampler list.
  49593. */
  49594. static AddSamplers(samplers: string[]): void;
  49595. /**
  49596. * Add the required uniforms to the current buffer.
  49597. * @param uniformBuffer defines the current uniform buffer.
  49598. */
  49599. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49600. /**
  49601. * Makes a duplicate of the current configuration into another one.
  49602. * @param configuration define the config where to copy the info
  49603. */
  49604. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  49605. /**
  49606. * Serializes this Sub Surface configuration.
  49607. * @returns - An object with the serialized config.
  49608. */
  49609. serialize(): any;
  49610. /**
  49611. * Parses a anisotropy Configuration from a serialized object.
  49612. * @param source - Serialized object.
  49613. * @param scene Defines the scene we are parsing for
  49614. * @param rootUrl Defines the rootUrl to load from
  49615. */
  49616. parse(source: any, scene: Scene, rootUrl: string): void;
  49617. }
  49618. }
  49619. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  49620. /** @hidden */
  49621. export var pbrFragmentDeclaration: {
  49622. name: string;
  49623. shader: string;
  49624. };
  49625. }
  49626. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  49627. /** @hidden */
  49628. export var pbrUboDeclaration: {
  49629. name: string;
  49630. shader: string;
  49631. };
  49632. }
  49633. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  49634. /** @hidden */
  49635. export var pbrFragmentExtraDeclaration: {
  49636. name: string;
  49637. shader: string;
  49638. };
  49639. }
  49640. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  49641. /** @hidden */
  49642. export var pbrFragmentSamplersDeclaration: {
  49643. name: string;
  49644. shader: string;
  49645. };
  49646. }
  49647. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  49648. /** @hidden */
  49649. export var pbrHelperFunctions: {
  49650. name: string;
  49651. shader: string;
  49652. };
  49653. }
  49654. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  49655. /** @hidden */
  49656. export var harmonicsFunctions: {
  49657. name: string;
  49658. shader: string;
  49659. };
  49660. }
  49661. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  49662. /** @hidden */
  49663. export var pbrDirectLightingSetupFunctions: {
  49664. name: string;
  49665. shader: string;
  49666. };
  49667. }
  49668. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  49669. /** @hidden */
  49670. export var pbrDirectLightingFalloffFunctions: {
  49671. name: string;
  49672. shader: string;
  49673. };
  49674. }
  49675. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  49676. /** @hidden */
  49677. export var pbrBRDFFunctions: {
  49678. name: string;
  49679. shader: string;
  49680. };
  49681. }
  49682. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  49683. /** @hidden */
  49684. export var pbrDirectLightingFunctions: {
  49685. name: string;
  49686. shader: string;
  49687. };
  49688. }
  49689. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  49690. /** @hidden */
  49691. export var pbrIBLFunctions: {
  49692. name: string;
  49693. shader: string;
  49694. };
  49695. }
  49696. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  49697. /** @hidden */
  49698. export var pbrDebug: {
  49699. name: string;
  49700. shader: string;
  49701. };
  49702. }
  49703. declare module "babylonjs/Shaders/pbr.fragment" {
  49704. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  49705. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  49706. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  49707. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  49708. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  49709. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  49710. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  49711. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  49712. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  49713. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  49714. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  49715. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  49716. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  49717. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  49718. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  49719. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  49720. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  49721. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  49722. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  49723. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  49724. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  49725. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  49726. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  49727. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  49728. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  49729. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  49730. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  49731. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  49732. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  49733. /** @hidden */
  49734. export var pbrPixelShader: {
  49735. name: string;
  49736. shader: string;
  49737. };
  49738. }
  49739. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  49740. /** @hidden */
  49741. export var pbrVertexDeclaration: {
  49742. name: string;
  49743. shader: string;
  49744. };
  49745. }
  49746. declare module "babylonjs/Shaders/pbr.vertex" {
  49747. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  49748. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  49749. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  49750. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  49751. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  49752. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  49753. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  49754. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  49755. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  49756. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  49757. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  49758. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  49759. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  49760. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  49761. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  49762. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  49763. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  49764. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  49765. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  49766. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  49767. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  49768. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  49769. /** @hidden */
  49770. export var pbrVertexShader: {
  49771. name: string;
  49772. shader: string;
  49773. };
  49774. }
  49775. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  49776. import { Nullable } from "babylonjs/types";
  49777. import { Scene } from "babylonjs/scene";
  49778. import { Matrix } from "babylonjs/Maths/math.vector";
  49779. import { SubMesh } from "babylonjs/Meshes/subMesh";
  49780. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49781. import { Mesh } from "babylonjs/Meshes/mesh";
  49782. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  49783. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  49784. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  49785. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  49786. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  49787. import { Color3 } from "babylonjs/Maths/math.color";
  49788. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  49789. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  49790. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  49791. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  49792. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49793. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49794. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  49795. import "babylonjs/Shaders/pbr.fragment";
  49796. import "babylonjs/Shaders/pbr.vertex";
  49797. /**
  49798. * Manages the defines for the PBR Material.
  49799. * @hidden
  49800. */
  49801. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines {
  49802. PBR: boolean;
  49803. MAINUV1: boolean;
  49804. MAINUV2: boolean;
  49805. UV1: boolean;
  49806. UV2: boolean;
  49807. ALBEDO: boolean;
  49808. ALBEDODIRECTUV: number;
  49809. VERTEXCOLOR: boolean;
  49810. AMBIENT: boolean;
  49811. AMBIENTDIRECTUV: number;
  49812. AMBIENTINGRAYSCALE: boolean;
  49813. OPACITY: boolean;
  49814. VERTEXALPHA: boolean;
  49815. OPACITYDIRECTUV: number;
  49816. OPACITYRGB: boolean;
  49817. ALPHATEST: boolean;
  49818. DEPTHPREPASS: boolean;
  49819. ALPHABLEND: boolean;
  49820. ALPHAFROMALBEDO: boolean;
  49821. ALPHATESTVALUE: string;
  49822. SPECULAROVERALPHA: boolean;
  49823. RADIANCEOVERALPHA: boolean;
  49824. ALPHAFRESNEL: boolean;
  49825. LINEARALPHAFRESNEL: boolean;
  49826. PREMULTIPLYALPHA: boolean;
  49827. EMISSIVE: boolean;
  49828. EMISSIVEDIRECTUV: number;
  49829. REFLECTIVITY: boolean;
  49830. REFLECTIVITYDIRECTUV: number;
  49831. SPECULARTERM: boolean;
  49832. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  49833. MICROSURFACEAUTOMATIC: boolean;
  49834. LODBASEDMICROSFURACE: boolean;
  49835. MICROSURFACEMAP: boolean;
  49836. MICROSURFACEMAPDIRECTUV: number;
  49837. METALLICWORKFLOW: boolean;
  49838. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  49839. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  49840. METALLNESSSTOREINMETALMAPBLUE: boolean;
  49841. AOSTOREINMETALMAPRED: boolean;
  49842. ENVIRONMENTBRDF: boolean;
  49843. ENVIRONMENTBRDF_RGBD: boolean;
  49844. NORMAL: boolean;
  49845. TANGENT: boolean;
  49846. BUMP: boolean;
  49847. BUMPDIRECTUV: number;
  49848. OBJECTSPACE_NORMALMAP: boolean;
  49849. PARALLAX: boolean;
  49850. PARALLAXOCCLUSION: boolean;
  49851. NORMALXYSCALE: boolean;
  49852. LIGHTMAP: boolean;
  49853. LIGHTMAPDIRECTUV: number;
  49854. USELIGHTMAPASSHADOWMAP: boolean;
  49855. GAMMALIGHTMAP: boolean;
  49856. RGBDLIGHTMAP: boolean;
  49857. REFLECTION: boolean;
  49858. REFLECTIONMAP_3D: boolean;
  49859. REFLECTIONMAP_SPHERICAL: boolean;
  49860. REFLECTIONMAP_PLANAR: boolean;
  49861. REFLECTIONMAP_CUBIC: boolean;
  49862. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  49863. REFLECTIONMAP_PROJECTION: boolean;
  49864. REFLECTIONMAP_SKYBOX: boolean;
  49865. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  49866. REFLECTIONMAP_EXPLICIT: boolean;
  49867. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  49868. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  49869. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  49870. INVERTCUBICMAP: boolean;
  49871. USESPHERICALFROMREFLECTIONMAP: boolean;
  49872. USEIRRADIANCEMAP: boolean;
  49873. SPHERICAL_HARMONICS: boolean;
  49874. USESPHERICALINVERTEX: boolean;
  49875. REFLECTIONMAP_OPPOSITEZ: boolean;
  49876. LODINREFLECTIONALPHA: boolean;
  49877. GAMMAREFLECTION: boolean;
  49878. RGBDREFLECTION: boolean;
  49879. LINEARSPECULARREFLECTION: boolean;
  49880. RADIANCEOCCLUSION: boolean;
  49881. HORIZONOCCLUSION: boolean;
  49882. INSTANCES: boolean;
  49883. NUM_BONE_INFLUENCERS: number;
  49884. BonesPerMesh: number;
  49885. BONETEXTURE: boolean;
  49886. NONUNIFORMSCALING: boolean;
  49887. MORPHTARGETS: boolean;
  49888. MORPHTARGETS_NORMAL: boolean;
  49889. MORPHTARGETS_TANGENT: boolean;
  49890. MORPHTARGETS_UV: boolean;
  49891. NUM_MORPH_INFLUENCERS: number;
  49892. IMAGEPROCESSING: boolean;
  49893. VIGNETTE: boolean;
  49894. VIGNETTEBLENDMODEMULTIPLY: boolean;
  49895. VIGNETTEBLENDMODEOPAQUE: boolean;
  49896. TONEMAPPING: boolean;
  49897. TONEMAPPING_ACES: boolean;
  49898. CONTRAST: boolean;
  49899. COLORCURVES: boolean;
  49900. COLORGRADING: boolean;
  49901. COLORGRADING3D: boolean;
  49902. SAMPLER3DGREENDEPTH: boolean;
  49903. SAMPLER3DBGRMAP: boolean;
  49904. IMAGEPROCESSINGPOSTPROCESS: boolean;
  49905. EXPOSURE: boolean;
  49906. MULTIVIEW: boolean;
  49907. USEPHYSICALLIGHTFALLOFF: boolean;
  49908. USEGLTFLIGHTFALLOFF: boolean;
  49909. TWOSIDEDLIGHTING: boolean;
  49910. SHADOWFLOAT: boolean;
  49911. CLIPPLANE: boolean;
  49912. CLIPPLANE2: boolean;
  49913. CLIPPLANE3: boolean;
  49914. CLIPPLANE4: boolean;
  49915. POINTSIZE: boolean;
  49916. FOG: boolean;
  49917. LOGARITHMICDEPTH: boolean;
  49918. FORCENORMALFORWARD: boolean;
  49919. SPECULARAA: boolean;
  49920. CLEARCOAT: boolean;
  49921. CLEARCOAT_DEFAULTIOR: boolean;
  49922. CLEARCOAT_TEXTURE: boolean;
  49923. CLEARCOAT_TEXTUREDIRECTUV: number;
  49924. CLEARCOAT_BUMP: boolean;
  49925. CLEARCOAT_BUMPDIRECTUV: number;
  49926. CLEARCOAT_TINT: boolean;
  49927. CLEARCOAT_TINT_TEXTURE: boolean;
  49928. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  49929. ANISOTROPIC: boolean;
  49930. ANISOTROPIC_TEXTURE: boolean;
  49931. ANISOTROPIC_TEXTUREDIRECTUV: number;
  49932. BRDF_V_HEIGHT_CORRELATED: boolean;
  49933. MS_BRDF_ENERGY_CONSERVATION: boolean;
  49934. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  49935. SHEEN: boolean;
  49936. SHEEN_TEXTURE: boolean;
  49937. SHEEN_TEXTUREDIRECTUV: number;
  49938. SHEEN_LINKWITHALBEDO: boolean;
  49939. SUBSURFACE: boolean;
  49940. SS_REFRACTION: boolean;
  49941. SS_TRANSLUCENCY: boolean;
  49942. SS_SCATERRING: boolean;
  49943. SS_THICKNESSANDMASK_TEXTURE: boolean;
  49944. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  49945. SS_REFRACTIONMAP_3D: boolean;
  49946. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  49947. SS_LODINREFRACTIONALPHA: boolean;
  49948. SS_GAMMAREFRACTION: boolean;
  49949. SS_RGBDREFRACTION: boolean;
  49950. SS_LINEARSPECULARREFRACTION: boolean;
  49951. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  49952. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  49953. UNLIT: boolean;
  49954. DEBUGMODE: number;
  49955. /**
  49956. * Initializes the PBR Material defines.
  49957. */
  49958. constructor();
  49959. /**
  49960. * Resets the PBR Material defines.
  49961. */
  49962. reset(): void;
  49963. }
  49964. /**
  49965. * The Physically based material base class of BJS.
  49966. *
  49967. * This offers the main features of a standard PBR material.
  49968. * For more information, please refer to the documentation :
  49969. * https://doc.babylonjs.com/how_to/physically_based_rendering
  49970. */
  49971. export abstract class PBRBaseMaterial extends PushMaterial {
  49972. /**
  49973. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  49974. */
  49975. static readonly PBRMATERIAL_OPAQUE: number;
  49976. /**
  49977. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  49978. */
  49979. static readonly PBRMATERIAL_ALPHATEST: number;
  49980. /**
  49981. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  49982. */
  49983. static readonly PBRMATERIAL_ALPHABLEND: number;
  49984. /**
  49985. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  49986. * They are also discarded below the alpha cutoff threshold to improve performances.
  49987. */
  49988. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  49989. /**
  49990. * Defines the default value of how much AO map is occluding the analytical lights
  49991. * (point spot...).
  49992. */
  49993. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  49994. /**
  49995. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  49996. */
  49997. static readonly LIGHTFALLOFF_PHYSICAL: number;
  49998. /**
  49999. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  50000. * to enhance interoperability with other engines.
  50001. */
  50002. static readonly LIGHTFALLOFF_GLTF: number;
  50003. /**
  50004. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  50005. * to enhance interoperability with other materials.
  50006. */
  50007. static readonly LIGHTFALLOFF_STANDARD: number;
  50008. /**
  50009. * Intensity of the direct lights e.g. the four lights available in your scene.
  50010. * This impacts both the direct diffuse and specular highlights.
  50011. */
  50012. protected _directIntensity: number;
  50013. /**
  50014. * Intensity of the emissive part of the material.
  50015. * This helps controlling the emissive effect without modifying the emissive color.
  50016. */
  50017. protected _emissiveIntensity: number;
  50018. /**
  50019. * Intensity of the environment e.g. how much the environment will light the object
  50020. * either through harmonics for rough material or through the refelction for shiny ones.
  50021. */
  50022. protected _environmentIntensity: number;
  50023. /**
  50024. * This is a special control allowing the reduction of the specular highlights coming from the
  50025. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  50026. */
  50027. protected _specularIntensity: number;
  50028. /**
  50029. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  50030. */
  50031. private _lightingInfos;
  50032. /**
  50033. * Debug Control allowing disabling the bump map on this material.
  50034. */
  50035. protected _disableBumpMap: boolean;
  50036. /**
  50037. * AKA Diffuse Texture in standard nomenclature.
  50038. */
  50039. protected _albedoTexture: Nullable<BaseTexture>;
  50040. /**
  50041. * AKA Occlusion Texture in other nomenclature.
  50042. */
  50043. protected _ambientTexture: Nullable<BaseTexture>;
  50044. /**
  50045. * AKA Occlusion Texture Intensity in other nomenclature.
  50046. */
  50047. protected _ambientTextureStrength: number;
  50048. /**
  50049. * Defines how much the AO map is occluding the analytical lights (point spot...).
  50050. * 1 means it completely occludes it
  50051. * 0 mean it has no impact
  50052. */
  50053. protected _ambientTextureImpactOnAnalyticalLights: number;
  50054. /**
  50055. * Stores the alpha values in a texture.
  50056. */
  50057. protected _opacityTexture: Nullable<BaseTexture>;
  50058. /**
  50059. * Stores the reflection values in a texture.
  50060. */
  50061. protected _reflectionTexture: Nullable<BaseTexture>;
  50062. /**
  50063. * Stores the emissive values in a texture.
  50064. */
  50065. protected _emissiveTexture: Nullable<BaseTexture>;
  50066. /**
  50067. * AKA Specular texture in other nomenclature.
  50068. */
  50069. protected _reflectivityTexture: Nullable<BaseTexture>;
  50070. /**
  50071. * Used to switch from specular/glossiness to metallic/roughness workflow.
  50072. */
  50073. protected _metallicTexture: Nullable<BaseTexture>;
  50074. /**
  50075. * Specifies the metallic scalar of the metallic/roughness workflow.
  50076. * Can also be used to scale the metalness values of the metallic texture.
  50077. */
  50078. protected _metallic: Nullable<number>;
  50079. /**
  50080. * Specifies the roughness scalar of the metallic/roughness workflow.
  50081. * Can also be used to scale the roughness values of the metallic texture.
  50082. */
  50083. protected _roughness: Nullable<number>;
  50084. /**
  50085. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  50086. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  50087. */
  50088. protected _microSurfaceTexture: Nullable<BaseTexture>;
  50089. /**
  50090. * Stores surface normal data used to displace a mesh in a texture.
  50091. */
  50092. protected _bumpTexture: Nullable<BaseTexture>;
  50093. /**
  50094. * Stores the pre-calculated light information of a mesh in a texture.
  50095. */
  50096. protected _lightmapTexture: Nullable<BaseTexture>;
  50097. /**
  50098. * The color of a material in ambient lighting.
  50099. */
  50100. protected _ambientColor: Color3;
  50101. /**
  50102. * AKA Diffuse Color in other nomenclature.
  50103. */
  50104. protected _albedoColor: Color3;
  50105. /**
  50106. * AKA Specular Color in other nomenclature.
  50107. */
  50108. protected _reflectivityColor: Color3;
  50109. /**
  50110. * The color applied when light is reflected from a material.
  50111. */
  50112. protected _reflectionColor: Color3;
  50113. /**
  50114. * The color applied when light is emitted from a material.
  50115. */
  50116. protected _emissiveColor: Color3;
  50117. /**
  50118. * AKA Glossiness in other nomenclature.
  50119. */
  50120. protected _microSurface: number;
  50121. /**
  50122. * Specifies that the material will use the light map as a show map.
  50123. */
  50124. protected _useLightmapAsShadowmap: boolean;
  50125. /**
  50126. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  50127. * makes the reflect vector face the model (under horizon).
  50128. */
  50129. protected _useHorizonOcclusion: boolean;
  50130. /**
  50131. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  50132. * too much the area relying on ambient texture to define their ambient occlusion.
  50133. */
  50134. protected _useRadianceOcclusion: boolean;
  50135. /**
  50136. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  50137. */
  50138. protected _useAlphaFromAlbedoTexture: boolean;
  50139. /**
  50140. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  50141. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  50142. */
  50143. protected _useSpecularOverAlpha: boolean;
  50144. /**
  50145. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  50146. */
  50147. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  50148. /**
  50149. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  50150. */
  50151. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  50152. /**
  50153. * Specifies if the metallic texture contains the roughness information in its green channel.
  50154. */
  50155. protected _useRoughnessFromMetallicTextureGreen: boolean;
  50156. /**
  50157. * Specifies if the metallic texture contains the metallness information in its blue channel.
  50158. */
  50159. protected _useMetallnessFromMetallicTextureBlue: boolean;
  50160. /**
  50161. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  50162. */
  50163. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  50164. /**
  50165. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  50166. */
  50167. protected _useAmbientInGrayScale: boolean;
  50168. /**
  50169. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  50170. * The material will try to infer what glossiness each pixel should be.
  50171. */
  50172. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  50173. /**
  50174. * Defines the falloff type used in this material.
  50175. * It by default is Physical.
  50176. */
  50177. protected _lightFalloff: number;
  50178. /**
  50179. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  50180. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  50181. */
  50182. protected _useRadianceOverAlpha: boolean;
  50183. /**
  50184. * Allows using an object space normal map (instead of tangent space).
  50185. */
  50186. protected _useObjectSpaceNormalMap: boolean;
  50187. /**
  50188. * Allows using the bump map in parallax mode.
  50189. */
  50190. protected _useParallax: boolean;
  50191. /**
  50192. * Allows using the bump map in parallax occlusion mode.
  50193. */
  50194. protected _useParallaxOcclusion: boolean;
  50195. /**
  50196. * Controls the scale bias of the parallax mode.
  50197. */
  50198. protected _parallaxScaleBias: number;
  50199. /**
  50200. * If sets to true, disables all the lights affecting the material.
  50201. */
  50202. protected _disableLighting: boolean;
  50203. /**
  50204. * Number of Simultaneous lights allowed on the material.
  50205. */
  50206. protected _maxSimultaneousLights: number;
  50207. /**
  50208. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  50209. */
  50210. protected _invertNormalMapX: boolean;
  50211. /**
  50212. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  50213. */
  50214. protected _invertNormalMapY: boolean;
  50215. /**
  50216. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  50217. */
  50218. protected _twoSidedLighting: boolean;
  50219. /**
  50220. * Defines the alpha limits in alpha test mode.
  50221. */
  50222. protected _alphaCutOff: number;
  50223. /**
  50224. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  50225. */
  50226. protected _forceAlphaTest: boolean;
  50227. /**
  50228. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  50229. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  50230. */
  50231. protected _useAlphaFresnel: boolean;
  50232. /**
  50233. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  50234. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  50235. */
  50236. protected _useLinearAlphaFresnel: boolean;
  50237. /**
  50238. * The transparency mode of the material.
  50239. */
  50240. protected _transparencyMode: Nullable<number>;
  50241. /**
  50242. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  50243. * from cos thetav and roughness:
  50244. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  50245. */
  50246. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  50247. /**
  50248. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  50249. */
  50250. protected _forceIrradianceInFragment: boolean;
  50251. /**
  50252. * Force normal to face away from face.
  50253. */
  50254. protected _forceNormalForward: boolean;
  50255. /**
  50256. * Enables specular anti aliasing in the PBR shader.
  50257. * It will both interacts on the Geometry for analytical and IBL lighting.
  50258. * It also prefilter the roughness map based on the bump values.
  50259. */
  50260. protected _enableSpecularAntiAliasing: boolean;
  50261. /**
  50262. * Default configuration related to image processing available in the PBR Material.
  50263. */
  50264. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  50265. /**
  50266. * Keep track of the image processing observer to allow dispose and replace.
  50267. */
  50268. private _imageProcessingObserver;
  50269. /**
  50270. * Attaches a new image processing configuration to the PBR Material.
  50271. * @param configuration
  50272. */
  50273. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  50274. /**
  50275. * Stores the available render targets.
  50276. */
  50277. private _renderTargets;
  50278. /**
  50279. * Sets the global ambient color for the material used in lighting calculations.
  50280. */
  50281. private _globalAmbientColor;
  50282. /**
  50283. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  50284. */
  50285. private _useLogarithmicDepth;
  50286. /**
  50287. * If set to true, no lighting calculations will be applied.
  50288. */
  50289. private _unlit;
  50290. private _debugMode;
  50291. /**
  50292. * @hidden
  50293. * This is reserved for the inspector.
  50294. * Defines the material debug mode.
  50295. * It helps seeing only some components of the material while troubleshooting.
  50296. */
  50297. debugMode: number;
  50298. /**
  50299. * @hidden
  50300. * This is reserved for the inspector.
  50301. * Specify from where on screen the debug mode should start.
  50302. * The value goes from -1 (full screen) to 1 (not visible)
  50303. * It helps with side by side comparison against the final render
  50304. * This defaults to -1
  50305. */
  50306. private debugLimit;
  50307. /**
  50308. * @hidden
  50309. * This is reserved for the inspector.
  50310. * As the default viewing range might not be enough (if the ambient is really small for instance)
  50311. * You can use the factor to better multiply the final value.
  50312. */
  50313. private debugFactor;
  50314. /**
  50315. * Defines the clear coat layer parameters for the material.
  50316. */
  50317. readonly clearCoat: PBRClearCoatConfiguration;
  50318. /**
  50319. * Defines the anisotropic parameters for the material.
  50320. */
  50321. readonly anisotropy: PBRAnisotropicConfiguration;
  50322. /**
  50323. * Defines the BRDF parameters for the material.
  50324. */
  50325. readonly brdf: PBRBRDFConfiguration;
  50326. /**
  50327. * Defines the Sheen parameters for the material.
  50328. */
  50329. readonly sheen: PBRSheenConfiguration;
  50330. /**
  50331. * Defines the SubSurface parameters for the material.
  50332. */
  50333. readonly subSurface: PBRSubSurfaceConfiguration;
  50334. /**
  50335. * Custom callback helping to override the default shader used in the material.
  50336. */
  50337. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: PBRMaterialDefines) => string;
  50338. protected _rebuildInParallel: boolean;
  50339. /**
  50340. * Instantiates a new PBRMaterial instance.
  50341. *
  50342. * @param name The material name
  50343. * @param scene The scene the material will be use in.
  50344. */
  50345. constructor(name: string, scene: Scene);
  50346. /**
  50347. * Gets a boolean indicating that current material needs to register RTT
  50348. */
  50349. readonly hasRenderTargetTextures: boolean;
  50350. /**
  50351. * Gets the name of the material class.
  50352. */
  50353. getClassName(): string;
  50354. /**
  50355. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  50356. */
  50357. /**
  50358. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  50359. */
  50360. useLogarithmicDepth: boolean;
  50361. /**
  50362. * Gets the current transparency mode.
  50363. */
  50364. /**
  50365. * Sets the transparency mode of the material.
  50366. *
  50367. * | Value | Type | Description |
  50368. * | ----- | ----------------------------------- | ----------- |
  50369. * | 0 | OPAQUE | |
  50370. * | 1 | ALPHATEST | |
  50371. * | 2 | ALPHABLEND | |
  50372. * | 3 | ALPHATESTANDBLEND | |
  50373. *
  50374. */
  50375. transparencyMode: Nullable<number>;
  50376. /**
  50377. * Returns true if alpha blending should be disabled.
  50378. */
  50379. private readonly _disableAlphaBlending;
  50380. /**
  50381. * Specifies whether or not this material should be rendered in alpha blend mode.
  50382. */
  50383. needAlphaBlending(): boolean;
  50384. /**
  50385. * Specifies if the mesh will require alpha blending.
  50386. * @param mesh - BJS mesh.
  50387. */
  50388. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  50389. /**
  50390. * Specifies whether or not this material should be rendered in alpha test mode.
  50391. */
  50392. needAlphaTesting(): boolean;
  50393. /**
  50394. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  50395. */
  50396. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  50397. /**
  50398. * Gets the texture used for the alpha test.
  50399. */
  50400. getAlphaTestTexture(): Nullable<BaseTexture>;
  50401. /**
  50402. * Specifies that the submesh is ready to be used.
  50403. * @param mesh - BJS mesh.
  50404. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  50405. * @param useInstances - Specifies that instances should be used.
  50406. * @returns - boolean indicating that the submesh is ready or not.
  50407. */
  50408. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  50409. /**
  50410. * Specifies if the material uses metallic roughness workflow.
  50411. * @returns boolean specifiying if the material uses metallic roughness workflow.
  50412. */
  50413. isMetallicWorkflow(): boolean;
  50414. private _prepareEffect;
  50415. private _prepareDefines;
  50416. /**
  50417. * Force shader compilation
  50418. */
  50419. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  50420. /**
  50421. * Initializes the uniform buffer layout for the shader.
  50422. */
  50423. buildUniformLayout(): void;
  50424. /**
  50425. * Unbinds the material from the mesh
  50426. */
  50427. unbind(): void;
  50428. /**
  50429. * Binds the submesh data.
  50430. * @param world - The world matrix.
  50431. * @param mesh - The BJS mesh.
  50432. * @param subMesh - A submesh of the BJS mesh.
  50433. */
  50434. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  50435. /**
  50436. * Returns the animatable textures.
  50437. * @returns - Array of animatable textures.
  50438. */
  50439. getAnimatables(): IAnimatable[];
  50440. /**
  50441. * Returns the texture used for reflections.
  50442. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  50443. */
  50444. private _getReflectionTexture;
  50445. /**
  50446. * Returns an array of the actively used textures.
  50447. * @returns - Array of BaseTextures
  50448. */
  50449. getActiveTextures(): BaseTexture[];
  50450. /**
  50451. * Checks to see if a texture is used in the material.
  50452. * @param texture - Base texture to use.
  50453. * @returns - Boolean specifying if a texture is used in the material.
  50454. */
  50455. hasTexture(texture: BaseTexture): boolean;
  50456. /**
  50457. * Disposes the resources of the material.
  50458. * @param forceDisposeEffect - Forces the disposal of effects.
  50459. * @param forceDisposeTextures - Forces the disposal of all textures.
  50460. */
  50461. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  50462. }
  50463. }
  50464. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  50465. import { Nullable } from "babylonjs/types";
  50466. import { Scene } from "babylonjs/scene";
  50467. import { Color3 } from "babylonjs/Maths/math.color";
  50468. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  50469. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  50470. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  50471. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  50472. /**
  50473. * The Physically based material of BJS.
  50474. *
  50475. * This offers the main features of a standard PBR material.
  50476. * For more information, please refer to the documentation :
  50477. * https://doc.babylonjs.com/how_to/physically_based_rendering
  50478. */
  50479. export class PBRMaterial extends PBRBaseMaterial {
  50480. /**
  50481. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  50482. */
  50483. static readonly PBRMATERIAL_OPAQUE: number;
  50484. /**
  50485. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  50486. */
  50487. static readonly PBRMATERIAL_ALPHATEST: number;
  50488. /**
  50489. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50490. */
  50491. static readonly PBRMATERIAL_ALPHABLEND: number;
  50492. /**
  50493. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50494. * They are also discarded below the alpha cutoff threshold to improve performances.
  50495. */
  50496. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  50497. /**
  50498. * Defines the default value of how much AO map is occluding the analytical lights
  50499. * (point spot...).
  50500. */
  50501. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  50502. /**
  50503. * Intensity of the direct lights e.g. the four lights available in your scene.
  50504. * This impacts both the direct diffuse and specular highlights.
  50505. */
  50506. directIntensity: number;
  50507. /**
  50508. * Intensity of the emissive part of the material.
  50509. * This helps controlling the emissive effect without modifying the emissive color.
  50510. */
  50511. emissiveIntensity: number;
  50512. /**
  50513. * Intensity of the environment e.g. how much the environment will light the object
  50514. * either through harmonics for rough material or through the refelction for shiny ones.
  50515. */
  50516. environmentIntensity: number;
  50517. /**
  50518. * This is a special control allowing the reduction of the specular highlights coming from the
  50519. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  50520. */
  50521. specularIntensity: number;
  50522. /**
  50523. * Debug Control allowing disabling the bump map on this material.
  50524. */
  50525. disableBumpMap: boolean;
  50526. /**
  50527. * AKA Diffuse Texture in standard nomenclature.
  50528. */
  50529. albedoTexture: BaseTexture;
  50530. /**
  50531. * AKA Occlusion Texture in other nomenclature.
  50532. */
  50533. ambientTexture: BaseTexture;
  50534. /**
  50535. * AKA Occlusion Texture Intensity in other nomenclature.
  50536. */
  50537. ambientTextureStrength: number;
  50538. /**
  50539. * Defines how much the AO map is occluding the analytical lights (point spot...).
  50540. * 1 means it completely occludes it
  50541. * 0 mean it has no impact
  50542. */
  50543. ambientTextureImpactOnAnalyticalLights: number;
  50544. /**
  50545. * Stores the alpha values in a texture.
  50546. */
  50547. opacityTexture: BaseTexture;
  50548. /**
  50549. * Stores the reflection values in a texture.
  50550. */
  50551. reflectionTexture: Nullable<BaseTexture>;
  50552. /**
  50553. * Stores the emissive values in a texture.
  50554. */
  50555. emissiveTexture: BaseTexture;
  50556. /**
  50557. * AKA Specular texture in other nomenclature.
  50558. */
  50559. reflectivityTexture: BaseTexture;
  50560. /**
  50561. * Used to switch from specular/glossiness to metallic/roughness workflow.
  50562. */
  50563. metallicTexture: BaseTexture;
  50564. /**
  50565. * Specifies the metallic scalar of the metallic/roughness workflow.
  50566. * Can also be used to scale the metalness values of the metallic texture.
  50567. */
  50568. metallic: Nullable<number>;
  50569. /**
  50570. * Specifies the roughness scalar of the metallic/roughness workflow.
  50571. * Can also be used to scale the roughness values of the metallic texture.
  50572. */
  50573. roughness: Nullable<number>;
  50574. /**
  50575. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  50576. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  50577. */
  50578. microSurfaceTexture: BaseTexture;
  50579. /**
  50580. * Stores surface normal data used to displace a mesh in a texture.
  50581. */
  50582. bumpTexture: BaseTexture;
  50583. /**
  50584. * Stores the pre-calculated light information of a mesh in a texture.
  50585. */
  50586. lightmapTexture: BaseTexture;
  50587. /**
  50588. * Stores the refracted light information in a texture.
  50589. */
  50590. refractionTexture: Nullable<BaseTexture>;
  50591. /**
  50592. * The color of a material in ambient lighting.
  50593. */
  50594. ambientColor: Color3;
  50595. /**
  50596. * AKA Diffuse Color in other nomenclature.
  50597. */
  50598. albedoColor: Color3;
  50599. /**
  50600. * AKA Specular Color in other nomenclature.
  50601. */
  50602. reflectivityColor: Color3;
  50603. /**
  50604. * The color reflected from the material.
  50605. */
  50606. reflectionColor: Color3;
  50607. /**
  50608. * The color emitted from the material.
  50609. */
  50610. emissiveColor: Color3;
  50611. /**
  50612. * AKA Glossiness in other nomenclature.
  50613. */
  50614. microSurface: number;
  50615. /**
  50616. * source material index of refraction (IOR)' / 'destination material IOR.
  50617. */
  50618. indexOfRefraction: number;
  50619. /**
  50620. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  50621. */
  50622. invertRefractionY: boolean;
  50623. /**
  50624. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  50625. * Materials half opaque for instance using refraction could benefit from this control.
  50626. */
  50627. linkRefractionWithTransparency: boolean;
  50628. /**
  50629. * If true, the light map contains occlusion information instead of lighting info.
  50630. */
  50631. useLightmapAsShadowmap: boolean;
  50632. /**
  50633. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  50634. */
  50635. useAlphaFromAlbedoTexture: boolean;
  50636. /**
  50637. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  50638. */
  50639. forceAlphaTest: boolean;
  50640. /**
  50641. * Defines the alpha limits in alpha test mode.
  50642. */
  50643. alphaCutOff: number;
  50644. /**
  50645. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  50646. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  50647. */
  50648. useSpecularOverAlpha: boolean;
  50649. /**
  50650. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  50651. */
  50652. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  50653. /**
  50654. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  50655. */
  50656. useRoughnessFromMetallicTextureAlpha: boolean;
  50657. /**
  50658. * Specifies if the metallic texture contains the roughness information in its green channel.
  50659. */
  50660. useRoughnessFromMetallicTextureGreen: boolean;
  50661. /**
  50662. * Specifies if the metallic texture contains the metallness information in its blue channel.
  50663. */
  50664. useMetallnessFromMetallicTextureBlue: boolean;
  50665. /**
  50666. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  50667. */
  50668. useAmbientOcclusionFromMetallicTextureRed: boolean;
  50669. /**
  50670. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  50671. */
  50672. useAmbientInGrayScale: boolean;
  50673. /**
  50674. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  50675. * The material will try to infer what glossiness each pixel should be.
  50676. */
  50677. useAutoMicroSurfaceFromReflectivityMap: boolean;
  50678. /**
  50679. * BJS is using an harcoded light falloff based on a manually sets up range.
  50680. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  50681. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  50682. */
  50683. /**
  50684. * BJS is using an harcoded light falloff based on a manually sets up range.
  50685. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  50686. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  50687. */
  50688. usePhysicalLightFalloff: boolean;
  50689. /**
  50690. * In order to support the falloff compatibility with gltf, a special mode has been added
  50691. * to reproduce the gltf light falloff.
  50692. */
  50693. /**
  50694. * In order to support the falloff compatibility with gltf, a special mode has been added
  50695. * to reproduce the gltf light falloff.
  50696. */
  50697. useGLTFLightFalloff: boolean;
  50698. /**
  50699. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  50700. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  50701. */
  50702. useRadianceOverAlpha: boolean;
  50703. /**
  50704. * Allows using an object space normal map (instead of tangent space).
  50705. */
  50706. useObjectSpaceNormalMap: boolean;
  50707. /**
  50708. * Allows using the bump map in parallax mode.
  50709. */
  50710. useParallax: boolean;
  50711. /**
  50712. * Allows using the bump map in parallax occlusion mode.
  50713. */
  50714. useParallaxOcclusion: boolean;
  50715. /**
  50716. * Controls the scale bias of the parallax mode.
  50717. */
  50718. parallaxScaleBias: number;
  50719. /**
  50720. * If sets to true, disables all the lights affecting the material.
  50721. */
  50722. disableLighting: boolean;
  50723. /**
  50724. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  50725. */
  50726. forceIrradianceInFragment: boolean;
  50727. /**
  50728. * Number of Simultaneous lights allowed on the material.
  50729. */
  50730. maxSimultaneousLights: number;
  50731. /**
  50732. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  50733. */
  50734. invertNormalMapX: boolean;
  50735. /**
  50736. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  50737. */
  50738. invertNormalMapY: boolean;
  50739. /**
  50740. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  50741. */
  50742. twoSidedLighting: boolean;
  50743. /**
  50744. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  50745. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  50746. */
  50747. useAlphaFresnel: boolean;
  50748. /**
  50749. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  50750. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  50751. */
  50752. useLinearAlphaFresnel: boolean;
  50753. /**
  50754. * Let user defines the brdf lookup texture used for IBL.
  50755. * A default 8bit version is embedded but you could point at :
  50756. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  50757. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  50758. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  50759. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  50760. */
  50761. environmentBRDFTexture: Nullable<BaseTexture>;
  50762. /**
  50763. * Force normal to face away from face.
  50764. */
  50765. forceNormalForward: boolean;
  50766. /**
  50767. * Enables specular anti aliasing in the PBR shader.
  50768. * It will both interacts on the Geometry for analytical and IBL lighting.
  50769. * It also prefilter the roughness map based on the bump values.
  50770. */
  50771. enableSpecularAntiAliasing: boolean;
  50772. /**
  50773. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  50774. * makes the reflect vector face the model (under horizon).
  50775. */
  50776. useHorizonOcclusion: boolean;
  50777. /**
  50778. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  50779. * too much the area relying on ambient texture to define their ambient occlusion.
  50780. */
  50781. useRadianceOcclusion: boolean;
  50782. /**
  50783. * If set to true, no lighting calculations will be applied.
  50784. */
  50785. unlit: boolean;
  50786. /**
  50787. * Gets the image processing configuration used either in this material.
  50788. */
  50789. /**
  50790. * Sets the Default image processing configuration used either in the this material.
  50791. *
  50792. * If sets to null, the scene one is in use.
  50793. */
  50794. imageProcessingConfiguration: ImageProcessingConfiguration;
  50795. /**
  50796. * Gets wether the color curves effect is enabled.
  50797. */
  50798. /**
  50799. * Sets wether the color curves effect is enabled.
  50800. */
  50801. cameraColorCurvesEnabled: boolean;
  50802. /**
  50803. * Gets wether the color grading effect is enabled.
  50804. */
  50805. /**
  50806. * Gets wether the color grading effect is enabled.
  50807. */
  50808. cameraColorGradingEnabled: boolean;
  50809. /**
  50810. * Gets wether tonemapping is enabled or not.
  50811. */
  50812. /**
  50813. * Sets wether tonemapping is enabled or not
  50814. */
  50815. cameraToneMappingEnabled: boolean;
  50816. /**
  50817. * The camera exposure used on this material.
  50818. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  50819. * This corresponds to a photographic exposure.
  50820. */
  50821. /**
  50822. * The camera exposure used on this material.
  50823. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  50824. * This corresponds to a photographic exposure.
  50825. */
  50826. cameraExposure: number;
  50827. /**
  50828. * Gets The camera contrast used on this material.
  50829. */
  50830. /**
  50831. * Sets The camera contrast used on this material.
  50832. */
  50833. cameraContrast: number;
  50834. /**
  50835. * Gets the Color Grading 2D Lookup Texture.
  50836. */
  50837. /**
  50838. * Sets the Color Grading 2D Lookup Texture.
  50839. */
  50840. cameraColorGradingTexture: Nullable<BaseTexture>;
  50841. /**
  50842. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  50843. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  50844. * 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;
  50845. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  50846. */
  50847. /**
  50848. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  50849. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  50850. * 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;
  50851. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  50852. */
  50853. cameraColorCurves: Nullable<ColorCurves>;
  50854. /**
  50855. * Instantiates a new PBRMaterial instance.
  50856. *
  50857. * @param name The material name
  50858. * @param scene The scene the material will be use in.
  50859. */
  50860. constructor(name: string, scene: Scene);
  50861. /**
  50862. * Returns the name of this material class.
  50863. */
  50864. getClassName(): string;
  50865. /**
  50866. * Makes a duplicate of the current material.
  50867. * @param name - name to use for the new material.
  50868. */
  50869. clone(name: string): PBRMaterial;
  50870. /**
  50871. * Serializes this PBR Material.
  50872. * @returns - An object with the serialized material.
  50873. */
  50874. serialize(): any;
  50875. /**
  50876. * Parses a PBR Material from a serialized object.
  50877. * @param source - Serialized object.
  50878. * @param scene - BJS scene instance.
  50879. * @param rootUrl - url for the scene object
  50880. * @returns - PBRMaterial
  50881. */
  50882. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  50883. }
  50884. }
  50885. declare module "babylonjs/Misc/dds" {
  50886. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  50887. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  50888. import { Nullable } from "babylonjs/types";
  50889. import { Scene } from "babylonjs/scene";
  50890. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  50891. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  50892. /**
  50893. * Direct draw surface info
  50894. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  50895. */
  50896. export interface DDSInfo {
  50897. /**
  50898. * Width of the texture
  50899. */
  50900. width: number;
  50901. /**
  50902. * Width of the texture
  50903. */
  50904. height: number;
  50905. /**
  50906. * Number of Mipmaps for the texture
  50907. * @see https://en.wikipedia.org/wiki/Mipmap
  50908. */
  50909. mipmapCount: number;
  50910. /**
  50911. * If the textures format is a known fourCC format
  50912. * @see https://www.fourcc.org/
  50913. */
  50914. isFourCC: boolean;
  50915. /**
  50916. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  50917. */
  50918. isRGB: boolean;
  50919. /**
  50920. * If the texture is a lumincance format
  50921. */
  50922. isLuminance: boolean;
  50923. /**
  50924. * If this is a cube texture
  50925. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  50926. */
  50927. isCube: boolean;
  50928. /**
  50929. * If the texture is a compressed format eg. FOURCC_DXT1
  50930. */
  50931. isCompressed: boolean;
  50932. /**
  50933. * The dxgiFormat of the texture
  50934. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  50935. */
  50936. dxgiFormat: number;
  50937. /**
  50938. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  50939. */
  50940. textureType: number;
  50941. /**
  50942. * Sphericle polynomial created for the dds texture
  50943. */
  50944. sphericalPolynomial?: SphericalPolynomial;
  50945. }
  50946. /**
  50947. * Class used to provide DDS decompression tools
  50948. */
  50949. export class DDSTools {
  50950. /**
  50951. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  50952. */
  50953. static StoreLODInAlphaChannel: boolean;
  50954. /**
  50955. * Gets DDS information from an array buffer
  50956. * @param arrayBuffer defines the array buffer to read data from
  50957. * @returns the DDS information
  50958. */
  50959. static GetDDSInfo(arrayBuffer: any): DDSInfo;
  50960. private static _FloatView;
  50961. private static _Int32View;
  50962. private static _ToHalfFloat;
  50963. private static _FromHalfFloat;
  50964. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  50965. private static _GetHalfFloatRGBAArrayBuffer;
  50966. private static _GetFloatRGBAArrayBuffer;
  50967. private static _GetFloatAsUIntRGBAArrayBuffer;
  50968. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  50969. private static _GetRGBAArrayBuffer;
  50970. private static _ExtractLongWordOrder;
  50971. private static _GetRGBArrayBuffer;
  50972. private static _GetLuminanceArrayBuffer;
  50973. /**
  50974. * Uploads DDS Levels to a Babylon Texture
  50975. * @hidden
  50976. */
  50977. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, arrayBuffer: any, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  50978. }
  50979. module "babylonjs/Engines/thinEngine" {
  50980. interface ThinEngine {
  50981. /**
  50982. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  50983. * @param rootUrl defines the url where the file to load is located
  50984. * @param scene defines the current scene
  50985. * @param lodScale defines scale to apply to the mip map selection
  50986. * @param lodOffset defines offset to apply to the mip map selection
  50987. * @param onLoad defines an optional callback raised when the texture is loaded
  50988. * @param onError defines an optional callback raised if there is an issue to load the texture
  50989. * @param format defines the format of the data
  50990. * @param forcedExtension defines the extension to use to pick the right loader
  50991. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  50992. * @returns the cube texture as an InternalTexture
  50993. */
  50994. 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;
  50995. }
  50996. }
  50997. }
  50998. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  50999. import { Nullable } from "babylonjs/types";
  51000. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51001. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51002. /**
  51003. * Implementation of the DDS Texture Loader.
  51004. * @hidden
  51005. */
  51006. export class _DDSTextureLoader implements IInternalTextureLoader {
  51007. /**
  51008. * Defines wether the loader supports cascade loading the different faces.
  51009. */
  51010. readonly supportCascades: boolean;
  51011. /**
  51012. * This returns if the loader support the current file information.
  51013. * @param extension defines the file extension of the file being loaded
  51014. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51015. * @param fallback defines the fallback internal texture if any
  51016. * @param isBase64 defines whether the texture is encoded as a base64
  51017. * @param isBuffer defines whether the texture data are stored as a buffer
  51018. * @returns true if the loader can load the specified file
  51019. */
  51020. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51021. /**
  51022. * Transform the url before loading if required.
  51023. * @param rootUrl the url of the texture
  51024. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51025. * @returns the transformed texture
  51026. */
  51027. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51028. /**
  51029. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51030. * @param rootUrl the url of the texture
  51031. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51032. * @returns the fallback texture
  51033. */
  51034. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51035. /**
  51036. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51037. * @param data contains the texture data
  51038. * @param texture defines the BabylonJS internal texture
  51039. * @param createPolynomials will be true if polynomials have been requested
  51040. * @param onLoad defines the callback to trigger once the texture is ready
  51041. * @param onError defines the callback to trigger in case of error
  51042. */
  51043. loadCubeData(imgs: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51044. /**
  51045. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51046. * @param data contains the texture data
  51047. * @param texture defines the BabylonJS internal texture
  51048. * @param callback defines the method to call once ready to upload
  51049. */
  51050. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  51051. }
  51052. }
  51053. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  51054. import { Nullable } from "babylonjs/types";
  51055. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51056. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51057. /**
  51058. * Implementation of the ENV Texture Loader.
  51059. * @hidden
  51060. */
  51061. export class _ENVTextureLoader implements IInternalTextureLoader {
  51062. /**
  51063. * Defines wether the loader supports cascade loading the different faces.
  51064. */
  51065. readonly supportCascades: boolean;
  51066. /**
  51067. * This returns if the loader support the current file information.
  51068. * @param extension defines the file extension of the file being loaded
  51069. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51070. * @param fallback defines the fallback internal texture if any
  51071. * @param isBase64 defines whether the texture is encoded as a base64
  51072. * @param isBuffer defines whether the texture data are stored as a buffer
  51073. * @returns true if the loader can load the specified file
  51074. */
  51075. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51076. /**
  51077. * Transform the url before loading if required.
  51078. * @param rootUrl the url of the texture
  51079. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51080. * @returns the transformed texture
  51081. */
  51082. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51083. /**
  51084. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51085. * @param rootUrl the url of the texture
  51086. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51087. * @returns the fallback texture
  51088. */
  51089. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51090. /**
  51091. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51092. * @param data contains the texture data
  51093. * @param texture defines the BabylonJS internal texture
  51094. * @param createPolynomials will be true if polynomials have been requested
  51095. * @param onLoad defines the callback to trigger once the texture is ready
  51096. * @param onError defines the callback to trigger in case of error
  51097. */
  51098. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51099. /**
  51100. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51101. * @param data contains the texture data
  51102. * @param texture defines the BabylonJS internal texture
  51103. * @param callback defines the method to call once ready to upload
  51104. */
  51105. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  51106. }
  51107. }
  51108. declare module "babylonjs/Misc/khronosTextureContainer" {
  51109. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51110. /**
  51111. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  51112. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  51113. */
  51114. export class KhronosTextureContainer {
  51115. /** contents of the KTX container file */
  51116. arrayBuffer: any;
  51117. private static HEADER_LEN;
  51118. private static COMPRESSED_2D;
  51119. private static COMPRESSED_3D;
  51120. private static TEX_2D;
  51121. private static TEX_3D;
  51122. /**
  51123. * Gets the openGL type
  51124. */
  51125. glType: number;
  51126. /**
  51127. * Gets the openGL type size
  51128. */
  51129. glTypeSize: number;
  51130. /**
  51131. * Gets the openGL format
  51132. */
  51133. glFormat: number;
  51134. /**
  51135. * Gets the openGL internal format
  51136. */
  51137. glInternalFormat: number;
  51138. /**
  51139. * Gets the base internal format
  51140. */
  51141. glBaseInternalFormat: number;
  51142. /**
  51143. * Gets image width in pixel
  51144. */
  51145. pixelWidth: number;
  51146. /**
  51147. * Gets image height in pixel
  51148. */
  51149. pixelHeight: number;
  51150. /**
  51151. * Gets image depth in pixels
  51152. */
  51153. pixelDepth: number;
  51154. /**
  51155. * Gets the number of array elements
  51156. */
  51157. numberOfArrayElements: number;
  51158. /**
  51159. * Gets the number of faces
  51160. */
  51161. numberOfFaces: number;
  51162. /**
  51163. * Gets the number of mipmap levels
  51164. */
  51165. numberOfMipmapLevels: number;
  51166. /**
  51167. * Gets the bytes of key value data
  51168. */
  51169. bytesOfKeyValueData: number;
  51170. /**
  51171. * Gets the load type
  51172. */
  51173. loadType: number;
  51174. /**
  51175. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  51176. */
  51177. isInvalid: boolean;
  51178. /**
  51179. * Creates a new KhronosTextureContainer
  51180. * @param arrayBuffer contents of the KTX container file
  51181. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  51182. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  51183. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  51184. */
  51185. constructor(
  51186. /** contents of the KTX container file */
  51187. arrayBuffer: any, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  51188. /**
  51189. * Uploads KTX content to a Babylon Texture.
  51190. * It is assumed that the texture has already been created & is currently bound
  51191. * @hidden
  51192. */
  51193. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  51194. private _upload2DCompressedLevels;
  51195. }
  51196. }
  51197. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  51198. import { Nullable } from "babylonjs/types";
  51199. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51200. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51201. /**
  51202. * Implementation of the KTX Texture Loader.
  51203. * @hidden
  51204. */
  51205. export class _KTXTextureLoader implements IInternalTextureLoader {
  51206. /**
  51207. * Defines wether the loader supports cascade loading the different faces.
  51208. */
  51209. readonly supportCascades: boolean;
  51210. /**
  51211. * This returns if the loader support the current file information.
  51212. * @param extension defines the file extension of the file being loaded
  51213. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51214. * @param fallback defines the fallback internal texture if any
  51215. * @param isBase64 defines whether the texture is encoded as a base64
  51216. * @param isBuffer defines whether the texture data are stored as a buffer
  51217. * @returns true if the loader can load the specified file
  51218. */
  51219. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51220. /**
  51221. * Transform the url before loading if required.
  51222. * @param rootUrl the url of the texture
  51223. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51224. * @returns the transformed texture
  51225. */
  51226. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51227. /**
  51228. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51229. * @param rootUrl the url of the texture
  51230. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51231. * @returns the fallback texture
  51232. */
  51233. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51234. /**
  51235. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51236. * @param data contains the texture data
  51237. * @param texture defines the BabylonJS internal texture
  51238. * @param createPolynomials will be true if polynomials have been requested
  51239. * @param onLoad defines the callback to trigger once the texture is ready
  51240. * @param onError defines the callback to trigger in case of error
  51241. */
  51242. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51243. /**
  51244. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51245. * @param data contains the texture data
  51246. * @param texture defines the BabylonJS internal texture
  51247. * @param callback defines the method to call once ready to upload
  51248. */
  51249. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  51250. }
  51251. }
  51252. declare module "babylonjs/Cameras/XR/webXRDefaultExperience" {
  51253. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  51254. import { Scene } from "babylonjs/scene";
  51255. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  51256. import { WebXRControllerModelLoader } from "babylonjs/Cameras/XR/webXRControllerModelLoader";
  51257. import { WebXRControllerPointerSelection } from "babylonjs/Cameras/XR/webXRControllerPointerSelection";
  51258. import { WebXRControllerTeleportation } from "babylonjs/Cameras/XR/webXRControllerTeleportation";
  51259. import { WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  51260. import { WebXREnterExitUI } from "babylonjs/Cameras/XR/webXREnterExitUI";
  51261. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51262. /**
  51263. * Options for the default xr helper
  51264. */
  51265. export class WebXRDefaultExperienceOptions {
  51266. /**
  51267. * Floor meshes that should be used for teleporting
  51268. */
  51269. floorMeshes: Array<AbstractMesh>;
  51270. /**
  51271. * Enable or disable default UI to enter XR
  51272. */
  51273. disableDefaultUI: boolean;
  51274. }
  51275. /**
  51276. * Default experience which provides a similar setup to the previous webVRExperience
  51277. */
  51278. export class WebXRDefaultExperience {
  51279. /**
  51280. * Base experience
  51281. */
  51282. baseExperience: WebXRExperienceHelper;
  51283. /**
  51284. * Input experience extension
  51285. */
  51286. input: WebXRInput;
  51287. /**
  51288. * Loads the controller models
  51289. */
  51290. controllerModelLoader: WebXRControllerModelLoader;
  51291. /**
  51292. * Enables laser pointer and selection
  51293. */
  51294. pointerSelection: WebXRControllerPointerSelection;
  51295. /**
  51296. * Enables teleportation
  51297. */
  51298. teleportation: WebXRControllerTeleportation;
  51299. /**
  51300. * Enables ui for enetering/exiting xr
  51301. */
  51302. enterExitUI: WebXREnterExitUI;
  51303. /**
  51304. * Default target xr should render to
  51305. */
  51306. renderTarget: WebXRRenderTarget;
  51307. /**
  51308. * Creates the default xr experience
  51309. * @param scene scene
  51310. * @param options options for basic configuration
  51311. * @returns resulting WebXRDefaultExperience
  51312. */
  51313. static CreateAsync(scene: Scene, options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51314. private constructor();
  51315. /**
  51316. * DIsposes of the experience helper
  51317. */
  51318. dispose(): void;
  51319. }
  51320. }
  51321. declare module "babylonjs/Helpers/sceneHelpers" {
  51322. import { Nullable } from "babylonjs/types";
  51323. import { Mesh } from "babylonjs/Meshes/mesh";
  51324. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  51325. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  51326. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  51327. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  51328. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  51329. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  51330. import "babylonjs/Meshes/Builders/boxBuilder";
  51331. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/Cameras/XR/webXRDefaultExperience";
  51332. /** @hidden */
  51333. export var _forceSceneHelpersToBundle: boolean;
  51334. module "babylonjs/scene" {
  51335. interface Scene {
  51336. /**
  51337. * Creates a default light for the scene.
  51338. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  51339. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  51340. */
  51341. createDefaultLight(replace?: boolean): void;
  51342. /**
  51343. * Creates a default camera for the scene.
  51344. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  51345. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  51346. * @param replace has default false, when true replaces the active camera in the scene
  51347. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  51348. */
  51349. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  51350. /**
  51351. * Creates a default camera and a default light.
  51352. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  51353. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  51354. * @param replace has the default false, when true replaces the active camera/light in the scene
  51355. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  51356. */
  51357. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  51358. /**
  51359. * Creates a new sky box
  51360. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  51361. * @param environmentTexture defines the texture to use as environment texture
  51362. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  51363. * @param scale defines the overall scale of the skybox
  51364. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  51365. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  51366. * @returns a new mesh holding the sky box
  51367. */
  51368. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  51369. /**
  51370. * Creates a new environment
  51371. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  51372. * @param options defines the options you can use to configure the environment
  51373. * @returns the new EnvironmentHelper
  51374. */
  51375. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  51376. /**
  51377. * Creates a new VREXperienceHelper
  51378. * @see http://doc.babylonjs.com/how_to/webvr_helper
  51379. * @param webVROptions defines the options used to create the new VREXperienceHelper
  51380. * @returns a new VREXperienceHelper
  51381. */
  51382. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  51383. /**
  51384. * Creates a new WebXRDefaultExperience
  51385. * @see http://doc.babylonjs.com/how_to/webxr
  51386. * @param options experience options
  51387. * @returns a promise for a new WebXRDefaultExperience
  51388. */
  51389. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51390. }
  51391. }
  51392. }
  51393. declare module "babylonjs/Helpers/videoDome" {
  51394. import { Scene } from "babylonjs/scene";
  51395. import { TransformNode } from "babylonjs/Meshes/transformNode";
  51396. import { Mesh } from "babylonjs/Meshes/mesh";
  51397. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  51398. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  51399. import "babylonjs/Meshes/Builders/sphereBuilder";
  51400. /**
  51401. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  51402. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  51403. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  51404. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  51405. */
  51406. export class VideoDome extends TransformNode {
  51407. /**
  51408. * Define the video source as a Monoscopic panoramic 360 video.
  51409. */
  51410. static readonly MODE_MONOSCOPIC: number;
  51411. /**
  51412. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  51413. */
  51414. static readonly MODE_TOPBOTTOM: number;
  51415. /**
  51416. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  51417. */
  51418. static readonly MODE_SIDEBYSIDE: number;
  51419. private _halfDome;
  51420. private _useDirectMapping;
  51421. /**
  51422. * The video texture being displayed on the sphere
  51423. */
  51424. protected _videoTexture: VideoTexture;
  51425. /**
  51426. * Gets the video texture being displayed on the sphere
  51427. */
  51428. readonly videoTexture: VideoTexture;
  51429. /**
  51430. * The skybox material
  51431. */
  51432. protected _material: BackgroundMaterial;
  51433. /**
  51434. * The surface used for the skybox
  51435. */
  51436. protected _mesh: Mesh;
  51437. /**
  51438. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  51439. */
  51440. private _halfDomeMask;
  51441. /**
  51442. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  51443. * Also see the options.resolution property.
  51444. */
  51445. fovMultiplier: number;
  51446. private _videoMode;
  51447. /**
  51448. * Gets or set the current video mode for the video. It can be:
  51449. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  51450. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  51451. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  51452. */
  51453. videoMode: number;
  51454. /**
  51455. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  51456. *
  51457. */
  51458. /**
  51459. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  51460. */
  51461. halfDome: boolean;
  51462. /**
  51463. * Oberserver used in Stereoscopic VR Mode.
  51464. */
  51465. private _onBeforeCameraRenderObserver;
  51466. /**
  51467. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  51468. * @param name Element's name, child elements will append suffixes for their own names.
  51469. * @param urlsOrVideo defines the url(s) or the video element to use
  51470. * @param options An object containing optional or exposed sub element properties
  51471. */
  51472. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  51473. resolution?: number;
  51474. clickToPlay?: boolean;
  51475. autoPlay?: boolean;
  51476. loop?: boolean;
  51477. size?: number;
  51478. poster?: string;
  51479. faceForward?: boolean;
  51480. useDirectMapping?: boolean;
  51481. halfDomeMode?: boolean;
  51482. }, scene: Scene);
  51483. private _changeVideoMode;
  51484. /**
  51485. * Releases resources associated with this node.
  51486. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  51487. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  51488. */
  51489. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  51490. }
  51491. }
  51492. declare module "babylonjs/Helpers/index" {
  51493. export * from "babylonjs/Helpers/environmentHelper";
  51494. export * from "babylonjs/Helpers/photoDome";
  51495. export * from "babylonjs/Helpers/sceneHelpers";
  51496. export * from "babylonjs/Helpers/videoDome";
  51497. }
  51498. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  51499. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  51500. import { IDisposable } from "babylonjs/scene";
  51501. import { Engine } from "babylonjs/Engines/engine";
  51502. /**
  51503. * This class can be used to get instrumentation data from a Babylon engine
  51504. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  51505. */
  51506. export class EngineInstrumentation implements IDisposable {
  51507. /**
  51508. * Define the instrumented engine.
  51509. */
  51510. engine: Engine;
  51511. private _captureGPUFrameTime;
  51512. private _gpuFrameTimeToken;
  51513. private _gpuFrameTime;
  51514. private _captureShaderCompilationTime;
  51515. private _shaderCompilationTime;
  51516. private _onBeginFrameObserver;
  51517. private _onEndFrameObserver;
  51518. private _onBeforeShaderCompilationObserver;
  51519. private _onAfterShaderCompilationObserver;
  51520. /**
  51521. * Gets the perf counter used for GPU frame time
  51522. */
  51523. readonly gpuFrameTimeCounter: PerfCounter;
  51524. /**
  51525. * Gets the GPU frame time capture status
  51526. */
  51527. /**
  51528. * Enable or disable the GPU frame time capture
  51529. */
  51530. captureGPUFrameTime: boolean;
  51531. /**
  51532. * Gets the perf counter used for shader compilation time
  51533. */
  51534. readonly shaderCompilationTimeCounter: PerfCounter;
  51535. /**
  51536. * Gets the shader compilation time capture status
  51537. */
  51538. /**
  51539. * Enable or disable the shader compilation time capture
  51540. */
  51541. captureShaderCompilationTime: boolean;
  51542. /**
  51543. * Instantiates a new engine instrumentation.
  51544. * This class can be used to get instrumentation data from a Babylon engine
  51545. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  51546. * @param engine Defines the engine to instrument
  51547. */
  51548. constructor(
  51549. /**
  51550. * Define the instrumented engine.
  51551. */
  51552. engine: Engine);
  51553. /**
  51554. * Dispose and release associated resources.
  51555. */
  51556. dispose(): void;
  51557. }
  51558. }
  51559. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  51560. import { Scene, IDisposable } from "babylonjs/scene";
  51561. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  51562. /**
  51563. * This class can be used to get instrumentation data from a Babylon engine
  51564. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  51565. */
  51566. export class SceneInstrumentation implements IDisposable {
  51567. /**
  51568. * Defines the scene to instrument
  51569. */
  51570. scene: Scene;
  51571. private _captureActiveMeshesEvaluationTime;
  51572. private _activeMeshesEvaluationTime;
  51573. private _captureRenderTargetsRenderTime;
  51574. private _renderTargetsRenderTime;
  51575. private _captureFrameTime;
  51576. private _frameTime;
  51577. private _captureRenderTime;
  51578. private _renderTime;
  51579. private _captureInterFrameTime;
  51580. private _interFrameTime;
  51581. private _captureParticlesRenderTime;
  51582. private _particlesRenderTime;
  51583. private _captureSpritesRenderTime;
  51584. private _spritesRenderTime;
  51585. private _capturePhysicsTime;
  51586. private _physicsTime;
  51587. private _captureAnimationsTime;
  51588. private _animationsTime;
  51589. private _captureCameraRenderTime;
  51590. private _cameraRenderTime;
  51591. private _onBeforeActiveMeshesEvaluationObserver;
  51592. private _onAfterActiveMeshesEvaluationObserver;
  51593. private _onBeforeRenderTargetsRenderObserver;
  51594. private _onAfterRenderTargetsRenderObserver;
  51595. private _onAfterRenderObserver;
  51596. private _onBeforeDrawPhaseObserver;
  51597. private _onAfterDrawPhaseObserver;
  51598. private _onBeforeAnimationsObserver;
  51599. private _onBeforeParticlesRenderingObserver;
  51600. private _onAfterParticlesRenderingObserver;
  51601. private _onBeforeSpritesRenderingObserver;
  51602. private _onAfterSpritesRenderingObserver;
  51603. private _onBeforePhysicsObserver;
  51604. private _onAfterPhysicsObserver;
  51605. private _onAfterAnimationsObserver;
  51606. private _onBeforeCameraRenderObserver;
  51607. private _onAfterCameraRenderObserver;
  51608. /**
  51609. * Gets the perf counter used for active meshes evaluation time
  51610. */
  51611. readonly activeMeshesEvaluationTimeCounter: PerfCounter;
  51612. /**
  51613. * Gets the active meshes evaluation time capture status
  51614. */
  51615. /**
  51616. * Enable or disable the active meshes evaluation time capture
  51617. */
  51618. captureActiveMeshesEvaluationTime: boolean;
  51619. /**
  51620. * Gets the perf counter used for render targets render time
  51621. */
  51622. readonly renderTargetsRenderTimeCounter: PerfCounter;
  51623. /**
  51624. * Gets the render targets render time capture status
  51625. */
  51626. /**
  51627. * Enable or disable the render targets render time capture
  51628. */
  51629. captureRenderTargetsRenderTime: boolean;
  51630. /**
  51631. * Gets the perf counter used for particles render time
  51632. */
  51633. readonly particlesRenderTimeCounter: PerfCounter;
  51634. /**
  51635. * Gets the particles render time capture status
  51636. */
  51637. /**
  51638. * Enable or disable the particles render time capture
  51639. */
  51640. captureParticlesRenderTime: boolean;
  51641. /**
  51642. * Gets the perf counter used for sprites render time
  51643. */
  51644. readonly spritesRenderTimeCounter: PerfCounter;
  51645. /**
  51646. * Gets the sprites render time capture status
  51647. */
  51648. /**
  51649. * Enable or disable the sprites render time capture
  51650. */
  51651. captureSpritesRenderTime: boolean;
  51652. /**
  51653. * Gets the perf counter used for physics time
  51654. */
  51655. readonly physicsTimeCounter: PerfCounter;
  51656. /**
  51657. * Gets the physics time capture status
  51658. */
  51659. /**
  51660. * Enable or disable the physics time capture
  51661. */
  51662. capturePhysicsTime: boolean;
  51663. /**
  51664. * Gets the perf counter used for animations time
  51665. */
  51666. readonly animationsTimeCounter: PerfCounter;
  51667. /**
  51668. * Gets the animations time capture status
  51669. */
  51670. /**
  51671. * Enable or disable the animations time capture
  51672. */
  51673. captureAnimationsTime: boolean;
  51674. /**
  51675. * Gets the perf counter used for frame time capture
  51676. */
  51677. readonly frameTimeCounter: PerfCounter;
  51678. /**
  51679. * Gets the frame time capture status
  51680. */
  51681. /**
  51682. * Enable or disable the frame time capture
  51683. */
  51684. captureFrameTime: boolean;
  51685. /**
  51686. * Gets the perf counter used for inter-frames time capture
  51687. */
  51688. readonly interFrameTimeCounter: PerfCounter;
  51689. /**
  51690. * Gets the inter-frames time capture status
  51691. */
  51692. /**
  51693. * Enable or disable the inter-frames time capture
  51694. */
  51695. captureInterFrameTime: boolean;
  51696. /**
  51697. * Gets the perf counter used for render time capture
  51698. */
  51699. readonly renderTimeCounter: PerfCounter;
  51700. /**
  51701. * Gets the render time capture status
  51702. */
  51703. /**
  51704. * Enable or disable the render time capture
  51705. */
  51706. captureRenderTime: boolean;
  51707. /**
  51708. * Gets the perf counter used for camera render time capture
  51709. */
  51710. readonly cameraRenderTimeCounter: PerfCounter;
  51711. /**
  51712. * Gets the camera render time capture status
  51713. */
  51714. /**
  51715. * Enable or disable the camera render time capture
  51716. */
  51717. captureCameraRenderTime: boolean;
  51718. /**
  51719. * Gets the perf counter used for draw calls
  51720. */
  51721. readonly drawCallsCounter: PerfCounter;
  51722. /**
  51723. * Instantiates a new scene instrumentation.
  51724. * This class can be used to get instrumentation data from a Babylon engine
  51725. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  51726. * @param scene Defines the scene to instrument
  51727. */
  51728. constructor(
  51729. /**
  51730. * Defines the scene to instrument
  51731. */
  51732. scene: Scene);
  51733. /**
  51734. * Dispose and release associated resources.
  51735. */
  51736. dispose(): void;
  51737. }
  51738. }
  51739. declare module "babylonjs/Instrumentation/index" {
  51740. export * from "babylonjs/Instrumentation/engineInstrumentation";
  51741. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  51742. export * from "babylonjs/Instrumentation/timeToken";
  51743. }
  51744. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  51745. /** @hidden */
  51746. export var glowMapGenerationPixelShader: {
  51747. name: string;
  51748. shader: string;
  51749. };
  51750. }
  51751. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  51752. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  51753. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  51754. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  51755. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  51756. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  51757. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  51758. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  51759. /** @hidden */
  51760. export var glowMapGenerationVertexShader: {
  51761. name: string;
  51762. shader: string;
  51763. };
  51764. }
  51765. declare module "babylonjs/Layers/effectLayer" {
  51766. import { Observable } from "babylonjs/Misc/observable";
  51767. import { Nullable } from "babylonjs/types";
  51768. import { Camera } from "babylonjs/Cameras/camera";
  51769. import { Scene } from "babylonjs/scene";
  51770. import { ISize } from "babylonjs/Maths/math.size";
  51771. import { Color4 } from "babylonjs/Maths/math.color";
  51772. import { Engine } from "babylonjs/Engines/engine";
  51773. import { SubMesh } from "babylonjs/Meshes/subMesh";
  51774. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51775. import { Mesh } from "babylonjs/Meshes/mesh";
  51776. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  51777. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  51778. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  51779. import { Effect } from "babylonjs/Materials/effect";
  51780. import { Material } from "babylonjs/Materials/material";
  51781. import "babylonjs/Shaders/glowMapGeneration.fragment";
  51782. import "babylonjs/Shaders/glowMapGeneration.vertex";
  51783. /**
  51784. * Effect layer options. This helps customizing the behaviour
  51785. * of the effect layer.
  51786. */
  51787. export interface IEffectLayerOptions {
  51788. /**
  51789. * Multiplication factor apply to the canvas size to compute the render target size
  51790. * used to generated the objects (the smaller the faster).
  51791. */
  51792. mainTextureRatio: number;
  51793. /**
  51794. * Enforces a fixed size texture to ensure effect stability across devices.
  51795. */
  51796. mainTextureFixedSize?: number;
  51797. /**
  51798. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  51799. */
  51800. alphaBlendingMode: number;
  51801. /**
  51802. * The camera attached to the layer.
  51803. */
  51804. camera: Nullable<Camera>;
  51805. /**
  51806. * The rendering group to draw the layer in.
  51807. */
  51808. renderingGroupId: number;
  51809. }
  51810. /**
  51811. * The effect layer Helps adding post process effect blended with the main pass.
  51812. *
  51813. * This can be for instance use to generate glow or higlight effects on the scene.
  51814. *
  51815. * The effect layer class can not be used directly and is intented to inherited from to be
  51816. * customized per effects.
  51817. */
  51818. export abstract class EffectLayer {
  51819. private _vertexBuffers;
  51820. private _indexBuffer;
  51821. private _cachedDefines;
  51822. private _effectLayerMapGenerationEffect;
  51823. private _effectLayerOptions;
  51824. private _mergeEffect;
  51825. protected _scene: Scene;
  51826. protected _engine: Engine;
  51827. protected _maxSize: number;
  51828. protected _mainTextureDesiredSize: ISize;
  51829. protected _mainTexture: RenderTargetTexture;
  51830. protected _shouldRender: boolean;
  51831. protected _postProcesses: PostProcess[];
  51832. protected _textures: BaseTexture[];
  51833. protected _emissiveTextureAndColor: {
  51834. texture: Nullable<BaseTexture>;
  51835. color: Color4;
  51836. };
  51837. /**
  51838. * The name of the layer
  51839. */
  51840. name: string;
  51841. /**
  51842. * The clear color of the texture used to generate the glow map.
  51843. */
  51844. neutralColor: Color4;
  51845. /**
  51846. * Specifies wether the highlight layer is enabled or not.
  51847. */
  51848. isEnabled: boolean;
  51849. /**
  51850. * Gets the camera attached to the layer.
  51851. */
  51852. readonly camera: Nullable<Camera>;
  51853. /**
  51854. * Gets the rendering group id the layer should render in.
  51855. */
  51856. renderingGroupId: number;
  51857. /**
  51858. * An event triggered when the effect layer has been disposed.
  51859. */
  51860. onDisposeObservable: Observable<EffectLayer>;
  51861. /**
  51862. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  51863. */
  51864. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  51865. /**
  51866. * An event triggered when the generated texture is being merged in the scene.
  51867. */
  51868. onBeforeComposeObservable: Observable<EffectLayer>;
  51869. /**
  51870. * An event triggered when the mesh is rendered into the effect render target.
  51871. */
  51872. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  51873. /**
  51874. * An event triggered after the mesh has been rendered into the effect render target.
  51875. */
  51876. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  51877. /**
  51878. * An event triggered when the generated texture has been merged in the scene.
  51879. */
  51880. onAfterComposeObservable: Observable<EffectLayer>;
  51881. /**
  51882. * An event triggered when the efffect layer changes its size.
  51883. */
  51884. onSizeChangedObservable: Observable<EffectLayer>;
  51885. /** @hidden */
  51886. static _SceneComponentInitialization: (scene: Scene) => void;
  51887. /**
  51888. * Instantiates a new effect Layer and references it in the scene.
  51889. * @param name The name of the layer
  51890. * @param scene The scene to use the layer in
  51891. */
  51892. constructor(
  51893. /** The Friendly of the effect in the scene */
  51894. name: string, scene: Scene);
  51895. /**
  51896. * Get the effect name of the layer.
  51897. * @return The effect name
  51898. */
  51899. abstract getEffectName(): string;
  51900. /**
  51901. * Checks for the readiness of the element composing the layer.
  51902. * @param subMesh the mesh to check for
  51903. * @param useInstances specify wether or not to use instances to render the mesh
  51904. * @return true if ready otherwise, false
  51905. */
  51906. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  51907. /**
  51908. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  51909. * @returns true if the effect requires stencil during the main canvas render pass.
  51910. */
  51911. abstract needStencil(): boolean;
  51912. /**
  51913. * Create the merge effect. This is the shader use to blit the information back
  51914. * to the main canvas at the end of the scene rendering.
  51915. * @returns The effect containing the shader used to merge the effect on the main canvas
  51916. */
  51917. protected abstract _createMergeEffect(): Effect;
  51918. /**
  51919. * Creates the render target textures and post processes used in the effect layer.
  51920. */
  51921. protected abstract _createTextureAndPostProcesses(): void;
  51922. /**
  51923. * Implementation specific of rendering the generating effect on the main canvas.
  51924. * @param effect The effect used to render through
  51925. */
  51926. protected abstract _internalRender(effect: Effect): void;
  51927. /**
  51928. * Sets the required values for both the emissive texture and and the main color.
  51929. */
  51930. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  51931. /**
  51932. * Free any resources and references associated to a mesh.
  51933. * Internal use
  51934. * @param mesh The mesh to free.
  51935. */
  51936. abstract _disposeMesh(mesh: Mesh): void;
  51937. /**
  51938. * Serializes this layer (Glow or Highlight for example)
  51939. * @returns a serialized layer object
  51940. */
  51941. abstract serialize?(): any;
  51942. /**
  51943. * Initializes the effect layer with the required options.
  51944. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  51945. */
  51946. protected _init(options: Partial<IEffectLayerOptions>): void;
  51947. /**
  51948. * Generates the index buffer of the full screen quad blending to the main canvas.
  51949. */
  51950. private _generateIndexBuffer;
  51951. /**
  51952. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  51953. */
  51954. private _generateVertexBuffer;
  51955. /**
  51956. * Sets the main texture desired size which is the closest power of two
  51957. * of the engine canvas size.
  51958. */
  51959. private _setMainTextureSize;
  51960. /**
  51961. * Creates the main texture for the effect layer.
  51962. */
  51963. protected _createMainTexture(): void;
  51964. /**
  51965. * Adds specific effects defines.
  51966. * @param defines The defines to add specifics to.
  51967. */
  51968. protected _addCustomEffectDefines(defines: string[]): void;
  51969. /**
  51970. * Checks for the readiness of the element composing the layer.
  51971. * @param subMesh the mesh to check for
  51972. * @param useInstances specify wether or not to use instances to render the mesh
  51973. * @param emissiveTexture the associated emissive texture used to generate the glow
  51974. * @return true if ready otherwise, false
  51975. */
  51976. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  51977. /**
  51978. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  51979. */
  51980. render(): void;
  51981. /**
  51982. * Determine if a given mesh will be used in the current effect.
  51983. * @param mesh mesh to test
  51984. * @returns true if the mesh will be used
  51985. */
  51986. hasMesh(mesh: AbstractMesh): boolean;
  51987. /**
  51988. * Returns true if the layer contains information to display, otherwise false.
  51989. * @returns true if the glow layer should be rendered
  51990. */
  51991. shouldRender(): boolean;
  51992. /**
  51993. * Returns true if the mesh should render, otherwise false.
  51994. * @param mesh The mesh to render
  51995. * @returns true if it should render otherwise false
  51996. */
  51997. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  51998. /**
  51999. * Returns true if the mesh can be rendered, otherwise false.
  52000. * @param mesh The mesh to render
  52001. * @param material The material used on the mesh
  52002. * @returns true if it can be rendered otherwise false
  52003. */
  52004. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  52005. /**
  52006. * Returns true if the mesh should render, otherwise false.
  52007. * @param mesh The mesh to render
  52008. * @returns true if it should render otherwise false
  52009. */
  52010. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  52011. /**
  52012. * Renders the submesh passed in parameter to the generation map.
  52013. */
  52014. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  52015. /**
  52016. * Defines wether the current material of the mesh should be use to render the effect.
  52017. * @param mesh defines the current mesh to render
  52018. */
  52019. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  52020. /**
  52021. * Rebuild the required buffers.
  52022. * @hidden Internal use only.
  52023. */
  52024. _rebuild(): void;
  52025. /**
  52026. * Dispose only the render target textures and post process.
  52027. */
  52028. private _disposeTextureAndPostProcesses;
  52029. /**
  52030. * Dispose the highlight layer and free resources.
  52031. */
  52032. dispose(): void;
  52033. /**
  52034. * Gets the class name of the effect layer
  52035. * @returns the string with the class name of the effect layer
  52036. */
  52037. getClassName(): string;
  52038. /**
  52039. * Creates an effect layer from parsed effect layer data
  52040. * @param parsedEffectLayer defines effect layer data
  52041. * @param scene defines the current scene
  52042. * @param rootUrl defines the root URL containing the effect layer information
  52043. * @returns a parsed effect Layer
  52044. */
  52045. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  52046. }
  52047. }
  52048. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  52049. import { Scene } from "babylonjs/scene";
  52050. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  52051. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52052. import { AbstractScene } from "babylonjs/abstractScene";
  52053. module "babylonjs/abstractScene" {
  52054. interface AbstractScene {
  52055. /**
  52056. * The list of effect layers (highlights/glow) added to the scene
  52057. * @see http://doc.babylonjs.com/how_to/highlight_layer
  52058. * @see http://doc.babylonjs.com/how_to/glow_layer
  52059. */
  52060. effectLayers: Array<EffectLayer>;
  52061. /**
  52062. * Removes the given effect layer from this scene.
  52063. * @param toRemove defines the effect layer to remove
  52064. * @returns the index of the removed effect layer
  52065. */
  52066. removeEffectLayer(toRemove: EffectLayer): number;
  52067. /**
  52068. * Adds the given effect layer to this scene
  52069. * @param newEffectLayer defines the effect layer to add
  52070. */
  52071. addEffectLayer(newEffectLayer: EffectLayer): void;
  52072. }
  52073. }
  52074. /**
  52075. * Defines the layer scene component responsible to manage any effect layers
  52076. * in a given scene.
  52077. */
  52078. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  52079. /**
  52080. * The component name helpfull to identify the component in the list of scene components.
  52081. */
  52082. readonly name: string;
  52083. /**
  52084. * The scene the component belongs to.
  52085. */
  52086. scene: Scene;
  52087. private _engine;
  52088. private _renderEffects;
  52089. private _needStencil;
  52090. private _previousStencilState;
  52091. /**
  52092. * Creates a new instance of the component for the given scene
  52093. * @param scene Defines the scene to register the component in
  52094. */
  52095. constructor(scene: Scene);
  52096. /**
  52097. * Registers the component in a given scene
  52098. */
  52099. register(): void;
  52100. /**
  52101. * Rebuilds the elements related to this component in case of
  52102. * context lost for instance.
  52103. */
  52104. rebuild(): void;
  52105. /**
  52106. * Serializes the component data to the specified json object
  52107. * @param serializationObject The object to serialize to
  52108. */
  52109. serialize(serializationObject: any): void;
  52110. /**
  52111. * Adds all the elements from the container to the scene
  52112. * @param container the container holding the elements
  52113. */
  52114. addFromContainer(container: AbstractScene): void;
  52115. /**
  52116. * Removes all the elements in the container from the scene
  52117. * @param container contains the elements to remove
  52118. * @param dispose if the removed element should be disposed (default: false)
  52119. */
  52120. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  52121. /**
  52122. * Disposes the component and the associated ressources.
  52123. */
  52124. dispose(): void;
  52125. private _isReadyForMesh;
  52126. private _renderMainTexture;
  52127. private _setStencil;
  52128. private _setStencilBack;
  52129. private _draw;
  52130. private _drawCamera;
  52131. private _drawRenderingGroup;
  52132. }
  52133. }
  52134. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  52135. /** @hidden */
  52136. export var glowMapMergePixelShader: {
  52137. name: string;
  52138. shader: string;
  52139. };
  52140. }
  52141. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  52142. /** @hidden */
  52143. export var glowMapMergeVertexShader: {
  52144. name: string;
  52145. shader: string;
  52146. };
  52147. }
  52148. declare module "babylonjs/Layers/glowLayer" {
  52149. import { Nullable } from "babylonjs/types";
  52150. import { Camera } from "babylonjs/Cameras/camera";
  52151. import { Scene } from "babylonjs/scene";
  52152. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52153. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52154. import { Mesh } from "babylonjs/Meshes/mesh";
  52155. import { Texture } from "babylonjs/Materials/Textures/texture";
  52156. import { Effect } from "babylonjs/Materials/effect";
  52157. import { Material } from "babylonjs/Materials/material";
  52158. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52159. import { Color4 } from "babylonjs/Maths/math.color";
  52160. import "babylonjs/Shaders/glowMapMerge.fragment";
  52161. import "babylonjs/Shaders/glowMapMerge.vertex";
  52162. import "babylonjs/Layers/effectLayerSceneComponent";
  52163. module "babylonjs/abstractScene" {
  52164. interface AbstractScene {
  52165. /**
  52166. * Return a the first highlight layer of the scene with a given name.
  52167. * @param name The name of the highlight layer to look for.
  52168. * @return The highlight layer if found otherwise null.
  52169. */
  52170. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  52171. }
  52172. }
  52173. /**
  52174. * Glow layer options. This helps customizing the behaviour
  52175. * of the glow layer.
  52176. */
  52177. export interface IGlowLayerOptions {
  52178. /**
  52179. * Multiplication factor apply to the canvas size to compute the render target size
  52180. * used to generated the glowing objects (the smaller the faster).
  52181. */
  52182. mainTextureRatio: number;
  52183. /**
  52184. * Enforces a fixed size texture to ensure resize independant blur.
  52185. */
  52186. mainTextureFixedSize?: number;
  52187. /**
  52188. * How big is the kernel of the blur texture.
  52189. */
  52190. blurKernelSize: number;
  52191. /**
  52192. * The camera attached to the layer.
  52193. */
  52194. camera: Nullable<Camera>;
  52195. /**
  52196. * Enable MSAA by chosing the number of samples.
  52197. */
  52198. mainTextureSamples?: number;
  52199. /**
  52200. * The rendering group to draw the layer in.
  52201. */
  52202. renderingGroupId: number;
  52203. }
  52204. /**
  52205. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  52206. *
  52207. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  52208. *
  52209. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  52210. */
  52211. export class GlowLayer extends EffectLayer {
  52212. /**
  52213. * Effect Name of the layer.
  52214. */
  52215. static readonly EffectName: string;
  52216. /**
  52217. * The default blur kernel size used for the glow.
  52218. */
  52219. static DefaultBlurKernelSize: number;
  52220. /**
  52221. * The default texture size ratio used for the glow.
  52222. */
  52223. static DefaultTextureRatio: number;
  52224. /**
  52225. * Sets the kernel size of the blur.
  52226. */
  52227. /**
  52228. * Gets the kernel size of the blur.
  52229. */
  52230. blurKernelSize: number;
  52231. /**
  52232. * Sets the glow intensity.
  52233. */
  52234. /**
  52235. * Gets the glow intensity.
  52236. */
  52237. intensity: number;
  52238. private _options;
  52239. private _intensity;
  52240. private _horizontalBlurPostprocess1;
  52241. private _verticalBlurPostprocess1;
  52242. private _horizontalBlurPostprocess2;
  52243. private _verticalBlurPostprocess2;
  52244. private _blurTexture1;
  52245. private _blurTexture2;
  52246. private _postProcesses1;
  52247. private _postProcesses2;
  52248. private _includedOnlyMeshes;
  52249. private _excludedMeshes;
  52250. private _meshesUsingTheirOwnMaterials;
  52251. /**
  52252. * Callback used to let the user override the color selection on a per mesh basis
  52253. */
  52254. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  52255. /**
  52256. * Callback used to let the user override the texture selection on a per mesh basis
  52257. */
  52258. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  52259. /**
  52260. * Instantiates a new glow Layer and references it to the scene.
  52261. * @param name The name of the layer
  52262. * @param scene The scene to use the layer in
  52263. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  52264. */
  52265. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  52266. /**
  52267. * Get the effect name of the layer.
  52268. * @return The effect name
  52269. */
  52270. getEffectName(): string;
  52271. /**
  52272. * Create the merge effect. This is the shader use to blit the information back
  52273. * to the main canvas at the end of the scene rendering.
  52274. */
  52275. protected _createMergeEffect(): Effect;
  52276. /**
  52277. * Creates the render target textures and post processes used in the glow layer.
  52278. */
  52279. protected _createTextureAndPostProcesses(): void;
  52280. /**
  52281. * Checks for the readiness of the element composing the layer.
  52282. * @param subMesh the mesh to check for
  52283. * @param useInstances specify wether or not to use instances to render the mesh
  52284. * @param emissiveTexture the associated emissive texture used to generate the glow
  52285. * @return true if ready otherwise, false
  52286. */
  52287. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  52288. /**
  52289. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  52290. */
  52291. needStencil(): boolean;
  52292. /**
  52293. * Returns true if the mesh can be rendered, otherwise false.
  52294. * @param mesh The mesh to render
  52295. * @param material The material used on the mesh
  52296. * @returns true if it can be rendered otherwise false
  52297. */
  52298. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  52299. /**
  52300. * Implementation specific of rendering the generating effect on the main canvas.
  52301. * @param effect The effect used to render through
  52302. */
  52303. protected _internalRender(effect: Effect): void;
  52304. /**
  52305. * Sets the required values for both the emissive texture and and the main color.
  52306. */
  52307. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  52308. /**
  52309. * Returns true if the mesh should render, otherwise false.
  52310. * @param mesh The mesh to render
  52311. * @returns true if it should render otherwise false
  52312. */
  52313. protected _shouldRenderMesh(mesh: Mesh): boolean;
  52314. /**
  52315. * Adds specific effects defines.
  52316. * @param defines The defines to add specifics to.
  52317. */
  52318. protected _addCustomEffectDefines(defines: string[]): void;
  52319. /**
  52320. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  52321. * @param mesh The mesh to exclude from the glow layer
  52322. */
  52323. addExcludedMesh(mesh: Mesh): void;
  52324. /**
  52325. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  52326. * @param mesh The mesh to remove
  52327. */
  52328. removeExcludedMesh(mesh: Mesh): void;
  52329. /**
  52330. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  52331. * @param mesh The mesh to include in the glow layer
  52332. */
  52333. addIncludedOnlyMesh(mesh: Mesh): void;
  52334. /**
  52335. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  52336. * @param mesh The mesh to remove
  52337. */
  52338. removeIncludedOnlyMesh(mesh: Mesh): void;
  52339. /**
  52340. * Determine if a given mesh will be used in the glow layer
  52341. * @param mesh The mesh to test
  52342. * @returns true if the mesh will be highlighted by the current glow layer
  52343. */
  52344. hasMesh(mesh: AbstractMesh): boolean;
  52345. /**
  52346. * Defines wether the current material of the mesh should be use to render the effect.
  52347. * @param mesh defines the current mesh to render
  52348. */
  52349. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  52350. /**
  52351. * Add a mesh to be rendered through its own material and not with emissive only.
  52352. * @param mesh The mesh for which we need to use its material
  52353. */
  52354. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  52355. /**
  52356. * Remove a mesh from being rendered through its own material and not with emissive only.
  52357. * @param mesh The mesh for which we need to not use its material
  52358. */
  52359. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  52360. /**
  52361. * Free any resources and references associated to a mesh.
  52362. * Internal use
  52363. * @param mesh The mesh to free.
  52364. * @hidden
  52365. */
  52366. _disposeMesh(mesh: Mesh): void;
  52367. /**
  52368. * Gets the class name of the effect layer
  52369. * @returns the string with the class name of the effect layer
  52370. */
  52371. getClassName(): string;
  52372. /**
  52373. * Serializes this glow layer
  52374. * @returns a serialized glow layer object
  52375. */
  52376. serialize(): any;
  52377. /**
  52378. * Creates a Glow Layer from parsed glow layer data
  52379. * @param parsedGlowLayer defines glow layer data
  52380. * @param scene defines the current scene
  52381. * @param rootUrl defines the root URL containing the glow layer information
  52382. * @returns a parsed Glow Layer
  52383. */
  52384. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  52385. }
  52386. }
  52387. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  52388. /** @hidden */
  52389. export var glowBlurPostProcessPixelShader: {
  52390. name: string;
  52391. shader: string;
  52392. };
  52393. }
  52394. declare module "babylonjs/Layers/highlightLayer" {
  52395. import { Observable } from "babylonjs/Misc/observable";
  52396. import { Nullable } from "babylonjs/types";
  52397. import { Camera } from "babylonjs/Cameras/camera";
  52398. import { Scene } from "babylonjs/scene";
  52399. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52400. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52401. import { Mesh } from "babylonjs/Meshes/mesh";
  52402. import { Effect } from "babylonjs/Materials/effect";
  52403. import { Material } from "babylonjs/Materials/material";
  52404. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52405. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  52406. import "babylonjs/Shaders/glowMapMerge.fragment";
  52407. import "babylonjs/Shaders/glowMapMerge.vertex";
  52408. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  52409. module "babylonjs/abstractScene" {
  52410. interface AbstractScene {
  52411. /**
  52412. * Return a the first highlight layer of the scene with a given name.
  52413. * @param name The name of the highlight layer to look for.
  52414. * @return The highlight layer if found otherwise null.
  52415. */
  52416. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  52417. }
  52418. }
  52419. /**
  52420. * Highlight layer options. This helps customizing the behaviour
  52421. * of the highlight layer.
  52422. */
  52423. export interface IHighlightLayerOptions {
  52424. /**
  52425. * Multiplication factor apply to the canvas size to compute the render target size
  52426. * used to generated the glowing objects (the smaller the faster).
  52427. */
  52428. mainTextureRatio: number;
  52429. /**
  52430. * Enforces a fixed size texture to ensure resize independant blur.
  52431. */
  52432. mainTextureFixedSize?: number;
  52433. /**
  52434. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  52435. * of the picture to blur (the smaller the faster).
  52436. */
  52437. blurTextureSizeRatio: number;
  52438. /**
  52439. * How big in texel of the blur texture is the vertical blur.
  52440. */
  52441. blurVerticalSize: number;
  52442. /**
  52443. * How big in texel of the blur texture is the horizontal blur.
  52444. */
  52445. blurHorizontalSize: number;
  52446. /**
  52447. * Alpha blending mode used to apply the blur. Default is combine.
  52448. */
  52449. alphaBlendingMode: number;
  52450. /**
  52451. * The camera attached to the layer.
  52452. */
  52453. camera: Nullable<Camera>;
  52454. /**
  52455. * Should we display highlight as a solid stroke?
  52456. */
  52457. isStroke?: boolean;
  52458. /**
  52459. * The rendering group to draw the layer in.
  52460. */
  52461. renderingGroupId: number;
  52462. }
  52463. /**
  52464. * The highlight layer Helps adding a glow effect around a mesh.
  52465. *
  52466. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  52467. * glowy meshes to your scene.
  52468. *
  52469. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  52470. */
  52471. export class HighlightLayer extends EffectLayer {
  52472. name: string;
  52473. /**
  52474. * Effect Name of the highlight layer.
  52475. */
  52476. static readonly EffectName: string;
  52477. /**
  52478. * The neutral color used during the preparation of the glow effect.
  52479. * This is black by default as the blend operation is a blend operation.
  52480. */
  52481. static NeutralColor: Color4;
  52482. /**
  52483. * Stencil value used for glowing meshes.
  52484. */
  52485. static GlowingMeshStencilReference: number;
  52486. /**
  52487. * Stencil value used for the other meshes in the scene.
  52488. */
  52489. static NormalMeshStencilReference: number;
  52490. /**
  52491. * Specifies whether or not the inner glow is ACTIVE in the layer.
  52492. */
  52493. innerGlow: boolean;
  52494. /**
  52495. * Specifies whether or not the outer glow is ACTIVE in the layer.
  52496. */
  52497. outerGlow: boolean;
  52498. /**
  52499. * Specifies the horizontal size of the blur.
  52500. */
  52501. /**
  52502. * Gets the horizontal size of the blur.
  52503. */
  52504. blurHorizontalSize: number;
  52505. /**
  52506. * Specifies the vertical size of the blur.
  52507. */
  52508. /**
  52509. * Gets the vertical size of the blur.
  52510. */
  52511. blurVerticalSize: number;
  52512. /**
  52513. * An event triggered when the highlight layer is being blurred.
  52514. */
  52515. onBeforeBlurObservable: Observable<HighlightLayer>;
  52516. /**
  52517. * An event triggered when the highlight layer has been blurred.
  52518. */
  52519. onAfterBlurObservable: Observable<HighlightLayer>;
  52520. private _instanceGlowingMeshStencilReference;
  52521. private _options;
  52522. private _downSamplePostprocess;
  52523. private _horizontalBlurPostprocess;
  52524. private _verticalBlurPostprocess;
  52525. private _blurTexture;
  52526. private _meshes;
  52527. private _excludedMeshes;
  52528. /**
  52529. * Instantiates a new highlight Layer and references it to the scene..
  52530. * @param name The name of the layer
  52531. * @param scene The scene to use the layer in
  52532. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  52533. */
  52534. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  52535. /**
  52536. * Get the effect name of the layer.
  52537. * @return The effect name
  52538. */
  52539. getEffectName(): string;
  52540. /**
  52541. * Create the merge effect. This is the shader use to blit the information back
  52542. * to the main canvas at the end of the scene rendering.
  52543. */
  52544. protected _createMergeEffect(): Effect;
  52545. /**
  52546. * Creates the render target textures and post processes used in the highlight layer.
  52547. */
  52548. protected _createTextureAndPostProcesses(): void;
  52549. /**
  52550. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  52551. */
  52552. needStencil(): boolean;
  52553. /**
  52554. * Checks for the readiness of the element composing the layer.
  52555. * @param subMesh the mesh to check for
  52556. * @param useInstances specify wether or not to use instances to render the mesh
  52557. * @param emissiveTexture the associated emissive texture used to generate the glow
  52558. * @return true if ready otherwise, false
  52559. */
  52560. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  52561. /**
  52562. * Implementation specific of rendering the generating effect on the main canvas.
  52563. * @param effect The effect used to render through
  52564. */
  52565. protected _internalRender(effect: Effect): void;
  52566. /**
  52567. * Returns true if the layer contains information to display, otherwise false.
  52568. */
  52569. shouldRender(): boolean;
  52570. /**
  52571. * Returns true if the mesh should render, otherwise false.
  52572. * @param mesh The mesh to render
  52573. * @returns true if it should render otherwise false
  52574. */
  52575. protected _shouldRenderMesh(mesh: Mesh): boolean;
  52576. /**
  52577. * Sets the required values for both the emissive texture and and the main color.
  52578. */
  52579. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  52580. /**
  52581. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  52582. * @param mesh The mesh to exclude from the highlight layer
  52583. */
  52584. addExcludedMesh(mesh: Mesh): void;
  52585. /**
  52586. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  52587. * @param mesh The mesh to highlight
  52588. */
  52589. removeExcludedMesh(mesh: Mesh): void;
  52590. /**
  52591. * Determine if a given mesh will be highlighted by the current HighlightLayer
  52592. * @param mesh mesh to test
  52593. * @returns true if the mesh will be highlighted by the current HighlightLayer
  52594. */
  52595. hasMesh(mesh: AbstractMesh): boolean;
  52596. /**
  52597. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  52598. * @param mesh The mesh to highlight
  52599. * @param color The color of the highlight
  52600. * @param glowEmissiveOnly Extract the glow from the emissive texture
  52601. */
  52602. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  52603. /**
  52604. * Remove a mesh from the highlight layer in order to make it stop glowing.
  52605. * @param mesh The mesh to highlight
  52606. */
  52607. removeMesh(mesh: Mesh): void;
  52608. /**
  52609. * Force the stencil to the normal expected value for none glowing parts
  52610. */
  52611. private _defaultStencilReference;
  52612. /**
  52613. * Free any resources and references associated to a mesh.
  52614. * Internal use
  52615. * @param mesh The mesh to free.
  52616. * @hidden
  52617. */
  52618. _disposeMesh(mesh: Mesh): void;
  52619. /**
  52620. * Dispose the highlight layer and free resources.
  52621. */
  52622. dispose(): void;
  52623. /**
  52624. * Gets the class name of the effect layer
  52625. * @returns the string with the class name of the effect layer
  52626. */
  52627. getClassName(): string;
  52628. /**
  52629. * Serializes this Highlight layer
  52630. * @returns a serialized Highlight layer object
  52631. */
  52632. serialize(): any;
  52633. /**
  52634. * Creates a Highlight layer from parsed Highlight layer data
  52635. * @param parsedHightlightLayer defines the Highlight layer data
  52636. * @param scene defines the current scene
  52637. * @param rootUrl defines the root URL containing the Highlight layer information
  52638. * @returns a parsed Highlight layer
  52639. */
  52640. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  52641. }
  52642. }
  52643. declare module "babylonjs/Layers/layerSceneComponent" {
  52644. import { Scene } from "babylonjs/scene";
  52645. import { ISceneComponent } from "babylonjs/sceneComponent";
  52646. import { Layer } from "babylonjs/Layers/layer";
  52647. import { AbstractScene } from "babylonjs/abstractScene";
  52648. module "babylonjs/abstractScene" {
  52649. interface AbstractScene {
  52650. /**
  52651. * The list of layers (background and foreground) of the scene
  52652. */
  52653. layers: Array<Layer>;
  52654. }
  52655. }
  52656. /**
  52657. * Defines the layer scene component responsible to manage any layers
  52658. * in a given scene.
  52659. */
  52660. export class LayerSceneComponent implements ISceneComponent {
  52661. /**
  52662. * The component name helpfull to identify the component in the list of scene components.
  52663. */
  52664. readonly name: string;
  52665. /**
  52666. * The scene the component belongs to.
  52667. */
  52668. scene: Scene;
  52669. private _engine;
  52670. /**
  52671. * Creates a new instance of the component for the given scene
  52672. * @param scene Defines the scene to register the component in
  52673. */
  52674. constructor(scene: Scene);
  52675. /**
  52676. * Registers the component in a given scene
  52677. */
  52678. register(): void;
  52679. /**
  52680. * Rebuilds the elements related to this component in case of
  52681. * context lost for instance.
  52682. */
  52683. rebuild(): void;
  52684. /**
  52685. * Disposes the component and the associated ressources.
  52686. */
  52687. dispose(): void;
  52688. private _draw;
  52689. private _drawCameraPredicate;
  52690. private _drawCameraBackground;
  52691. private _drawCameraForeground;
  52692. private _drawRenderTargetPredicate;
  52693. private _drawRenderTargetBackground;
  52694. private _drawRenderTargetForeground;
  52695. /**
  52696. * Adds all the elements from the container to the scene
  52697. * @param container the container holding the elements
  52698. */
  52699. addFromContainer(container: AbstractScene): void;
  52700. /**
  52701. * Removes all the elements in the container from the scene
  52702. * @param container contains the elements to remove
  52703. * @param dispose if the removed element should be disposed (default: false)
  52704. */
  52705. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  52706. }
  52707. }
  52708. declare module "babylonjs/Shaders/layer.fragment" {
  52709. /** @hidden */
  52710. export var layerPixelShader: {
  52711. name: string;
  52712. shader: string;
  52713. };
  52714. }
  52715. declare module "babylonjs/Shaders/layer.vertex" {
  52716. /** @hidden */
  52717. export var layerVertexShader: {
  52718. name: string;
  52719. shader: string;
  52720. };
  52721. }
  52722. declare module "babylonjs/Layers/layer" {
  52723. import { Observable } from "babylonjs/Misc/observable";
  52724. import { Nullable } from "babylonjs/types";
  52725. import { Scene } from "babylonjs/scene";
  52726. import { Vector2 } from "babylonjs/Maths/math.vector";
  52727. import { Color4 } from "babylonjs/Maths/math.color";
  52728. import { Texture } from "babylonjs/Materials/Textures/texture";
  52729. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  52730. import "babylonjs/Shaders/layer.fragment";
  52731. import "babylonjs/Shaders/layer.vertex";
  52732. /**
  52733. * This represents a full screen 2d layer.
  52734. * This can be useful to display a picture in the background of your scene for instance.
  52735. * @see https://www.babylonjs-playground.com/#08A2BS#1
  52736. */
  52737. export class Layer {
  52738. /**
  52739. * Define the name of the layer.
  52740. */
  52741. name: string;
  52742. /**
  52743. * Define the texture the layer should display.
  52744. */
  52745. texture: Nullable<Texture>;
  52746. /**
  52747. * Is the layer in background or foreground.
  52748. */
  52749. isBackground: boolean;
  52750. /**
  52751. * Define the color of the layer (instead of texture).
  52752. */
  52753. color: Color4;
  52754. /**
  52755. * Define the scale of the layer in order to zoom in out of the texture.
  52756. */
  52757. scale: Vector2;
  52758. /**
  52759. * Define an offset for the layer in order to shift the texture.
  52760. */
  52761. offset: Vector2;
  52762. /**
  52763. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  52764. */
  52765. alphaBlendingMode: number;
  52766. /**
  52767. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  52768. * Alpha test will not mix with the background color in case of transparency.
  52769. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  52770. */
  52771. alphaTest: boolean;
  52772. /**
  52773. * Define a mask to restrict the layer to only some of the scene cameras.
  52774. */
  52775. layerMask: number;
  52776. /**
  52777. * Define the list of render target the layer is visible into.
  52778. */
  52779. renderTargetTextures: RenderTargetTexture[];
  52780. /**
  52781. * Define if the layer is only used in renderTarget or if it also
  52782. * renders in the main frame buffer of the canvas.
  52783. */
  52784. renderOnlyInRenderTargetTextures: boolean;
  52785. private _scene;
  52786. private _vertexBuffers;
  52787. private _indexBuffer;
  52788. private _effect;
  52789. private _alphaTestEffect;
  52790. /**
  52791. * An event triggered when the layer is disposed.
  52792. */
  52793. onDisposeObservable: Observable<Layer>;
  52794. private _onDisposeObserver;
  52795. /**
  52796. * Back compatibility with callback before the onDisposeObservable existed.
  52797. * The set callback will be triggered when the layer has been disposed.
  52798. */
  52799. onDispose: () => void;
  52800. /**
  52801. * An event triggered before rendering the scene
  52802. */
  52803. onBeforeRenderObservable: Observable<Layer>;
  52804. private _onBeforeRenderObserver;
  52805. /**
  52806. * Back compatibility with callback before the onBeforeRenderObservable existed.
  52807. * The set callback will be triggered just before rendering the layer.
  52808. */
  52809. onBeforeRender: () => void;
  52810. /**
  52811. * An event triggered after rendering the scene
  52812. */
  52813. onAfterRenderObservable: Observable<Layer>;
  52814. private _onAfterRenderObserver;
  52815. /**
  52816. * Back compatibility with callback before the onAfterRenderObservable existed.
  52817. * The set callback will be triggered just after rendering the layer.
  52818. */
  52819. onAfterRender: () => void;
  52820. /**
  52821. * Instantiates a new layer.
  52822. * This represents a full screen 2d layer.
  52823. * This can be useful to display a picture in the background of your scene for instance.
  52824. * @see https://www.babylonjs-playground.com/#08A2BS#1
  52825. * @param name Define the name of the layer in the scene
  52826. * @param imgUrl Define the url of the texture to display in the layer
  52827. * @param scene Define the scene the layer belongs to
  52828. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  52829. * @param color Defines a color for the layer
  52830. */
  52831. constructor(
  52832. /**
  52833. * Define the name of the layer.
  52834. */
  52835. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  52836. private _createIndexBuffer;
  52837. /** @hidden */
  52838. _rebuild(): void;
  52839. /**
  52840. * Renders the layer in the scene.
  52841. */
  52842. render(): void;
  52843. /**
  52844. * Disposes and releases the associated ressources.
  52845. */
  52846. dispose(): void;
  52847. }
  52848. }
  52849. declare module "babylonjs/Layers/index" {
  52850. export * from "babylonjs/Layers/effectLayer";
  52851. export * from "babylonjs/Layers/effectLayerSceneComponent";
  52852. export * from "babylonjs/Layers/glowLayer";
  52853. export * from "babylonjs/Layers/highlightLayer";
  52854. export * from "babylonjs/Layers/layer";
  52855. export * from "babylonjs/Layers/layerSceneComponent";
  52856. }
  52857. declare module "babylonjs/Shaders/lensFlare.fragment" {
  52858. /** @hidden */
  52859. export var lensFlarePixelShader: {
  52860. name: string;
  52861. shader: string;
  52862. };
  52863. }
  52864. declare module "babylonjs/Shaders/lensFlare.vertex" {
  52865. /** @hidden */
  52866. export var lensFlareVertexShader: {
  52867. name: string;
  52868. shader: string;
  52869. };
  52870. }
  52871. declare module "babylonjs/LensFlares/lensFlareSystem" {
  52872. import { Scene } from "babylonjs/scene";
  52873. import { Vector3 } from "babylonjs/Maths/math.vector";
  52874. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52875. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  52876. import "babylonjs/Shaders/lensFlare.fragment";
  52877. import "babylonjs/Shaders/lensFlare.vertex";
  52878. import { Viewport } from "babylonjs/Maths/math.viewport";
  52879. /**
  52880. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  52881. * It is usually composed of several `lensFlare`.
  52882. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  52883. */
  52884. export class LensFlareSystem {
  52885. /**
  52886. * Define the name of the lens flare system
  52887. */
  52888. name: string;
  52889. /**
  52890. * List of lens flares used in this system.
  52891. */
  52892. lensFlares: LensFlare[];
  52893. /**
  52894. * Define a limit from the border the lens flare can be visible.
  52895. */
  52896. borderLimit: number;
  52897. /**
  52898. * Define a viewport border we do not want to see the lens flare in.
  52899. */
  52900. viewportBorder: number;
  52901. /**
  52902. * Define a predicate which could limit the list of meshes able to occlude the effect.
  52903. */
  52904. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  52905. /**
  52906. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  52907. */
  52908. layerMask: number;
  52909. /**
  52910. * Define the id of the lens flare system in the scene.
  52911. * (equal to name by default)
  52912. */
  52913. id: string;
  52914. private _scene;
  52915. private _emitter;
  52916. private _vertexBuffers;
  52917. private _indexBuffer;
  52918. private _effect;
  52919. private _positionX;
  52920. private _positionY;
  52921. private _isEnabled;
  52922. /** @hidden */
  52923. static _SceneComponentInitialization: (scene: Scene) => void;
  52924. /**
  52925. * Instantiates a lens flare system.
  52926. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  52927. * It is usually composed of several `lensFlare`.
  52928. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  52929. * @param name Define the name of the lens flare system in the scene
  52930. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  52931. * @param scene Define the scene the lens flare system belongs to
  52932. */
  52933. constructor(
  52934. /**
  52935. * Define the name of the lens flare system
  52936. */
  52937. name: string, emitter: any, scene: Scene);
  52938. /**
  52939. * Define if the lens flare system is enabled.
  52940. */
  52941. isEnabled: boolean;
  52942. /**
  52943. * Get the scene the effects belongs to.
  52944. * @returns the scene holding the lens flare system
  52945. */
  52946. getScene(): Scene;
  52947. /**
  52948. * Get the emitter of the lens flare system.
  52949. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  52950. * @returns the emitter of the lens flare system
  52951. */
  52952. getEmitter(): any;
  52953. /**
  52954. * Set the emitter of the lens flare system.
  52955. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  52956. * @param newEmitter Define the new emitter of the system
  52957. */
  52958. setEmitter(newEmitter: any): void;
  52959. /**
  52960. * Get the lens flare system emitter position.
  52961. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  52962. * @returns the position
  52963. */
  52964. getEmitterPosition(): Vector3;
  52965. /**
  52966. * @hidden
  52967. */
  52968. computeEffectivePosition(globalViewport: Viewport): boolean;
  52969. /** @hidden */
  52970. _isVisible(): boolean;
  52971. /**
  52972. * @hidden
  52973. */
  52974. render(): boolean;
  52975. /**
  52976. * Dispose and release the lens flare with its associated resources.
  52977. */
  52978. dispose(): void;
  52979. /**
  52980. * Parse a lens flare system from a JSON repressentation
  52981. * @param parsedLensFlareSystem Define the JSON to parse
  52982. * @param scene Define the scene the parsed system should be instantiated in
  52983. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  52984. * @returns the parsed system
  52985. */
  52986. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  52987. /**
  52988. * Serialize the current Lens Flare System into a JSON representation.
  52989. * @returns the serialized JSON
  52990. */
  52991. serialize(): any;
  52992. }
  52993. }
  52994. declare module "babylonjs/LensFlares/lensFlare" {
  52995. import { Nullable } from "babylonjs/types";
  52996. import { Color3 } from "babylonjs/Maths/math.color";
  52997. import { Texture } from "babylonjs/Materials/Textures/texture";
  52998. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  52999. /**
  53000. * This represents one of the lens effect in a `lensFlareSystem`.
  53001. * It controls one of the indiviual texture used in the effect.
  53002. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53003. */
  53004. export class LensFlare {
  53005. /**
  53006. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  53007. */
  53008. size: number;
  53009. /**
  53010. * 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.
  53011. */
  53012. position: number;
  53013. /**
  53014. * Define the lens color.
  53015. */
  53016. color: Color3;
  53017. /**
  53018. * Define the lens texture.
  53019. */
  53020. texture: Nullable<Texture>;
  53021. /**
  53022. * Define the alpha mode to render this particular lens.
  53023. */
  53024. alphaMode: number;
  53025. private _system;
  53026. /**
  53027. * Creates a new Lens Flare.
  53028. * This represents one of the lens effect in a `lensFlareSystem`.
  53029. * It controls one of the indiviual texture used in the effect.
  53030. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53031. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  53032. * @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.
  53033. * @param color Define the lens color
  53034. * @param imgUrl Define the lens texture url
  53035. * @param system Define the `lensFlareSystem` this flare is part of
  53036. * @returns The newly created Lens Flare
  53037. */
  53038. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  53039. /**
  53040. * Instantiates a new Lens Flare.
  53041. * This represents one of the lens effect in a `lensFlareSystem`.
  53042. * It controls one of the indiviual texture used in the effect.
  53043. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53044. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  53045. * @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.
  53046. * @param color Define the lens color
  53047. * @param imgUrl Define the lens texture url
  53048. * @param system Define the `lensFlareSystem` this flare is part of
  53049. */
  53050. constructor(
  53051. /**
  53052. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  53053. */
  53054. size: number,
  53055. /**
  53056. * 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.
  53057. */
  53058. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  53059. /**
  53060. * Dispose and release the lens flare with its associated resources.
  53061. */
  53062. dispose(): void;
  53063. }
  53064. }
  53065. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  53066. import { Nullable } from "babylonjs/types";
  53067. import { Scene } from "babylonjs/scene";
  53068. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  53069. import { AbstractScene } from "babylonjs/abstractScene";
  53070. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  53071. module "babylonjs/abstractScene" {
  53072. interface AbstractScene {
  53073. /**
  53074. * The list of lens flare system added to the scene
  53075. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53076. */
  53077. lensFlareSystems: Array<LensFlareSystem>;
  53078. /**
  53079. * Removes the given lens flare system from this scene.
  53080. * @param toRemove The lens flare system to remove
  53081. * @returns The index of the removed lens flare system
  53082. */
  53083. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  53084. /**
  53085. * Adds the given lens flare system to this scene
  53086. * @param newLensFlareSystem The lens flare system to add
  53087. */
  53088. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  53089. /**
  53090. * Gets a lens flare system using its name
  53091. * @param name defines the name to look for
  53092. * @returns the lens flare system or null if not found
  53093. */
  53094. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  53095. /**
  53096. * Gets a lens flare system using its id
  53097. * @param id defines the id to look for
  53098. * @returns the lens flare system or null if not found
  53099. */
  53100. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  53101. }
  53102. }
  53103. /**
  53104. * Defines the lens flare scene component responsible to manage any lens flares
  53105. * in a given scene.
  53106. */
  53107. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  53108. /**
  53109. * The component name helpfull to identify the component in the list of scene components.
  53110. */
  53111. readonly name: string;
  53112. /**
  53113. * The scene the component belongs to.
  53114. */
  53115. scene: Scene;
  53116. /**
  53117. * Creates a new instance of the component for the given scene
  53118. * @param scene Defines the scene to register the component in
  53119. */
  53120. constructor(scene: Scene);
  53121. /**
  53122. * Registers the component in a given scene
  53123. */
  53124. register(): void;
  53125. /**
  53126. * Rebuilds the elements related to this component in case of
  53127. * context lost for instance.
  53128. */
  53129. rebuild(): void;
  53130. /**
  53131. * Adds all the elements from the container to the scene
  53132. * @param container the container holding the elements
  53133. */
  53134. addFromContainer(container: AbstractScene): void;
  53135. /**
  53136. * Removes all the elements in the container from the scene
  53137. * @param container contains the elements to remove
  53138. * @param dispose if the removed element should be disposed (default: false)
  53139. */
  53140. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  53141. /**
  53142. * Serializes the component data to the specified json object
  53143. * @param serializationObject The object to serialize to
  53144. */
  53145. serialize(serializationObject: any): void;
  53146. /**
  53147. * Disposes the component and the associated ressources.
  53148. */
  53149. dispose(): void;
  53150. private _draw;
  53151. }
  53152. }
  53153. declare module "babylonjs/LensFlares/index" {
  53154. export * from "babylonjs/LensFlares/lensFlare";
  53155. export * from "babylonjs/LensFlares/lensFlareSystem";
  53156. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  53157. }
  53158. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  53159. import { Scene } from "babylonjs/scene";
  53160. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  53161. import { AbstractScene } from "babylonjs/abstractScene";
  53162. /**
  53163. * Defines the shadow generator component responsible to manage any shadow generators
  53164. * in a given scene.
  53165. */
  53166. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  53167. /**
  53168. * The component name helpfull to identify the component in the list of scene components.
  53169. */
  53170. readonly name: string;
  53171. /**
  53172. * The scene the component belongs to.
  53173. */
  53174. scene: Scene;
  53175. /**
  53176. * Creates a new instance of the component for the given scene
  53177. * @param scene Defines the scene to register the component in
  53178. */
  53179. constructor(scene: Scene);
  53180. /**
  53181. * Registers the component in a given scene
  53182. */
  53183. register(): void;
  53184. /**
  53185. * Rebuilds the elements related to this component in case of
  53186. * context lost for instance.
  53187. */
  53188. rebuild(): void;
  53189. /**
  53190. * Serializes the component data to the specified json object
  53191. * @param serializationObject The object to serialize to
  53192. */
  53193. serialize(serializationObject: any): void;
  53194. /**
  53195. * Adds all the elements from the container to the scene
  53196. * @param container the container holding the elements
  53197. */
  53198. addFromContainer(container: AbstractScene): void;
  53199. /**
  53200. * Removes all the elements in the container from the scene
  53201. * @param container contains the elements to remove
  53202. * @param dispose if the removed element should be disposed (default: false)
  53203. */
  53204. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  53205. /**
  53206. * Rebuilds the elements related to this component in case of
  53207. * context lost for instance.
  53208. */
  53209. dispose(): void;
  53210. private _gatherRenderTargets;
  53211. }
  53212. }
  53213. declare module "babylonjs/Lights/Shadows/index" {
  53214. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  53215. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  53216. }
  53217. declare module "babylonjs/Lights/pointLight" {
  53218. import { Scene } from "babylonjs/scene";
  53219. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  53220. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53221. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  53222. import { Effect } from "babylonjs/Materials/effect";
  53223. /**
  53224. * A point light is a light defined by an unique point in world space.
  53225. * The light is emitted in every direction from this point.
  53226. * A good example of a point light is a standard light bulb.
  53227. * Documentation: https://doc.babylonjs.com/babylon101/lights
  53228. */
  53229. export class PointLight extends ShadowLight {
  53230. private _shadowAngle;
  53231. /**
  53232. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53233. * This specifies what angle the shadow will use to be created.
  53234. *
  53235. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  53236. */
  53237. /**
  53238. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53239. * This specifies what angle the shadow will use to be created.
  53240. *
  53241. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  53242. */
  53243. shadowAngle: number;
  53244. /**
  53245. * Gets the direction if it has been set.
  53246. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53247. */
  53248. /**
  53249. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53250. */
  53251. direction: Vector3;
  53252. /**
  53253. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  53254. * A PointLight emits the light in every direction.
  53255. * It can cast shadows.
  53256. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  53257. * ```javascript
  53258. * var pointLight = new PointLight("pl", camera.position, scene);
  53259. * ```
  53260. * Documentation : https://doc.babylonjs.com/babylon101/lights
  53261. * @param name The light friendly name
  53262. * @param position The position of the point light in the scene
  53263. * @param scene The scene the lights belongs to
  53264. */
  53265. constructor(name: string, position: Vector3, scene: Scene);
  53266. /**
  53267. * Returns the string "PointLight"
  53268. * @returns the class name
  53269. */
  53270. getClassName(): string;
  53271. /**
  53272. * Returns the integer 0.
  53273. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  53274. */
  53275. getTypeID(): number;
  53276. /**
  53277. * Specifies wether or not the shadowmap should be a cube texture.
  53278. * @returns true if the shadowmap needs to be a cube texture.
  53279. */
  53280. needCube(): boolean;
  53281. /**
  53282. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  53283. * @param faceIndex The index of the face we are computed the direction to generate shadow
  53284. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  53285. */
  53286. getShadowDirection(faceIndex?: number): Vector3;
  53287. /**
  53288. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  53289. * - fov = PI / 2
  53290. * - aspect ratio : 1.0
  53291. * - z-near and far equal to the active camera minZ and maxZ.
  53292. * Returns the PointLight.
  53293. */
  53294. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  53295. protected _buildUniformLayout(): void;
  53296. /**
  53297. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  53298. * @param effect The effect to update
  53299. * @param lightIndex The index of the light in the effect to update
  53300. * @returns The point light
  53301. */
  53302. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  53303. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  53304. /**
  53305. * Prepares the list of defines specific to the light type.
  53306. * @param defines the list of defines
  53307. * @param lightIndex defines the index of the light for the effect
  53308. */
  53309. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  53310. }
  53311. }
  53312. declare module "babylonjs/Lights/index" {
  53313. export * from "babylonjs/Lights/light";
  53314. export * from "babylonjs/Lights/shadowLight";
  53315. export * from "babylonjs/Lights/Shadows/index";
  53316. export * from "babylonjs/Lights/directionalLight";
  53317. export * from "babylonjs/Lights/hemisphericLight";
  53318. export * from "babylonjs/Lights/pointLight";
  53319. export * from "babylonjs/Lights/spotLight";
  53320. }
  53321. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  53322. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  53323. /**
  53324. * Header information of HDR texture files.
  53325. */
  53326. export interface HDRInfo {
  53327. /**
  53328. * The height of the texture in pixels.
  53329. */
  53330. height: number;
  53331. /**
  53332. * The width of the texture in pixels.
  53333. */
  53334. width: number;
  53335. /**
  53336. * The index of the beginning of the data in the binary file.
  53337. */
  53338. dataPosition: number;
  53339. }
  53340. /**
  53341. * This groups tools to convert HDR texture to native colors array.
  53342. */
  53343. export class HDRTools {
  53344. private static Ldexp;
  53345. private static Rgbe2float;
  53346. private static readStringLine;
  53347. /**
  53348. * Reads header information from an RGBE texture stored in a native array.
  53349. * More information on this format are available here:
  53350. * https://en.wikipedia.org/wiki/RGBE_image_format
  53351. *
  53352. * @param uint8array The binary file stored in native array.
  53353. * @return The header information.
  53354. */
  53355. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  53356. /**
  53357. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  53358. * This RGBE texture needs to store the information as a panorama.
  53359. *
  53360. * More information on this format are available here:
  53361. * https://en.wikipedia.org/wiki/RGBE_image_format
  53362. *
  53363. * @param buffer The binary file stored in an array buffer.
  53364. * @param size The expected size of the extracted cubemap.
  53365. * @return The Cube Map information.
  53366. */
  53367. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  53368. /**
  53369. * Returns the pixels data extracted from an RGBE texture.
  53370. * This pixels will be stored left to right up to down in the R G B order in one array.
  53371. *
  53372. * More information on this format are available here:
  53373. * https://en.wikipedia.org/wiki/RGBE_image_format
  53374. *
  53375. * @param uint8array The binary file stored in an array buffer.
  53376. * @param hdrInfo The header information of the file.
  53377. * @return The pixels data in RGB right to left up to down order.
  53378. */
  53379. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  53380. private static RGBE_ReadPixels_RLE;
  53381. }
  53382. }
  53383. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  53384. import { Nullable } from "babylonjs/types";
  53385. import { Scene } from "babylonjs/scene";
  53386. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  53387. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53388. import "babylonjs/Engines/Extensions/engine.rawTexture";
  53389. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  53390. /**
  53391. * This represents a texture coming from an HDR input.
  53392. *
  53393. * The only supported format is currently panorama picture stored in RGBE format.
  53394. * Example of such files can be found on HDRLib: http://hdrlib.com/
  53395. */
  53396. export class HDRCubeTexture extends BaseTexture {
  53397. private static _facesMapping;
  53398. private _generateHarmonics;
  53399. private _noMipmap;
  53400. private _textureMatrix;
  53401. private _size;
  53402. private _onLoad;
  53403. private _onError;
  53404. /**
  53405. * The texture URL.
  53406. */
  53407. url: string;
  53408. /**
  53409. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  53410. */
  53411. coordinatesMode: number;
  53412. protected _isBlocking: boolean;
  53413. /**
  53414. * Sets wether or not the texture is blocking during loading.
  53415. */
  53416. /**
  53417. * Gets wether or not the texture is blocking during loading.
  53418. */
  53419. isBlocking: boolean;
  53420. protected _rotationY: number;
  53421. /**
  53422. * Sets texture matrix rotation angle around Y axis in radians.
  53423. */
  53424. /**
  53425. * Gets texture matrix rotation angle around Y axis radians.
  53426. */
  53427. rotationY: number;
  53428. /**
  53429. * Gets or sets the center of the bounding box associated with the cube texture
  53430. * It must define where the camera used to render the texture was set
  53431. */
  53432. boundingBoxPosition: Vector3;
  53433. private _boundingBoxSize;
  53434. /**
  53435. * Gets or sets the size of the bounding box associated with the cube texture
  53436. * When defined, the cubemap will switch to local mode
  53437. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  53438. * @example https://www.babylonjs-playground.com/#RNASML
  53439. */
  53440. boundingBoxSize: Vector3;
  53441. /**
  53442. * Instantiates an HDRTexture from the following parameters.
  53443. *
  53444. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  53445. * @param scene The scene the texture will be used in
  53446. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  53447. * @param noMipmap Forces to not generate the mipmap if true
  53448. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  53449. * @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)
  53450. * @param reserved Reserved flag for internal use.
  53451. */
  53452. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  53453. /**
  53454. * Get the current class name of the texture useful for serialization or dynamic coding.
  53455. * @returns "HDRCubeTexture"
  53456. */
  53457. getClassName(): string;
  53458. /**
  53459. * Occurs when the file is raw .hdr file.
  53460. */
  53461. private loadTexture;
  53462. clone(): HDRCubeTexture;
  53463. delayLoad(): void;
  53464. /**
  53465. * Get the texture reflection matrix used to rotate/transform the reflection.
  53466. * @returns the reflection matrix
  53467. */
  53468. getReflectionTextureMatrix(): Matrix;
  53469. /**
  53470. * Set the texture reflection matrix used to rotate/transform the reflection.
  53471. * @param value Define the reflection matrix to set
  53472. */
  53473. setReflectionTextureMatrix(value: Matrix): void;
  53474. /**
  53475. * Parses a JSON representation of an HDR Texture in order to create the texture
  53476. * @param parsedTexture Define the JSON representation
  53477. * @param scene Define the scene the texture should be created in
  53478. * @param rootUrl Define the root url in case we need to load relative dependencies
  53479. * @returns the newly created texture after parsing
  53480. */
  53481. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  53482. serialize(): any;
  53483. }
  53484. }
  53485. declare module "babylonjs/Physics/physicsEngine" {
  53486. import { Nullable } from "babylonjs/types";
  53487. import { Vector3 } from "babylonjs/Maths/math.vector";
  53488. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  53489. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  53490. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  53491. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  53492. /**
  53493. * Class used to control physics engine
  53494. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  53495. */
  53496. export class PhysicsEngine implements IPhysicsEngine {
  53497. private _physicsPlugin;
  53498. /**
  53499. * Global value used to control the smallest number supported by the simulation
  53500. */
  53501. static Epsilon: number;
  53502. private _impostors;
  53503. private _joints;
  53504. /**
  53505. * Gets the gravity vector used by the simulation
  53506. */
  53507. gravity: Vector3;
  53508. /**
  53509. * Factory used to create the default physics plugin.
  53510. * @returns The default physics plugin
  53511. */
  53512. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  53513. /**
  53514. * Creates a new Physics Engine
  53515. * @param gravity defines the gravity vector used by the simulation
  53516. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  53517. */
  53518. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  53519. /**
  53520. * Sets the gravity vector used by the simulation
  53521. * @param gravity defines the gravity vector to use
  53522. */
  53523. setGravity(gravity: Vector3): void;
  53524. /**
  53525. * Set the time step of the physics engine.
  53526. * Default is 1/60.
  53527. * To slow it down, enter 1/600 for example.
  53528. * To speed it up, 1/30
  53529. * @param newTimeStep defines the new timestep to apply to this world.
  53530. */
  53531. setTimeStep(newTimeStep?: number): void;
  53532. /**
  53533. * Get the time step of the physics engine.
  53534. * @returns the current time step
  53535. */
  53536. getTimeStep(): number;
  53537. /**
  53538. * Release all resources
  53539. */
  53540. dispose(): void;
  53541. /**
  53542. * Gets the name of the current physics plugin
  53543. * @returns the name of the plugin
  53544. */
  53545. getPhysicsPluginName(): string;
  53546. /**
  53547. * Adding a new impostor for the impostor tracking.
  53548. * This will be done by the impostor itself.
  53549. * @param impostor the impostor to add
  53550. */
  53551. addImpostor(impostor: PhysicsImpostor): void;
  53552. /**
  53553. * Remove an impostor from the engine.
  53554. * This impostor and its mesh will not longer be updated by the physics engine.
  53555. * @param impostor the impostor to remove
  53556. */
  53557. removeImpostor(impostor: PhysicsImpostor): void;
  53558. /**
  53559. * Add a joint to the physics engine
  53560. * @param mainImpostor defines the main impostor to which the joint is added.
  53561. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  53562. * @param joint defines the joint that will connect both impostors.
  53563. */
  53564. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  53565. /**
  53566. * Removes a joint from the simulation
  53567. * @param mainImpostor defines the impostor used with the joint
  53568. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  53569. * @param joint defines the joint to remove
  53570. */
  53571. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  53572. /**
  53573. * Called by the scene. No need to call it.
  53574. * @param delta defines the timespam between frames
  53575. */
  53576. _step(delta: number): void;
  53577. /**
  53578. * Gets the current plugin used to run the simulation
  53579. * @returns current plugin
  53580. */
  53581. getPhysicsPlugin(): IPhysicsEnginePlugin;
  53582. /**
  53583. * Gets the list of physic impostors
  53584. * @returns an array of PhysicsImpostor
  53585. */
  53586. getImpostors(): Array<PhysicsImpostor>;
  53587. /**
  53588. * Gets the impostor for a physics enabled object
  53589. * @param object defines the object impersonated by the impostor
  53590. * @returns the PhysicsImpostor or null if not found
  53591. */
  53592. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  53593. /**
  53594. * Gets the impostor for a physics body object
  53595. * @param body defines physics body used by the impostor
  53596. * @returns the PhysicsImpostor or null if not found
  53597. */
  53598. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  53599. /**
  53600. * Does a raycast in the physics world
  53601. * @param from when should the ray start?
  53602. * @param to when should the ray end?
  53603. * @returns PhysicsRaycastResult
  53604. */
  53605. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  53606. }
  53607. }
  53608. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  53609. import { Nullable } from "babylonjs/types";
  53610. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  53611. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53612. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  53613. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  53614. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  53615. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  53616. /** @hidden */
  53617. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  53618. private _useDeltaForWorldStep;
  53619. world: any;
  53620. name: string;
  53621. private _physicsMaterials;
  53622. private _fixedTimeStep;
  53623. private _cannonRaycastResult;
  53624. private _raycastResult;
  53625. private _physicsBodysToRemoveAfterStep;
  53626. BJSCANNON: any;
  53627. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  53628. setGravity(gravity: Vector3): void;
  53629. setTimeStep(timeStep: number): void;
  53630. getTimeStep(): number;
  53631. executeStep(delta: number): void;
  53632. private _removeMarkedPhysicsBodiesFromWorld;
  53633. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53634. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53635. generatePhysicsBody(impostor: PhysicsImpostor): void;
  53636. private _processChildMeshes;
  53637. removePhysicsBody(impostor: PhysicsImpostor): void;
  53638. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  53639. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  53640. private _addMaterial;
  53641. private _checkWithEpsilon;
  53642. private _createShape;
  53643. private _createHeightmap;
  53644. private _minus90X;
  53645. private _plus90X;
  53646. private _tmpPosition;
  53647. private _tmpDeltaPosition;
  53648. private _tmpUnityRotation;
  53649. private _updatePhysicsBodyTransformation;
  53650. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  53651. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  53652. isSupported(): boolean;
  53653. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  53654. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  53655. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  53656. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  53657. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  53658. getBodyMass(impostor: PhysicsImpostor): number;
  53659. getBodyFriction(impostor: PhysicsImpostor): number;
  53660. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  53661. getBodyRestitution(impostor: PhysicsImpostor): number;
  53662. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  53663. sleepBody(impostor: PhysicsImpostor): void;
  53664. wakeUpBody(impostor: PhysicsImpostor): void;
  53665. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  53666. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  53667. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  53668. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  53669. getRadius(impostor: PhysicsImpostor): number;
  53670. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  53671. dispose(): void;
  53672. private _extendNamespace;
  53673. /**
  53674. * Does a raycast in the physics world
  53675. * @param from when should the ray start?
  53676. * @param to when should the ray end?
  53677. * @returns PhysicsRaycastResult
  53678. */
  53679. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  53680. }
  53681. }
  53682. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  53683. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  53684. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  53685. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  53686. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53687. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  53688. import { Nullable } from "babylonjs/types";
  53689. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  53690. /** @hidden */
  53691. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  53692. world: any;
  53693. name: string;
  53694. BJSOIMO: any;
  53695. private _raycastResult;
  53696. constructor(iterations?: number, oimoInjection?: any);
  53697. setGravity(gravity: Vector3): void;
  53698. setTimeStep(timeStep: number): void;
  53699. getTimeStep(): number;
  53700. private _tmpImpostorsArray;
  53701. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  53702. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53703. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53704. generatePhysicsBody(impostor: PhysicsImpostor): void;
  53705. private _tmpPositionVector;
  53706. removePhysicsBody(impostor: PhysicsImpostor): void;
  53707. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  53708. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  53709. isSupported(): boolean;
  53710. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  53711. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  53712. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  53713. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  53714. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  53715. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  53716. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  53717. getBodyMass(impostor: PhysicsImpostor): number;
  53718. getBodyFriction(impostor: PhysicsImpostor): number;
  53719. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  53720. getBodyRestitution(impostor: PhysicsImpostor): number;
  53721. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  53722. sleepBody(impostor: PhysicsImpostor): void;
  53723. wakeUpBody(impostor: PhysicsImpostor): void;
  53724. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  53725. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  53726. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  53727. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  53728. getRadius(impostor: PhysicsImpostor): number;
  53729. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  53730. dispose(): void;
  53731. /**
  53732. * Does a raycast in the physics world
  53733. * @param from when should the ray start?
  53734. * @param to when should the ray end?
  53735. * @returns PhysicsRaycastResult
  53736. */
  53737. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  53738. }
  53739. }
  53740. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  53741. import { Nullable } from "babylonjs/types";
  53742. import { Scene } from "babylonjs/scene";
  53743. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  53744. import { Color4 } from "babylonjs/Maths/math.color";
  53745. import { Mesh } from "babylonjs/Meshes/mesh";
  53746. /**
  53747. * Class containing static functions to help procedurally build meshes
  53748. */
  53749. export class RibbonBuilder {
  53750. /**
  53751. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  53752. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  53753. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  53754. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  53755. * * 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
  53756. * * 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
  53757. * * 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
  53758. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53759. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53760. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53761. * * 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
  53762. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  53763. * * 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
  53764. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  53765. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53766. * @param name defines the name of the mesh
  53767. * @param options defines the options used to create the mesh
  53768. * @param scene defines the hosting scene
  53769. * @returns the ribbon mesh
  53770. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  53771. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53772. */
  53773. static CreateRibbon(name: string, options: {
  53774. pathArray: Vector3[][];
  53775. closeArray?: boolean;
  53776. closePath?: boolean;
  53777. offset?: number;
  53778. updatable?: boolean;
  53779. sideOrientation?: number;
  53780. frontUVs?: Vector4;
  53781. backUVs?: Vector4;
  53782. instance?: Mesh;
  53783. invertUV?: boolean;
  53784. uvs?: Vector2[];
  53785. colors?: Color4[];
  53786. }, scene?: Nullable<Scene>): Mesh;
  53787. }
  53788. }
  53789. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  53790. import { Nullable } from "babylonjs/types";
  53791. import { Scene } from "babylonjs/scene";
  53792. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  53793. import { Mesh } from "babylonjs/Meshes/mesh";
  53794. /**
  53795. * Class containing static functions to help procedurally build meshes
  53796. */
  53797. export class ShapeBuilder {
  53798. /**
  53799. * 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.
  53800. * * 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.
  53801. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53802. * * 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.
  53803. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  53804. * * 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
  53805. * * 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
  53806. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  53807. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53808. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53809. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  53810. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  53811. * @param name defines the name of the mesh
  53812. * @param options defines the options used to create the mesh
  53813. * @param scene defines the hosting scene
  53814. * @returns the extruded shape mesh
  53815. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53816. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53817. */
  53818. static ExtrudeShape(name: string, options: {
  53819. shape: Vector3[];
  53820. path: Vector3[];
  53821. scale?: number;
  53822. rotation?: number;
  53823. cap?: number;
  53824. updatable?: boolean;
  53825. sideOrientation?: number;
  53826. frontUVs?: Vector4;
  53827. backUVs?: Vector4;
  53828. instance?: Mesh;
  53829. invertUV?: boolean;
  53830. }, scene?: Nullable<Scene>): Mesh;
  53831. /**
  53832. * Creates an custom extruded shape mesh.
  53833. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  53834. * * 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.
  53835. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53836. * * 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
  53837. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  53838. * * 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
  53839. * * It must returns a float value that will be the scale value applied to the shape on each path point
  53840. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  53841. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  53842. * * 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
  53843. * * 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
  53844. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  53845. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53846. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53847. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53848. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53849. * @param name defines the name of the mesh
  53850. * @param options defines the options used to create the mesh
  53851. * @param scene defines the hosting scene
  53852. * @returns the custom extruded shape mesh
  53853. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  53854. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53855. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53856. */
  53857. static ExtrudeShapeCustom(name: string, options: {
  53858. shape: Vector3[];
  53859. path: Vector3[];
  53860. scaleFunction?: any;
  53861. rotationFunction?: any;
  53862. ribbonCloseArray?: boolean;
  53863. ribbonClosePath?: boolean;
  53864. cap?: number;
  53865. updatable?: boolean;
  53866. sideOrientation?: number;
  53867. frontUVs?: Vector4;
  53868. backUVs?: Vector4;
  53869. instance?: Mesh;
  53870. invertUV?: boolean;
  53871. }, scene?: Nullable<Scene>): Mesh;
  53872. private static _ExtrudeShapeGeneric;
  53873. }
  53874. }
  53875. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  53876. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  53877. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  53878. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  53879. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  53880. import { Nullable } from "babylonjs/types";
  53881. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53882. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  53883. /**
  53884. * AmmoJS Physics plugin
  53885. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  53886. * @see https://github.com/kripken/ammo.js/
  53887. */
  53888. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  53889. private _useDeltaForWorldStep;
  53890. /**
  53891. * Reference to the Ammo library
  53892. */
  53893. bjsAMMO: any;
  53894. /**
  53895. * Created ammoJS world which physics bodies are added to
  53896. */
  53897. world: any;
  53898. /**
  53899. * Name of the plugin
  53900. */
  53901. name: string;
  53902. private _timeStep;
  53903. private _fixedTimeStep;
  53904. private _maxSteps;
  53905. private _tmpQuaternion;
  53906. private _tmpAmmoTransform;
  53907. private _tmpAmmoQuaternion;
  53908. private _tmpAmmoConcreteContactResultCallback;
  53909. private _collisionConfiguration;
  53910. private _dispatcher;
  53911. private _overlappingPairCache;
  53912. private _solver;
  53913. private _softBodySolver;
  53914. private _tmpAmmoVectorA;
  53915. private _tmpAmmoVectorB;
  53916. private _tmpAmmoVectorC;
  53917. private _tmpAmmoVectorD;
  53918. private _tmpContactCallbackResult;
  53919. private _tmpAmmoVectorRCA;
  53920. private _tmpAmmoVectorRCB;
  53921. private _raycastResult;
  53922. private static readonly DISABLE_COLLISION_FLAG;
  53923. private static readonly KINEMATIC_FLAG;
  53924. private static readonly DISABLE_DEACTIVATION_FLAG;
  53925. /**
  53926. * Initializes the ammoJS plugin
  53927. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  53928. * @param ammoInjection can be used to inject your own ammo reference
  53929. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  53930. */
  53931. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  53932. /**
  53933. * Sets the gravity of the physics world (m/(s^2))
  53934. * @param gravity Gravity to set
  53935. */
  53936. setGravity(gravity: Vector3): void;
  53937. /**
  53938. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  53939. * @param timeStep timestep to use in seconds
  53940. */
  53941. setTimeStep(timeStep: number): void;
  53942. /**
  53943. * 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)
  53944. * @param fixedTimeStep fixedTimeStep to use in seconds
  53945. */
  53946. setFixedTimeStep(fixedTimeStep: number): void;
  53947. /**
  53948. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  53949. * @param maxSteps the maximum number of steps by the physics engine per frame
  53950. */
  53951. setMaxSteps(maxSteps: number): void;
  53952. /**
  53953. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  53954. * @returns the current timestep in seconds
  53955. */
  53956. getTimeStep(): number;
  53957. private _isImpostorInContact;
  53958. private _isImpostorPairInContact;
  53959. private _stepSimulation;
  53960. /**
  53961. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  53962. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  53963. * After the step the babylon meshes are set to the position of the physics imposters
  53964. * @param delta amount of time to step forward
  53965. * @param impostors array of imposters to update before/after the step
  53966. */
  53967. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  53968. /**
  53969. * Update babylon mesh to match physics world object
  53970. * @param impostor imposter to match
  53971. */
  53972. private _afterSoftStep;
  53973. /**
  53974. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  53975. * @param impostor imposter to match
  53976. */
  53977. private _ropeStep;
  53978. /**
  53979. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  53980. * @param impostor imposter to match
  53981. */
  53982. private _softbodyOrClothStep;
  53983. private _tmpVector;
  53984. private _tmpMatrix;
  53985. /**
  53986. * Applies an impulse on the imposter
  53987. * @param impostor imposter to apply impulse to
  53988. * @param force amount of force to be applied to the imposter
  53989. * @param contactPoint the location to apply the impulse on the imposter
  53990. */
  53991. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53992. /**
  53993. * Applies a force on the imposter
  53994. * @param impostor imposter to apply force
  53995. * @param force amount of force to be applied to the imposter
  53996. * @param contactPoint the location to apply the force on the imposter
  53997. */
  53998. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53999. /**
  54000. * Creates a physics body using the plugin
  54001. * @param impostor the imposter to create the physics body on
  54002. */
  54003. generatePhysicsBody(impostor: PhysicsImpostor): void;
  54004. /**
  54005. * Removes the physics body from the imposter and disposes of the body's memory
  54006. * @param impostor imposter to remove the physics body from
  54007. */
  54008. removePhysicsBody(impostor: PhysicsImpostor): void;
  54009. /**
  54010. * Generates a joint
  54011. * @param impostorJoint the imposter joint to create the joint with
  54012. */
  54013. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  54014. /**
  54015. * Removes a joint
  54016. * @param impostorJoint the imposter joint to remove the joint from
  54017. */
  54018. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  54019. private _addMeshVerts;
  54020. /**
  54021. * Initialise the soft body vertices to match its object's (mesh) vertices
  54022. * Softbody vertices (nodes) are in world space and to match this
  54023. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  54024. * @param impostor to create the softbody for
  54025. */
  54026. private _softVertexData;
  54027. /**
  54028. * Create an impostor's soft body
  54029. * @param impostor to create the softbody for
  54030. */
  54031. private _createSoftbody;
  54032. /**
  54033. * Create cloth for an impostor
  54034. * @param impostor to create the softbody for
  54035. */
  54036. private _createCloth;
  54037. /**
  54038. * Create rope for an impostor
  54039. * @param impostor to create the softbody for
  54040. */
  54041. private _createRope;
  54042. private _addHullVerts;
  54043. private _createShape;
  54044. /**
  54045. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  54046. * @param impostor imposter containing the physics body and babylon object
  54047. */
  54048. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  54049. /**
  54050. * Sets the babylon object's position/rotation from the physics body's position/rotation
  54051. * @param impostor imposter containing the physics body and babylon object
  54052. * @param newPosition new position
  54053. * @param newRotation new rotation
  54054. */
  54055. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  54056. /**
  54057. * If this plugin is supported
  54058. * @returns true if its supported
  54059. */
  54060. isSupported(): boolean;
  54061. /**
  54062. * Sets the linear velocity of the physics body
  54063. * @param impostor imposter to set the velocity on
  54064. * @param velocity velocity to set
  54065. */
  54066. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54067. /**
  54068. * Sets the angular velocity of the physics body
  54069. * @param impostor imposter to set the velocity on
  54070. * @param velocity velocity to set
  54071. */
  54072. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54073. /**
  54074. * gets the linear velocity
  54075. * @param impostor imposter to get linear velocity from
  54076. * @returns linear velocity
  54077. */
  54078. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54079. /**
  54080. * gets the angular velocity
  54081. * @param impostor imposter to get angular velocity from
  54082. * @returns angular velocity
  54083. */
  54084. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54085. /**
  54086. * Sets the mass of physics body
  54087. * @param impostor imposter to set the mass on
  54088. * @param mass mass to set
  54089. */
  54090. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  54091. /**
  54092. * Gets the mass of the physics body
  54093. * @param impostor imposter to get the mass from
  54094. * @returns mass
  54095. */
  54096. getBodyMass(impostor: PhysicsImpostor): number;
  54097. /**
  54098. * Gets friction of the impostor
  54099. * @param impostor impostor to get friction from
  54100. * @returns friction value
  54101. */
  54102. getBodyFriction(impostor: PhysicsImpostor): number;
  54103. /**
  54104. * Sets friction of the impostor
  54105. * @param impostor impostor to set friction on
  54106. * @param friction friction value
  54107. */
  54108. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  54109. /**
  54110. * Gets restitution of the impostor
  54111. * @param impostor impostor to get restitution from
  54112. * @returns restitution value
  54113. */
  54114. getBodyRestitution(impostor: PhysicsImpostor): number;
  54115. /**
  54116. * Sets resitution of the impostor
  54117. * @param impostor impostor to set resitution on
  54118. * @param restitution resitution value
  54119. */
  54120. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  54121. /**
  54122. * Gets pressure inside the impostor
  54123. * @param impostor impostor to get pressure from
  54124. * @returns pressure value
  54125. */
  54126. getBodyPressure(impostor: PhysicsImpostor): number;
  54127. /**
  54128. * Sets pressure inside a soft body impostor
  54129. * Cloth and rope must remain 0 pressure
  54130. * @param impostor impostor to set pressure on
  54131. * @param pressure pressure value
  54132. */
  54133. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  54134. /**
  54135. * Gets stiffness of the impostor
  54136. * @param impostor impostor to get stiffness from
  54137. * @returns pressure value
  54138. */
  54139. getBodyStiffness(impostor: PhysicsImpostor): number;
  54140. /**
  54141. * Sets stiffness of the impostor
  54142. * @param impostor impostor to set stiffness on
  54143. * @param stiffness stiffness value from 0 to 1
  54144. */
  54145. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  54146. /**
  54147. * Gets velocityIterations of the impostor
  54148. * @param impostor impostor to get velocity iterations from
  54149. * @returns velocityIterations value
  54150. */
  54151. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  54152. /**
  54153. * Sets velocityIterations of the impostor
  54154. * @param impostor impostor to set velocity iterations on
  54155. * @param velocityIterations velocityIterations value
  54156. */
  54157. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  54158. /**
  54159. * Gets positionIterations of the impostor
  54160. * @param impostor impostor to get position iterations from
  54161. * @returns positionIterations value
  54162. */
  54163. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  54164. /**
  54165. * Sets positionIterations of the impostor
  54166. * @param impostor impostor to set position on
  54167. * @param positionIterations positionIterations value
  54168. */
  54169. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  54170. /**
  54171. * Append an anchor to a cloth object
  54172. * @param impostor is the cloth impostor to add anchor to
  54173. * @param otherImpostor is the rigid impostor to anchor to
  54174. * @param width ratio across width from 0 to 1
  54175. * @param height ratio up height from 0 to 1
  54176. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  54177. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  54178. */
  54179. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  54180. /**
  54181. * Append an hook to a rope object
  54182. * @param impostor is the rope impostor to add hook to
  54183. * @param otherImpostor is the rigid impostor to hook to
  54184. * @param length ratio along the rope from 0 to 1
  54185. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  54186. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  54187. */
  54188. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  54189. /**
  54190. * Sleeps the physics body and stops it from being active
  54191. * @param impostor impostor to sleep
  54192. */
  54193. sleepBody(impostor: PhysicsImpostor): void;
  54194. /**
  54195. * Activates the physics body
  54196. * @param impostor impostor to activate
  54197. */
  54198. wakeUpBody(impostor: PhysicsImpostor): void;
  54199. /**
  54200. * Updates the distance parameters of the joint
  54201. * @param joint joint to update
  54202. * @param maxDistance maximum distance of the joint
  54203. * @param minDistance minimum distance of the joint
  54204. */
  54205. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  54206. /**
  54207. * Sets a motor on the joint
  54208. * @param joint joint to set motor on
  54209. * @param speed speed of the motor
  54210. * @param maxForce maximum force of the motor
  54211. * @param motorIndex index of the motor
  54212. */
  54213. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  54214. /**
  54215. * Sets the motors limit
  54216. * @param joint joint to set limit on
  54217. * @param upperLimit upper limit
  54218. * @param lowerLimit lower limit
  54219. */
  54220. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  54221. /**
  54222. * Syncs the position and rotation of a mesh with the impostor
  54223. * @param mesh mesh to sync
  54224. * @param impostor impostor to update the mesh with
  54225. */
  54226. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  54227. /**
  54228. * Gets the radius of the impostor
  54229. * @param impostor impostor to get radius from
  54230. * @returns the radius
  54231. */
  54232. getRadius(impostor: PhysicsImpostor): number;
  54233. /**
  54234. * Gets the box size of the impostor
  54235. * @param impostor impostor to get box size from
  54236. * @param result the resulting box size
  54237. */
  54238. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  54239. /**
  54240. * Disposes of the impostor
  54241. */
  54242. dispose(): void;
  54243. /**
  54244. * Does a raycast in the physics world
  54245. * @param from when should the ray start?
  54246. * @param to when should the ray end?
  54247. * @returns PhysicsRaycastResult
  54248. */
  54249. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  54250. }
  54251. }
  54252. declare module "babylonjs/Probes/reflectionProbe" {
  54253. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  54254. import { Vector3 } from "babylonjs/Maths/math.vector";
  54255. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54256. import { Nullable } from "babylonjs/types";
  54257. import { Scene } from "babylonjs/scene";
  54258. module "babylonjs/abstractScene" {
  54259. interface AbstractScene {
  54260. /**
  54261. * The list of reflection probes added to the scene
  54262. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  54263. */
  54264. reflectionProbes: Array<ReflectionProbe>;
  54265. /**
  54266. * Removes the given reflection probe from this scene.
  54267. * @param toRemove The reflection probe to remove
  54268. * @returns The index of the removed reflection probe
  54269. */
  54270. removeReflectionProbe(toRemove: ReflectionProbe): number;
  54271. /**
  54272. * Adds the given reflection probe to this scene.
  54273. * @param newReflectionProbe The reflection probe to add
  54274. */
  54275. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  54276. }
  54277. }
  54278. /**
  54279. * Class used to generate realtime reflection / refraction cube textures
  54280. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  54281. */
  54282. export class ReflectionProbe {
  54283. /** defines the name of the probe */
  54284. name: string;
  54285. private _scene;
  54286. private _renderTargetTexture;
  54287. private _projectionMatrix;
  54288. private _viewMatrix;
  54289. private _target;
  54290. private _add;
  54291. private _attachedMesh;
  54292. private _invertYAxis;
  54293. /** Gets or sets probe position (center of the cube map) */
  54294. position: Vector3;
  54295. /**
  54296. * Creates a new reflection probe
  54297. * @param name defines the name of the probe
  54298. * @param size defines the texture resolution (for each face)
  54299. * @param scene defines the hosting scene
  54300. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  54301. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  54302. */
  54303. constructor(
  54304. /** defines the name of the probe */
  54305. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  54306. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  54307. samples: number;
  54308. /** Gets or sets the refresh rate to use (on every frame by default) */
  54309. refreshRate: number;
  54310. /**
  54311. * Gets the hosting scene
  54312. * @returns a Scene
  54313. */
  54314. getScene(): Scene;
  54315. /** Gets the internal CubeTexture used to render to */
  54316. readonly cubeTexture: RenderTargetTexture;
  54317. /** Gets the list of meshes to render */
  54318. readonly renderList: Nullable<AbstractMesh[]>;
  54319. /**
  54320. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  54321. * @param mesh defines the mesh to attach to
  54322. */
  54323. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  54324. /**
  54325. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  54326. * @param renderingGroupId The rendering group id corresponding to its index
  54327. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  54328. */
  54329. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  54330. /**
  54331. * Clean all associated resources
  54332. */
  54333. dispose(): void;
  54334. /**
  54335. * Converts the reflection probe information to a readable string for debug purpose.
  54336. * @param fullDetails Supports for multiple levels of logging within scene loading
  54337. * @returns the human readable reflection probe info
  54338. */
  54339. toString(fullDetails?: boolean): string;
  54340. /**
  54341. * Get the class name of the relfection probe.
  54342. * @returns "ReflectionProbe"
  54343. */
  54344. getClassName(): string;
  54345. /**
  54346. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  54347. * @returns The JSON representation of the texture
  54348. */
  54349. serialize(): any;
  54350. /**
  54351. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  54352. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  54353. * @param scene Define the scene the parsed reflection probe should be instantiated in
  54354. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  54355. * @returns The parsed reflection probe if successful
  54356. */
  54357. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  54358. }
  54359. }
  54360. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  54361. /** @hidden */
  54362. export var _BabylonLoaderRegistered: boolean;
  54363. /**
  54364. * Helps setting up some configuration for the babylon file loader.
  54365. */
  54366. export class BabylonFileLoaderConfiguration {
  54367. /**
  54368. * The loader does not allow injecting custom physix engine into the plugins.
  54369. * Unfortunately in ES6, we need to manually inject them into the plugin.
  54370. * So you could set this variable to your engine import to make it work.
  54371. */
  54372. static LoaderInjectedPhysicsEngine: any;
  54373. }
  54374. }
  54375. declare module "babylonjs/Loading/Plugins/index" {
  54376. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  54377. }
  54378. declare module "babylonjs/Loading/index" {
  54379. export * from "babylonjs/Loading/loadingScreen";
  54380. export * from "babylonjs/Loading/Plugins/index";
  54381. export * from "babylonjs/Loading/sceneLoader";
  54382. export * from "babylonjs/Loading/sceneLoaderFlags";
  54383. }
  54384. declare module "babylonjs/Materials/Background/index" {
  54385. export * from "babylonjs/Materials/Background/backgroundMaterial";
  54386. }
  54387. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  54388. import { Scene } from "babylonjs/scene";
  54389. import { Color3 } from "babylonjs/Maths/math.color";
  54390. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  54391. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54392. /**
  54393. * The Physically based simple base material of BJS.
  54394. *
  54395. * This enables better naming and convention enforcements on top of the pbrMaterial.
  54396. * It is used as the base class for both the specGloss and metalRough conventions.
  54397. */
  54398. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  54399. /**
  54400. * Number of Simultaneous lights allowed on the material.
  54401. */
  54402. maxSimultaneousLights: number;
  54403. /**
  54404. * If sets to true, disables all the lights affecting the material.
  54405. */
  54406. disableLighting: boolean;
  54407. /**
  54408. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  54409. */
  54410. environmentTexture: BaseTexture;
  54411. /**
  54412. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  54413. */
  54414. invertNormalMapX: boolean;
  54415. /**
  54416. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  54417. */
  54418. invertNormalMapY: boolean;
  54419. /**
  54420. * Normal map used in the model.
  54421. */
  54422. normalTexture: BaseTexture;
  54423. /**
  54424. * Emissivie color used to self-illuminate the model.
  54425. */
  54426. emissiveColor: Color3;
  54427. /**
  54428. * Emissivie texture used to self-illuminate the model.
  54429. */
  54430. emissiveTexture: BaseTexture;
  54431. /**
  54432. * Occlusion Channel Strenght.
  54433. */
  54434. occlusionStrength: number;
  54435. /**
  54436. * Occlusion Texture of the material (adding extra occlusion effects).
  54437. */
  54438. occlusionTexture: BaseTexture;
  54439. /**
  54440. * Defines the alpha limits in alpha test mode.
  54441. */
  54442. alphaCutOff: number;
  54443. /**
  54444. * Gets the current double sided mode.
  54445. */
  54446. /**
  54447. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  54448. */
  54449. doubleSided: boolean;
  54450. /**
  54451. * Stores the pre-calculated light information of a mesh in a texture.
  54452. */
  54453. lightmapTexture: BaseTexture;
  54454. /**
  54455. * If true, the light map contains occlusion information instead of lighting info.
  54456. */
  54457. useLightmapAsShadowmap: boolean;
  54458. /**
  54459. * Instantiates a new PBRMaterial instance.
  54460. *
  54461. * @param name The material name
  54462. * @param scene The scene the material will be use in.
  54463. */
  54464. constructor(name: string, scene: Scene);
  54465. getClassName(): string;
  54466. }
  54467. }
  54468. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  54469. import { Scene } from "babylonjs/scene";
  54470. import { Color3 } from "babylonjs/Maths/math.color";
  54471. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54472. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  54473. /**
  54474. * The PBR material of BJS following the metal roughness convention.
  54475. *
  54476. * This fits to the PBR convention in the GLTF definition:
  54477. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  54478. */
  54479. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  54480. /**
  54481. * The base color has two different interpretations depending on the value of metalness.
  54482. * When the material is a metal, the base color is the specific measured reflectance value
  54483. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  54484. * of the material.
  54485. */
  54486. baseColor: Color3;
  54487. /**
  54488. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  54489. * well as opacity information in the alpha channel.
  54490. */
  54491. baseTexture: BaseTexture;
  54492. /**
  54493. * Specifies the metallic scalar value of the material.
  54494. * Can also be used to scale the metalness values of the metallic texture.
  54495. */
  54496. metallic: number;
  54497. /**
  54498. * Specifies the roughness scalar value of the material.
  54499. * Can also be used to scale the roughness values of the metallic texture.
  54500. */
  54501. roughness: number;
  54502. /**
  54503. * Texture containing both the metallic value in the B channel and the
  54504. * roughness value in the G channel to keep better precision.
  54505. */
  54506. metallicRoughnessTexture: BaseTexture;
  54507. /**
  54508. * Instantiates a new PBRMetalRoughnessMaterial instance.
  54509. *
  54510. * @param name The material name
  54511. * @param scene The scene the material will be use in.
  54512. */
  54513. constructor(name: string, scene: Scene);
  54514. /**
  54515. * Return the currrent class name of the material.
  54516. */
  54517. getClassName(): string;
  54518. /**
  54519. * Makes a duplicate of the current material.
  54520. * @param name - name to use for the new material.
  54521. */
  54522. clone(name: string): PBRMetallicRoughnessMaterial;
  54523. /**
  54524. * Serialize the material to a parsable JSON object.
  54525. */
  54526. serialize(): any;
  54527. /**
  54528. * Parses a JSON object correponding to the serialize function.
  54529. */
  54530. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  54531. }
  54532. }
  54533. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  54534. import { Scene } from "babylonjs/scene";
  54535. import { Color3 } from "babylonjs/Maths/math.color";
  54536. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54537. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  54538. /**
  54539. * The PBR material of BJS following the specular glossiness convention.
  54540. *
  54541. * This fits to the PBR convention in the GLTF definition:
  54542. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  54543. */
  54544. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  54545. /**
  54546. * Specifies the diffuse color of the material.
  54547. */
  54548. diffuseColor: Color3;
  54549. /**
  54550. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  54551. * channel.
  54552. */
  54553. diffuseTexture: BaseTexture;
  54554. /**
  54555. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  54556. */
  54557. specularColor: Color3;
  54558. /**
  54559. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  54560. */
  54561. glossiness: number;
  54562. /**
  54563. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  54564. */
  54565. specularGlossinessTexture: BaseTexture;
  54566. /**
  54567. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  54568. *
  54569. * @param name The material name
  54570. * @param scene The scene the material will be use in.
  54571. */
  54572. constructor(name: string, scene: Scene);
  54573. /**
  54574. * Return the currrent class name of the material.
  54575. */
  54576. getClassName(): string;
  54577. /**
  54578. * Makes a duplicate of the current material.
  54579. * @param name - name to use for the new material.
  54580. */
  54581. clone(name: string): PBRSpecularGlossinessMaterial;
  54582. /**
  54583. * Serialize the material to a parsable JSON object.
  54584. */
  54585. serialize(): any;
  54586. /**
  54587. * Parses a JSON object correponding to the serialize function.
  54588. */
  54589. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  54590. }
  54591. }
  54592. declare module "babylonjs/Materials/PBR/index" {
  54593. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  54594. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  54595. export * from "babylonjs/Materials/PBR/pbrMaterial";
  54596. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  54597. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  54598. }
  54599. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  54600. import { Nullable } from "babylonjs/types";
  54601. import { Scene } from "babylonjs/scene";
  54602. import { Matrix } from "babylonjs/Maths/math.vector";
  54603. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54604. /**
  54605. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  54606. * It can help converting any input color in a desired output one. This can then be used to create effects
  54607. * from sepia, black and white to sixties or futuristic rendering...
  54608. *
  54609. * The only supported format is currently 3dl.
  54610. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  54611. */
  54612. export class ColorGradingTexture extends BaseTexture {
  54613. /**
  54614. * The current texture matrix. (will always be identity in color grading texture)
  54615. */
  54616. private _textureMatrix;
  54617. /**
  54618. * The texture URL.
  54619. */
  54620. url: string;
  54621. /**
  54622. * Empty line regex stored for GC.
  54623. */
  54624. private static _noneEmptyLineRegex;
  54625. private _engine;
  54626. /**
  54627. * Instantiates a ColorGradingTexture from the following parameters.
  54628. *
  54629. * @param url The location of the color gradind data (currently only supporting 3dl)
  54630. * @param scene The scene the texture will be used in
  54631. */
  54632. constructor(url: string, scene: Scene);
  54633. /**
  54634. * Returns the texture matrix used in most of the material.
  54635. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  54636. */
  54637. getTextureMatrix(): Matrix;
  54638. /**
  54639. * Occurs when the file being loaded is a .3dl LUT file.
  54640. */
  54641. private load3dlTexture;
  54642. /**
  54643. * Starts the loading process of the texture.
  54644. */
  54645. private loadTexture;
  54646. /**
  54647. * Clones the color gradind texture.
  54648. */
  54649. clone(): ColorGradingTexture;
  54650. /**
  54651. * Called during delayed load for textures.
  54652. */
  54653. delayLoad(): void;
  54654. /**
  54655. * Parses a color grading texture serialized by Babylon.
  54656. * @param parsedTexture The texture information being parsedTexture
  54657. * @param scene The scene to load the texture in
  54658. * @param rootUrl The root url of the data assets to load
  54659. * @return A color gradind texture
  54660. */
  54661. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  54662. /**
  54663. * Serializes the LUT texture to json format.
  54664. */
  54665. serialize(): any;
  54666. }
  54667. }
  54668. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  54669. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54670. import { Scene } from "babylonjs/scene";
  54671. import { Nullable } from "babylonjs/types";
  54672. import "babylonjs/Engines/Extensions/engine.rawTexture";
  54673. /**
  54674. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  54675. */
  54676. export class EquiRectangularCubeTexture extends BaseTexture {
  54677. /** The six faces of the cube. */
  54678. private static _FacesMapping;
  54679. private _noMipmap;
  54680. private _onLoad;
  54681. private _onError;
  54682. /** The size of the cubemap. */
  54683. private _size;
  54684. /** The buffer of the image. */
  54685. private _buffer;
  54686. /** The width of the input image. */
  54687. private _width;
  54688. /** The height of the input image. */
  54689. private _height;
  54690. /** The URL to the image. */
  54691. url: string;
  54692. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  54693. coordinatesMode: number;
  54694. /**
  54695. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  54696. * @param url The location of the image
  54697. * @param scene The scene the texture will be used in
  54698. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  54699. * @param noMipmap Forces to not generate the mipmap if true
  54700. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  54701. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  54702. * @param onLoad — defines a callback called when texture is loaded
  54703. * @param onError — defines a callback called if there is an error
  54704. */
  54705. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  54706. /**
  54707. * Load the image data, by putting the image on a canvas and extracting its buffer.
  54708. */
  54709. private loadImage;
  54710. /**
  54711. * Convert the image buffer into a cubemap and create a CubeTexture.
  54712. */
  54713. private loadTexture;
  54714. /**
  54715. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  54716. * @param buffer The ArrayBuffer that should be converted.
  54717. * @returns The buffer as Float32Array.
  54718. */
  54719. private getFloat32ArrayFromArrayBuffer;
  54720. /**
  54721. * Get the current class name of the texture useful for serialization or dynamic coding.
  54722. * @returns "EquiRectangularCubeTexture"
  54723. */
  54724. getClassName(): string;
  54725. /**
  54726. * Create a clone of the current EquiRectangularCubeTexture and return it.
  54727. * @returns A clone of the current EquiRectangularCubeTexture.
  54728. */
  54729. clone(): EquiRectangularCubeTexture;
  54730. }
  54731. }
  54732. declare module "babylonjs/Misc/tga" {
  54733. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54734. /**
  54735. * Based on jsTGALoader - Javascript loader for TGA file
  54736. * By Vincent Thibault
  54737. * @see http://blog.robrowser.com/javascript-tga-loader.html
  54738. */
  54739. export class TGATools {
  54740. private static _TYPE_INDEXED;
  54741. private static _TYPE_RGB;
  54742. private static _TYPE_GREY;
  54743. private static _TYPE_RLE_INDEXED;
  54744. private static _TYPE_RLE_RGB;
  54745. private static _TYPE_RLE_GREY;
  54746. private static _ORIGIN_MASK;
  54747. private static _ORIGIN_SHIFT;
  54748. private static _ORIGIN_BL;
  54749. private static _ORIGIN_BR;
  54750. private static _ORIGIN_UL;
  54751. private static _ORIGIN_UR;
  54752. /**
  54753. * Gets the header of a TGA file
  54754. * @param data defines the TGA data
  54755. * @returns the header
  54756. */
  54757. static GetTGAHeader(data: Uint8Array): any;
  54758. /**
  54759. * Uploads TGA content to a Babylon Texture
  54760. * @hidden
  54761. */
  54762. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  54763. /** @hidden */
  54764. 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;
  54765. /** @hidden */
  54766. 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;
  54767. /** @hidden */
  54768. 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;
  54769. /** @hidden */
  54770. 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;
  54771. /** @hidden */
  54772. 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;
  54773. /** @hidden */
  54774. 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;
  54775. }
  54776. }
  54777. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  54778. import { Nullable } from "babylonjs/types";
  54779. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54780. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  54781. /**
  54782. * Implementation of the TGA Texture Loader.
  54783. * @hidden
  54784. */
  54785. export class _TGATextureLoader implements IInternalTextureLoader {
  54786. /**
  54787. * Defines wether the loader supports cascade loading the different faces.
  54788. */
  54789. readonly supportCascades: boolean;
  54790. /**
  54791. * This returns if the loader support the current file information.
  54792. * @param extension defines the file extension of the file being loaded
  54793. * @param textureFormatInUse defines the current compressed format in use iun the engine
  54794. * @param fallback defines the fallback internal texture if any
  54795. * @param isBase64 defines whether the texture is encoded as a base64
  54796. * @param isBuffer defines whether the texture data are stored as a buffer
  54797. * @returns true if the loader can load the specified file
  54798. */
  54799. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  54800. /**
  54801. * Transform the url before loading if required.
  54802. * @param rootUrl the url of the texture
  54803. * @param textureFormatInUse defines the current compressed format in use iun the engine
  54804. * @returns the transformed texture
  54805. */
  54806. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  54807. /**
  54808. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  54809. * @param rootUrl the url of the texture
  54810. * @param textureFormatInUse defines the current compressed format in use iun the engine
  54811. * @returns the fallback texture
  54812. */
  54813. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  54814. /**
  54815. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  54816. * @param data contains the texture data
  54817. * @param texture defines the BabylonJS internal texture
  54818. * @param createPolynomials will be true if polynomials have been requested
  54819. * @param onLoad defines the callback to trigger once the texture is ready
  54820. * @param onError defines the callback to trigger in case of error
  54821. */
  54822. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  54823. /**
  54824. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  54825. * @param data contains the texture data
  54826. * @param texture defines the BabylonJS internal texture
  54827. * @param callback defines the method to call once ready to upload
  54828. */
  54829. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  54830. }
  54831. }
  54832. declare module "babylonjs/Misc/basis" {
  54833. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54834. /**
  54835. * Info about the .basis files
  54836. */
  54837. class BasisFileInfo {
  54838. /**
  54839. * If the file has alpha
  54840. */
  54841. hasAlpha: boolean;
  54842. /**
  54843. * Info about each image of the basis file
  54844. */
  54845. images: Array<{
  54846. levels: Array<{
  54847. width: number;
  54848. height: number;
  54849. transcodedPixels: ArrayBufferView;
  54850. }>;
  54851. }>;
  54852. }
  54853. /**
  54854. * Result of transcoding a basis file
  54855. */
  54856. class TranscodeResult {
  54857. /**
  54858. * Info about the .basis file
  54859. */
  54860. fileInfo: BasisFileInfo;
  54861. /**
  54862. * Format to use when loading the file
  54863. */
  54864. format: number;
  54865. }
  54866. /**
  54867. * Configuration options for the Basis transcoder
  54868. */
  54869. export class BasisTranscodeConfiguration {
  54870. /**
  54871. * Supported compression formats used to determine the supported output format of the transcoder
  54872. */
  54873. supportedCompressionFormats?: {
  54874. /**
  54875. * etc1 compression format
  54876. */
  54877. etc1?: boolean;
  54878. /**
  54879. * s3tc compression format
  54880. */
  54881. s3tc?: boolean;
  54882. /**
  54883. * pvrtc compression format
  54884. */
  54885. pvrtc?: boolean;
  54886. /**
  54887. * etc2 compression format
  54888. */
  54889. etc2?: boolean;
  54890. };
  54891. /**
  54892. * If mipmap levels should be loaded for transcoded images (Default: true)
  54893. */
  54894. loadMipmapLevels?: boolean;
  54895. /**
  54896. * Index of a single image to load (Default: all images)
  54897. */
  54898. loadSingleImage?: number;
  54899. }
  54900. /**
  54901. * Used to load .Basis files
  54902. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  54903. */
  54904. export class BasisTools {
  54905. private static _IgnoreSupportedFormats;
  54906. /**
  54907. * URL to use when loading the basis transcoder
  54908. */
  54909. static JSModuleURL: string;
  54910. /**
  54911. * URL to use when loading the wasm module for the transcoder
  54912. */
  54913. static WasmModuleURL: string;
  54914. /**
  54915. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  54916. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  54917. * @returns internal format corresponding to the Basis format
  54918. */
  54919. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  54920. private static _WorkerPromise;
  54921. private static _Worker;
  54922. private static _actionId;
  54923. private static _CreateWorkerAsync;
  54924. /**
  54925. * Transcodes a loaded image file to compressed pixel data
  54926. * @param imageData image data to transcode
  54927. * @param config configuration options for the transcoding
  54928. * @returns a promise resulting in the transcoded image
  54929. */
  54930. static TranscodeAsync(imageData: ArrayBuffer, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  54931. /**
  54932. * Loads a texture from the transcode result
  54933. * @param texture texture load to
  54934. * @param transcodeResult the result of transcoding the basis file to load from
  54935. */
  54936. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  54937. }
  54938. }
  54939. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  54940. import { Nullable } from "babylonjs/types";
  54941. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54942. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  54943. /**
  54944. * Loader for .basis file format
  54945. */
  54946. export class _BasisTextureLoader implements IInternalTextureLoader {
  54947. /**
  54948. * Defines whether the loader supports cascade loading the different faces.
  54949. */
  54950. readonly supportCascades: boolean;
  54951. /**
  54952. * This returns if the loader support the current file information.
  54953. * @param extension defines the file extension of the file being loaded
  54954. * @param textureFormatInUse defines the current compressed format in use iun the engine
  54955. * @param fallback defines the fallback internal texture if any
  54956. * @param isBase64 defines whether the texture is encoded as a base64
  54957. * @param isBuffer defines whether the texture data are stored as a buffer
  54958. * @returns true if the loader can load the specified file
  54959. */
  54960. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  54961. /**
  54962. * Transform the url before loading if required.
  54963. * @param rootUrl the url of the texture
  54964. * @param textureFormatInUse defines the current compressed format in use iun the engine
  54965. * @returns the transformed texture
  54966. */
  54967. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  54968. /**
  54969. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  54970. * @param rootUrl the url of the texture
  54971. * @param textureFormatInUse defines the current compressed format in use iun the engine
  54972. * @returns the fallback texture
  54973. */
  54974. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  54975. /**
  54976. * Uploads the cube texture data to the WebGl Texture. It has already been bound.
  54977. * @param data contains the texture data
  54978. * @param texture defines the BabylonJS internal texture
  54979. * @param createPolynomials will be true if polynomials have been requested
  54980. * @param onLoad defines the callback to trigger once the texture is ready
  54981. * @param onError defines the callback to trigger in case of error
  54982. */
  54983. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  54984. /**
  54985. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  54986. * @param data contains the texture data
  54987. * @param texture defines the BabylonJS internal texture
  54988. * @param callback defines the method to call once ready to upload
  54989. */
  54990. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  54991. }
  54992. }
  54993. declare module "babylonjs/Materials/Textures/Loaders/index" {
  54994. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  54995. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  54996. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  54997. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  54998. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  54999. }
  55000. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  55001. import { Scene } from "babylonjs/scene";
  55002. import { Texture } from "babylonjs/Materials/Textures/texture";
  55003. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55004. /**
  55005. * 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.
  55006. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  55007. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  55008. */
  55009. export class CustomProceduralTexture extends ProceduralTexture {
  55010. private _animate;
  55011. private _time;
  55012. private _config;
  55013. private _texturePath;
  55014. /**
  55015. * Instantiates a new Custom Procedural Texture.
  55016. * 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.
  55017. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  55018. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  55019. * @param name Define the name of the texture
  55020. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  55021. * @param size Define the size of the texture to create
  55022. * @param scene Define the scene the texture belongs to
  55023. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  55024. * @param generateMipMaps Define if the texture should creates mip maps or not
  55025. */
  55026. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  55027. private _loadJson;
  55028. /**
  55029. * Is the texture ready to be used ? (rendered at least once)
  55030. * @returns true if ready, otherwise, false.
  55031. */
  55032. isReady(): boolean;
  55033. /**
  55034. * Render the texture to its associated render target.
  55035. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  55036. */
  55037. render(useCameraPostProcess?: boolean): void;
  55038. /**
  55039. * Update the list of dependant textures samplers in the shader.
  55040. */
  55041. updateTextures(): void;
  55042. /**
  55043. * Update the uniform values of the procedural texture in the shader.
  55044. */
  55045. updateShaderUniforms(): void;
  55046. /**
  55047. * Define if the texture animates or not.
  55048. */
  55049. animate: boolean;
  55050. }
  55051. }
  55052. declare module "babylonjs/Shaders/noise.fragment" {
  55053. /** @hidden */
  55054. export var noisePixelShader: {
  55055. name: string;
  55056. shader: string;
  55057. };
  55058. }
  55059. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  55060. import { Nullable } from "babylonjs/types";
  55061. import { Scene } from "babylonjs/scene";
  55062. import { Texture } from "babylonjs/Materials/Textures/texture";
  55063. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55064. import "babylonjs/Shaders/noise.fragment";
  55065. /**
  55066. * Class used to generate noise procedural textures
  55067. */
  55068. export class NoiseProceduralTexture extends ProceduralTexture {
  55069. private _time;
  55070. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  55071. brightness: number;
  55072. /** Defines the number of octaves to process */
  55073. octaves: number;
  55074. /** Defines the level of persistence (0.8 by default) */
  55075. persistence: number;
  55076. /** Gets or sets animation speed factor (default is 1) */
  55077. animationSpeedFactor: number;
  55078. /**
  55079. * Creates a new NoiseProceduralTexture
  55080. * @param name defines the name fo the texture
  55081. * @param size defines the size of the texture (default is 256)
  55082. * @param scene defines the hosting scene
  55083. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  55084. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  55085. */
  55086. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  55087. private _updateShaderUniforms;
  55088. protected _getDefines(): string;
  55089. /** Generate the current state of the procedural texture */
  55090. render(useCameraPostProcess?: boolean): void;
  55091. /**
  55092. * Serializes this noise procedural texture
  55093. * @returns a serialized noise procedural texture object
  55094. */
  55095. serialize(): any;
  55096. /**
  55097. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  55098. * @param parsedTexture defines parsed texture data
  55099. * @param scene defines the current scene
  55100. * @param rootUrl defines the root URL containing noise procedural texture information
  55101. * @returns a parsed NoiseProceduralTexture
  55102. */
  55103. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  55104. }
  55105. }
  55106. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  55107. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  55108. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  55109. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55110. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  55111. }
  55112. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  55113. import { Nullable } from "babylonjs/types";
  55114. import { Scene } from "babylonjs/scene";
  55115. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  55116. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55117. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  55118. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55119. /**
  55120. * Raw cube texture where the raw buffers are passed in
  55121. */
  55122. export class RawCubeTexture extends CubeTexture {
  55123. /**
  55124. * Creates a cube texture where the raw buffers are passed in.
  55125. * @param scene defines the scene the texture is attached to
  55126. * @param data defines the array of data to use to create each face
  55127. * @param size defines the size of the textures
  55128. * @param format defines the format of the data
  55129. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  55130. * @param generateMipMaps defines if the engine should generate the mip levels
  55131. * @param invertY defines if data must be stored with Y axis inverted
  55132. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  55133. * @param compression defines the compression used (null by default)
  55134. */
  55135. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  55136. /**
  55137. * Updates the raw cube texture.
  55138. * @param data defines the data to store
  55139. * @param format defines the data format
  55140. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  55141. * @param invertY defines if data must be stored with Y axis inverted
  55142. * @param compression defines the compression used (null by default)
  55143. * @param level defines which level of the texture to update
  55144. */
  55145. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  55146. /**
  55147. * Updates a raw cube texture with RGBD encoded data.
  55148. * @param data defines the array of data [mipmap][face] to use to create each face
  55149. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  55150. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  55151. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  55152. * @returns a promsie that resolves when the operation is complete
  55153. */
  55154. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  55155. /**
  55156. * Clones the raw cube texture.
  55157. * @return a new cube texture
  55158. */
  55159. clone(): CubeTexture;
  55160. /** @hidden */
  55161. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  55162. }
  55163. }
  55164. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  55165. import { Scene } from "babylonjs/scene";
  55166. import { Texture } from "babylonjs/Materials/Textures/texture";
  55167. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55168. /**
  55169. * Class used to store 3D textures containing user data
  55170. */
  55171. export class RawTexture3D extends Texture {
  55172. /** Gets or sets the texture format to use */
  55173. format: number;
  55174. private _engine;
  55175. /**
  55176. * Create a new RawTexture3D
  55177. * @param data defines the data of the texture
  55178. * @param width defines the width of the texture
  55179. * @param height defines the height of the texture
  55180. * @param depth defines the depth of the texture
  55181. * @param format defines the texture format to use
  55182. * @param scene defines the hosting scene
  55183. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  55184. * @param invertY defines if texture must be stored with Y axis inverted
  55185. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  55186. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  55187. */
  55188. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  55189. /** Gets or sets the texture format to use */
  55190. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  55191. /**
  55192. * Update the texture with new data
  55193. * @param data defines the data to store in the texture
  55194. */
  55195. update(data: ArrayBufferView): void;
  55196. }
  55197. }
  55198. declare module "babylonjs/Materials/Textures/refractionTexture" {
  55199. import { Scene } from "babylonjs/scene";
  55200. import { Plane } from "babylonjs/Maths/math.plane";
  55201. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  55202. /**
  55203. * Creates a refraction texture used by refraction channel of the standard material.
  55204. * It is like a mirror but to see through a material.
  55205. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55206. */
  55207. export class RefractionTexture extends RenderTargetTexture {
  55208. /**
  55209. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  55210. * 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.
  55211. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55212. */
  55213. refractionPlane: Plane;
  55214. /**
  55215. * Define how deep under the surface we should see.
  55216. */
  55217. depth: number;
  55218. /**
  55219. * Creates a refraction texture used by refraction channel of the standard material.
  55220. * It is like a mirror but to see through a material.
  55221. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55222. * @param name Define the texture name
  55223. * @param size Define the size of the underlying texture
  55224. * @param scene Define the scene the refraction belongs to
  55225. * @param generateMipMaps Define if we need to generate mips level for the refraction
  55226. */
  55227. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  55228. /**
  55229. * Clone the refraction texture.
  55230. * @returns the cloned texture
  55231. */
  55232. clone(): RefractionTexture;
  55233. /**
  55234. * Serialize the texture to a JSON representation you could use in Parse later on
  55235. * @returns the serialized JSON representation
  55236. */
  55237. serialize(): any;
  55238. }
  55239. }
  55240. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  55241. import { Nullable } from "babylonjs/types";
  55242. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55243. import { Matrix } from "babylonjs/Maths/math.vector";
  55244. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  55245. import "babylonjs/Engines/Extensions/engine.videoTexture";
  55246. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  55247. import { Scene } from "babylonjs/scene";
  55248. /**
  55249. * Defines the options related to the creation of an HtmlElementTexture
  55250. */
  55251. export interface IHtmlElementTextureOptions {
  55252. /**
  55253. * Defines wether mip maps should be created or not.
  55254. */
  55255. generateMipMaps?: boolean;
  55256. /**
  55257. * Defines the sampling mode of the texture.
  55258. */
  55259. samplingMode?: number;
  55260. /**
  55261. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  55262. */
  55263. engine: Nullable<ThinEngine>;
  55264. /**
  55265. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  55266. */
  55267. scene: Nullable<Scene>;
  55268. }
  55269. /**
  55270. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  55271. * To be as efficient as possible depending on your constraints nothing aside the first upload
  55272. * is automatically managed.
  55273. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  55274. * in your application.
  55275. *
  55276. * As the update is not automatic, you need to call them manually.
  55277. */
  55278. export class HtmlElementTexture extends BaseTexture {
  55279. /**
  55280. * The texture URL.
  55281. */
  55282. element: HTMLVideoElement | HTMLCanvasElement;
  55283. private static readonly DefaultOptions;
  55284. private _textureMatrix;
  55285. private _engine;
  55286. private _isVideo;
  55287. private _generateMipMaps;
  55288. private _samplingMode;
  55289. /**
  55290. * Instantiates a HtmlElementTexture from the following parameters.
  55291. *
  55292. * @param name Defines the name of the texture
  55293. * @param element Defines the video or canvas the texture is filled with
  55294. * @param options Defines the other none mandatory texture creation options
  55295. */
  55296. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  55297. private _createInternalTexture;
  55298. /**
  55299. * Returns the texture matrix used in most of the material.
  55300. */
  55301. getTextureMatrix(): Matrix;
  55302. /**
  55303. * Updates the content of the texture.
  55304. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  55305. */
  55306. update(invertY?: Nullable<boolean>): void;
  55307. }
  55308. }
  55309. declare module "babylonjs/Materials/Textures/index" {
  55310. export * from "babylonjs/Materials/Textures/baseTexture";
  55311. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  55312. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  55313. export * from "babylonjs/Materials/Textures/cubeTexture";
  55314. export * from "babylonjs/Materials/Textures/dynamicTexture";
  55315. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  55316. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  55317. export * from "babylonjs/Materials/Textures/internalTexture";
  55318. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  55319. export * from "babylonjs/Materials/Textures/Loaders/index";
  55320. export * from "babylonjs/Materials/Textures/mirrorTexture";
  55321. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  55322. export * from "babylonjs/Materials/Textures/Procedurals/index";
  55323. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  55324. export * from "babylonjs/Materials/Textures/rawTexture";
  55325. export * from "babylonjs/Materials/Textures/rawTexture3D";
  55326. export * from "babylonjs/Materials/Textures/refractionTexture";
  55327. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  55328. export * from "babylonjs/Materials/Textures/texture";
  55329. export * from "babylonjs/Materials/Textures/videoTexture";
  55330. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  55331. }
  55332. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  55333. /**
  55334. * Enum used to define the target of a block
  55335. */
  55336. export enum NodeMaterialBlockTargets {
  55337. /** Vertex shader */
  55338. Vertex = 1,
  55339. /** Fragment shader */
  55340. Fragment = 2,
  55341. /** Neutral */
  55342. Neutral = 4,
  55343. /** Vertex and Fragment */
  55344. VertexAndFragment = 3
  55345. }
  55346. }
  55347. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  55348. /**
  55349. * Defines the kind of connection point for node based material
  55350. */
  55351. export enum NodeMaterialBlockConnectionPointTypes {
  55352. /** Float */
  55353. Float = 1,
  55354. /** Int */
  55355. Int = 2,
  55356. /** Vector2 */
  55357. Vector2 = 4,
  55358. /** Vector3 */
  55359. Vector3 = 8,
  55360. /** Vector4 */
  55361. Vector4 = 16,
  55362. /** Color3 */
  55363. Color3 = 32,
  55364. /** Color4 */
  55365. Color4 = 64,
  55366. /** Matrix */
  55367. Matrix = 128,
  55368. /** Detect type based on connection */
  55369. AutoDetect = 1024,
  55370. /** Output type that will be defined by input type */
  55371. BasedOnInput = 2048
  55372. }
  55373. }
  55374. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  55375. /**
  55376. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  55377. */
  55378. export enum NodeMaterialBlockConnectionPointMode {
  55379. /** Value is an uniform */
  55380. Uniform = 0,
  55381. /** Value is a mesh attribute */
  55382. Attribute = 1,
  55383. /** Value is a varying between vertex and fragment shaders */
  55384. Varying = 2,
  55385. /** Mode is undefined */
  55386. Undefined = 3
  55387. }
  55388. }
  55389. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  55390. /**
  55391. * Enum used to define system values e.g. values automatically provided by the system
  55392. */
  55393. export enum NodeMaterialSystemValues {
  55394. /** World */
  55395. World = 1,
  55396. /** View */
  55397. View = 2,
  55398. /** Projection */
  55399. Projection = 3,
  55400. /** ViewProjection */
  55401. ViewProjection = 4,
  55402. /** WorldView */
  55403. WorldView = 5,
  55404. /** WorldViewProjection */
  55405. WorldViewProjection = 6,
  55406. /** CameraPosition */
  55407. CameraPosition = 7,
  55408. /** Fog Color */
  55409. FogColor = 8,
  55410. /** Delta time */
  55411. DeltaTime = 9
  55412. }
  55413. }
  55414. declare module "babylonjs/Materials/Node/Enums/index" {
  55415. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  55416. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  55417. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  55418. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  55419. }
  55420. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  55421. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55422. /**
  55423. * Root class for all node material optimizers
  55424. */
  55425. export class NodeMaterialOptimizer {
  55426. /**
  55427. * Function used to optimize a NodeMaterial graph
  55428. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  55429. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  55430. */
  55431. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  55432. }
  55433. }
  55434. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  55435. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55436. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55437. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55438. import { Scene } from "babylonjs/scene";
  55439. /**
  55440. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  55441. */
  55442. export class TransformBlock extends NodeMaterialBlock {
  55443. /**
  55444. * Defines the value to use to complement W value to transform it to a Vector4
  55445. */
  55446. complementW: number;
  55447. /**
  55448. * Defines the value to use to complement z value to transform it to a Vector4
  55449. */
  55450. complementZ: number;
  55451. /**
  55452. * Creates a new TransformBlock
  55453. * @param name defines the block name
  55454. */
  55455. constructor(name: string);
  55456. /**
  55457. * Gets the current class name
  55458. * @returns the class name
  55459. */
  55460. getClassName(): string;
  55461. /**
  55462. * Gets the vector input
  55463. */
  55464. readonly vector: NodeMaterialConnectionPoint;
  55465. /**
  55466. * Gets the output component
  55467. */
  55468. readonly output: NodeMaterialConnectionPoint;
  55469. /**
  55470. * Gets the matrix transform input
  55471. */
  55472. readonly transform: NodeMaterialConnectionPoint;
  55473. protected _buildBlock(state: NodeMaterialBuildState): this;
  55474. serialize(): any;
  55475. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  55476. protected _dumpPropertiesCode(): string;
  55477. }
  55478. }
  55479. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  55480. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55481. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55482. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55483. /**
  55484. * Block used to output the vertex position
  55485. */
  55486. export class VertexOutputBlock extends NodeMaterialBlock {
  55487. /**
  55488. * Creates a new VertexOutputBlock
  55489. * @param name defines the block name
  55490. */
  55491. constructor(name: string);
  55492. /**
  55493. * Gets the current class name
  55494. * @returns the class name
  55495. */
  55496. getClassName(): string;
  55497. /**
  55498. * Gets the vector input component
  55499. */
  55500. readonly vector: NodeMaterialConnectionPoint;
  55501. protected _buildBlock(state: NodeMaterialBuildState): this;
  55502. }
  55503. }
  55504. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  55505. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55506. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55507. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55508. /**
  55509. * Block used to output the final color
  55510. */
  55511. export class FragmentOutputBlock extends NodeMaterialBlock {
  55512. /**
  55513. * Create a new FragmentOutputBlock
  55514. * @param name defines the block name
  55515. */
  55516. constructor(name: string);
  55517. /**
  55518. * Gets the current class name
  55519. * @returns the class name
  55520. */
  55521. getClassName(): string;
  55522. /**
  55523. * Gets the rgba input component
  55524. */
  55525. readonly rgba: NodeMaterialConnectionPoint;
  55526. /**
  55527. * Gets the rgb input component
  55528. */
  55529. readonly rgb: NodeMaterialConnectionPoint;
  55530. /**
  55531. * Gets the a input component
  55532. */
  55533. readonly a: NodeMaterialConnectionPoint;
  55534. protected _buildBlock(state: NodeMaterialBuildState): this;
  55535. }
  55536. }
  55537. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  55538. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55539. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55540. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55541. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55542. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55543. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  55544. import { Effect } from "babylonjs/Materials/effect";
  55545. import { Mesh } from "babylonjs/Meshes/mesh";
  55546. import { Nullable } from "babylonjs/types";
  55547. import { Scene } from "babylonjs/scene";
  55548. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  55549. /**
  55550. * Block used to read a reflection texture from a sampler
  55551. */
  55552. export class ReflectionTextureBlock extends NodeMaterialBlock {
  55553. private _define3DName;
  55554. private _defineCubicName;
  55555. private _defineExplicitName;
  55556. private _defineProjectionName;
  55557. private _defineLocalCubicName;
  55558. private _defineSphericalName;
  55559. private _definePlanarName;
  55560. private _defineEquirectangularName;
  55561. private _defineMirroredEquirectangularFixedName;
  55562. private _defineEquirectangularFixedName;
  55563. private _defineSkyboxName;
  55564. private _cubeSamplerName;
  55565. private _2DSamplerName;
  55566. private _positionUVWName;
  55567. private _directionWName;
  55568. private _reflectionCoordsName;
  55569. private _reflection2DCoordsName;
  55570. private _reflectionColorName;
  55571. private _reflectionMatrixName;
  55572. /**
  55573. * Gets or sets the texture associated with the node
  55574. */
  55575. texture: Nullable<BaseTexture>;
  55576. /**
  55577. * Create a new TextureBlock
  55578. * @param name defines the block name
  55579. */
  55580. constructor(name: string);
  55581. /**
  55582. * Gets the current class name
  55583. * @returns the class name
  55584. */
  55585. getClassName(): string;
  55586. /**
  55587. * Gets the world position input component
  55588. */
  55589. readonly position: NodeMaterialConnectionPoint;
  55590. /**
  55591. * Gets the world position input component
  55592. */
  55593. readonly worldPosition: NodeMaterialConnectionPoint;
  55594. /**
  55595. * Gets the world normal input component
  55596. */
  55597. readonly worldNormal: NodeMaterialConnectionPoint;
  55598. /**
  55599. * Gets the world input component
  55600. */
  55601. readonly world: NodeMaterialConnectionPoint;
  55602. /**
  55603. * Gets the camera (or eye) position component
  55604. */
  55605. readonly cameraPosition: NodeMaterialConnectionPoint;
  55606. /**
  55607. * Gets the view input component
  55608. */
  55609. readonly view: NodeMaterialConnectionPoint;
  55610. /**
  55611. * Gets the rgb output component
  55612. */
  55613. readonly rgb: NodeMaterialConnectionPoint;
  55614. /**
  55615. * Gets the r output component
  55616. */
  55617. readonly r: NodeMaterialConnectionPoint;
  55618. /**
  55619. * Gets the g output component
  55620. */
  55621. readonly g: NodeMaterialConnectionPoint;
  55622. /**
  55623. * Gets the b output component
  55624. */
  55625. readonly b: NodeMaterialConnectionPoint;
  55626. autoConfigure(material: NodeMaterial): void;
  55627. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  55628. isReady(): boolean;
  55629. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  55630. private _injectVertexCode;
  55631. private _writeOutput;
  55632. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  55633. protected _dumpPropertiesCode(): string;
  55634. serialize(): any;
  55635. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  55636. }
  55637. }
  55638. declare module "babylonjs/Materials/Node/nodeMaterial" {
  55639. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55640. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  55641. import { Scene } from "babylonjs/scene";
  55642. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55643. import { Matrix } from "babylonjs/Maths/math.vector";
  55644. import { Mesh } from "babylonjs/Meshes/mesh";
  55645. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55646. import { Observable } from "babylonjs/Misc/observable";
  55647. import { SubMesh } from "babylonjs/Meshes/subMesh";
  55648. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  55649. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  55650. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  55651. import { Nullable } from "babylonjs/types";
  55652. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  55653. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  55654. import { ReflectionTextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  55655. /**
  55656. * Interface used to configure the node material editor
  55657. */
  55658. export interface INodeMaterialEditorOptions {
  55659. /** Define the URl to load node editor script */
  55660. editorURL?: string;
  55661. }
  55662. /** @hidden */
  55663. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  55664. /** BONES */
  55665. NUM_BONE_INFLUENCERS: number;
  55666. BonesPerMesh: number;
  55667. BONETEXTURE: boolean;
  55668. /** MORPH TARGETS */
  55669. MORPHTARGETS: boolean;
  55670. MORPHTARGETS_NORMAL: boolean;
  55671. MORPHTARGETS_TANGENT: boolean;
  55672. MORPHTARGETS_UV: boolean;
  55673. NUM_MORPH_INFLUENCERS: number;
  55674. /** IMAGE PROCESSING */
  55675. IMAGEPROCESSING: boolean;
  55676. VIGNETTE: boolean;
  55677. VIGNETTEBLENDMODEMULTIPLY: boolean;
  55678. VIGNETTEBLENDMODEOPAQUE: boolean;
  55679. TONEMAPPING: boolean;
  55680. TONEMAPPING_ACES: boolean;
  55681. CONTRAST: boolean;
  55682. EXPOSURE: boolean;
  55683. COLORCURVES: boolean;
  55684. COLORGRADING: boolean;
  55685. COLORGRADING3D: boolean;
  55686. SAMPLER3DGREENDEPTH: boolean;
  55687. SAMPLER3DBGRMAP: boolean;
  55688. IMAGEPROCESSINGPOSTPROCESS: boolean;
  55689. /** MISC. */
  55690. BUMPDIRECTUV: number;
  55691. constructor();
  55692. setValue(name: string, value: boolean): void;
  55693. }
  55694. /**
  55695. * Class used to configure NodeMaterial
  55696. */
  55697. export interface INodeMaterialOptions {
  55698. /**
  55699. * Defines if blocks should emit comments
  55700. */
  55701. emitComments: boolean;
  55702. }
  55703. /**
  55704. * Class used to create a node based material built by assembling shader blocks
  55705. */
  55706. export class NodeMaterial extends PushMaterial {
  55707. private static _BuildIdGenerator;
  55708. private _options;
  55709. private _vertexCompilationState;
  55710. private _fragmentCompilationState;
  55711. private _sharedData;
  55712. private _buildId;
  55713. private _buildWasSuccessful;
  55714. private _cachedWorldViewMatrix;
  55715. private _cachedWorldViewProjectionMatrix;
  55716. private _optimizers;
  55717. private _animationFrame;
  55718. /** Define the URl to load node editor script */
  55719. static EditorURL: string;
  55720. private BJSNODEMATERIALEDITOR;
  55721. /** Get the inspector from bundle or global */
  55722. private _getGlobalNodeMaterialEditor;
  55723. /**
  55724. * 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)
  55725. */
  55726. ignoreAlpha: boolean;
  55727. /**
  55728. * Defines the maximum number of lights that can be used in the material
  55729. */
  55730. maxSimultaneousLights: number;
  55731. /**
  55732. * Observable raised when the material is built
  55733. */
  55734. onBuildObservable: Observable<NodeMaterial>;
  55735. /**
  55736. * Gets or sets the root nodes of the material vertex shader
  55737. */
  55738. _vertexOutputNodes: NodeMaterialBlock[];
  55739. /**
  55740. * Gets or sets the root nodes of the material fragment (pixel) shader
  55741. */
  55742. _fragmentOutputNodes: NodeMaterialBlock[];
  55743. /** Gets or sets options to control the node material overall behavior */
  55744. options: INodeMaterialOptions;
  55745. /**
  55746. * Default configuration related to image processing available in the standard Material.
  55747. */
  55748. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  55749. /**
  55750. * Gets the image processing configuration used either in this material.
  55751. */
  55752. /**
  55753. * Sets the Default image processing configuration used either in the this material.
  55754. *
  55755. * If sets to null, the scene one is in use.
  55756. */
  55757. imageProcessingConfiguration: ImageProcessingConfiguration;
  55758. /**
  55759. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  55760. */
  55761. attachedBlocks: NodeMaterialBlock[];
  55762. /**
  55763. * Create a new node based material
  55764. * @param name defines the material name
  55765. * @param scene defines the hosting scene
  55766. * @param options defines creation option
  55767. */
  55768. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  55769. /**
  55770. * Gets the current class name of the material e.g. "NodeMaterial"
  55771. * @returns the class name
  55772. */
  55773. getClassName(): string;
  55774. /**
  55775. * Keep track of the image processing observer to allow dispose and replace.
  55776. */
  55777. private _imageProcessingObserver;
  55778. /**
  55779. * Attaches a new image processing configuration to the Standard Material.
  55780. * @param configuration
  55781. */
  55782. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  55783. /**
  55784. * Get a block by its name
  55785. * @param name defines the name of the block to retrieve
  55786. * @returns the required block or null if not found
  55787. */
  55788. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  55789. /**
  55790. * Get a block by its name
  55791. * @param predicate defines the predicate used to find the good candidate
  55792. * @returns the required block or null if not found
  55793. */
  55794. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  55795. /**
  55796. * Get an input block by its name
  55797. * @param predicate defines the predicate used to find the good candidate
  55798. * @returns the required input block or null if not found
  55799. */
  55800. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  55801. /**
  55802. * Gets the list of input blocks attached to this material
  55803. * @returns an array of InputBlocks
  55804. */
  55805. getInputBlocks(): InputBlock[];
  55806. /**
  55807. * Adds a new optimizer to the list of optimizers
  55808. * @param optimizer defines the optimizers to add
  55809. * @returns the current material
  55810. */
  55811. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  55812. /**
  55813. * Remove an optimizer from the list of optimizers
  55814. * @param optimizer defines the optimizers to remove
  55815. * @returns the current material
  55816. */
  55817. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  55818. /**
  55819. * Add a new block to the list of output nodes
  55820. * @param node defines the node to add
  55821. * @returns the current material
  55822. */
  55823. addOutputNode(node: NodeMaterialBlock): this;
  55824. /**
  55825. * Remove a block from the list of root nodes
  55826. * @param node defines the node to remove
  55827. * @returns the current material
  55828. */
  55829. removeOutputNode(node: NodeMaterialBlock): this;
  55830. private _addVertexOutputNode;
  55831. private _removeVertexOutputNode;
  55832. private _addFragmentOutputNode;
  55833. private _removeFragmentOutputNode;
  55834. /**
  55835. * Specifies if the material will require alpha blending
  55836. * @returns a boolean specifying if alpha blending is needed
  55837. */
  55838. needAlphaBlending(): boolean;
  55839. /**
  55840. * Specifies if this material should be rendered in alpha test mode
  55841. * @returns a boolean specifying if an alpha test is needed.
  55842. */
  55843. needAlphaTesting(): boolean;
  55844. private _initializeBlock;
  55845. private _resetDualBlocks;
  55846. /**
  55847. * Build the material and generates the inner effect
  55848. * @param verbose defines if the build should log activity
  55849. */
  55850. build(verbose?: boolean): void;
  55851. /**
  55852. * Runs an otpimization phase to try to improve the shader code
  55853. */
  55854. optimize(): void;
  55855. private _prepareDefinesForAttributes;
  55856. /**
  55857. * Get if the submesh is ready to be used and all its information available.
  55858. * Child classes can use it to update shaders
  55859. * @param mesh defines the mesh to check
  55860. * @param subMesh defines which submesh to check
  55861. * @param useInstances specifies that instances should be used
  55862. * @returns a boolean indicating that the submesh is ready or not
  55863. */
  55864. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  55865. /**
  55866. * Get a string representing the shaders built by the current node graph
  55867. */
  55868. readonly compiledShaders: string;
  55869. /**
  55870. * Binds the world matrix to the material
  55871. * @param world defines the world transformation matrix
  55872. */
  55873. bindOnlyWorldMatrix(world: Matrix): void;
  55874. /**
  55875. * Binds the submesh to this material by preparing the effect and shader to draw
  55876. * @param world defines the world transformation matrix
  55877. * @param mesh defines the mesh containing the submesh
  55878. * @param subMesh defines the submesh to bind the material to
  55879. */
  55880. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  55881. /**
  55882. * Gets the active textures from the material
  55883. * @returns an array of textures
  55884. */
  55885. getActiveTextures(): BaseTexture[];
  55886. /**
  55887. * Gets the list of texture blocks
  55888. * @returns an array of texture blocks
  55889. */
  55890. getTextureBlocks(): (TextureBlock | ReflectionTextureBlock)[];
  55891. /**
  55892. * Specifies if the material uses a texture
  55893. * @param texture defines the texture to check against the material
  55894. * @returns a boolean specifying if the material uses the texture
  55895. */
  55896. hasTexture(texture: BaseTexture): boolean;
  55897. /**
  55898. * Disposes the material
  55899. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  55900. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  55901. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  55902. */
  55903. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  55904. /** Creates the node editor window. */
  55905. private _createNodeEditor;
  55906. /**
  55907. * Launch the node material editor
  55908. * @param config Define the configuration of the editor
  55909. * @return a promise fulfilled when the node editor is visible
  55910. */
  55911. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  55912. /**
  55913. * Clear the current material
  55914. */
  55915. clear(): void;
  55916. /**
  55917. * Clear the current material and set it to a default state
  55918. */
  55919. setToDefault(): void;
  55920. /**
  55921. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  55922. * @param url defines the url to load from
  55923. * @returns a promise that will fullfil when the material is fully loaded
  55924. */
  55925. loadAsync(url: string): Promise<void>;
  55926. private _gatherBlocks;
  55927. /**
  55928. * Generate a string containing the code declaration required to create an equivalent of this material
  55929. * @returns a string
  55930. */
  55931. generateCode(): string;
  55932. /**
  55933. * Serializes this material in a JSON representation
  55934. * @returns the serialized material object
  55935. */
  55936. serialize(): any;
  55937. private _restoreConnections;
  55938. /**
  55939. * Clear the current graph and load a new one from a serialization object
  55940. * @param source defines the JSON representation of the material
  55941. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  55942. */
  55943. loadFromSerialization(source: any, rootUrl?: string): void;
  55944. /**
  55945. * Creates a node material from parsed material data
  55946. * @param source defines the JSON representation of the material
  55947. * @param scene defines the hosting scene
  55948. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  55949. * @returns a new node material
  55950. */
  55951. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  55952. /**
  55953. * Creates a new node material set to default basic configuration
  55954. * @param name defines the name of the material
  55955. * @param scene defines the hosting scene
  55956. * @returns a new NodeMaterial
  55957. */
  55958. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  55959. }
  55960. }
  55961. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  55962. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55963. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55964. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  55965. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55966. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55967. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  55968. import { Effect } from "babylonjs/Materials/effect";
  55969. import { Mesh } from "babylonjs/Meshes/mesh";
  55970. import { Nullable } from "babylonjs/types";
  55971. import { Texture } from "babylonjs/Materials/Textures/texture";
  55972. import { Scene } from "babylonjs/scene";
  55973. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  55974. /**
  55975. * Block used to read a texture from a sampler
  55976. */
  55977. export class TextureBlock extends NodeMaterialBlock {
  55978. private _defineName;
  55979. private _linearDefineName;
  55980. private _samplerName;
  55981. private _transformedUVName;
  55982. private _textureTransformName;
  55983. private _textureInfoName;
  55984. private _mainUVName;
  55985. private _mainUVDefineName;
  55986. /**
  55987. * Gets or sets the texture associated with the node
  55988. */
  55989. texture: Nullable<Texture>;
  55990. /**
  55991. * Create a new TextureBlock
  55992. * @param name defines the block name
  55993. */
  55994. constructor(name: string);
  55995. /**
  55996. * Gets the current class name
  55997. * @returns the class name
  55998. */
  55999. getClassName(): string;
  56000. /**
  56001. * Gets the uv input component
  56002. */
  56003. readonly uv: NodeMaterialConnectionPoint;
  56004. /**
  56005. * Gets the rgba output component
  56006. */
  56007. readonly rgba: NodeMaterialConnectionPoint;
  56008. /**
  56009. * Gets the rgb output component
  56010. */
  56011. readonly rgb: NodeMaterialConnectionPoint;
  56012. /**
  56013. * Gets the r output component
  56014. */
  56015. readonly r: NodeMaterialConnectionPoint;
  56016. /**
  56017. * Gets the g output component
  56018. */
  56019. readonly g: NodeMaterialConnectionPoint;
  56020. /**
  56021. * Gets the b output component
  56022. */
  56023. readonly b: NodeMaterialConnectionPoint;
  56024. /**
  56025. * Gets the a output component
  56026. */
  56027. readonly a: NodeMaterialConnectionPoint;
  56028. readonly target: NodeMaterialBlockTargets;
  56029. autoConfigure(material: NodeMaterial): void;
  56030. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56031. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56032. isReady(): boolean;
  56033. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56034. private readonly _isMixed;
  56035. private _injectVertexCode;
  56036. private _writeOutput;
  56037. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  56038. protected _dumpPropertiesCode(): string;
  56039. serialize(): any;
  56040. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56041. }
  56042. }
  56043. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  56044. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56045. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56046. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  56047. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  56048. import { ReflectionTextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  56049. import { Scene } from "babylonjs/scene";
  56050. /**
  56051. * Class used to store shared data between 2 NodeMaterialBuildState
  56052. */
  56053. export class NodeMaterialBuildStateSharedData {
  56054. /**
  56055. * Gets the list of emitted varyings
  56056. */
  56057. temps: string[];
  56058. /**
  56059. * Gets the list of emitted varyings
  56060. */
  56061. varyings: string[];
  56062. /**
  56063. * Gets the varying declaration string
  56064. */
  56065. varyingDeclaration: string;
  56066. /**
  56067. * Input blocks
  56068. */
  56069. inputBlocks: InputBlock[];
  56070. /**
  56071. * Input blocks
  56072. */
  56073. textureBlocks: (ReflectionTextureBlock | TextureBlock)[];
  56074. /**
  56075. * Bindable blocks (Blocks that need to set data to the effect)
  56076. */
  56077. bindableBlocks: NodeMaterialBlock[];
  56078. /**
  56079. * List of blocks that can provide a compilation fallback
  56080. */
  56081. blocksWithFallbacks: NodeMaterialBlock[];
  56082. /**
  56083. * List of blocks that can provide a define update
  56084. */
  56085. blocksWithDefines: NodeMaterialBlock[];
  56086. /**
  56087. * List of blocks that can provide a repeatable content
  56088. */
  56089. repeatableContentBlocks: NodeMaterialBlock[];
  56090. /**
  56091. * List of blocks that can provide a dynamic list of uniforms
  56092. */
  56093. dynamicUniformBlocks: NodeMaterialBlock[];
  56094. /**
  56095. * List of blocks that can block the isReady function for the material
  56096. */
  56097. blockingBlocks: NodeMaterialBlock[];
  56098. /**
  56099. * Gets the list of animated inputs
  56100. */
  56101. animatedInputs: InputBlock[];
  56102. /**
  56103. * Build Id used to avoid multiple recompilations
  56104. */
  56105. buildId: number;
  56106. /** List of emitted variables */
  56107. variableNames: {
  56108. [key: string]: number;
  56109. };
  56110. /** List of emitted defines */
  56111. defineNames: {
  56112. [key: string]: number;
  56113. };
  56114. /** Should emit comments? */
  56115. emitComments: boolean;
  56116. /** Emit build activity */
  56117. verbose: boolean;
  56118. /** Gets or sets the hosting scene */
  56119. scene: Scene;
  56120. /**
  56121. * Gets the compilation hints emitted at compilation time
  56122. */
  56123. hints: {
  56124. needWorldViewMatrix: boolean;
  56125. needWorldViewProjectionMatrix: boolean;
  56126. needAlphaBlending: boolean;
  56127. needAlphaTesting: boolean;
  56128. };
  56129. /**
  56130. * List of compilation checks
  56131. */
  56132. checks: {
  56133. emitVertex: boolean;
  56134. emitFragment: boolean;
  56135. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  56136. };
  56137. /** Creates a new shared data */
  56138. constructor();
  56139. /**
  56140. * Emits console errors and exceptions if there is a failing check
  56141. */
  56142. emitErrors(): void;
  56143. }
  56144. }
  56145. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  56146. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56147. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56148. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  56149. /**
  56150. * Class used to store node based material build state
  56151. */
  56152. export class NodeMaterialBuildState {
  56153. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  56154. supportUniformBuffers: boolean;
  56155. /**
  56156. * Gets the list of emitted attributes
  56157. */
  56158. attributes: string[];
  56159. /**
  56160. * Gets the list of emitted uniforms
  56161. */
  56162. uniforms: string[];
  56163. /**
  56164. * Gets the list of emitted constants
  56165. */
  56166. constants: string[];
  56167. /**
  56168. * Gets the list of emitted samplers
  56169. */
  56170. samplers: string[];
  56171. /**
  56172. * Gets the list of emitted functions
  56173. */
  56174. functions: {
  56175. [key: string]: string;
  56176. };
  56177. /**
  56178. * Gets the list of emitted extensions
  56179. */
  56180. extensions: {
  56181. [key: string]: string;
  56182. };
  56183. /**
  56184. * Gets the target of the compilation state
  56185. */
  56186. target: NodeMaterialBlockTargets;
  56187. /**
  56188. * Gets the list of emitted counters
  56189. */
  56190. counters: {
  56191. [key: string]: number;
  56192. };
  56193. /**
  56194. * Shared data between multiple NodeMaterialBuildState instances
  56195. */
  56196. sharedData: NodeMaterialBuildStateSharedData;
  56197. /** @hidden */
  56198. _vertexState: NodeMaterialBuildState;
  56199. /** @hidden */
  56200. _attributeDeclaration: string;
  56201. /** @hidden */
  56202. _uniformDeclaration: string;
  56203. /** @hidden */
  56204. _constantDeclaration: string;
  56205. /** @hidden */
  56206. _samplerDeclaration: string;
  56207. /** @hidden */
  56208. _varyingTransfer: string;
  56209. private _repeatableContentAnchorIndex;
  56210. /** @hidden */
  56211. _builtCompilationString: string;
  56212. /**
  56213. * Gets the emitted compilation strings
  56214. */
  56215. compilationString: string;
  56216. /**
  56217. * Finalize the compilation strings
  56218. * @param state defines the current compilation state
  56219. */
  56220. finalize(state: NodeMaterialBuildState): void;
  56221. /** @hidden */
  56222. readonly _repeatableContentAnchor: string;
  56223. /** @hidden */
  56224. _getFreeVariableName(prefix: string): string;
  56225. /** @hidden */
  56226. _getFreeDefineName(prefix: string): string;
  56227. /** @hidden */
  56228. _excludeVariableName(name: string): void;
  56229. /** @hidden */
  56230. _emit2DSampler(name: string): void;
  56231. /** @hidden */
  56232. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  56233. /** @hidden */
  56234. _emitExtension(name: string, extension: string): void;
  56235. /** @hidden */
  56236. _emitFunction(name: string, code: string, comments: string): void;
  56237. /** @hidden */
  56238. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  56239. replaceStrings?: {
  56240. search: RegExp;
  56241. replace: string;
  56242. }[];
  56243. repeatKey?: string;
  56244. }): string;
  56245. /** @hidden */
  56246. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  56247. repeatKey?: string;
  56248. removeAttributes?: boolean;
  56249. removeUniforms?: boolean;
  56250. removeVaryings?: boolean;
  56251. removeIfDef?: boolean;
  56252. replaceStrings?: {
  56253. search: RegExp;
  56254. replace: string;
  56255. }[];
  56256. }, storeKey?: string): void;
  56257. /** @hidden */
  56258. _registerTempVariable(name: string): boolean;
  56259. /** @hidden */
  56260. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  56261. /** @hidden */
  56262. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  56263. /** @hidden */
  56264. _emitFloat(value: number): string;
  56265. }
  56266. }
  56267. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  56268. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56269. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56270. import { Nullable } from "babylonjs/types";
  56271. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56272. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56273. import { Effect } from "babylonjs/Materials/effect";
  56274. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56275. import { Mesh } from "babylonjs/Meshes/mesh";
  56276. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56277. import { Scene } from "babylonjs/scene";
  56278. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  56279. /**
  56280. * Defines a block that can be used inside a node based material
  56281. */
  56282. export class NodeMaterialBlock {
  56283. private _buildId;
  56284. private _buildTarget;
  56285. private _target;
  56286. private _isFinalMerger;
  56287. private _isInput;
  56288. /** @hidden */
  56289. _codeVariableName: string;
  56290. /** @hidden */
  56291. _inputs: NodeMaterialConnectionPoint[];
  56292. /** @hidden */
  56293. _outputs: NodeMaterialConnectionPoint[];
  56294. /** @hidden */
  56295. _preparationId: number;
  56296. /**
  56297. * Gets or sets the name of the block
  56298. */
  56299. name: string;
  56300. /**
  56301. * Gets or sets the unique id of the node
  56302. */
  56303. uniqueId: number;
  56304. /**
  56305. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  56306. */
  56307. readonly isFinalMerger: boolean;
  56308. /**
  56309. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  56310. */
  56311. readonly isInput: boolean;
  56312. /**
  56313. * Gets or sets the build Id
  56314. */
  56315. buildId: number;
  56316. /**
  56317. * Gets or sets the target of the block
  56318. */
  56319. target: NodeMaterialBlockTargets;
  56320. /**
  56321. * Gets the list of input points
  56322. */
  56323. readonly inputs: NodeMaterialConnectionPoint[];
  56324. /** Gets the list of output points */
  56325. readonly outputs: NodeMaterialConnectionPoint[];
  56326. /**
  56327. * Find an input by its name
  56328. * @param name defines the name of the input to look for
  56329. * @returns the input or null if not found
  56330. */
  56331. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  56332. /**
  56333. * Find an output by its name
  56334. * @param name defines the name of the outputto look for
  56335. * @returns the output or null if not found
  56336. */
  56337. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  56338. /**
  56339. * Creates a new NodeMaterialBlock
  56340. * @param name defines the block name
  56341. * @param target defines the target of that block (Vertex by default)
  56342. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  56343. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  56344. */
  56345. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  56346. /**
  56347. * Initialize the block and prepare the context for build
  56348. * @param state defines the state that will be used for the build
  56349. */
  56350. initialize(state: NodeMaterialBuildState): void;
  56351. /**
  56352. * Bind data to effect. Will only be called for blocks with isBindable === true
  56353. * @param effect defines the effect to bind data to
  56354. * @param nodeMaterial defines the hosting NodeMaterial
  56355. * @param mesh defines the mesh that will be rendered
  56356. */
  56357. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56358. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  56359. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  56360. protected _writeFloat(value: number): string;
  56361. /**
  56362. * Gets the current class name e.g. "NodeMaterialBlock"
  56363. * @returns the class name
  56364. */
  56365. getClassName(): string;
  56366. /**
  56367. * Register a new input. Must be called inside a block constructor
  56368. * @param name defines the connection point name
  56369. * @param type defines the connection point type
  56370. * @param isOptional defines a boolean indicating that this input can be omitted
  56371. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  56372. * @returns the current block
  56373. */
  56374. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets): this;
  56375. /**
  56376. * Register a new output. Must be called inside a block constructor
  56377. * @param name defines the connection point name
  56378. * @param type defines the connection point type
  56379. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  56380. * @returns the current block
  56381. */
  56382. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets): this;
  56383. /**
  56384. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  56385. * @param forOutput defines an optional connection point to check compatibility with
  56386. * @returns the first available input or null
  56387. */
  56388. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  56389. /**
  56390. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  56391. * @param forBlock defines an optional block to check compatibility with
  56392. * @returns the first available input or null
  56393. */
  56394. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  56395. /**
  56396. * Gets the sibling of the given output
  56397. * @param current defines the current output
  56398. * @returns the next output in the list or null
  56399. */
  56400. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  56401. /**
  56402. * Connect current block with another block
  56403. * @param other defines the block to connect with
  56404. * @param options define the various options to help pick the right connections
  56405. * @returns the current block
  56406. */
  56407. connectTo(other: NodeMaterialBlock, options?: {
  56408. input?: string;
  56409. output?: string;
  56410. outputSwizzle?: string;
  56411. }): this | undefined;
  56412. protected _buildBlock(state: NodeMaterialBuildState): void;
  56413. /**
  56414. * Add uniforms, samplers and uniform buffers at compilation time
  56415. * @param state defines the state to update
  56416. * @param nodeMaterial defines the node material requesting the update
  56417. * @param defines defines the material defines to update
  56418. * @param uniformBuffers defines the list of uniform buffer names
  56419. */
  56420. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  56421. /**
  56422. * Add potential fallbacks if shader compilation fails
  56423. * @param mesh defines the mesh to be rendered
  56424. * @param fallbacks defines the current prioritized list of fallbacks
  56425. */
  56426. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  56427. /**
  56428. * Initialize defines for shader compilation
  56429. * @param mesh defines the mesh to be rendered
  56430. * @param nodeMaterial defines the node material requesting the update
  56431. * @param defines defines the material defines to update
  56432. * @param useInstances specifies that instances should be used
  56433. */
  56434. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56435. /**
  56436. * Update defines for shader compilation
  56437. * @param mesh defines the mesh to be rendered
  56438. * @param nodeMaterial defines the node material requesting the update
  56439. * @param defines defines the material defines to update
  56440. * @param useInstances specifies that instances should be used
  56441. */
  56442. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56443. /**
  56444. * Lets the block try to connect some inputs automatically
  56445. * @param material defines the hosting NodeMaterial
  56446. */
  56447. autoConfigure(material: NodeMaterial): void;
  56448. /**
  56449. * Function called when a block is declared as repeatable content generator
  56450. * @param vertexShaderState defines the current compilation state for the vertex shader
  56451. * @param fragmentShaderState defines the current compilation state for the fragment shader
  56452. * @param mesh defines the mesh to be rendered
  56453. * @param defines defines the material defines to update
  56454. */
  56455. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  56456. /**
  56457. * Checks if the block is ready
  56458. * @param mesh defines the mesh to be rendered
  56459. * @param nodeMaterial defines the node material requesting the update
  56460. * @param defines defines the material defines to update
  56461. * @param useInstances specifies that instances should be used
  56462. * @returns true if the block is ready
  56463. */
  56464. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  56465. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  56466. private _processBuild;
  56467. /**
  56468. * Compile the current node and generate the shader code
  56469. * @param state defines the current compilation state (uniforms, samplers, current string)
  56470. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  56471. * @returns true if already built
  56472. */
  56473. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  56474. protected _inputRename(name: string): string;
  56475. protected _outputRename(name: string): string;
  56476. protected _dumpPropertiesCode(): string;
  56477. /** @hidden */
  56478. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  56479. /**
  56480. * Clone the current block to a new identical block
  56481. * @param scene defines the hosting scene
  56482. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  56483. * @returns a copy of the current block
  56484. */
  56485. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  56486. /**
  56487. * Serializes this block in a JSON representation
  56488. * @returns the serialized block object
  56489. */
  56490. serialize(): any;
  56491. /** @hidden */
  56492. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56493. /**
  56494. * Release resources
  56495. */
  56496. dispose(): void;
  56497. }
  56498. }
  56499. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  56500. /**
  56501. * Enum defining the type of animations supported by InputBlock
  56502. */
  56503. export enum AnimatedInputBlockTypes {
  56504. /** No animation */
  56505. None = 0,
  56506. /** Time based animation. Will only work for floats */
  56507. Time = 1
  56508. }
  56509. }
  56510. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  56511. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56512. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56513. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  56514. import { Nullable } from "babylonjs/types";
  56515. import { Effect } from "babylonjs/Materials/effect";
  56516. import { Matrix } from "babylonjs/Maths/math.vector";
  56517. import { Scene } from "babylonjs/scene";
  56518. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56519. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56520. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56521. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  56522. /**
  56523. * Block used to expose an input value
  56524. */
  56525. export class InputBlock extends NodeMaterialBlock {
  56526. private _mode;
  56527. private _associatedVariableName;
  56528. private _storedValue;
  56529. private _valueCallback;
  56530. private _type;
  56531. private _animationType;
  56532. /** Gets or set a value used to limit the range of float values */
  56533. min: number;
  56534. /** Gets or set a value used to limit the range of float values */
  56535. max: number;
  56536. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  56537. matrixMode: number;
  56538. /** @hidden */
  56539. _systemValue: Nullable<NodeMaterialSystemValues>;
  56540. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  56541. visibleInInspector: boolean;
  56542. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  56543. isConstant: boolean;
  56544. /**
  56545. * Gets or sets the connection point type (default is float)
  56546. */
  56547. readonly type: NodeMaterialBlockConnectionPointTypes;
  56548. /**
  56549. * Creates a new InputBlock
  56550. * @param name defines the block name
  56551. * @param target defines the target of that block (Vertex by default)
  56552. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  56553. */
  56554. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  56555. /**
  56556. * Gets the output component
  56557. */
  56558. readonly output: NodeMaterialConnectionPoint;
  56559. /**
  56560. * Set the source of this connection point to a vertex attribute
  56561. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  56562. * @returns the current connection point
  56563. */
  56564. setAsAttribute(attributeName?: string): InputBlock;
  56565. /**
  56566. * Set the source of this connection point to a system value
  56567. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  56568. * @returns the current connection point
  56569. */
  56570. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  56571. /**
  56572. * Gets or sets the value of that point.
  56573. * Please note that this value will be ignored if valueCallback is defined
  56574. */
  56575. value: any;
  56576. /**
  56577. * Gets or sets a callback used to get the value of that point.
  56578. * Please note that setting this value will force the connection point to ignore the value property
  56579. */
  56580. valueCallback: () => any;
  56581. /**
  56582. * Gets or sets the associated variable name in the shader
  56583. */
  56584. associatedVariableName: string;
  56585. /** Gets or sets the type of animation applied to the input */
  56586. animationType: AnimatedInputBlockTypes;
  56587. /**
  56588. * Gets a boolean indicating that this connection point not defined yet
  56589. */
  56590. readonly isUndefined: boolean;
  56591. /**
  56592. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  56593. * In this case the connection point name must be the name of the uniform to use.
  56594. * Can only be set on inputs
  56595. */
  56596. isUniform: boolean;
  56597. /**
  56598. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  56599. * In this case the connection point name must be the name of the attribute to use
  56600. * Can only be set on inputs
  56601. */
  56602. isAttribute: boolean;
  56603. /**
  56604. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  56605. * Can only be set on exit points
  56606. */
  56607. isVarying: boolean;
  56608. /**
  56609. * Gets a boolean indicating that the current connection point is a system value
  56610. */
  56611. readonly isSystemValue: boolean;
  56612. /**
  56613. * Gets or sets the current well known value or null if not defined as a system value
  56614. */
  56615. systemValue: Nullable<NodeMaterialSystemValues>;
  56616. /**
  56617. * Gets the current class name
  56618. * @returns the class name
  56619. */
  56620. getClassName(): string;
  56621. /**
  56622. * Animate the input if animationType !== None
  56623. * @param scene defines the rendering scene
  56624. */
  56625. animate(scene: Scene): void;
  56626. private _emitDefine;
  56627. initialize(state: NodeMaterialBuildState): void;
  56628. /**
  56629. * Set the input block to its default value (based on its type)
  56630. */
  56631. setDefaultValue(): void;
  56632. private _emitConstant;
  56633. private _emit;
  56634. /** @hidden */
  56635. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  56636. /** @hidden */
  56637. _transmit(effect: Effect, scene: Scene): void;
  56638. protected _buildBlock(state: NodeMaterialBuildState): void;
  56639. protected _dumpPropertiesCode(): string;
  56640. serialize(): any;
  56641. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56642. }
  56643. }
  56644. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  56645. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56646. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56647. import { Nullable } from "babylonjs/types";
  56648. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  56649. import { Observable } from "babylonjs/Misc/observable";
  56650. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56651. /**
  56652. * Defines a connection point for a block
  56653. */
  56654. export class NodeMaterialConnectionPoint {
  56655. /** @hidden */
  56656. _ownerBlock: NodeMaterialBlock;
  56657. /** @hidden */
  56658. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  56659. private _endpoints;
  56660. private _associatedVariableName;
  56661. /** @hidden */
  56662. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  56663. /** @hidden */
  56664. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  56665. private _type;
  56666. /** @hidden */
  56667. _enforceAssociatedVariableName: boolean;
  56668. /**
  56669. * Gets or sets the additional types supported by this connection point
  56670. */
  56671. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  56672. /**
  56673. * Gets or sets the additional types excluded by this connection point
  56674. */
  56675. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  56676. /**
  56677. * Observable triggered when this point is connected
  56678. */
  56679. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  56680. /**
  56681. * Gets or sets the associated variable name in the shader
  56682. */
  56683. associatedVariableName: string;
  56684. /**
  56685. * Gets or sets the connection point type (default is float)
  56686. */
  56687. type: NodeMaterialBlockConnectionPointTypes;
  56688. /**
  56689. * Gets or sets the connection point name
  56690. */
  56691. name: string;
  56692. /**
  56693. * Gets or sets a boolean indicating that this connection point can be omitted
  56694. */
  56695. isOptional: boolean;
  56696. /**
  56697. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  56698. */
  56699. define: string;
  56700. /** @hidden */
  56701. _prioritizeVertex: boolean;
  56702. private _target;
  56703. /** Gets or sets the target of that connection point */
  56704. target: NodeMaterialBlockTargets;
  56705. /**
  56706. * Gets a boolean indicating that the current point is connected
  56707. */
  56708. readonly isConnected: boolean;
  56709. /**
  56710. * Gets a boolean indicating that the current point is connected to an input block
  56711. */
  56712. readonly isConnectedToInputBlock: boolean;
  56713. /**
  56714. * Gets a the connected input block (if any)
  56715. */
  56716. readonly connectInputBlock: Nullable<InputBlock>;
  56717. /** Get the other side of the connection (if any) */
  56718. readonly connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  56719. /** Get the block that owns this connection point */
  56720. readonly ownerBlock: NodeMaterialBlock;
  56721. /** Get the block connected on the other side of this connection (if any) */
  56722. readonly sourceBlock: Nullable<NodeMaterialBlock>;
  56723. /** Get the block connected on the endpoints of this connection (if any) */
  56724. readonly connectedBlocks: Array<NodeMaterialBlock>;
  56725. /** Gets the list of connected endpoints */
  56726. readonly endpoints: NodeMaterialConnectionPoint[];
  56727. /** Gets a boolean indicating if that output point is connected to at least one input */
  56728. readonly hasEndpoints: boolean;
  56729. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  56730. readonly isConnectedInVertexShader: boolean;
  56731. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  56732. readonly isConnectedInFragmentShader: boolean;
  56733. /**
  56734. * Creates a new connection point
  56735. * @param name defines the connection point name
  56736. * @param ownerBlock defines the block hosting this connection point
  56737. */
  56738. constructor(name: string, ownerBlock: NodeMaterialBlock);
  56739. /**
  56740. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  56741. * @returns the class name
  56742. */
  56743. getClassName(): string;
  56744. /**
  56745. * Gets an boolean indicating if the current point can be connected to another point
  56746. * @param connectionPoint defines the other connection point
  56747. * @returns true if the connection is possible
  56748. */
  56749. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  56750. /**
  56751. * Connect this point to another connection point
  56752. * @param connectionPoint defines the other connection point
  56753. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  56754. * @returns the current connection point
  56755. */
  56756. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  56757. /**
  56758. * Disconnect this point from one of his endpoint
  56759. * @param endpoint defines the other connection point
  56760. * @returns the current connection point
  56761. */
  56762. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  56763. /**
  56764. * Serializes this point in a JSON representation
  56765. * @returns the serialized point object
  56766. */
  56767. serialize(): any;
  56768. /**
  56769. * Release resources
  56770. */
  56771. dispose(): void;
  56772. }
  56773. }
  56774. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  56775. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56776. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56777. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56778. import { Mesh } from "babylonjs/Meshes/mesh";
  56779. import { Effect } from "babylonjs/Materials/effect";
  56780. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56781. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56782. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  56783. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  56784. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  56785. /**
  56786. * Block used to add support for vertex skinning (bones)
  56787. */
  56788. export class BonesBlock extends NodeMaterialBlock {
  56789. /**
  56790. * Creates a new BonesBlock
  56791. * @param name defines the block name
  56792. */
  56793. constructor(name: string);
  56794. /**
  56795. * Initialize the block and prepare the context for build
  56796. * @param state defines the state that will be used for the build
  56797. */
  56798. initialize(state: NodeMaterialBuildState): void;
  56799. /**
  56800. * Gets the current class name
  56801. * @returns the class name
  56802. */
  56803. getClassName(): string;
  56804. /**
  56805. * Gets the matrix indices input component
  56806. */
  56807. readonly matricesIndices: NodeMaterialConnectionPoint;
  56808. /**
  56809. * Gets the matrix weights input component
  56810. */
  56811. readonly matricesWeights: NodeMaterialConnectionPoint;
  56812. /**
  56813. * Gets the extra matrix indices input component
  56814. */
  56815. readonly matricesIndicesExtra: NodeMaterialConnectionPoint;
  56816. /**
  56817. * Gets the extra matrix weights input component
  56818. */
  56819. readonly matricesWeightsExtra: NodeMaterialConnectionPoint;
  56820. /**
  56821. * Gets the world input component
  56822. */
  56823. readonly world: NodeMaterialConnectionPoint;
  56824. /**
  56825. * Gets the output component
  56826. */
  56827. readonly output: NodeMaterialConnectionPoint;
  56828. autoConfigure(material: NodeMaterial): void;
  56829. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  56830. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56831. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56832. protected _buildBlock(state: NodeMaterialBuildState): this;
  56833. }
  56834. }
  56835. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  56836. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56837. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56838. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56839. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56840. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56841. /**
  56842. * Block used to add support for instances
  56843. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  56844. */
  56845. export class InstancesBlock extends NodeMaterialBlock {
  56846. /**
  56847. * Creates a new InstancesBlock
  56848. * @param name defines the block name
  56849. */
  56850. constructor(name: string);
  56851. /**
  56852. * Gets the current class name
  56853. * @returns the class name
  56854. */
  56855. getClassName(): string;
  56856. /**
  56857. * Gets the first world row input component
  56858. */
  56859. readonly world0: NodeMaterialConnectionPoint;
  56860. /**
  56861. * Gets the second world row input component
  56862. */
  56863. readonly world1: NodeMaterialConnectionPoint;
  56864. /**
  56865. * Gets the third world row input component
  56866. */
  56867. readonly world2: NodeMaterialConnectionPoint;
  56868. /**
  56869. * Gets the forth world row input component
  56870. */
  56871. readonly world3: NodeMaterialConnectionPoint;
  56872. /**
  56873. * Gets the world input component
  56874. */
  56875. readonly world: NodeMaterialConnectionPoint;
  56876. /**
  56877. * Gets the output component
  56878. */
  56879. readonly output: NodeMaterialConnectionPoint;
  56880. autoConfigure(material: NodeMaterial): void;
  56881. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56882. protected _buildBlock(state: NodeMaterialBuildState): this;
  56883. }
  56884. }
  56885. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  56886. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56887. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56888. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56889. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56890. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56891. import { Effect } from "babylonjs/Materials/effect";
  56892. import { Mesh } from "babylonjs/Meshes/mesh";
  56893. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  56894. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  56895. /**
  56896. * Block used to add morph targets support to vertex shader
  56897. */
  56898. export class MorphTargetsBlock extends NodeMaterialBlock {
  56899. private _repeatableContentAnchor;
  56900. private _repeatebleContentGenerated;
  56901. /**
  56902. * Create a new MorphTargetsBlock
  56903. * @param name defines the block name
  56904. */
  56905. constructor(name: string);
  56906. /**
  56907. * Gets the current class name
  56908. * @returns the class name
  56909. */
  56910. getClassName(): string;
  56911. /**
  56912. * Gets the position input component
  56913. */
  56914. readonly position: NodeMaterialConnectionPoint;
  56915. /**
  56916. * Gets the normal input component
  56917. */
  56918. readonly normal: NodeMaterialConnectionPoint;
  56919. /**
  56920. * Gets the tangent input component
  56921. */
  56922. readonly tangent: NodeMaterialConnectionPoint;
  56923. /**
  56924. * Gets the tangent input component
  56925. */
  56926. readonly uv: NodeMaterialConnectionPoint;
  56927. /**
  56928. * Gets the position output component
  56929. */
  56930. readonly positionOutput: NodeMaterialConnectionPoint;
  56931. /**
  56932. * Gets the normal output component
  56933. */
  56934. readonly normalOutput: NodeMaterialConnectionPoint;
  56935. /**
  56936. * Gets the tangent output component
  56937. */
  56938. readonly tangentOutput: NodeMaterialConnectionPoint;
  56939. /**
  56940. * Gets the tangent output component
  56941. */
  56942. readonly uvOutput: NodeMaterialConnectionPoint;
  56943. initialize(state: NodeMaterialBuildState): void;
  56944. autoConfigure(material: NodeMaterial): void;
  56945. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56946. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56947. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  56948. protected _buildBlock(state: NodeMaterialBuildState): this;
  56949. }
  56950. }
  56951. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  56952. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56953. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56954. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56955. import { Nullable } from "babylonjs/types";
  56956. import { Scene } from "babylonjs/scene";
  56957. import { Effect } from "babylonjs/Materials/effect";
  56958. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56959. import { Mesh } from "babylonjs/Meshes/mesh";
  56960. import { Light } from "babylonjs/Lights/light";
  56961. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56962. /**
  56963. * Block used to get data information from a light
  56964. */
  56965. export class LightInformationBlock extends NodeMaterialBlock {
  56966. private _lightDataUniformName;
  56967. private _lightColorUniformName;
  56968. private _lightTypeDefineName;
  56969. /**
  56970. * Gets or sets the light associated with this block
  56971. */
  56972. light: Nullable<Light>;
  56973. /**
  56974. * Creates a new LightInformationBlock
  56975. * @param name defines the block name
  56976. */
  56977. constructor(name: string);
  56978. /**
  56979. * Gets the current class name
  56980. * @returns the class name
  56981. */
  56982. getClassName(): string;
  56983. /**
  56984. * Gets the world position input component
  56985. */
  56986. readonly worldPosition: NodeMaterialConnectionPoint;
  56987. /**
  56988. * Gets the direction output component
  56989. */
  56990. readonly direction: NodeMaterialConnectionPoint;
  56991. /**
  56992. * Gets the direction output component
  56993. */
  56994. readonly color: NodeMaterialConnectionPoint;
  56995. /**
  56996. * Gets the direction output component
  56997. */
  56998. readonly intensity: NodeMaterialConnectionPoint;
  56999. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57000. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57001. protected _buildBlock(state: NodeMaterialBuildState): this;
  57002. serialize(): any;
  57003. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57004. }
  57005. }
  57006. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  57007. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  57008. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  57009. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  57010. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  57011. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  57012. }
  57013. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  57014. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57015. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57016. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57017. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57018. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57019. import { Effect } from "babylonjs/Materials/effect";
  57020. import { Mesh } from "babylonjs/Meshes/mesh";
  57021. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57022. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  57023. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  57024. /**
  57025. * Block used to add image processing support to fragment shader
  57026. */
  57027. export class ImageProcessingBlock extends NodeMaterialBlock {
  57028. /**
  57029. * Create a new ImageProcessingBlock
  57030. * @param name defines the block name
  57031. */
  57032. constructor(name: string);
  57033. /**
  57034. * Gets the current class name
  57035. * @returns the class name
  57036. */
  57037. getClassName(): string;
  57038. /**
  57039. * Gets the color input component
  57040. */
  57041. readonly color: NodeMaterialConnectionPoint;
  57042. /**
  57043. * Gets the output component
  57044. */
  57045. readonly output: NodeMaterialConnectionPoint;
  57046. /**
  57047. * Initialize the block and prepare the context for build
  57048. * @param state defines the state that will be used for the build
  57049. */
  57050. initialize(state: NodeMaterialBuildState): void;
  57051. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  57052. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57053. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57054. protected _buildBlock(state: NodeMaterialBuildState): this;
  57055. }
  57056. }
  57057. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  57058. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57059. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57060. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57061. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57062. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57063. import { Effect } from "babylonjs/Materials/effect";
  57064. import { Mesh } from "babylonjs/Meshes/mesh";
  57065. import { Scene } from "babylonjs/scene";
  57066. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  57067. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  57068. /**
  57069. * Block used to pertub normals based on a normal map
  57070. */
  57071. export class PerturbNormalBlock extends NodeMaterialBlock {
  57072. private _tangentSpaceParameterName;
  57073. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  57074. invertX: boolean;
  57075. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  57076. invertY: boolean;
  57077. /**
  57078. * Create a new PerturbNormalBlock
  57079. * @param name defines the block name
  57080. */
  57081. constructor(name: string);
  57082. /**
  57083. * Gets the current class name
  57084. * @returns the class name
  57085. */
  57086. getClassName(): string;
  57087. /**
  57088. * Gets the world position input component
  57089. */
  57090. readonly worldPosition: NodeMaterialConnectionPoint;
  57091. /**
  57092. * Gets the world normal input component
  57093. */
  57094. readonly worldNormal: NodeMaterialConnectionPoint;
  57095. /**
  57096. * Gets the uv input component
  57097. */
  57098. readonly uv: NodeMaterialConnectionPoint;
  57099. /**
  57100. * Gets the normal map color input component
  57101. */
  57102. readonly normalMapColor: NodeMaterialConnectionPoint;
  57103. /**
  57104. * Gets the strength input component
  57105. */
  57106. readonly strength: NodeMaterialConnectionPoint;
  57107. /**
  57108. * Gets the output component
  57109. */
  57110. readonly output: NodeMaterialConnectionPoint;
  57111. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57112. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57113. autoConfigure(material: NodeMaterial): void;
  57114. protected _buildBlock(state: NodeMaterialBuildState): this;
  57115. protected _dumpPropertiesCode(): string;
  57116. serialize(): any;
  57117. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57118. }
  57119. }
  57120. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  57121. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57122. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57123. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57124. /**
  57125. * Block used to discard a pixel if a value is smaller than a cutoff
  57126. */
  57127. export class DiscardBlock extends NodeMaterialBlock {
  57128. /**
  57129. * Create a new DiscardBlock
  57130. * @param name defines the block name
  57131. */
  57132. constructor(name: string);
  57133. /**
  57134. * Gets the current class name
  57135. * @returns the class name
  57136. */
  57137. getClassName(): string;
  57138. /**
  57139. * Gets the color input component
  57140. */
  57141. readonly value: NodeMaterialConnectionPoint;
  57142. /**
  57143. * Gets the cutoff input component
  57144. */
  57145. readonly cutoff: NodeMaterialConnectionPoint;
  57146. protected _buildBlock(state: NodeMaterialBuildState): this;
  57147. }
  57148. }
  57149. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  57150. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  57151. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  57152. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  57153. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  57154. }
  57155. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  57156. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57157. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57158. import { Mesh } from "babylonjs/Meshes/mesh";
  57159. import { Effect } from "babylonjs/Materials/effect";
  57160. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57161. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57162. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57163. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  57164. /**
  57165. * Block used to add support for scene fog
  57166. */
  57167. export class FogBlock extends NodeMaterialBlock {
  57168. private _fogDistanceName;
  57169. private _fogParameters;
  57170. /**
  57171. * Create a new FogBlock
  57172. * @param name defines the block name
  57173. */
  57174. constructor(name: string);
  57175. /**
  57176. * Gets the current class name
  57177. * @returns the class name
  57178. */
  57179. getClassName(): string;
  57180. /**
  57181. * Gets the world position input component
  57182. */
  57183. readonly worldPosition: NodeMaterialConnectionPoint;
  57184. /**
  57185. * Gets the view input component
  57186. */
  57187. readonly view: NodeMaterialConnectionPoint;
  57188. /**
  57189. * Gets the color input component
  57190. */
  57191. readonly input: NodeMaterialConnectionPoint;
  57192. /**
  57193. * Gets the fog color input component
  57194. */
  57195. readonly fogColor: NodeMaterialConnectionPoint;
  57196. /**
  57197. * Gets the output component
  57198. */
  57199. readonly output: NodeMaterialConnectionPoint;
  57200. autoConfigure(material: NodeMaterial): void;
  57201. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57202. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57203. protected _buildBlock(state: NodeMaterialBuildState): this;
  57204. }
  57205. }
  57206. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  57207. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57208. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57209. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57210. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57211. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57212. import { Effect } from "babylonjs/Materials/effect";
  57213. import { Mesh } from "babylonjs/Meshes/mesh";
  57214. import { Light } from "babylonjs/Lights/light";
  57215. import { Nullable } from "babylonjs/types";
  57216. import { Scene } from "babylonjs/scene";
  57217. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  57218. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  57219. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  57220. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57221. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  57222. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  57223. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  57224. /**
  57225. * Block used to add light in the fragment shader
  57226. */
  57227. export class LightBlock extends NodeMaterialBlock {
  57228. private _lightId;
  57229. /**
  57230. * Gets or sets the light associated with this block
  57231. */
  57232. light: Nullable<Light>;
  57233. /**
  57234. * Create a new LightBlock
  57235. * @param name defines the block name
  57236. */
  57237. constructor(name: string);
  57238. /**
  57239. * Gets the current class name
  57240. * @returns the class name
  57241. */
  57242. getClassName(): string;
  57243. /**
  57244. * Gets the world position input component
  57245. */
  57246. readonly worldPosition: NodeMaterialConnectionPoint;
  57247. /**
  57248. * Gets the world normal input component
  57249. */
  57250. readonly worldNormal: NodeMaterialConnectionPoint;
  57251. /**
  57252. * Gets the camera (or eye) position component
  57253. */
  57254. readonly cameraPosition: NodeMaterialConnectionPoint;
  57255. /**
  57256. * Gets the glossiness component
  57257. */
  57258. readonly glossiness: NodeMaterialConnectionPoint;
  57259. /**
  57260. * Gets the glossinness power component
  57261. */
  57262. readonly glossPower: NodeMaterialConnectionPoint;
  57263. /**
  57264. * Gets the diffuse color component
  57265. */
  57266. readonly diffuseColor: NodeMaterialConnectionPoint;
  57267. /**
  57268. * Gets the specular color component
  57269. */
  57270. readonly specularColor: NodeMaterialConnectionPoint;
  57271. /**
  57272. * Gets the diffuse output component
  57273. */
  57274. readonly diffuseOutput: NodeMaterialConnectionPoint;
  57275. /**
  57276. * Gets the specular output component
  57277. */
  57278. readonly specularOutput: NodeMaterialConnectionPoint;
  57279. autoConfigure(material: NodeMaterial): void;
  57280. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57281. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  57282. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57283. private _injectVertexCode;
  57284. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  57285. serialize(): any;
  57286. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57287. }
  57288. }
  57289. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  57290. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  57291. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  57292. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  57293. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  57294. }
  57295. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  57296. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  57297. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  57298. }
  57299. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  57300. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57301. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57302. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57303. /**
  57304. * Block used to multiply 2 values
  57305. */
  57306. export class MultiplyBlock extends NodeMaterialBlock {
  57307. /**
  57308. * Creates a new MultiplyBlock
  57309. * @param name defines the block name
  57310. */
  57311. constructor(name: string);
  57312. /**
  57313. * Gets the current class name
  57314. * @returns the class name
  57315. */
  57316. getClassName(): string;
  57317. /**
  57318. * Gets the left operand input component
  57319. */
  57320. readonly left: NodeMaterialConnectionPoint;
  57321. /**
  57322. * Gets the right operand input component
  57323. */
  57324. readonly right: NodeMaterialConnectionPoint;
  57325. /**
  57326. * Gets the output component
  57327. */
  57328. readonly output: NodeMaterialConnectionPoint;
  57329. protected _buildBlock(state: NodeMaterialBuildState): this;
  57330. }
  57331. }
  57332. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  57333. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57334. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57335. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57336. /**
  57337. * Block used to add 2 vectors
  57338. */
  57339. export class AddBlock extends NodeMaterialBlock {
  57340. /**
  57341. * Creates a new AddBlock
  57342. * @param name defines the block name
  57343. */
  57344. constructor(name: string);
  57345. /**
  57346. * Gets the current class name
  57347. * @returns the class name
  57348. */
  57349. getClassName(): string;
  57350. /**
  57351. * Gets the left operand input component
  57352. */
  57353. readonly left: NodeMaterialConnectionPoint;
  57354. /**
  57355. * Gets the right operand input component
  57356. */
  57357. readonly right: NodeMaterialConnectionPoint;
  57358. /**
  57359. * Gets the output component
  57360. */
  57361. readonly output: NodeMaterialConnectionPoint;
  57362. protected _buildBlock(state: NodeMaterialBuildState): this;
  57363. }
  57364. }
  57365. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  57366. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57367. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57368. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57369. /**
  57370. * Block used to scale a vector by a float
  57371. */
  57372. export class ScaleBlock extends NodeMaterialBlock {
  57373. /**
  57374. * Creates a new ScaleBlock
  57375. * @param name defines the block name
  57376. */
  57377. constructor(name: string);
  57378. /**
  57379. * Gets the current class name
  57380. * @returns the class name
  57381. */
  57382. getClassName(): string;
  57383. /**
  57384. * Gets the input component
  57385. */
  57386. readonly input: NodeMaterialConnectionPoint;
  57387. /**
  57388. * Gets the factor input component
  57389. */
  57390. readonly factor: NodeMaterialConnectionPoint;
  57391. /**
  57392. * Gets the output component
  57393. */
  57394. readonly output: NodeMaterialConnectionPoint;
  57395. protected _buildBlock(state: NodeMaterialBuildState): this;
  57396. }
  57397. }
  57398. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  57399. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57400. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57401. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57402. import { Scene } from "babylonjs/scene";
  57403. /**
  57404. * Block used to clamp a float
  57405. */
  57406. export class ClampBlock extends NodeMaterialBlock {
  57407. /** Gets or sets the minimum range */
  57408. minimum: number;
  57409. /** Gets or sets the maximum range */
  57410. maximum: number;
  57411. /**
  57412. * Creates a new ClampBlock
  57413. * @param name defines the block name
  57414. */
  57415. constructor(name: string);
  57416. /**
  57417. * Gets the current class name
  57418. * @returns the class name
  57419. */
  57420. getClassName(): string;
  57421. /**
  57422. * Gets the value input component
  57423. */
  57424. readonly value: NodeMaterialConnectionPoint;
  57425. /**
  57426. * Gets the output component
  57427. */
  57428. readonly output: NodeMaterialConnectionPoint;
  57429. protected _buildBlock(state: NodeMaterialBuildState): this;
  57430. protected _dumpPropertiesCode(): string;
  57431. serialize(): any;
  57432. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57433. }
  57434. }
  57435. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  57436. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57437. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57438. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57439. /**
  57440. * Block used to apply a cross product between 2 vectors
  57441. */
  57442. export class CrossBlock extends NodeMaterialBlock {
  57443. /**
  57444. * Creates a new CrossBlock
  57445. * @param name defines the block name
  57446. */
  57447. constructor(name: string);
  57448. /**
  57449. * Gets the current class name
  57450. * @returns the class name
  57451. */
  57452. getClassName(): string;
  57453. /**
  57454. * Gets the left operand input component
  57455. */
  57456. readonly left: NodeMaterialConnectionPoint;
  57457. /**
  57458. * Gets the right operand input component
  57459. */
  57460. readonly right: NodeMaterialConnectionPoint;
  57461. /**
  57462. * Gets the output component
  57463. */
  57464. readonly output: NodeMaterialConnectionPoint;
  57465. protected _buildBlock(state: NodeMaterialBuildState): this;
  57466. }
  57467. }
  57468. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  57469. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57470. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57471. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57472. /**
  57473. * Block used to apply a dot product between 2 vectors
  57474. */
  57475. export class DotBlock extends NodeMaterialBlock {
  57476. /**
  57477. * Creates a new DotBlock
  57478. * @param name defines the block name
  57479. */
  57480. constructor(name: string);
  57481. /**
  57482. * Gets the current class name
  57483. * @returns the class name
  57484. */
  57485. getClassName(): string;
  57486. /**
  57487. * Gets the left operand input component
  57488. */
  57489. readonly left: NodeMaterialConnectionPoint;
  57490. /**
  57491. * Gets the right operand input component
  57492. */
  57493. readonly right: NodeMaterialConnectionPoint;
  57494. /**
  57495. * Gets the output component
  57496. */
  57497. readonly output: NodeMaterialConnectionPoint;
  57498. protected _buildBlock(state: NodeMaterialBuildState): this;
  57499. }
  57500. }
  57501. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  57502. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57503. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57504. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57505. import { Vector2 } from "babylonjs/Maths/math.vector";
  57506. import { Scene } from "babylonjs/scene";
  57507. /**
  57508. * Block used to remap a float from a range to a new one
  57509. */
  57510. export class RemapBlock extends NodeMaterialBlock {
  57511. /**
  57512. * Gets or sets the source range
  57513. */
  57514. sourceRange: Vector2;
  57515. /**
  57516. * Gets or sets the target range
  57517. */
  57518. targetRange: Vector2;
  57519. /**
  57520. * Creates a new RemapBlock
  57521. * @param name defines the block name
  57522. */
  57523. constructor(name: string);
  57524. /**
  57525. * Gets the current class name
  57526. * @returns the class name
  57527. */
  57528. getClassName(): string;
  57529. /**
  57530. * Gets the input component
  57531. */
  57532. readonly input: NodeMaterialConnectionPoint;
  57533. /**
  57534. * Gets the source min input component
  57535. */
  57536. readonly sourceMin: NodeMaterialConnectionPoint;
  57537. /**
  57538. * Gets the source max input component
  57539. */
  57540. readonly sourceMax: NodeMaterialConnectionPoint;
  57541. /**
  57542. * Gets the target min input component
  57543. */
  57544. readonly targetMin: NodeMaterialConnectionPoint;
  57545. /**
  57546. * Gets the target max input component
  57547. */
  57548. readonly targetMax: NodeMaterialConnectionPoint;
  57549. /**
  57550. * Gets the output component
  57551. */
  57552. readonly output: NodeMaterialConnectionPoint;
  57553. protected _buildBlock(state: NodeMaterialBuildState): this;
  57554. protected _dumpPropertiesCode(): string;
  57555. serialize(): any;
  57556. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57557. }
  57558. }
  57559. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  57560. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57561. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57562. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57563. /**
  57564. * Block used to normalize a vector
  57565. */
  57566. export class NormalizeBlock extends NodeMaterialBlock {
  57567. /**
  57568. * Creates a new NormalizeBlock
  57569. * @param name defines the block name
  57570. */
  57571. constructor(name: string);
  57572. /**
  57573. * Gets the current class name
  57574. * @returns the class name
  57575. */
  57576. getClassName(): string;
  57577. /**
  57578. * Gets the input component
  57579. */
  57580. readonly input: NodeMaterialConnectionPoint;
  57581. /**
  57582. * Gets the output component
  57583. */
  57584. readonly output: NodeMaterialConnectionPoint;
  57585. protected _buildBlock(state: NodeMaterialBuildState): this;
  57586. }
  57587. }
  57588. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  57589. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57590. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57591. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57592. import { Scene } from "babylonjs/scene";
  57593. /**
  57594. * Operations supported by the Trigonometry block
  57595. */
  57596. export enum TrigonometryBlockOperations {
  57597. /** Cos */
  57598. Cos = 0,
  57599. /** Sin */
  57600. Sin = 1,
  57601. /** Abs */
  57602. Abs = 2,
  57603. /** Exp */
  57604. Exp = 3,
  57605. /** Exp2 */
  57606. Exp2 = 4,
  57607. /** Round */
  57608. Round = 5,
  57609. /** Floor */
  57610. Floor = 6,
  57611. /** Ceiling */
  57612. Ceiling = 7,
  57613. /** Square root */
  57614. Sqrt = 8,
  57615. /** Log */
  57616. Log = 9,
  57617. /** Tangent */
  57618. Tan = 10,
  57619. /** Arc tangent */
  57620. ArcTan = 11,
  57621. /** Arc cosinus */
  57622. ArcCos = 12,
  57623. /** Arc sinus */
  57624. ArcSin = 13,
  57625. /** Fraction */
  57626. Fract = 14,
  57627. /** Sign */
  57628. Sign = 15,
  57629. /** To radians (from degrees) */
  57630. Radians = 16,
  57631. /** To degrees (from radians) */
  57632. Degrees = 17
  57633. }
  57634. /**
  57635. * Block used to apply trigonometry operation to floats
  57636. */
  57637. export class TrigonometryBlock extends NodeMaterialBlock {
  57638. /**
  57639. * Gets or sets the operation applied by the block
  57640. */
  57641. operation: TrigonometryBlockOperations;
  57642. /**
  57643. * Creates a new TrigonometryBlock
  57644. * @param name defines the block name
  57645. */
  57646. constructor(name: string);
  57647. /**
  57648. * Gets the current class name
  57649. * @returns the class name
  57650. */
  57651. getClassName(): string;
  57652. /**
  57653. * Gets the input component
  57654. */
  57655. readonly input: NodeMaterialConnectionPoint;
  57656. /**
  57657. * Gets the output component
  57658. */
  57659. readonly output: NodeMaterialConnectionPoint;
  57660. protected _buildBlock(state: NodeMaterialBuildState): this;
  57661. serialize(): any;
  57662. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57663. }
  57664. }
  57665. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  57666. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57667. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57668. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57669. /**
  57670. * Block used to create a Color3/4 out of individual inputs (one for each component)
  57671. */
  57672. export class ColorMergerBlock extends NodeMaterialBlock {
  57673. /**
  57674. * Create a new ColorMergerBlock
  57675. * @param name defines the block name
  57676. */
  57677. constructor(name: string);
  57678. /**
  57679. * Gets the current class name
  57680. * @returns the class name
  57681. */
  57682. getClassName(): string;
  57683. /**
  57684. * Gets the r component (input)
  57685. */
  57686. readonly r: NodeMaterialConnectionPoint;
  57687. /**
  57688. * Gets the g component (input)
  57689. */
  57690. readonly g: NodeMaterialConnectionPoint;
  57691. /**
  57692. * Gets the b component (input)
  57693. */
  57694. readonly b: NodeMaterialConnectionPoint;
  57695. /**
  57696. * Gets the a component (input)
  57697. */
  57698. readonly a: NodeMaterialConnectionPoint;
  57699. /**
  57700. * Gets the rgba component (output)
  57701. */
  57702. readonly rgba: NodeMaterialConnectionPoint;
  57703. /**
  57704. * Gets the rgb component (output)
  57705. */
  57706. readonly rgb: NodeMaterialConnectionPoint;
  57707. protected _buildBlock(state: NodeMaterialBuildState): this;
  57708. }
  57709. }
  57710. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  57711. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57712. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57713. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57714. /**
  57715. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  57716. */
  57717. export class VectorMergerBlock extends NodeMaterialBlock {
  57718. /**
  57719. * Create a new VectorMergerBlock
  57720. * @param name defines the block name
  57721. */
  57722. constructor(name: string);
  57723. /**
  57724. * Gets the current class name
  57725. * @returns the class name
  57726. */
  57727. getClassName(): string;
  57728. /**
  57729. * Gets the x component (input)
  57730. */
  57731. readonly x: NodeMaterialConnectionPoint;
  57732. /**
  57733. * Gets the y component (input)
  57734. */
  57735. readonly y: NodeMaterialConnectionPoint;
  57736. /**
  57737. * Gets the z component (input)
  57738. */
  57739. readonly z: NodeMaterialConnectionPoint;
  57740. /**
  57741. * Gets the w component (input)
  57742. */
  57743. readonly w: NodeMaterialConnectionPoint;
  57744. /**
  57745. * Gets the xyzw component (output)
  57746. */
  57747. readonly xyzw: NodeMaterialConnectionPoint;
  57748. /**
  57749. * Gets the xyz component (output)
  57750. */
  57751. readonly xyz: NodeMaterialConnectionPoint;
  57752. /**
  57753. * Gets the xy component (output)
  57754. */
  57755. readonly xy: NodeMaterialConnectionPoint;
  57756. protected _buildBlock(state: NodeMaterialBuildState): this;
  57757. }
  57758. }
  57759. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  57760. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57761. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57762. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57763. /**
  57764. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  57765. */
  57766. export class ColorSplitterBlock extends NodeMaterialBlock {
  57767. /**
  57768. * Create a new ColorSplitterBlock
  57769. * @param name defines the block name
  57770. */
  57771. constructor(name: string);
  57772. /**
  57773. * Gets the current class name
  57774. * @returns the class name
  57775. */
  57776. getClassName(): string;
  57777. /**
  57778. * Gets the rgba component (input)
  57779. */
  57780. readonly rgba: NodeMaterialConnectionPoint;
  57781. /**
  57782. * Gets the rgb component (input)
  57783. */
  57784. readonly rgbIn: NodeMaterialConnectionPoint;
  57785. /**
  57786. * Gets the rgb component (output)
  57787. */
  57788. readonly rgbOut: NodeMaterialConnectionPoint;
  57789. /**
  57790. * Gets the r component (output)
  57791. */
  57792. readonly r: NodeMaterialConnectionPoint;
  57793. /**
  57794. * Gets the g component (output)
  57795. */
  57796. readonly g: NodeMaterialConnectionPoint;
  57797. /**
  57798. * Gets the b component (output)
  57799. */
  57800. readonly b: NodeMaterialConnectionPoint;
  57801. /**
  57802. * Gets the a component (output)
  57803. */
  57804. readonly a: NodeMaterialConnectionPoint;
  57805. protected _inputRename(name: string): string;
  57806. protected _outputRename(name: string): string;
  57807. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  57808. }
  57809. }
  57810. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  57811. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57812. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57813. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57814. /**
  57815. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  57816. */
  57817. export class VectorSplitterBlock extends NodeMaterialBlock {
  57818. /**
  57819. * Create a new VectorSplitterBlock
  57820. * @param name defines the block name
  57821. */
  57822. constructor(name: string);
  57823. /**
  57824. * Gets the current class name
  57825. * @returns the class name
  57826. */
  57827. getClassName(): string;
  57828. /**
  57829. * Gets the xyzw component (input)
  57830. */
  57831. readonly xyzw: NodeMaterialConnectionPoint;
  57832. /**
  57833. * Gets the xyz component (input)
  57834. */
  57835. readonly xyzIn: NodeMaterialConnectionPoint;
  57836. /**
  57837. * Gets the xy component (input)
  57838. */
  57839. readonly xyIn: NodeMaterialConnectionPoint;
  57840. /**
  57841. * Gets the xyz component (output)
  57842. */
  57843. readonly xyzOut: NodeMaterialConnectionPoint;
  57844. /**
  57845. * Gets the xy component (output)
  57846. */
  57847. readonly xyOut: NodeMaterialConnectionPoint;
  57848. /**
  57849. * Gets the x component (output)
  57850. */
  57851. readonly x: NodeMaterialConnectionPoint;
  57852. /**
  57853. * Gets the y component (output)
  57854. */
  57855. readonly y: NodeMaterialConnectionPoint;
  57856. /**
  57857. * Gets the z component (output)
  57858. */
  57859. readonly z: NodeMaterialConnectionPoint;
  57860. /**
  57861. * Gets the w component (output)
  57862. */
  57863. readonly w: NodeMaterialConnectionPoint;
  57864. protected _inputRename(name: string): string;
  57865. protected _outputRename(name: string): string;
  57866. protected _buildBlock(state: NodeMaterialBuildState): this;
  57867. }
  57868. }
  57869. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  57870. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57871. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57872. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57873. /**
  57874. * Block used to lerp between 2 values
  57875. */
  57876. export class LerpBlock extends NodeMaterialBlock {
  57877. /**
  57878. * Creates a new LerpBlock
  57879. * @param name defines the block name
  57880. */
  57881. constructor(name: string);
  57882. /**
  57883. * Gets the current class name
  57884. * @returns the class name
  57885. */
  57886. getClassName(): string;
  57887. /**
  57888. * Gets the left operand input component
  57889. */
  57890. readonly left: NodeMaterialConnectionPoint;
  57891. /**
  57892. * Gets the right operand input component
  57893. */
  57894. readonly right: NodeMaterialConnectionPoint;
  57895. /**
  57896. * Gets the gradient operand input component
  57897. */
  57898. readonly gradient: NodeMaterialConnectionPoint;
  57899. /**
  57900. * Gets the output component
  57901. */
  57902. readonly output: NodeMaterialConnectionPoint;
  57903. protected _buildBlock(state: NodeMaterialBuildState): this;
  57904. }
  57905. }
  57906. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  57907. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57908. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57909. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57910. /**
  57911. * Block used to divide 2 vectors
  57912. */
  57913. export class DivideBlock extends NodeMaterialBlock {
  57914. /**
  57915. * Creates a new DivideBlock
  57916. * @param name defines the block name
  57917. */
  57918. constructor(name: string);
  57919. /**
  57920. * Gets the current class name
  57921. * @returns the class name
  57922. */
  57923. getClassName(): string;
  57924. /**
  57925. * Gets the left operand input component
  57926. */
  57927. readonly left: NodeMaterialConnectionPoint;
  57928. /**
  57929. * Gets the right operand input component
  57930. */
  57931. readonly right: NodeMaterialConnectionPoint;
  57932. /**
  57933. * Gets the output component
  57934. */
  57935. readonly output: NodeMaterialConnectionPoint;
  57936. protected _buildBlock(state: NodeMaterialBuildState): this;
  57937. }
  57938. }
  57939. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  57940. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57941. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57942. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57943. /**
  57944. * Block used to subtract 2 vectors
  57945. */
  57946. export class SubtractBlock extends NodeMaterialBlock {
  57947. /**
  57948. * Creates a new SubtractBlock
  57949. * @param name defines the block name
  57950. */
  57951. constructor(name: string);
  57952. /**
  57953. * Gets the current class name
  57954. * @returns the class name
  57955. */
  57956. getClassName(): string;
  57957. /**
  57958. * Gets the left operand input component
  57959. */
  57960. readonly left: NodeMaterialConnectionPoint;
  57961. /**
  57962. * Gets the right operand input component
  57963. */
  57964. readonly right: NodeMaterialConnectionPoint;
  57965. /**
  57966. * Gets the output component
  57967. */
  57968. readonly output: NodeMaterialConnectionPoint;
  57969. protected _buildBlock(state: NodeMaterialBuildState): this;
  57970. }
  57971. }
  57972. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  57973. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57974. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57975. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57976. /**
  57977. * Block used to step a value
  57978. */
  57979. export class StepBlock extends NodeMaterialBlock {
  57980. /**
  57981. * Creates a new StepBlock
  57982. * @param name defines the block name
  57983. */
  57984. constructor(name: string);
  57985. /**
  57986. * Gets the current class name
  57987. * @returns the class name
  57988. */
  57989. getClassName(): string;
  57990. /**
  57991. * Gets the value operand input component
  57992. */
  57993. readonly value: NodeMaterialConnectionPoint;
  57994. /**
  57995. * Gets the edge operand input component
  57996. */
  57997. readonly edge: NodeMaterialConnectionPoint;
  57998. /**
  57999. * Gets the output component
  58000. */
  58001. readonly output: NodeMaterialConnectionPoint;
  58002. protected _buildBlock(state: NodeMaterialBuildState): this;
  58003. }
  58004. }
  58005. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  58006. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58007. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58008. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58009. /**
  58010. * Block used to get the opposite (1 - x) of a value
  58011. */
  58012. export class OneMinusBlock extends NodeMaterialBlock {
  58013. /**
  58014. * Creates a new OneMinusBlock
  58015. * @param name defines the block name
  58016. */
  58017. constructor(name: string);
  58018. /**
  58019. * Gets the current class name
  58020. * @returns the class name
  58021. */
  58022. getClassName(): string;
  58023. /**
  58024. * Gets the input component
  58025. */
  58026. readonly input: NodeMaterialConnectionPoint;
  58027. /**
  58028. * Gets the output component
  58029. */
  58030. readonly output: NodeMaterialConnectionPoint;
  58031. protected _buildBlock(state: NodeMaterialBuildState): this;
  58032. }
  58033. }
  58034. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  58035. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58036. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58037. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58038. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  58039. /**
  58040. * Block used to get the view direction
  58041. */
  58042. export class ViewDirectionBlock extends NodeMaterialBlock {
  58043. /**
  58044. * Creates a new ViewDirectionBlock
  58045. * @param name defines the block name
  58046. */
  58047. constructor(name: string);
  58048. /**
  58049. * Gets the current class name
  58050. * @returns the class name
  58051. */
  58052. getClassName(): string;
  58053. /**
  58054. * Gets the world position component
  58055. */
  58056. readonly worldPosition: NodeMaterialConnectionPoint;
  58057. /**
  58058. * Gets the camera position component
  58059. */
  58060. readonly cameraPosition: NodeMaterialConnectionPoint;
  58061. /**
  58062. * Gets the output component
  58063. */
  58064. readonly output: NodeMaterialConnectionPoint;
  58065. autoConfigure(material: NodeMaterial): void;
  58066. protected _buildBlock(state: NodeMaterialBuildState): this;
  58067. }
  58068. }
  58069. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  58070. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58071. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58072. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58073. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  58074. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  58075. /**
  58076. * Block used to compute fresnel value
  58077. */
  58078. export class FresnelBlock extends NodeMaterialBlock {
  58079. /**
  58080. * Create a new FresnelBlock
  58081. * @param name defines the block name
  58082. */
  58083. constructor(name: string);
  58084. /**
  58085. * Gets the current class name
  58086. * @returns the class name
  58087. */
  58088. getClassName(): string;
  58089. /**
  58090. * Gets the world normal input component
  58091. */
  58092. readonly worldNormal: NodeMaterialConnectionPoint;
  58093. /**
  58094. * Gets the view direction input component
  58095. */
  58096. readonly viewDirection: NodeMaterialConnectionPoint;
  58097. /**
  58098. * Gets the bias input component
  58099. */
  58100. readonly bias: NodeMaterialConnectionPoint;
  58101. /**
  58102. * Gets the camera (or eye) position component
  58103. */
  58104. readonly power: NodeMaterialConnectionPoint;
  58105. /**
  58106. * Gets the fresnel output component
  58107. */
  58108. readonly fresnel: NodeMaterialConnectionPoint;
  58109. autoConfigure(material: NodeMaterial): void;
  58110. protected _buildBlock(state: NodeMaterialBuildState): this;
  58111. }
  58112. }
  58113. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  58114. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58115. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58116. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58117. /**
  58118. * Block used to get the max of 2 values
  58119. */
  58120. export class MaxBlock extends NodeMaterialBlock {
  58121. /**
  58122. * Creates a new MaxBlock
  58123. * @param name defines the block name
  58124. */
  58125. constructor(name: string);
  58126. /**
  58127. * Gets the current class name
  58128. * @returns the class name
  58129. */
  58130. getClassName(): string;
  58131. /**
  58132. * Gets the left operand input component
  58133. */
  58134. readonly left: NodeMaterialConnectionPoint;
  58135. /**
  58136. * Gets the right operand input component
  58137. */
  58138. readonly right: NodeMaterialConnectionPoint;
  58139. /**
  58140. * Gets the output component
  58141. */
  58142. readonly output: NodeMaterialConnectionPoint;
  58143. protected _buildBlock(state: NodeMaterialBuildState): this;
  58144. }
  58145. }
  58146. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  58147. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58148. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58149. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58150. /**
  58151. * Block used to get the min of 2 values
  58152. */
  58153. export class MinBlock extends NodeMaterialBlock {
  58154. /**
  58155. * Creates a new MinBlock
  58156. * @param name defines the block name
  58157. */
  58158. constructor(name: string);
  58159. /**
  58160. * Gets the current class name
  58161. * @returns the class name
  58162. */
  58163. getClassName(): string;
  58164. /**
  58165. * Gets the left operand input component
  58166. */
  58167. readonly left: NodeMaterialConnectionPoint;
  58168. /**
  58169. * Gets the right operand input component
  58170. */
  58171. readonly right: NodeMaterialConnectionPoint;
  58172. /**
  58173. * Gets the output component
  58174. */
  58175. readonly output: NodeMaterialConnectionPoint;
  58176. protected _buildBlock(state: NodeMaterialBuildState): this;
  58177. }
  58178. }
  58179. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  58180. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58181. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58182. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58183. /**
  58184. * Block used to get the distance between 2 values
  58185. */
  58186. export class DistanceBlock extends NodeMaterialBlock {
  58187. /**
  58188. * Creates a new DistanceBlock
  58189. * @param name defines the block name
  58190. */
  58191. constructor(name: string);
  58192. /**
  58193. * Gets the current class name
  58194. * @returns the class name
  58195. */
  58196. getClassName(): string;
  58197. /**
  58198. * Gets the left operand input component
  58199. */
  58200. readonly left: NodeMaterialConnectionPoint;
  58201. /**
  58202. * Gets the right operand input component
  58203. */
  58204. readonly right: NodeMaterialConnectionPoint;
  58205. /**
  58206. * Gets the output component
  58207. */
  58208. readonly output: NodeMaterialConnectionPoint;
  58209. protected _buildBlock(state: NodeMaterialBuildState): this;
  58210. }
  58211. }
  58212. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  58213. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58214. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58215. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58216. /**
  58217. * Block used to get the length of a vector
  58218. */
  58219. export class LengthBlock extends NodeMaterialBlock {
  58220. /**
  58221. * Creates a new LengthBlock
  58222. * @param name defines the block name
  58223. */
  58224. constructor(name: string);
  58225. /**
  58226. * Gets the current class name
  58227. * @returns the class name
  58228. */
  58229. getClassName(): string;
  58230. /**
  58231. * Gets the value input component
  58232. */
  58233. readonly value: NodeMaterialConnectionPoint;
  58234. /**
  58235. * Gets the output component
  58236. */
  58237. readonly output: NodeMaterialConnectionPoint;
  58238. protected _buildBlock(state: NodeMaterialBuildState): this;
  58239. }
  58240. }
  58241. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  58242. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58243. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58244. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58245. /**
  58246. * Block used to get negative version of a value (i.e. x * -1)
  58247. */
  58248. export class NegateBlock extends NodeMaterialBlock {
  58249. /**
  58250. * Creates a new NegateBlock
  58251. * @param name defines the block name
  58252. */
  58253. constructor(name: string);
  58254. /**
  58255. * Gets the current class name
  58256. * @returns the class name
  58257. */
  58258. getClassName(): string;
  58259. /**
  58260. * Gets the value input component
  58261. */
  58262. readonly value: NodeMaterialConnectionPoint;
  58263. /**
  58264. * Gets the output component
  58265. */
  58266. readonly output: NodeMaterialConnectionPoint;
  58267. protected _buildBlock(state: NodeMaterialBuildState): this;
  58268. }
  58269. }
  58270. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  58271. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58272. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58273. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58274. /**
  58275. * Block used to get the value of the first parameter raised to the power of the second
  58276. */
  58277. export class PowBlock extends NodeMaterialBlock {
  58278. /**
  58279. * Creates a new PowBlock
  58280. * @param name defines the block name
  58281. */
  58282. constructor(name: string);
  58283. /**
  58284. * Gets the current class name
  58285. * @returns the class name
  58286. */
  58287. getClassName(): string;
  58288. /**
  58289. * Gets the value operand input component
  58290. */
  58291. readonly value: NodeMaterialConnectionPoint;
  58292. /**
  58293. * Gets the power operand input component
  58294. */
  58295. readonly power: NodeMaterialConnectionPoint;
  58296. /**
  58297. * Gets the output component
  58298. */
  58299. readonly output: NodeMaterialConnectionPoint;
  58300. protected _buildBlock(state: NodeMaterialBuildState): this;
  58301. }
  58302. }
  58303. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  58304. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58305. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58306. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58307. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58308. /**
  58309. * Block used to get a random number
  58310. */
  58311. export class RandomNumberBlock extends NodeMaterialBlock {
  58312. /**
  58313. * Creates a new RandomNumberBlock
  58314. * @param name defines the block name
  58315. */
  58316. constructor(name: string);
  58317. /**
  58318. * Gets the current class name
  58319. * @returns the class name
  58320. */
  58321. getClassName(): string;
  58322. /**
  58323. * Gets the seed input component
  58324. */
  58325. readonly seed: NodeMaterialConnectionPoint;
  58326. /**
  58327. * Gets the output component
  58328. */
  58329. readonly output: NodeMaterialConnectionPoint;
  58330. protected _buildBlock(state: NodeMaterialBuildState): this;
  58331. }
  58332. }
  58333. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  58334. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58335. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58336. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58337. /**
  58338. * Block used to compute arc tangent of 2 values
  58339. */
  58340. export class ArcTan2Block extends NodeMaterialBlock {
  58341. /**
  58342. * Creates a new ArcTan2Block
  58343. * @param name defines the block name
  58344. */
  58345. constructor(name: string);
  58346. /**
  58347. * Gets the current class name
  58348. * @returns the class name
  58349. */
  58350. getClassName(): string;
  58351. /**
  58352. * Gets the x operand input component
  58353. */
  58354. readonly x: NodeMaterialConnectionPoint;
  58355. /**
  58356. * Gets the y operand input component
  58357. */
  58358. readonly y: NodeMaterialConnectionPoint;
  58359. /**
  58360. * Gets the output component
  58361. */
  58362. readonly output: NodeMaterialConnectionPoint;
  58363. protected _buildBlock(state: NodeMaterialBuildState): this;
  58364. }
  58365. }
  58366. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  58367. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58368. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58369. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58370. /**
  58371. * Block used to smooth step a value
  58372. */
  58373. export class SmoothStepBlock extends NodeMaterialBlock {
  58374. /**
  58375. * Creates a new SmoothStepBlock
  58376. * @param name defines the block name
  58377. */
  58378. constructor(name: string);
  58379. /**
  58380. * Gets the current class name
  58381. * @returns the class name
  58382. */
  58383. getClassName(): string;
  58384. /**
  58385. * Gets the value operand input component
  58386. */
  58387. readonly value: NodeMaterialConnectionPoint;
  58388. /**
  58389. * Gets the first edge operand input component
  58390. */
  58391. readonly edge0: NodeMaterialConnectionPoint;
  58392. /**
  58393. * Gets the second edge operand input component
  58394. */
  58395. readonly edge1: NodeMaterialConnectionPoint;
  58396. /**
  58397. * Gets the output component
  58398. */
  58399. readonly output: NodeMaterialConnectionPoint;
  58400. protected _buildBlock(state: NodeMaterialBuildState): this;
  58401. }
  58402. }
  58403. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  58404. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58405. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58406. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58407. /**
  58408. * Block used to get the reciprocal (1 / x) of a value
  58409. */
  58410. export class ReciprocalBlock extends NodeMaterialBlock {
  58411. /**
  58412. * Creates a new ReciprocalBlock
  58413. * @param name defines the block name
  58414. */
  58415. constructor(name: string);
  58416. /**
  58417. * Gets the current class name
  58418. * @returns the class name
  58419. */
  58420. getClassName(): string;
  58421. /**
  58422. * Gets the input component
  58423. */
  58424. readonly input: NodeMaterialConnectionPoint;
  58425. /**
  58426. * Gets the output component
  58427. */
  58428. readonly output: NodeMaterialConnectionPoint;
  58429. protected _buildBlock(state: NodeMaterialBuildState): this;
  58430. }
  58431. }
  58432. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  58433. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58434. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58435. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58436. /**
  58437. * Block used to replace a color by another one
  58438. */
  58439. export class ReplaceColorBlock extends NodeMaterialBlock {
  58440. /**
  58441. * Creates a new ReplaceColorBlock
  58442. * @param name defines the block name
  58443. */
  58444. constructor(name: string);
  58445. /**
  58446. * Gets the current class name
  58447. * @returns the class name
  58448. */
  58449. getClassName(): string;
  58450. /**
  58451. * Gets the value input component
  58452. */
  58453. readonly value: NodeMaterialConnectionPoint;
  58454. /**
  58455. * Gets the reference input component
  58456. */
  58457. readonly reference: NodeMaterialConnectionPoint;
  58458. /**
  58459. * Gets the distance input component
  58460. */
  58461. readonly distance: NodeMaterialConnectionPoint;
  58462. /**
  58463. * Gets the replacement input component
  58464. */
  58465. readonly replacement: NodeMaterialConnectionPoint;
  58466. /**
  58467. * Gets the output component
  58468. */
  58469. readonly output: NodeMaterialConnectionPoint;
  58470. protected _buildBlock(state: NodeMaterialBuildState): this;
  58471. }
  58472. }
  58473. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  58474. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58475. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58476. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58477. /**
  58478. * Block used to posterize a value
  58479. * @see https://en.wikipedia.org/wiki/Posterization
  58480. */
  58481. export class PosterizeBlock extends NodeMaterialBlock {
  58482. /**
  58483. * Creates a new PosterizeBlock
  58484. * @param name defines the block name
  58485. */
  58486. constructor(name: string);
  58487. /**
  58488. * Gets the current class name
  58489. * @returns the class name
  58490. */
  58491. getClassName(): string;
  58492. /**
  58493. * Gets the value input component
  58494. */
  58495. readonly value: NodeMaterialConnectionPoint;
  58496. /**
  58497. * Gets the steps input component
  58498. */
  58499. readonly steps: NodeMaterialConnectionPoint;
  58500. /**
  58501. * Gets the output component
  58502. */
  58503. readonly output: NodeMaterialConnectionPoint;
  58504. protected _buildBlock(state: NodeMaterialBuildState): this;
  58505. }
  58506. }
  58507. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  58508. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58509. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58510. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58511. import { Scene } from "babylonjs/scene";
  58512. /**
  58513. * Operations supported by the Wave block
  58514. */
  58515. export enum WaveBlockKind {
  58516. /** SawTooth */
  58517. SawTooth = 0,
  58518. /** Square */
  58519. Square = 1,
  58520. /** Triangle */
  58521. Triangle = 2
  58522. }
  58523. /**
  58524. * Block used to apply wave operation to floats
  58525. */
  58526. export class WaveBlock extends NodeMaterialBlock {
  58527. /**
  58528. * Gets or sets the kibnd of wave to be applied by the block
  58529. */
  58530. kind: WaveBlockKind;
  58531. /**
  58532. * Creates a new WaveBlock
  58533. * @param name defines the block name
  58534. */
  58535. constructor(name: string);
  58536. /**
  58537. * Gets the current class name
  58538. * @returns the class name
  58539. */
  58540. getClassName(): string;
  58541. /**
  58542. * Gets the input component
  58543. */
  58544. readonly input: NodeMaterialConnectionPoint;
  58545. /**
  58546. * Gets the output component
  58547. */
  58548. readonly output: NodeMaterialConnectionPoint;
  58549. protected _buildBlock(state: NodeMaterialBuildState): this;
  58550. serialize(): any;
  58551. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  58552. }
  58553. }
  58554. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  58555. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58556. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58557. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58558. import { Color3 } from "babylonjs/Maths/math.color";
  58559. import { Scene } from "babylonjs/scene";
  58560. /**
  58561. * Class used to store a color step for the GradientBlock
  58562. */
  58563. export class GradientBlockColorStep {
  58564. /**
  58565. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  58566. */
  58567. step: number;
  58568. /**
  58569. * Gets or sets the color associated with this step
  58570. */
  58571. color: Color3;
  58572. /**
  58573. * Creates a new GradientBlockColorStep
  58574. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  58575. * @param color defines the color associated with this step
  58576. */
  58577. constructor(
  58578. /**
  58579. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  58580. */
  58581. step: number,
  58582. /**
  58583. * Gets or sets the color associated with this step
  58584. */
  58585. color: Color3);
  58586. }
  58587. /**
  58588. * Block used to return a color from a gradient based on an input value between 0 and 1
  58589. */
  58590. export class GradientBlock extends NodeMaterialBlock {
  58591. /**
  58592. * Gets or sets the list of color steps
  58593. */
  58594. colorSteps: GradientBlockColorStep[];
  58595. /**
  58596. * Creates a new GradientBlock
  58597. * @param name defines the block name
  58598. */
  58599. constructor(name: string);
  58600. /**
  58601. * Gets the current class name
  58602. * @returns the class name
  58603. */
  58604. getClassName(): string;
  58605. /**
  58606. * Gets the gradient input component
  58607. */
  58608. readonly gradient: NodeMaterialConnectionPoint;
  58609. /**
  58610. * Gets the output component
  58611. */
  58612. readonly output: NodeMaterialConnectionPoint;
  58613. private _writeColorConstant;
  58614. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  58615. serialize(): any;
  58616. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  58617. protected _dumpPropertiesCode(): string;
  58618. }
  58619. }
  58620. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  58621. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58622. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58623. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58624. /**
  58625. * Block used to normalize lerp between 2 values
  58626. */
  58627. export class NLerpBlock extends NodeMaterialBlock {
  58628. /**
  58629. * Creates a new NLerpBlock
  58630. * @param name defines the block name
  58631. */
  58632. constructor(name: string);
  58633. /**
  58634. * Gets the current class name
  58635. * @returns the class name
  58636. */
  58637. getClassName(): string;
  58638. /**
  58639. * Gets the left operand input component
  58640. */
  58641. readonly left: NodeMaterialConnectionPoint;
  58642. /**
  58643. * Gets the right operand input component
  58644. */
  58645. readonly right: NodeMaterialConnectionPoint;
  58646. /**
  58647. * Gets the gradient operand input component
  58648. */
  58649. readonly gradient: NodeMaterialConnectionPoint;
  58650. /**
  58651. * Gets the output component
  58652. */
  58653. readonly output: NodeMaterialConnectionPoint;
  58654. protected _buildBlock(state: NodeMaterialBuildState): this;
  58655. }
  58656. }
  58657. declare module "babylonjs/Materials/Node/Blocks/frontFacingBlock" {
  58658. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58659. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58660. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58661. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  58662. /**
  58663. * Block used to test if the fragment shader is front facing
  58664. */
  58665. export class FrontFacingBlock extends NodeMaterialBlock {
  58666. /**
  58667. * Creates a new FrontFacingBlock
  58668. * @param name defines the block name
  58669. */
  58670. constructor(name: string);
  58671. /**
  58672. * Gets the current class name
  58673. * @returns the class name
  58674. */
  58675. getClassName(): string;
  58676. /**
  58677. * Gets the world normal component
  58678. */
  58679. readonly worldNormal: NodeMaterialConnectionPoint;
  58680. /**
  58681. * Gets the view direction input component
  58682. */
  58683. readonly viewDirection: NodeMaterialConnectionPoint;
  58684. /**
  58685. * Gets the output component
  58686. */
  58687. readonly output: NodeMaterialConnectionPoint;
  58688. autoConfigure(material: NodeMaterial): void;
  58689. protected _buildBlock(state: NodeMaterialBuildState): this;
  58690. }
  58691. }
  58692. declare module "babylonjs/Materials/Node/Blocks/index" {
  58693. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  58694. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  58695. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  58696. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  58697. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  58698. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  58699. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  58700. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  58701. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  58702. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  58703. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  58704. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  58705. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  58706. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  58707. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  58708. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  58709. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  58710. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  58711. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  58712. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  58713. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  58714. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  58715. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  58716. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  58717. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  58718. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  58719. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  58720. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  58721. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  58722. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  58723. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  58724. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  58725. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  58726. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  58727. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  58728. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  58729. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  58730. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  58731. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  58732. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  58733. export * from "babylonjs/Materials/Node/Blocks/frontFacingBlock";
  58734. }
  58735. declare module "babylonjs/Materials/Node/Optimizers/index" {
  58736. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  58737. }
  58738. declare module "babylonjs/Materials/Node/index" {
  58739. export * from "babylonjs/Materials/Node/Enums/index";
  58740. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58741. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  58742. export * from "babylonjs/Materials/Node/nodeMaterial";
  58743. export * from "babylonjs/Materials/Node/Blocks/index";
  58744. export * from "babylonjs/Materials/Node/Optimizers/index";
  58745. }
  58746. declare module "babylonjs/Materials/effectRenderer" {
  58747. import { Nullable } from "babylonjs/types";
  58748. import { Texture } from "babylonjs/Materials/Textures/texture";
  58749. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  58750. import { Viewport } from "babylonjs/Maths/math.viewport";
  58751. import { Observable } from "babylonjs/Misc/observable";
  58752. import { Effect } from "babylonjs/Materials/effect";
  58753. import "babylonjs/Engines/Extensions/engine.renderTarget";
  58754. import "babylonjs/Shaders/postprocess.vertex";
  58755. /**
  58756. * Effect Render Options
  58757. */
  58758. export interface IEffectRendererOptions {
  58759. /**
  58760. * Defines the vertices positions.
  58761. */
  58762. positions?: number[];
  58763. /**
  58764. * Defines the indices.
  58765. */
  58766. indices?: number[];
  58767. }
  58768. /**
  58769. * Helper class to render one or more effects
  58770. */
  58771. export class EffectRenderer {
  58772. private engine;
  58773. private static _DefaultOptions;
  58774. private _vertexBuffers;
  58775. private _indexBuffer;
  58776. private _ringBufferIndex;
  58777. private _ringScreenBuffer;
  58778. private _fullscreenViewport;
  58779. private _getNextFrameBuffer;
  58780. /**
  58781. * Creates an effect renderer
  58782. * @param engine the engine to use for rendering
  58783. * @param options defines the options of the effect renderer
  58784. */
  58785. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  58786. /**
  58787. * Sets the current viewport in normalized coordinates 0-1
  58788. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  58789. */
  58790. setViewport(viewport?: Viewport): void;
  58791. /**
  58792. * Binds the embedded attributes buffer to the effect.
  58793. * @param effect Defines the effect to bind the attributes for
  58794. */
  58795. bindBuffers(effect: Effect): void;
  58796. /**
  58797. * Sets the current effect wrapper to use during draw.
  58798. * The effect needs to be ready before calling this api.
  58799. * This also sets the default full screen position attribute.
  58800. * @param effectWrapper Defines the effect to draw with
  58801. */
  58802. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  58803. /**
  58804. * Draws a full screen quad.
  58805. */
  58806. draw(): void;
  58807. /**
  58808. * renders one or more effects to a specified texture
  58809. * @param effectWrappers list of effects to renderer
  58810. * @param outputTexture texture to draw to, if null it will render to the screen
  58811. */
  58812. render(effectWrappers: Array<EffectWrapper> | EffectWrapper, outputTexture?: Nullable<Texture>): void;
  58813. /**
  58814. * Disposes of the effect renderer
  58815. */
  58816. dispose(): void;
  58817. }
  58818. /**
  58819. * Options to create an EffectWrapper
  58820. */
  58821. interface EffectWrapperCreationOptions {
  58822. /**
  58823. * Engine to use to create the effect
  58824. */
  58825. engine: ThinEngine;
  58826. /**
  58827. * Fragment shader for the effect
  58828. */
  58829. fragmentShader: string;
  58830. /**
  58831. * Vertex shader for the effect
  58832. */
  58833. vertexShader?: string;
  58834. /**
  58835. * Attributes to use in the shader
  58836. */
  58837. attributeNames?: Array<string>;
  58838. /**
  58839. * Uniforms to use in the shader
  58840. */
  58841. uniformNames?: Array<string>;
  58842. /**
  58843. * Texture sampler names to use in the shader
  58844. */
  58845. samplerNames?: Array<string>;
  58846. /**
  58847. * The friendly name of the effect displayed in Spector.
  58848. */
  58849. name?: string;
  58850. }
  58851. /**
  58852. * Wraps an effect to be used for rendering
  58853. */
  58854. export class EffectWrapper {
  58855. /**
  58856. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  58857. */
  58858. onApplyObservable: Observable<{}>;
  58859. /**
  58860. * The underlying effect
  58861. */
  58862. effect: Effect;
  58863. /**
  58864. * Creates an effect to be renderer
  58865. * @param creationOptions options to create the effect
  58866. */
  58867. constructor(creationOptions: EffectWrapperCreationOptions);
  58868. /**
  58869. * Disposes of the effect wrapper
  58870. */
  58871. dispose(): void;
  58872. }
  58873. }
  58874. declare module "babylonjs/Materials/index" {
  58875. export * from "babylonjs/Materials/Background/index";
  58876. export * from "babylonjs/Materials/colorCurves";
  58877. export * from "babylonjs/Materials/iEffectFallbacks";
  58878. export * from "babylonjs/Materials/effectFallbacks";
  58879. export * from "babylonjs/Materials/effect";
  58880. export * from "babylonjs/Materials/fresnelParameters";
  58881. export * from "babylonjs/Materials/imageProcessingConfiguration";
  58882. export * from "babylonjs/Materials/material";
  58883. export * from "babylonjs/Materials/materialDefines";
  58884. export * from "babylonjs/Materials/materialHelper";
  58885. export * from "babylonjs/Materials/multiMaterial";
  58886. export * from "babylonjs/Materials/PBR/index";
  58887. export * from "babylonjs/Materials/pushMaterial";
  58888. export * from "babylonjs/Materials/shaderMaterial";
  58889. export * from "babylonjs/Materials/standardMaterial";
  58890. export * from "babylonjs/Materials/Textures/index";
  58891. export * from "babylonjs/Materials/uniformBuffer";
  58892. export * from "babylonjs/Materials/materialFlags";
  58893. export * from "babylonjs/Materials/Node/index";
  58894. export * from "babylonjs/Materials/effectRenderer";
  58895. }
  58896. declare module "babylonjs/Maths/index" {
  58897. export * from "babylonjs/Maths/math.scalar";
  58898. export * from "babylonjs/Maths/math";
  58899. export * from "babylonjs/Maths/sphericalPolynomial";
  58900. }
  58901. declare module "babylonjs/Misc/workerPool" {
  58902. import { IDisposable } from "babylonjs/scene";
  58903. /**
  58904. * Helper class to push actions to a pool of workers.
  58905. */
  58906. export class WorkerPool implements IDisposable {
  58907. private _workerInfos;
  58908. private _pendingActions;
  58909. /**
  58910. * Constructor
  58911. * @param workers Array of workers to use for actions
  58912. */
  58913. constructor(workers: Array<Worker>);
  58914. /**
  58915. * Terminates all workers and clears any pending actions.
  58916. */
  58917. dispose(): void;
  58918. /**
  58919. * Pushes an action to the worker pool. If all the workers are active, the action will be
  58920. * pended until a worker has completed its action.
  58921. * @param action The action to perform. Call onComplete when the action is complete.
  58922. */
  58923. push(action: (worker: Worker, onComplete: () => void) => void): void;
  58924. private _execute;
  58925. }
  58926. }
  58927. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  58928. import { IDisposable } from "babylonjs/scene";
  58929. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  58930. /**
  58931. * Configuration for Draco compression
  58932. */
  58933. export interface IDracoCompressionConfiguration {
  58934. /**
  58935. * Configuration for the decoder.
  58936. */
  58937. decoder: {
  58938. /**
  58939. * The url to the WebAssembly module.
  58940. */
  58941. wasmUrl?: string;
  58942. /**
  58943. * The url to the WebAssembly binary.
  58944. */
  58945. wasmBinaryUrl?: string;
  58946. /**
  58947. * The url to the fallback JavaScript module.
  58948. */
  58949. fallbackUrl?: string;
  58950. };
  58951. }
  58952. /**
  58953. * Draco compression (https://google.github.io/draco/)
  58954. *
  58955. * This class wraps the Draco module.
  58956. *
  58957. * **Encoder**
  58958. *
  58959. * The encoder is not currently implemented.
  58960. *
  58961. * **Decoder**
  58962. *
  58963. * 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.
  58964. *
  58965. * To update the configuration, use the following code:
  58966. * ```javascript
  58967. * DracoCompression.Configuration = {
  58968. * decoder: {
  58969. * wasmUrl: "<url to the WebAssembly library>",
  58970. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  58971. * fallbackUrl: "<url to the fallback JavaScript library>",
  58972. * }
  58973. * };
  58974. * ```
  58975. *
  58976. * 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.
  58977. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  58978. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  58979. *
  58980. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  58981. * ```javascript
  58982. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  58983. * ```
  58984. *
  58985. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  58986. */
  58987. export class DracoCompression implements IDisposable {
  58988. private _workerPoolPromise?;
  58989. private _decoderModulePromise?;
  58990. /**
  58991. * The configuration. Defaults to the following urls:
  58992. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  58993. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  58994. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  58995. */
  58996. static Configuration: IDracoCompressionConfiguration;
  58997. /**
  58998. * Returns true if the decoder configuration is available.
  58999. */
  59000. static readonly DecoderAvailable: boolean;
  59001. /**
  59002. * Default number of workers to create when creating the draco compression object.
  59003. */
  59004. static DefaultNumWorkers: number;
  59005. private static GetDefaultNumWorkers;
  59006. private static _Default;
  59007. /**
  59008. * Default instance for the draco compression object.
  59009. */
  59010. static readonly Default: DracoCompression;
  59011. /**
  59012. * Constructor
  59013. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  59014. */
  59015. constructor(numWorkers?: number);
  59016. /**
  59017. * Stop all async operations and release resources.
  59018. */
  59019. dispose(): void;
  59020. /**
  59021. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  59022. * @returns a promise that resolves when ready
  59023. */
  59024. whenReadyAsync(): Promise<void>;
  59025. /**
  59026. * Decode Draco compressed mesh data to vertex data.
  59027. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  59028. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  59029. * @returns A promise that resolves with the decoded vertex data
  59030. */
  59031. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  59032. [kind: string]: number;
  59033. }): Promise<VertexData>;
  59034. }
  59035. }
  59036. declare module "babylonjs/Meshes/Compression/index" {
  59037. export * from "babylonjs/Meshes/Compression/dracoCompression";
  59038. }
  59039. declare module "babylonjs/Meshes/csg" {
  59040. import { Nullable } from "babylonjs/types";
  59041. import { Scene } from "babylonjs/scene";
  59042. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  59043. import { Mesh } from "babylonjs/Meshes/mesh";
  59044. import { Material } from "babylonjs/Materials/material";
  59045. /**
  59046. * Class for building Constructive Solid Geometry
  59047. */
  59048. export class CSG {
  59049. private polygons;
  59050. /**
  59051. * The world matrix
  59052. */
  59053. matrix: Matrix;
  59054. /**
  59055. * Stores the position
  59056. */
  59057. position: Vector3;
  59058. /**
  59059. * Stores the rotation
  59060. */
  59061. rotation: Vector3;
  59062. /**
  59063. * Stores the rotation quaternion
  59064. */
  59065. rotationQuaternion: Nullable<Quaternion>;
  59066. /**
  59067. * Stores the scaling vector
  59068. */
  59069. scaling: Vector3;
  59070. /**
  59071. * Convert the Mesh to CSG
  59072. * @param mesh The Mesh to convert to CSG
  59073. * @returns A new CSG from the Mesh
  59074. */
  59075. static FromMesh(mesh: Mesh): CSG;
  59076. /**
  59077. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  59078. * @param polygons Polygons used to construct a CSG solid
  59079. */
  59080. private static FromPolygons;
  59081. /**
  59082. * Clones, or makes a deep copy, of the CSG
  59083. * @returns A new CSG
  59084. */
  59085. clone(): CSG;
  59086. /**
  59087. * Unions this CSG with another CSG
  59088. * @param csg The CSG to union against this CSG
  59089. * @returns The unioned CSG
  59090. */
  59091. union(csg: CSG): CSG;
  59092. /**
  59093. * Unions this CSG with another CSG in place
  59094. * @param csg The CSG to union against this CSG
  59095. */
  59096. unionInPlace(csg: CSG): void;
  59097. /**
  59098. * Subtracts this CSG with another CSG
  59099. * @param csg The CSG to subtract against this CSG
  59100. * @returns A new CSG
  59101. */
  59102. subtract(csg: CSG): CSG;
  59103. /**
  59104. * Subtracts this CSG with another CSG in place
  59105. * @param csg The CSG to subtact against this CSG
  59106. */
  59107. subtractInPlace(csg: CSG): void;
  59108. /**
  59109. * Intersect this CSG with another CSG
  59110. * @param csg The CSG to intersect against this CSG
  59111. * @returns A new CSG
  59112. */
  59113. intersect(csg: CSG): CSG;
  59114. /**
  59115. * Intersects this CSG with another CSG in place
  59116. * @param csg The CSG to intersect against this CSG
  59117. */
  59118. intersectInPlace(csg: CSG): void;
  59119. /**
  59120. * Return a new CSG solid with solid and empty space switched. This solid is
  59121. * not modified.
  59122. * @returns A new CSG solid with solid and empty space switched
  59123. */
  59124. inverse(): CSG;
  59125. /**
  59126. * Inverses the CSG in place
  59127. */
  59128. inverseInPlace(): void;
  59129. /**
  59130. * This is used to keep meshes transformations so they can be restored
  59131. * when we build back a Babylon Mesh
  59132. * NB : All CSG operations are performed in world coordinates
  59133. * @param csg The CSG to copy the transform attributes from
  59134. * @returns This CSG
  59135. */
  59136. copyTransformAttributes(csg: CSG): CSG;
  59137. /**
  59138. * Build Raw mesh from CSG
  59139. * Coordinates here are in world space
  59140. * @param name The name of the mesh geometry
  59141. * @param scene The Scene
  59142. * @param keepSubMeshes Specifies if the submeshes should be kept
  59143. * @returns A new Mesh
  59144. */
  59145. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  59146. /**
  59147. * Build Mesh from CSG taking material and transforms into account
  59148. * @param name The name of the Mesh
  59149. * @param material The material of the Mesh
  59150. * @param scene The Scene
  59151. * @param keepSubMeshes Specifies if submeshes should be kept
  59152. * @returns The new Mesh
  59153. */
  59154. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  59155. }
  59156. }
  59157. declare module "babylonjs/Meshes/trailMesh" {
  59158. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59159. import { Mesh } from "babylonjs/Meshes/mesh";
  59160. import { Scene } from "babylonjs/scene";
  59161. /**
  59162. * Class used to create a trail following a mesh
  59163. */
  59164. export class TrailMesh extends Mesh {
  59165. private _generator;
  59166. private _autoStart;
  59167. private _running;
  59168. private _diameter;
  59169. private _length;
  59170. private _sectionPolygonPointsCount;
  59171. private _sectionVectors;
  59172. private _sectionNormalVectors;
  59173. private _beforeRenderObserver;
  59174. /**
  59175. * @constructor
  59176. * @param name The value used by scene.getMeshByName() to do a lookup.
  59177. * @param generator The mesh to generate a trail.
  59178. * @param scene The scene to add this mesh to.
  59179. * @param diameter Diameter of trailing mesh. Default is 1.
  59180. * @param length Length of trailing mesh. Default is 60.
  59181. * @param autoStart Automatically start trailing mesh. Default true.
  59182. */
  59183. constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  59184. /**
  59185. * "TrailMesh"
  59186. * @returns "TrailMesh"
  59187. */
  59188. getClassName(): string;
  59189. private _createMesh;
  59190. /**
  59191. * Start trailing mesh.
  59192. */
  59193. start(): void;
  59194. /**
  59195. * Stop trailing mesh.
  59196. */
  59197. stop(): void;
  59198. /**
  59199. * Update trailing mesh geometry.
  59200. */
  59201. update(): void;
  59202. /**
  59203. * Returns a new TrailMesh object.
  59204. * @param name is a string, the name given to the new mesh
  59205. * @param newGenerator use new generator object for cloned trail mesh
  59206. * @returns a new mesh
  59207. */
  59208. clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
  59209. /**
  59210. * Serializes this trail mesh
  59211. * @param serializationObject object to write serialization to
  59212. */
  59213. serialize(serializationObject: any): void;
  59214. /**
  59215. * Parses a serialized trail mesh
  59216. * @param parsedMesh the serialized mesh
  59217. * @param scene the scene to create the trail mesh in
  59218. * @returns the created trail mesh
  59219. */
  59220. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  59221. }
  59222. }
  59223. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  59224. import { Nullable } from "babylonjs/types";
  59225. import { Scene } from "babylonjs/scene";
  59226. import { Vector4 } from "babylonjs/Maths/math.vector";
  59227. import { Color4 } from "babylonjs/Maths/math.color";
  59228. import { Mesh } from "babylonjs/Meshes/mesh";
  59229. /**
  59230. * Class containing static functions to help procedurally build meshes
  59231. */
  59232. export class TiledBoxBuilder {
  59233. /**
  59234. * Creates a box mesh
  59235. * 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)
  59236. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  59237. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59238. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59239. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59240. * @param name defines the name of the mesh
  59241. * @param options defines the options used to create the mesh
  59242. * @param scene defines the hosting scene
  59243. * @returns the box mesh
  59244. */
  59245. static CreateTiledBox(name: string, options: {
  59246. pattern?: number;
  59247. width?: number;
  59248. height?: number;
  59249. depth?: number;
  59250. tileSize?: number;
  59251. tileWidth?: number;
  59252. tileHeight?: number;
  59253. alignHorizontal?: number;
  59254. alignVertical?: number;
  59255. faceUV?: Vector4[];
  59256. faceColors?: Color4[];
  59257. sideOrientation?: number;
  59258. updatable?: boolean;
  59259. }, scene?: Nullable<Scene>): Mesh;
  59260. }
  59261. }
  59262. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  59263. import { Vector4 } from "babylonjs/Maths/math.vector";
  59264. import { Mesh } from "babylonjs/Meshes/mesh";
  59265. /**
  59266. * Class containing static functions to help procedurally build meshes
  59267. */
  59268. export class TorusKnotBuilder {
  59269. /**
  59270. * Creates a torus knot mesh
  59271. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  59272. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  59273. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  59274. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  59275. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59276. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59277. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  59278. * @param name defines the name of the mesh
  59279. * @param options defines the options used to create the mesh
  59280. * @param scene defines the hosting scene
  59281. * @returns the torus knot mesh
  59282. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  59283. */
  59284. static CreateTorusKnot(name: string, options: {
  59285. radius?: number;
  59286. tube?: number;
  59287. radialSegments?: number;
  59288. tubularSegments?: number;
  59289. p?: number;
  59290. q?: number;
  59291. updatable?: boolean;
  59292. sideOrientation?: number;
  59293. frontUVs?: Vector4;
  59294. backUVs?: Vector4;
  59295. }, scene: any): Mesh;
  59296. }
  59297. }
  59298. declare module "babylonjs/Meshes/polygonMesh" {
  59299. import { Scene } from "babylonjs/scene";
  59300. import { Vector2 } from "babylonjs/Maths/math.vector";
  59301. import { Mesh } from "babylonjs/Meshes/mesh";
  59302. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  59303. import { Path2 } from "babylonjs/Maths/math.path";
  59304. /**
  59305. * Polygon
  59306. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  59307. */
  59308. export class Polygon {
  59309. /**
  59310. * Creates a rectangle
  59311. * @param xmin bottom X coord
  59312. * @param ymin bottom Y coord
  59313. * @param xmax top X coord
  59314. * @param ymax top Y coord
  59315. * @returns points that make the resulting rectation
  59316. */
  59317. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  59318. /**
  59319. * Creates a circle
  59320. * @param radius radius of circle
  59321. * @param cx scale in x
  59322. * @param cy scale in y
  59323. * @param numberOfSides number of sides that make up the circle
  59324. * @returns points that make the resulting circle
  59325. */
  59326. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  59327. /**
  59328. * Creates a polygon from input string
  59329. * @param input Input polygon data
  59330. * @returns the parsed points
  59331. */
  59332. static Parse(input: string): Vector2[];
  59333. /**
  59334. * Starts building a polygon from x and y coordinates
  59335. * @param x x coordinate
  59336. * @param y y coordinate
  59337. * @returns the started path2
  59338. */
  59339. static StartingAt(x: number, y: number): Path2;
  59340. }
  59341. /**
  59342. * Builds a polygon
  59343. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  59344. */
  59345. export class PolygonMeshBuilder {
  59346. private _points;
  59347. private _outlinepoints;
  59348. private _holes;
  59349. private _name;
  59350. private _scene;
  59351. private _epoints;
  59352. private _eholes;
  59353. private _addToepoint;
  59354. /**
  59355. * Babylon reference to the earcut plugin.
  59356. */
  59357. bjsEarcut: any;
  59358. /**
  59359. * Creates a PolygonMeshBuilder
  59360. * @param name name of the builder
  59361. * @param contours Path of the polygon
  59362. * @param scene scene to add to when creating the mesh
  59363. * @param earcutInjection can be used to inject your own earcut reference
  59364. */
  59365. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  59366. /**
  59367. * Adds a whole within the polygon
  59368. * @param hole Array of points defining the hole
  59369. * @returns this
  59370. */
  59371. addHole(hole: Vector2[]): PolygonMeshBuilder;
  59372. /**
  59373. * Creates the polygon
  59374. * @param updatable If the mesh should be updatable
  59375. * @param depth The depth of the mesh created
  59376. * @returns the created mesh
  59377. */
  59378. build(updatable?: boolean, depth?: number): Mesh;
  59379. /**
  59380. * Creates the polygon
  59381. * @param depth The depth of the mesh created
  59382. * @returns the created VertexData
  59383. */
  59384. buildVertexData(depth?: number): VertexData;
  59385. /**
  59386. * Adds a side to the polygon
  59387. * @param positions points that make the polygon
  59388. * @param normals normals of the polygon
  59389. * @param uvs uvs of the polygon
  59390. * @param indices indices of the polygon
  59391. * @param bounds bounds of the polygon
  59392. * @param points points of the polygon
  59393. * @param depth depth of the polygon
  59394. * @param flip flip of the polygon
  59395. */
  59396. private addSide;
  59397. }
  59398. }
  59399. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  59400. import { Scene } from "babylonjs/scene";
  59401. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  59402. import { Color4 } from "babylonjs/Maths/math.color";
  59403. import { Mesh } from "babylonjs/Meshes/mesh";
  59404. import { Nullable } from "babylonjs/types";
  59405. /**
  59406. * Class containing static functions to help procedurally build meshes
  59407. */
  59408. export class PolygonBuilder {
  59409. /**
  59410. * Creates a polygon mesh
  59411. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  59412. * * 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
  59413. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  59414. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59415. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  59416. * * Remember you can only change the shape positions, not their number when updating a polygon
  59417. * @param name defines the name of the mesh
  59418. * @param options defines the options used to create the mesh
  59419. * @param scene defines the hosting scene
  59420. * @param earcutInjection can be used to inject your own earcut reference
  59421. * @returns the polygon mesh
  59422. */
  59423. static CreatePolygon(name: string, options: {
  59424. shape: Vector3[];
  59425. holes?: Vector3[][];
  59426. depth?: number;
  59427. faceUV?: Vector4[];
  59428. faceColors?: Color4[];
  59429. updatable?: boolean;
  59430. sideOrientation?: number;
  59431. frontUVs?: Vector4;
  59432. backUVs?: Vector4;
  59433. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  59434. /**
  59435. * Creates an extruded polygon mesh, with depth in the Y direction.
  59436. * * 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)
  59437. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  59438. * @param name defines the name of the mesh
  59439. * @param options defines the options used to create the mesh
  59440. * @param scene defines the hosting scene
  59441. * @param earcutInjection can be used to inject your own earcut reference
  59442. * @returns the polygon mesh
  59443. */
  59444. static ExtrudePolygon(name: string, options: {
  59445. shape: Vector3[];
  59446. holes?: Vector3[][];
  59447. depth?: number;
  59448. faceUV?: Vector4[];
  59449. faceColors?: Color4[];
  59450. updatable?: boolean;
  59451. sideOrientation?: number;
  59452. frontUVs?: Vector4;
  59453. backUVs?: Vector4;
  59454. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  59455. }
  59456. }
  59457. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  59458. import { Scene } from "babylonjs/scene";
  59459. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  59460. import { Mesh } from "babylonjs/Meshes/mesh";
  59461. import { Nullable } from "babylonjs/types";
  59462. /**
  59463. * Class containing static functions to help procedurally build meshes
  59464. */
  59465. export class LatheBuilder {
  59466. /**
  59467. * Creates lathe mesh.
  59468. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  59469. * * 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
  59470. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  59471. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  59472. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  59473. * * 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
  59474. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  59475. * * 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
  59476. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59477. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59478. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  59479. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59480. * @param name defines the name of the mesh
  59481. * @param options defines the options used to create the mesh
  59482. * @param scene defines the hosting scene
  59483. * @returns the lathe mesh
  59484. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  59485. */
  59486. static CreateLathe(name: string, options: {
  59487. shape: Vector3[];
  59488. radius?: number;
  59489. tessellation?: number;
  59490. clip?: number;
  59491. arc?: number;
  59492. closed?: boolean;
  59493. updatable?: boolean;
  59494. sideOrientation?: number;
  59495. frontUVs?: Vector4;
  59496. backUVs?: Vector4;
  59497. cap?: number;
  59498. invertUV?: boolean;
  59499. }, scene?: Nullable<Scene>): Mesh;
  59500. }
  59501. }
  59502. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  59503. import { Nullable } from "babylonjs/types";
  59504. import { Scene } from "babylonjs/scene";
  59505. import { Vector4 } from "babylonjs/Maths/math.vector";
  59506. import { Mesh } from "babylonjs/Meshes/mesh";
  59507. /**
  59508. * Class containing static functions to help procedurally build meshes
  59509. */
  59510. export class TiledPlaneBuilder {
  59511. /**
  59512. * Creates a tiled plane mesh
  59513. * * The parameter `pattern` will, depending on value, do nothing or
  59514. * * * flip (reflect about central vertical) alternate tiles across and up
  59515. * * * flip every tile on alternate rows
  59516. * * * rotate (180 degs) alternate tiles across and up
  59517. * * * rotate every tile on alternate rows
  59518. * * * flip and rotate alternate tiles across and up
  59519. * * * flip and rotate every tile on alternate rows
  59520. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  59521. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  59522. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59523. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  59524. * * 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)
  59525. * * 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)
  59526. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  59527. * @param name defines the name of the mesh
  59528. * @param options defines the options used to create the mesh
  59529. * @param scene defines the hosting scene
  59530. * @returns the box mesh
  59531. */
  59532. static CreateTiledPlane(name: string, options: {
  59533. pattern?: number;
  59534. tileSize?: number;
  59535. tileWidth?: number;
  59536. tileHeight?: number;
  59537. size?: number;
  59538. width?: number;
  59539. height?: number;
  59540. alignHorizontal?: number;
  59541. alignVertical?: number;
  59542. sideOrientation?: number;
  59543. frontUVs?: Vector4;
  59544. backUVs?: Vector4;
  59545. updatable?: boolean;
  59546. }, scene?: Nullable<Scene>): Mesh;
  59547. }
  59548. }
  59549. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  59550. import { Nullable } from "babylonjs/types";
  59551. import { Scene } from "babylonjs/scene";
  59552. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  59553. import { Mesh } from "babylonjs/Meshes/mesh";
  59554. /**
  59555. * Class containing static functions to help procedurally build meshes
  59556. */
  59557. export class TubeBuilder {
  59558. /**
  59559. * Creates a tube mesh.
  59560. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  59561. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  59562. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  59563. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  59564. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  59565. * * 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)
  59566. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  59567. * * 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
  59568. * * 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
  59569. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59570. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59571. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  59572. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59573. * @param name defines the name of the mesh
  59574. * @param options defines the options used to create the mesh
  59575. * @param scene defines the hosting scene
  59576. * @returns the tube mesh
  59577. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  59578. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  59579. */
  59580. static CreateTube(name: string, options: {
  59581. path: Vector3[];
  59582. radius?: number;
  59583. tessellation?: number;
  59584. radiusFunction?: {
  59585. (i: number, distance: number): number;
  59586. };
  59587. cap?: number;
  59588. arc?: number;
  59589. updatable?: boolean;
  59590. sideOrientation?: number;
  59591. frontUVs?: Vector4;
  59592. backUVs?: Vector4;
  59593. instance?: Mesh;
  59594. invertUV?: boolean;
  59595. }, scene?: Nullable<Scene>): Mesh;
  59596. }
  59597. }
  59598. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  59599. import { Scene } from "babylonjs/scene";
  59600. import { Vector4 } from "babylonjs/Maths/math.vector";
  59601. import { Mesh } from "babylonjs/Meshes/mesh";
  59602. import { Nullable } from "babylonjs/types";
  59603. /**
  59604. * Class containing static functions to help procedurally build meshes
  59605. */
  59606. export class IcoSphereBuilder {
  59607. /**
  59608. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  59609. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  59610. * * 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`)
  59611. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  59612. * * 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
  59613. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59614. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59615. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59616. * @param name defines the name of the mesh
  59617. * @param options defines the options used to create the mesh
  59618. * @param scene defines the hosting scene
  59619. * @returns the icosahedron mesh
  59620. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  59621. */
  59622. static CreateIcoSphere(name: string, options: {
  59623. radius?: number;
  59624. radiusX?: number;
  59625. radiusY?: number;
  59626. radiusZ?: number;
  59627. flat?: boolean;
  59628. subdivisions?: number;
  59629. sideOrientation?: number;
  59630. frontUVs?: Vector4;
  59631. backUVs?: Vector4;
  59632. updatable?: boolean;
  59633. }, scene?: Nullable<Scene>): Mesh;
  59634. }
  59635. }
  59636. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  59637. import { Vector3 } from "babylonjs/Maths/math.vector";
  59638. import { Mesh } from "babylonjs/Meshes/mesh";
  59639. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59640. /**
  59641. * Class containing static functions to help procedurally build meshes
  59642. */
  59643. export class DecalBuilder {
  59644. /**
  59645. * Creates a decal mesh.
  59646. * 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
  59647. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  59648. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  59649. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  59650. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  59651. * @param name defines the name of the mesh
  59652. * @param sourceMesh defines the mesh where the decal must be applied
  59653. * @param options defines the options used to create the mesh
  59654. * @param scene defines the hosting scene
  59655. * @returns the decal mesh
  59656. * @see https://doc.babylonjs.com/how_to/decals
  59657. */
  59658. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  59659. position?: Vector3;
  59660. normal?: Vector3;
  59661. size?: Vector3;
  59662. angle?: number;
  59663. }): Mesh;
  59664. }
  59665. }
  59666. declare module "babylonjs/Meshes/meshBuilder" {
  59667. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  59668. import { Nullable } from "babylonjs/types";
  59669. import { Scene } from "babylonjs/scene";
  59670. import { Mesh } from "babylonjs/Meshes/mesh";
  59671. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  59672. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  59673. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59674. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  59675. import { Plane } from "babylonjs/Maths/math.plane";
  59676. /**
  59677. * Class containing static functions to help procedurally build meshes
  59678. */
  59679. export class MeshBuilder {
  59680. /**
  59681. * Creates a box mesh
  59682. * * The parameter `size` sets the size (float) of each box side (default 1)
  59683. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  59684. * * 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)
  59685. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  59686. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59687. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59688. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59689. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  59690. * @param name defines the name of the mesh
  59691. * @param options defines the options used to create the mesh
  59692. * @param scene defines the hosting scene
  59693. * @returns the box mesh
  59694. */
  59695. static CreateBox(name: string, options: {
  59696. size?: number;
  59697. width?: number;
  59698. height?: number;
  59699. depth?: number;
  59700. faceUV?: Vector4[];
  59701. faceColors?: Color4[];
  59702. sideOrientation?: number;
  59703. frontUVs?: Vector4;
  59704. backUVs?: Vector4;
  59705. updatable?: boolean;
  59706. }, scene?: Nullable<Scene>): Mesh;
  59707. /**
  59708. * Creates a tiled box mesh
  59709. * * faceTiles sets the pattern, tile size and number of tiles for a face
  59710. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59711. * @param name defines the name of the mesh
  59712. * @param options defines the options used to create the mesh
  59713. * @param scene defines the hosting scene
  59714. * @returns the tiled box mesh
  59715. */
  59716. static CreateTiledBox(name: string, options: {
  59717. pattern?: number;
  59718. size?: number;
  59719. width?: number;
  59720. height?: number;
  59721. depth: number;
  59722. tileSize?: number;
  59723. tileWidth?: number;
  59724. tileHeight?: number;
  59725. faceUV?: Vector4[];
  59726. faceColors?: Color4[];
  59727. alignHorizontal?: number;
  59728. alignVertical?: number;
  59729. sideOrientation?: number;
  59730. updatable?: boolean;
  59731. }, scene?: Nullable<Scene>): Mesh;
  59732. /**
  59733. * Creates a sphere mesh
  59734. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  59735. * * 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`)
  59736. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  59737. * * 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
  59738. * * 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)
  59739. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59740. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59741. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59742. * @param name defines the name of the mesh
  59743. * @param options defines the options used to create the mesh
  59744. * @param scene defines the hosting scene
  59745. * @returns the sphere mesh
  59746. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  59747. */
  59748. static CreateSphere(name: string, options: {
  59749. segments?: number;
  59750. diameter?: number;
  59751. diameterX?: number;
  59752. diameterY?: number;
  59753. diameterZ?: number;
  59754. arc?: number;
  59755. slice?: number;
  59756. sideOrientation?: number;
  59757. frontUVs?: Vector4;
  59758. backUVs?: Vector4;
  59759. updatable?: boolean;
  59760. }, scene?: Nullable<Scene>): Mesh;
  59761. /**
  59762. * Creates a plane polygonal mesh. By default, this is a disc
  59763. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  59764. * * 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
  59765. * * 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
  59766. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59767. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59768. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59769. * @param name defines the name of the mesh
  59770. * @param options defines the options used to create the mesh
  59771. * @param scene defines the hosting scene
  59772. * @returns the plane polygonal mesh
  59773. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  59774. */
  59775. static CreateDisc(name: string, options: {
  59776. radius?: number;
  59777. tessellation?: number;
  59778. arc?: number;
  59779. updatable?: boolean;
  59780. sideOrientation?: number;
  59781. frontUVs?: Vector4;
  59782. backUVs?: Vector4;
  59783. }, scene?: Nullable<Scene>): Mesh;
  59784. /**
  59785. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  59786. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  59787. * * 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`)
  59788. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  59789. * * 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
  59790. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59791. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59792. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59793. * @param name defines the name of the mesh
  59794. * @param options defines the options used to create the mesh
  59795. * @param scene defines the hosting scene
  59796. * @returns the icosahedron mesh
  59797. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  59798. */
  59799. static CreateIcoSphere(name: string, options: {
  59800. radius?: number;
  59801. radiusX?: number;
  59802. radiusY?: number;
  59803. radiusZ?: number;
  59804. flat?: boolean;
  59805. subdivisions?: number;
  59806. sideOrientation?: number;
  59807. frontUVs?: Vector4;
  59808. backUVs?: Vector4;
  59809. updatable?: boolean;
  59810. }, scene?: Nullable<Scene>): Mesh;
  59811. /**
  59812. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  59813. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  59814. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  59815. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  59816. * * 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
  59817. * * 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
  59818. * * 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
  59819. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59820. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59821. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  59822. * * 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
  59823. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  59824. * * 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
  59825. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  59826. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59827. * @param name defines the name of the mesh
  59828. * @param options defines the options used to create the mesh
  59829. * @param scene defines the hosting scene
  59830. * @returns the ribbon mesh
  59831. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  59832. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  59833. */
  59834. static CreateRibbon(name: string, options: {
  59835. pathArray: Vector3[][];
  59836. closeArray?: boolean;
  59837. closePath?: boolean;
  59838. offset?: number;
  59839. updatable?: boolean;
  59840. sideOrientation?: number;
  59841. frontUVs?: Vector4;
  59842. backUVs?: Vector4;
  59843. instance?: Mesh;
  59844. invertUV?: boolean;
  59845. uvs?: Vector2[];
  59846. colors?: Color4[];
  59847. }, scene?: Nullable<Scene>): Mesh;
  59848. /**
  59849. * Creates a cylinder or a cone mesh
  59850. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  59851. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  59852. * * 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.
  59853. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  59854. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  59855. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  59856. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  59857. * * 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).
  59858. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  59859. * * 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).
  59860. * * 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
  59861. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  59862. * * 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
  59863. * * 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.
  59864. * * If `enclose` is false, a ring surface is one element.
  59865. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  59866. * * 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
  59867. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59868. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59869. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  59870. * @param name defines the name of the mesh
  59871. * @param options defines the options used to create the mesh
  59872. * @param scene defines the hosting scene
  59873. * @returns the cylinder mesh
  59874. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  59875. */
  59876. static CreateCylinder(name: string, options: {
  59877. height?: number;
  59878. diameterTop?: number;
  59879. diameterBottom?: number;
  59880. diameter?: number;
  59881. tessellation?: number;
  59882. subdivisions?: number;
  59883. arc?: number;
  59884. faceColors?: Color4[];
  59885. faceUV?: Vector4[];
  59886. updatable?: boolean;
  59887. hasRings?: boolean;
  59888. enclose?: boolean;
  59889. cap?: number;
  59890. sideOrientation?: number;
  59891. frontUVs?: Vector4;
  59892. backUVs?: Vector4;
  59893. }, scene?: Nullable<Scene>): Mesh;
  59894. /**
  59895. * Creates a torus mesh
  59896. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  59897. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  59898. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  59899. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59900. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59901. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  59902. * @param name defines the name of the mesh
  59903. * @param options defines the options used to create the mesh
  59904. * @param scene defines the hosting scene
  59905. * @returns the torus mesh
  59906. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  59907. */
  59908. static CreateTorus(name: string, options: {
  59909. diameter?: number;
  59910. thickness?: number;
  59911. tessellation?: number;
  59912. updatable?: boolean;
  59913. sideOrientation?: number;
  59914. frontUVs?: Vector4;
  59915. backUVs?: Vector4;
  59916. }, scene?: Nullable<Scene>): Mesh;
  59917. /**
  59918. * Creates a torus knot mesh
  59919. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  59920. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  59921. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  59922. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  59923. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59924. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59925. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  59926. * @param name defines the name of the mesh
  59927. * @param options defines the options used to create the mesh
  59928. * @param scene defines the hosting scene
  59929. * @returns the torus knot mesh
  59930. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  59931. */
  59932. static CreateTorusKnot(name: string, options: {
  59933. radius?: number;
  59934. tube?: number;
  59935. radialSegments?: number;
  59936. tubularSegments?: number;
  59937. p?: number;
  59938. q?: number;
  59939. updatable?: boolean;
  59940. sideOrientation?: number;
  59941. frontUVs?: Vector4;
  59942. backUVs?: Vector4;
  59943. }, scene?: Nullable<Scene>): Mesh;
  59944. /**
  59945. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  59946. * * 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
  59947. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  59948. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  59949. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  59950. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  59951. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  59952. * * 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
  59953. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  59954. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59955. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  59956. * @param name defines the name of the new line system
  59957. * @param options defines the options used to create the line system
  59958. * @param scene defines the hosting scene
  59959. * @returns a new line system mesh
  59960. */
  59961. static CreateLineSystem(name: string, options: {
  59962. lines: Vector3[][];
  59963. updatable?: boolean;
  59964. instance?: Nullable<LinesMesh>;
  59965. colors?: Nullable<Color4[][]>;
  59966. useVertexAlpha?: boolean;
  59967. }, scene: Nullable<Scene>): LinesMesh;
  59968. /**
  59969. * Creates a line mesh
  59970. * 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
  59971. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  59972. * * The parameter `points` is an array successive Vector3
  59973. * * 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
  59974. * * The optional parameter `colors` is an array of successive Color4, one per line point
  59975. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  59976. * * When updating an instance, remember that only point positions can change, not the number of points
  59977. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59978. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  59979. * @param name defines the name of the new line system
  59980. * @param options defines the options used to create the line system
  59981. * @param scene defines the hosting scene
  59982. * @returns a new line mesh
  59983. */
  59984. static CreateLines(name: string, options: {
  59985. points: Vector3[];
  59986. updatable?: boolean;
  59987. instance?: Nullable<LinesMesh>;
  59988. colors?: Color4[];
  59989. useVertexAlpha?: boolean;
  59990. }, scene?: Nullable<Scene>): LinesMesh;
  59991. /**
  59992. * Creates a dashed line mesh
  59993. * * 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
  59994. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  59995. * * The parameter `points` is an array successive Vector3
  59996. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  59997. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  59998. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  59999. * * 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
  60000. * * When updating an instance, remember that only point positions can change, not the number of points
  60001. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60002. * @param name defines the name of the mesh
  60003. * @param options defines the options used to create the mesh
  60004. * @param scene defines the hosting scene
  60005. * @returns the dashed line mesh
  60006. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  60007. */
  60008. static CreateDashedLines(name: string, options: {
  60009. points: Vector3[];
  60010. dashSize?: number;
  60011. gapSize?: number;
  60012. dashNb?: number;
  60013. updatable?: boolean;
  60014. instance?: LinesMesh;
  60015. }, scene?: Nullable<Scene>): LinesMesh;
  60016. /**
  60017. * 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.
  60018. * * 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.
  60019. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  60020. * * 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.
  60021. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  60022. * * 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
  60023. * * 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
  60024. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  60025. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60026. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60027. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  60028. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60029. * @param name defines the name of the mesh
  60030. * @param options defines the options used to create the mesh
  60031. * @param scene defines the hosting scene
  60032. * @returns the extruded shape mesh
  60033. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60034. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  60035. */
  60036. static ExtrudeShape(name: string, options: {
  60037. shape: Vector3[];
  60038. path: Vector3[];
  60039. scale?: number;
  60040. rotation?: number;
  60041. cap?: number;
  60042. updatable?: boolean;
  60043. sideOrientation?: number;
  60044. frontUVs?: Vector4;
  60045. backUVs?: Vector4;
  60046. instance?: Mesh;
  60047. invertUV?: boolean;
  60048. }, scene?: Nullable<Scene>): Mesh;
  60049. /**
  60050. * Creates an custom extruded shape mesh.
  60051. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  60052. * * 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.
  60053. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  60054. * * 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
  60055. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  60056. * * 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
  60057. * * It must returns a float value that will be the scale value applied to the shape on each path point
  60058. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  60059. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  60060. * * 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
  60061. * * 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
  60062. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  60063. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60064. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60065. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60066. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60067. * @param name defines the name of the mesh
  60068. * @param options defines the options used to create the mesh
  60069. * @param scene defines the hosting scene
  60070. * @returns the custom extruded shape mesh
  60071. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  60072. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60073. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  60074. */
  60075. static ExtrudeShapeCustom(name: string, options: {
  60076. shape: Vector3[];
  60077. path: Vector3[];
  60078. scaleFunction?: any;
  60079. rotationFunction?: any;
  60080. ribbonCloseArray?: boolean;
  60081. ribbonClosePath?: boolean;
  60082. cap?: number;
  60083. updatable?: boolean;
  60084. sideOrientation?: number;
  60085. frontUVs?: Vector4;
  60086. backUVs?: Vector4;
  60087. instance?: Mesh;
  60088. invertUV?: boolean;
  60089. }, scene?: Nullable<Scene>): Mesh;
  60090. /**
  60091. * Creates lathe mesh.
  60092. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  60093. * * 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
  60094. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  60095. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  60096. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  60097. * * 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
  60098. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  60099. * * 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
  60100. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60101. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60102. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60103. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60104. * @param name defines the name of the mesh
  60105. * @param options defines the options used to create the mesh
  60106. * @param scene defines the hosting scene
  60107. * @returns the lathe mesh
  60108. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  60109. */
  60110. static CreateLathe(name: string, options: {
  60111. shape: Vector3[];
  60112. radius?: number;
  60113. tessellation?: number;
  60114. clip?: number;
  60115. arc?: number;
  60116. closed?: boolean;
  60117. updatable?: boolean;
  60118. sideOrientation?: number;
  60119. frontUVs?: Vector4;
  60120. backUVs?: Vector4;
  60121. cap?: number;
  60122. invertUV?: boolean;
  60123. }, scene?: Nullable<Scene>): Mesh;
  60124. /**
  60125. * Creates a tiled plane mesh
  60126. * * You can set a limited pattern arrangement with the tiles
  60127. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60128. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60129. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60130. * @param name defines the name of the mesh
  60131. * @param options defines the options used to create the mesh
  60132. * @param scene defines the hosting scene
  60133. * @returns the plane mesh
  60134. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  60135. */
  60136. static CreateTiledPlane(name: string, options: {
  60137. pattern?: number;
  60138. tileSize?: number;
  60139. tileWidth?: number;
  60140. tileHeight?: number;
  60141. size?: number;
  60142. width?: number;
  60143. height?: number;
  60144. alignHorizontal?: number;
  60145. alignVertical?: number;
  60146. sideOrientation?: number;
  60147. frontUVs?: Vector4;
  60148. backUVs?: Vector4;
  60149. updatable?: boolean;
  60150. }, scene?: Nullable<Scene>): Mesh;
  60151. /**
  60152. * Creates a plane mesh
  60153. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  60154. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  60155. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  60156. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60157. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60158. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60159. * @param name defines the name of the mesh
  60160. * @param options defines the options used to create the mesh
  60161. * @param scene defines the hosting scene
  60162. * @returns the plane mesh
  60163. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  60164. */
  60165. static CreatePlane(name: string, options: {
  60166. size?: number;
  60167. width?: number;
  60168. height?: number;
  60169. sideOrientation?: number;
  60170. frontUVs?: Vector4;
  60171. backUVs?: Vector4;
  60172. updatable?: boolean;
  60173. sourcePlane?: Plane;
  60174. }, scene?: Nullable<Scene>): Mesh;
  60175. /**
  60176. * Creates a ground mesh
  60177. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  60178. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  60179. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60180. * @param name defines the name of the mesh
  60181. * @param options defines the options used to create the mesh
  60182. * @param scene defines the hosting scene
  60183. * @returns the ground mesh
  60184. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  60185. */
  60186. static CreateGround(name: string, options: {
  60187. width?: number;
  60188. height?: number;
  60189. subdivisions?: number;
  60190. subdivisionsX?: number;
  60191. subdivisionsY?: number;
  60192. updatable?: boolean;
  60193. }, scene?: Nullable<Scene>): Mesh;
  60194. /**
  60195. * Creates a tiled ground mesh
  60196. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  60197. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  60198. * * 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
  60199. * * 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
  60200. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60201. * @param name defines the name of the mesh
  60202. * @param options defines the options used to create the mesh
  60203. * @param scene defines the hosting scene
  60204. * @returns the tiled ground mesh
  60205. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  60206. */
  60207. static CreateTiledGround(name: string, options: {
  60208. xmin: number;
  60209. zmin: number;
  60210. xmax: number;
  60211. zmax: number;
  60212. subdivisions?: {
  60213. w: number;
  60214. h: number;
  60215. };
  60216. precision?: {
  60217. w: number;
  60218. h: number;
  60219. };
  60220. updatable?: boolean;
  60221. }, scene?: Nullable<Scene>): Mesh;
  60222. /**
  60223. * Creates a ground mesh from a height map
  60224. * * The parameter `url` sets the URL of the height map image resource.
  60225. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  60226. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  60227. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  60228. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  60229. * * 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.
  60230. * * 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).
  60231. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  60232. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60233. * @param name defines the name of the mesh
  60234. * @param url defines the url to the height map
  60235. * @param options defines the options used to create the mesh
  60236. * @param scene defines the hosting scene
  60237. * @returns the ground mesh
  60238. * @see https://doc.babylonjs.com/babylon101/height_map
  60239. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  60240. */
  60241. static CreateGroundFromHeightMap(name: string, url: string, options: {
  60242. width?: number;
  60243. height?: number;
  60244. subdivisions?: number;
  60245. minHeight?: number;
  60246. maxHeight?: number;
  60247. colorFilter?: Color3;
  60248. alphaFilter?: number;
  60249. updatable?: boolean;
  60250. onReady?: (mesh: GroundMesh) => void;
  60251. }, scene?: Nullable<Scene>): GroundMesh;
  60252. /**
  60253. * Creates a polygon mesh
  60254. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  60255. * * 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
  60256. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  60257. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60258. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  60259. * * Remember you can only change the shape positions, not their number when updating a polygon
  60260. * @param name defines the name of the mesh
  60261. * @param options defines the options used to create the mesh
  60262. * @param scene defines the hosting scene
  60263. * @param earcutInjection can be used to inject your own earcut reference
  60264. * @returns the polygon mesh
  60265. */
  60266. static CreatePolygon(name: string, options: {
  60267. shape: Vector3[];
  60268. holes?: Vector3[][];
  60269. depth?: number;
  60270. faceUV?: Vector4[];
  60271. faceColors?: Color4[];
  60272. updatable?: boolean;
  60273. sideOrientation?: number;
  60274. frontUVs?: Vector4;
  60275. backUVs?: Vector4;
  60276. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  60277. /**
  60278. * Creates an extruded polygon mesh, with depth in the Y direction.
  60279. * * 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)
  60280. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  60281. * @param name defines the name of the mesh
  60282. * @param options defines the options used to create the mesh
  60283. * @param scene defines the hosting scene
  60284. * @param earcutInjection can be used to inject your own earcut reference
  60285. * @returns the polygon mesh
  60286. */
  60287. static ExtrudePolygon(name: string, options: {
  60288. shape: Vector3[];
  60289. holes?: Vector3[][];
  60290. depth?: number;
  60291. faceUV?: Vector4[];
  60292. faceColors?: Color4[];
  60293. updatable?: boolean;
  60294. sideOrientation?: number;
  60295. frontUVs?: Vector4;
  60296. backUVs?: Vector4;
  60297. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  60298. /**
  60299. * Creates a tube mesh.
  60300. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  60301. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  60302. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  60303. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  60304. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  60305. * * 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)
  60306. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  60307. * * 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
  60308. * * 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
  60309. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60310. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60311. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60312. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60313. * @param name defines the name of the mesh
  60314. * @param options defines the options used to create the mesh
  60315. * @param scene defines the hosting scene
  60316. * @returns the tube mesh
  60317. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60318. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  60319. */
  60320. static CreateTube(name: string, options: {
  60321. path: Vector3[];
  60322. radius?: number;
  60323. tessellation?: number;
  60324. radiusFunction?: {
  60325. (i: number, distance: number): number;
  60326. };
  60327. cap?: number;
  60328. arc?: number;
  60329. updatable?: boolean;
  60330. sideOrientation?: number;
  60331. frontUVs?: Vector4;
  60332. backUVs?: Vector4;
  60333. instance?: Mesh;
  60334. invertUV?: boolean;
  60335. }, scene?: Nullable<Scene>): Mesh;
  60336. /**
  60337. * Creates a polyhedron mesh
  60338. * * 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
  60339. * * The parameter `size` (positive float, default 1) sets the polygon size
  60340. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  60341. * * 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`
  60342. * * 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
  60343. * * 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)`)
  60344. * * 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
  60345. * * 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
  60346. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60347. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60348. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60349. * @param name defines the name of the mesh
  60350. * @param options defines the options used to create the mesh
  60351. * @param scene defines the hosting scene
  60352. * @returns the polyhedron mesh
  60353. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  60354. */
  60355. static CreatePolyhedron(name: string, options: {
  60356. type?: number;
  60357. size?: number;
  60358. sizeX?: number;
  60359. sizeY?: number;
  60360. sizeZ?: number;
  60361. custom?: any;
  60362. faceUV?: Vector4[];
  60363. faceColors?: Color4[];
  60364. flat?: boolean;
  60365. updatable?: boolean;
  60366. sideOrientation?: number;
  60367. frontUVs?: Vector4;
  60368. backUVs?: Vector4;
  60369. }, scene?: Nullable<Scene>): Mesh;
  60370. /**
  60371. * Creates a decal mesh.
  60372. * 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
  60373. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  60374. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  60375. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  60376. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  60377. * @param name defines the name of the mesh
  60378. * @param sourceMesh defines the mesh where the decal must be applied
  60379. * @param options defines the options used to create the mesh
  60380. * @param scene defines the hosting scene
  60381. * @returns the decal mesh
  60382. * @see https://doc.babylonjs.com/how_to/decals
  60383. */
  60384. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  60385. position?: Vector3;
  60386. normal?: Vector3;
  60387. size?: Vector3;
  60388. angle?: number;
  60389. }): Mesh;
  60390. }
  60391. }
  60392. declare module "babylonjs/Meshes/meshSimplification" {
  60393. import { Mesh } from "babylonjs/Meshes/mesh";
  60394. /**
  60395. * A simplifier interface for future simplification implementations
  60396. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60397. */
  60398. export interface ISimplifier {
  60399. /**
  60400. * Simplification of a given mesh according to the given settings.
  60401. * Since this requires computation, it is assumed that the function runs async.
  60402. * @param settings The settings of the simplification, including quality and distance
  60403. * @param successCallback A callback that will be called after the mesh was simplified.
  60404. * @param errorCallback in case of an error, this callback will be called. optional.
  60405. */
  60406. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  60407. }
  60408. /**
  60409. * Expected simplification settings.
  60410. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  60411. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60412. */
  60413. export interface ISimplificationSettings {
  60414. /**
  60415. * Gets or sets the expected quality
  60416. */
  60417. quality: number;
  60418. /**
  60419. * Gets or sets the distance when this optimized version should be used
  60420. */
  60421. distance: number;
  60422. /**
  60423. * Gets an already optimized mesh
  60424. */
  60425. optimizeMesh?: boolean;
  60426. }
  60427. /**
  60428. * Class used to specify simplification options
  60429. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60430. */
  60431. export class SimplificationSettings implements ISimplificationSettings {
  60432. /** expected quality */
  60433. quality: number;
  60434. /** distance when this optimized version should be used */
  60435. distance: number;
  60436. /** already optimized mesh */
  60437. optimizeMesh?: boolean | undefined;
  60438. /**
  60439. * Creates a SimplificationSettings
  60440. * @param quality expected quality
  60441. * @param distance distance when this optimized version should be used
  60442. * @param optimizeMesh already optimized mesh
  60443. */
  60444. constructor(
  60445. /** expected quality */
  60446. quality: number,
  60447. /** distance when this optimized version should be used */
  60448. distance: number,
  60449. /** already optimized mesh */
  60450. optimizeMesh?: boolean | undefined);
  60451. }
  60452. /**
  60453. * Interface used to define a simplification task
  60454. */
  60455. export interface ISimplificationTask {
  60456. /**
  60457. * Array of settings
  60458. */
  60459. settings: Array<ISimplificationSettings>;
  60460. /**
  60461. * Simplification type
  60462. */
  60463. simplificationType: SimplificationType;
  60464. /**
  60465. * Mesh to simplify
  60466. */
  60467. mesh: Mesh;
  60468. /**
  60469. * Callback called on success
  60470. */
  60471. successCallback?: () => void;
  60472. /**
  60473. * Defines if parallel processing can be used
  60474. */
  60475. parallelProcessing: boolean;
  60476. }
  60477. /**
  60478. * Queue used to order the simplification tasks
  60479. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60480. */
  60481. export class SimplificationQueue {
  60482. private _simplificationArray;
  60483. /**
  60484. * Gets a boolean indicating that the process is still running
  60485. */
  60486. running: boolean;
  60487. /**
  60488. * Creates a new queue
  60489. */
  60490. constructor();
  60491. /**
  60492. * Adds a new simplification task
  60493. * @param task defines a task to add
  60494. */
  60495. addTask(task: ISimplificationTask): void;
  60496. /**
  60497. * Execute next task
  60498. */
  60499. executeNext(): void;
  60500. /**
  60501. * Execute a simplification task
  60502. * @param task defines the task to run
  60503. */
  60504. runSimplification(task: ISimplificationTask): void;
  60505. private getSimplifier;
  60506. }
  60507. /**
  60508. * The implemented types of simplification
  60509. * At the moment only Quadratic Error Decimation is implemented
  60510. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60511. */
  60512. export enum SimplificationType {
  60513. /** Quadratic error decimation */
  60514. QUADRATIC = 0
  60515. }
  60516. }
  60517. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  60518. import { Scene } from "babylonjs/scene";
  60519. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  60520. import { ISceneComponent } from "babylonjs/sceneComponent";
  60521. module "babylonjs/scene" {
  60522. interface Scene {
  60523. /** @hidden (Backing field) */
  60524. _simplificationQueue: SimplificationQueue;
  60525. /**
  60526. * Gets or sets the simplification queue attached to the scene
  60527. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60528. */
  60529. simplificationQueue: SimplificationQueue;
  60530. }
  60531. }
  60532. module "babylonjs/Meshes/mesh" {
  60533. interface Mesh {
  60534. /**
  60535. * Simplify the mesh according to the given array of settings.
  60536. * Function will return immediately and will simplify async
  60537. * @param settings a collection of simplification settings
  60538. * @param parallelProcessing should all levels calculate parallel or one after the other
  60539. * @param simplificationType the type of simplification to run
  60540. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  60541. * @returns the current mesh
  60542. */
  60543. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  60544. }
  60545. }
  60546. /**
  60547. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  60548. * created in a scene
  60549. */
  60550. export class SimplicationQueueSceneComponent implements ISceneComponent {
  60551. /**
  60552. * The component name helpfull to identify the component in the list of scene components.
  60553. */
  60554. readonly name: string;
  60555. /**
  60556. * The scene the component belongs to.
  60557. */
  60558. scene: Scene;
  60559. /**
  60560. * Creates a new instance of the component for the given scene
  60561. * @param scene Defines the scene to register the component in
  60562. */
  60563. constructor(scene: Scene);
  60564. /**
  60565. * Registers the component in a given scene
  60566. */
  60567. register(): void;
  60568. /**
  60569. * Rebuilds the elements related to this component in case of
  60570. * context lost for instance.
  60571. */
  60572. rebuild(): void;
  60573. /**
  60574. * Disposes the component and the associated ressources
  60575. */
  60576. dispose(): void;
  60577. private _beforeCameraUpdate;
  60578. }
  60579. }
  60580. declare module "babylonjs/Meshes/Builders/index" {
  60581. export * from "babylonjs/Meshes/Builders/boxBuilder";
  60582. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  60583. export * from "babylonjs/Meshes/Builders/discBuilder";
  60584. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  60585. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  60586. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  60587. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  60588. export * from "babylonjs/Meshes/Builders/torusBuilder";
  60589. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  60590. export * from "babylonjs/Meshes/Builders/linesBuilder";
  60591. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  60592. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  60593. export * from "babylonjs/Meshes/Builders/latheBuilder";
  60594. export * from "babylonjs/Meshes/Builders/planeBuilder";
  60595. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  60596. export * from "babylonjs/Meshes/Builders/groundBuilder";
  60597. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  60598. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  60599. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  60600. export * from "babylonjs/Meshes/Builders/decalBuilder";
  60601. }
  60602. declare module "babylonjs/Meshes/index" {
  60603. export * from "babylonjs/Meshes/abstractMesh";
  60604. export * from "babylonjs/Meshes/buffer";
  60605. export * from "babylonjs/Meshes/Compression/index";
  60606. export * from "babylonjs/Meshes/csg";
  60607. export * from "babylonjs/Meshes/geometry";
  60608. export * from "babylonjs/Meshes/groundMesh";
  60609. export * from "babylonjs/Meshes/trailMesh";
  60610. export * from "babylonjs/Meshes/instancedMesh";
  60611. export * from "babylonjs/Meshes/linesMesh";
  60612. export * from "babylonjs/Meshes/mesh";
  60613. export * from "babylonjs/Meshes/mesh.vertexData";
  60614. export * from "babylonjs/Meshes/meshBuilder";
  60615. export * from "babylonjs/Meshes/meshSimplification";
  60616. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  60617. export * from "babylonjs/Meshes/polygonMesh";
  60618. export * from "babylonjs/Meshes/subMesh";
  60619. export * from "babylonjs/Meshes/meshLODLevel";
  60620. export * from "babylonjs/Meshes/transformNode";
  60621. export * from "babylonjs/Meshes/Builders/index";
  60622. export * from "babylonjs/Meshes/dataBuffer";
  60623. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  60624. }
  60625. declare module "babylonjs/Morph/index" {
  60626. export * from "babylonjs/Morph/morphTarget";
  60627. export * from "babylonjs/Morph/morphTargetManager";
  60628. }
  60629. declare module "babylonjs/Navigation/INavigationEngine" {
  60630. import { TransformNode } from "babylonjs/Meshes/transformNode";
  60631. import { Vector3 } from "babylonjs/Maths/math";
  60632. import { Mesh } from "babylonjs/Meshes/mesh";
  60633. import { Scene } from "babylonjs/scene";
  60634. /**
  60635. * Navigation plugin interface to add navigation constrained by a navigation mesh
  60636. */
  60637. export interface INavigationEnginePlugin {
  60638. /**
  60639. * plugin name
  60640. */
  60641. name: string;
  60642. /**
  60643. * Creates a navigation mesh
  60644. * @param meshes array of all the geometry used to compute the navigatio mesh
  60645. * @param parameters bunch of parameters used to filter geometry
  60646. */
  60647. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  60648. /**
  60649. * Create a navigation mesh debug mesh
  60650. * @param scene is where the mesh will be added
  60651. * @returns debug display mesh
  60652. */
  60653. createDebugNavMesh(scene: Scene): Mesh;
  60654. /**
  60655. * Get a navigation mesh constrained position, closest to the parameter position
  60656. * @param position world position
  60657. * @returns the closest point to position constrained by the navigation mesh
  60658. */
  60659. getClosestPoint(position: Vector3): Vector3;
  60660. /**
  60661. * Get a navigation mesh constrained position, within a particular radius
  60662. * @param position world position
  60663. * @param maxRadius the maximum distance to the constrained world position
  60664. * @returns the closest point to position constrained by the navigation mesh
  60665. */
  60666. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  60667. /**
  60668. * Compute the final position from a segment made of destination-position
  60669. * @param position world position
  60670. * @param destination world position
  60671. * @returns the resulting point along the navmesh
  60672. */
  60673. moveAlong(position: Vector3, destination: Vector3): Vector3;
  60674. /**
  60675. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  60676. * @param start world position
  60677. * @param end world position
  60678. * @returns array containing world position composing the path
  60679. */
  60680. computePath(start: Vector3, end: Vector3): Vector3[];
  60681. /**
  60682. * If this plugin is supported
  60683. * @returns true if plugin is supported
  60684. */
  60685. isSupported(): boolean;
  60686. /**
  60687. * Create a new Crowd so you can add agents
  60688. * @param maxAgents the maximum agent count in the crowd
  60689. * @param maxAgentRadius the maximum radius an agent can have
  60690. * @param scene to attach the crowd to
  60691. * @returns the crowd you can add agents to
  60692. */
  60693. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  60694. /**
  60695. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  60696. * The queries will try to find a solution within those bounds
  60697. * default is (1,1,1)
  60698. * @param extent x,y,z value that define the extent around the queries point of reference
  60699. */
  60700. setDefaultQueryExtent(extent: Vector3): void;
  60701. /**
  60702. * Get the Bounding box extent specified by setDefaultQueryExtent
  60703. * @returns the box extent values
  60704. */
  60705. getDefaultQueryExtent(): Vector3;
  60706. /**
  60707. * Release all resources
  60708. */
  60709. dispose(): void;
  60710. }
  60711. /**
  60712. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  60713. */
  60714. export interface ICrowd {
  60715. /**
  60716. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  60717. * You can attach anything to that node. The node position is updated in the scene update tick.
  60718. * @param pos world position that will be constrained by the navigation mesh
  60719. * @param parameters agent parameters
  60720. * @param transform hooked to the agent that will be update by the scene
  60721. * @returns agent index
  60722. */
  60723. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  60724. /**
  60725. * Returns the agent position in world space
  60726. * @param index agent index returned by addAgent
  60727. * @returns world space position
  60728. */
  60729. getAgentPosition(index: number): Vector3;
  60730. /**
  60731. * Gets the agent velocity in world space
  60732. * @param index agent index returned by addAgent
  60733. * @returns world space velocity
  60734. */
  60735. getAgentVelocity(index: number): Vector3;
  60736. /**
  60737. * remove a particular agent previously created
  60738. * @param index agent index returned by addAgent
  60739. */
  60740. removeAgent(index: number): void;
  60741. /**
  60742. * get the list of all agents attached to this crowd
  60743. * @returns list of agent indices
  60744. */
  60745. getAgents(): number[];
  60746. /**
  60747. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  60748. * @param deltaTime in seconds
  60749. */
  60750. update(deltaTime: number): void;
  60751. /**
  60752. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  60753. * @param index agent index returned by addAgent
  60754. * @param destination targeted world position
  60755. */
  60756. agentGoto(index: number, destination: Vector3): void;
  60757. /**
  60758. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  60759. * The queries will try to find a solution within those bounds
  60760. * default is (1,1,1)
  60761. * @param extent x,y,z value that define the extent around the queries point of reference
  60762. */
  60763. setDefaultQueryExtent(extent: Vector3): void;
  60764. /**
  60765. * Get the Bounding box extent specified by setDefaultQueryExtent
  60766. * @returns the box extent values
  60767. */
  60768. getDefaultQueryExtent(): Vector3;
  60769. /**
  60770. * Release all resources
  60771. */
  60772. dispose(): void;
  60773. }
  60774. /**
  60775. * Configures an agent
  60776. */
  60777. export interface IAgentParameters {
  60778. /**
  60779. * Agent radius. [Limit: >= 0]
  60780. */
  60781. radius: number;
  60782. /**
  60783. * Agent height. [Limit: > 0]
  60784. */
  60785. height: number;
  60786. /**
  60787. * Maximum allowed acceleration. [Limit: >= 0]
  60788. */
  60789. maxAcceleration: number;
  60790. /**
  60791. * Maximum allowed speed. [Limit: >= 0]
  60792. */
  60793. maxSpeed: number;
  60794. /**
  60795. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  60796. */
  60797. collisionQueryRange: number;
  60798. /**
  60799. * The path visibility optimization range. [Limit: > 0]
  60800. */
  60801. pathOptimizationRange: number;
  60802. /**
  60803. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  60804. */
  60805. separationWeight: number;
  60806. }
  60807. /**
  60808. * Configures the navigation mesh creation
  60809. */
  60810. export interface INavMeshParameters {
  60811. /**
  60812. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  60813. */
  60814. cs: number;
  60815. /**
  60816. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  60817. */
  60818. ch: number;
  60819. /**
  60820. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  60821. */
  60822. walkableSlopeAngle: number;
  60823. /**
  60824. * Minimum floor to 'ceiling' height that will still allow the floor area to
  60825. * be considered walkable. [Limit: >= 3] [Units: vx]
  60826. */
  60827. walkableHeight: number;
  60828. /**
  60829. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  60830. */
  60831. walkableClimb: number;
  60832. /**
  60833. * The distance to erode/shrink the walkable area of the heightfield away from
  60834. * obstructions. [Limit: >=0] [Units: vx]
  60835. */
  60836. walkableRadius: number;
  60837. /**
  60838. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  60839. */
  60840. maxEdgeLen: number;
  60841. /**
  60842. * The maximum distance a simplfied contour's border edges should deviate
  60843. * the original raw contour. [Limit: >=0] [Units: vx]
  60844. */
  60845. maxSimplificationError: number;
  60846. /**
  60847. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  60848. */
  60849. minRegionArea: number;
  60850. /**
  60851. * Any regions with a span count smaller than this value will, if possible,
  60852. * be merged with larger regions. [Limit: >=0] [Units: vx]
  60853. */
  60854. mergeRegionArea: number;
  60855. /**
  60856. * The maximum number of vertices allowed for polygons generated during the
  60857. * contour to polygon conversion process. [Limit: >= 3]
  60858. */
  60859. maxVertsPerPoly: number;
  60860. /**
  60861. * Sets the sampling distance to use when generating the detail mesh.
  60862. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  60863. */
  60864. detailSampleDist: number;
  60865. /**
  60866. * The maximum distance the detail mesh surface should deviate from heightfield
  60867. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  60868. */
  60869. detailSampleMaxError: number;
  60870. }
  60871. }
  60872. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  60873. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  60874. import { Mesh } from "babylonjs/Meshes/mesh";
  60875. import { Scene } from "babylonjs/scene";
  60876. import { Vector3 } from "babylonjs/Maths/math";
  60877. import { TransformNode } from "babylonjs/Meshes/transformNode";
  60878. /**
  60879. * RecastJS navigation plugin
  60880. */
  60881. export class RecastJSPlugin implements INavigationEnginePlugin {
  60882. /**
  60883. * Reference to the Recast library
  60884. */
  60885. bjsRECAST: any;
  60886. /**
  60887. * plugin name
  60888. */
  60889. name: string;
  60890. /**
  60891. * the first navmesh created. We might extend this to support multiple navmeshes
  60892. */
  60893. navMesh: any;
  60894. /**
  60895. * Initializes the recastJS plugin
  60896. * @param recastInjection can be used to inject your own recast reference
  60897. */
  60898. constructor(recastInjection?: any);
  60899. /**
  60900. * Creates a navigation mesh
  60901. * @param meshes array of all the geometry used to compute the navigatio mesh
  60902. * @param parameters bunch of parameters used to filter geometry
  60903. */
  60904. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  60905. /**
  60906. * Create a navigation mesh debug mesh
  60907. * @param scene is where the mesh will be added
  60908. * @returns debug display mesh
  60909. */
  60910. createDebugNavMesh(scene: Scene): Mesh;
  60911. /**
  60912. * Get a navigation mesh constrained position, closest to the parameter position
  60913. * @param position world position
  60914. * @returns the closest point to position constrained by the navigation mesh
  60915. */
  60916. getClosestPoint(position: Vector3): Vector3;
  60917. /**
  60918. * Get a navigation mesh constrained position, within a particular radius
  60919. * @param position world position
  60920. * @param maxRadius the maximum distance to the constrained world position
  60921. * @returns the closest point to position constrained by the navigation mesh
  60922. */
  60923. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  60924. /**
  60925. * Compute the final position from a segment made of destination-position
  60926. * @param position world position
  60927. * @param destination world position
  60928. * @returns the resulting point along the navmesh
  60929. */
  60930. moveAlong(position: Vector3, destination: Vector3): Vector3;
  60931. /**
  60932. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  60933. * @param start world position
  60934. * @param end world position
  60935. * @returns array containing world position composing the path
  60936. */
  60937. computePath(start: Vector3, end: Vector3): Vector3[];
  60938. /**
  60939. * Create a new Crowd so you can add agents
  60940. * @param maxAgents the maximum agent count in the crowd
  60941. * @param maxAgentRadius the maximum radius an agent can have
  60942. * @param scene to attach the crowd to
  60943. * @returns the crowd you can add agents to
  60944. */
  60945. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  60946. /**
  60947. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  60948. * The queries will try to find a solution within those bounds
  60949. * default is (1,1,1)
  60950. * @param extent x,y,z value that define the extent around the queries point of reference
  60951. */
  60952. setDefaultQueryExtent(extent: Vector3): void;
  60953. /**
  60954. * Get the Bounding box extent specified by setDefaultQueryExtent
  60955. * @returns the box extent values
  60956. */
  60957. getDefaultQueryExtent(): Vector3;
  60958. /**
  60959. * Disposes
  60960. */
  60961. dispose(): void;
  60962. /**
  60963. * If this plugin is supported
  60964. * @returns true if plugin is supported
  60965. */
  60966. isSupported(): boolean;
  60967. }
  60968. /**
  60969. * Recast detour crowd implementation
  60970. */
  60971. export class RecastJSCrowd implements ICrowd {
  60972. /**
  60973. * Recast/detour plugin
  60974. */
  60975. bjsRECASTPlugin: RecastJSPlugin;
  60976. /**
  60977. * Link to the detour crowd
  60978. */
  60979. recastCrowd: any;
  60980. /**
  60981. * One transform per agent
  60982. */
  60983. transforms: TransformNode[];
  60984. /**
  60985. * All agents created
  60986. */
  60987. agents: number[];
  60988. /**
  60989. * Link to the scene is kept to unregister the crowd from the scene
  60990. */
  60991. private _scene;
  60992. /**
  60993. * Observer for crowd updates
  60994. */
  60995. private _onBeforeAnimationsObserver;
  60996. /**
  60997. * Constructor
  60998. * @param plugin recastJS plugin
  60999. * @param maxAgents the maximum agent count in the crowd
  61000. * @param maxAgentRadius the maximum radius an agent can have
  61001. * @param scene to attach the crowd to
  61002. * @returns the crowd you can add agents to
  61003. */
  61004. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  61005. /**
  61006. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  61007. * You can attach anything to that node. The node position is updated in the scene update tick.
  61008. * @param pos world position that will be constrained by the navigation mesh
  61009. * @param parameters agent parameters
  61010. * @param transform hooked to the agent that will be update by the scene
  61011. * @returns agent index
  61012. */
  61013. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  61014. /**
  61015. * Returns the agent position in world space
  61016. * @param index agent index returned by addAgent
  61017. * @returns world space position
  61018. */
  61019. getAgentPosition(index: number): Vector3;
  61020. /**
  61021. * Returns the agent velocity in world space
  61022. * @param index agent index returned by addAgent
  61023. * @returns world space velocity
  61024. */
  61025. getAgentVelocity(index: number): Vector3;
  61026. /**
  61027. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  61028. * @param index agent index returned by addAgent
  61029. * @param destination targeted world position
  61030. */
  61031. agentGoto(index: number, destination: Vector3): void;
  61032. /**
  61033. * remove a particular agent previously created
  61034. * @param index agent index returned by addAgent
  61035. */
  61036. removeAgent(index: number): void;
  61037. /**
  61038. * get the list of all agents attached to this crowd
  61039. * @returns list of agent indices
  61040. */
  61041. getAgents(): number[];
  61042. /**
  61043. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  61044. * @param deltaTime in seconds
  61045. */
  61046. update(deltaTime: number): void;
  61047. /**
  61048. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61049. * The queries will try to find a solution within those bounds
  61050. * default is (1,1,1)
  61051. * @param extent x,y,z value that define the extent around the queries point of reference
  61052. */
  61053. setDefaultQueryExtent(extent: Vector3): void;
  61054. /**
  61055. * Get the Bounding box extent specified by setDefaultQueryExtent
  61056. * @returns the box extent values
  61057. */
  61058. getDefaultQueryExtent(): Vector3;
  61059. /**
  61060. * Release all resources
  61061. */
  61062. dispose(): void;
  61063. }
  61064. }
  61065. declare module "babylonjs/Navigation/Plugins/index" {
  61066. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  61067. }
  61068. declare module "babylonjs/Navigation/index" {
  61069. export * from "babylonjs/Navigation/INavigationEngine";
  61070. export * from "babylonjs/Navigation/Plugins/index";
  61071. }
  61072. declare module "babylonjs/Offline/database" {
  61073. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  61074. /**
  61075. * Class used to enable access to IndexedDB
  61076. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  61077. */
  61078. export class Database implements IOfflineProvider {
  61079. private _callbackManifestChecked;
  61080. private _currentSceneUrl;
  61081. private _db;
  61082. private _enableSceneOffline;
  61083. private _enableTexturesOffline;
  61084. private _manifestVersionFound;
  61085. private _mustUpdateRessources;
  61086. private _hasReachedQuota;
  61087. private _isSupported;
  61088. private _idbFactory;
  61089. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  61090. private static IsUASupportingBlobStorage;
  61091. /**
  61092. * Gets a boolean indicating if Database storate is enabled (off by default)
  61093. */
  61094. static IDBStorageEnabled: boolean;
  61095. /**
  61096. * Gets a boolean indicating if scene must be saved in the database
  61097. */
  61098. readonly enableSceneOffline: boolean;
  61099. /**
  61100. * Gets a boolean indicating if textures must be saved in the database
  61101. */
  61102. readonly enableTexturesOffline: boolean;
  61103. /**
  61104. * Creates a new Database
  61105. * @param urlToScene defines the url to load the scene
  61106. * @param callbackManifestChecked defines the callback to use when manifest is checked
  61107. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  61108. */
  61109. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  61110. private static _ParseURL;
  61111. private static _ReturnFullUrlLocation;
  61112. private _checkManifestFile;
  61113. /**
  61114. * Open the database and make it available
  61115. * @param successCallback defines the callback to call on success
  61116. * @param errorCallback defines the callback to call on error
  61117. */
  61118. open(successCallback: () => void, errorCallback: () => void): void;
  61119. /**
  61120. * Loads an image from the database
  61121. * @param url defines the url to load from
  61122. * @param image defines the target DOM image
  61123. */
  61124. loadImage(url: string, image: HTMLImageElement): void;
  61125. private _loadImageFromDBAsync;
  61126. private _saveImageIntoDBAsync;
  61127. private _checkVersionFromDB;
  61128. private _loadVersionFromDBAsync;
  61129. private _saveVersionIntoDBAsync;
  61130. /**
  61131. * Loads a file from database
  61132. * @param url defines the URL to load from
  61133. * @param sceneLoaded defines a callback to call on success
  61134. * @param progressCallBack defines a callback to call when progress changed
  61135. * @param errorCallback defines a callback to call on error
  61136. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  61137. */
  61138. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  61139. private _loadFileAsync;
  61140. private _saveFileAsync;
  61141. /**
  61142. * Validates if xhr data is correct
  61143. * @param xhr defines the request to validate
  61144. * @param dataType defines the expected data type
  61145. * @returns true if data is correct
  61146. */
  61147. private static _ValidateXHRData;
  61148. }
  61149. }
  61150. declare module "babylonjs/Offline/index" {
  61151. export * from "babylonjs/Offline/database";
  61152. export * from "babylonjs/Offline/IOfflineProvider";
  61153. }
  61154. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  61155. /** @hidden */
  61156. export var gpuUpdateParticlesPixelShader: {
  61157. name: string;
  61158. shader: string;
  61159. };
  61160. }
  61161. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  61162. /** @hidden */
  61163. export var gpuUpdateParticlesVertexShader: {
  61164. name: string;
  61165. shader: string;
  61166. };
  61167. }
  61168. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  61169. /** @hidden */
  61170. export var clipPlaneFragmentDeclaration2: {
  61171. name: string;
  61172. shader: string;
  61173. };
  61174. }
  61175. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  61176. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  61177. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  61178. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61179. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  61180. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  61181. /** @hidden */
  61182. export var gpuRenderParticlesPixelShader: {
  61183. name: string;
  61184. shader: string;
  61185. };
  61186. }
  61187. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  61188. /** @hidden */
  61189. export var clipPlaneVertexDeclaration2: {
  61190. name: string;
  61191. shader: string;
  61192. };
  61193. }
  61194. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  61195. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  61196. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  61197. /** @hidden */
  61198. export var gpuRenderParticlesVertexShader: {
  61199. name: string;
  61200. shader: string;
  61201. };
  61202. }
  61203. declare module "babylonjs/Particles/gpuParticleSystem" {
  61204. import { Nullable } from "babylonjs/types";
  61205. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  61206. import { Observable } from "babylonjs/Misc/observable";
  61207. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61208. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  61209. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  61210. import { Scene, IDisposable } from "babylonjs/scene";
  61211. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  61212. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  61213. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  61214. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  61215. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  61216. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  61217. /**
  61218. * This represents a GPU particle system in Babylon
  61219. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  61220. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  61221. */
  61222. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  61223. /**
  61224. * The layer mask we are rendering the particles through.
  61225. */
  61226. layerMask: number;
  61227. private _capacity;
  61228. private _activeCount;
  61229. private _currentActiveCount;
  61230. private _accumulatedCount;
  61231. private _renderEffect;
  61232. private _updateEffect;
  61233. private _buffer0;
  61234. private _buffer1;
  61235. private _spriteBuffer;
  61236. private _updateVAO;
  61237. private _renderVAO;
  61238. private _targetIndex;
  61239. private _sourceBuffer;
  61240. private _targetBuffer;
  61241. private _engine;
  61242. private _currentRenderId;
  61243. private _started;
  61244. private _stopped;
  61245. private _timeDelta;
  61246. private _randomTexture;
  61247. private _randomTexture2;
  61248. private _attributesStrideSize;
  61249. private _updateEffectOptions;
  61250. private _randomTextureSize;
  61251. private _actualFrame;
  61252. private readonly _rawTextureWidth;
  61253. /**
  61254. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  61255. */
  61256. static readonly IsSupported: boolean;
  61257. /**
  61258. * An event triggered when the system is disposed.
  61259. */
  61260. onDisposeObservable: Observable<GPUParticleSystem>;
  61261. /**
  61262. * Gets the maximum number of particles active at the same time.
  61263. * @returns The max number of active particles.
  61264. */
  61265. getCapacity(): number;
  61266. /**
  61267. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  61268. * to override the particles.
  61269. */
  61270. forceDepthWrite: boolean;
  61271. /**
  61272. * Gets or set the number of active particles
  61273. */
  61274. activeParticleCount: number;
  61275. private _preWarmDone;
  61276. /**
  61277. * Is this system ready to be used/rendered
  61278. * @return true if the system is ready
  61279. */
  61280. isReady(): boolean;
  61281. /**
  61282. * Gets if the system has been started. (Note: this will still be true after stop is called)
  61283. * @returns True if it has been started, otherwise false.
  61284. */
  61285. isStarted(): boolean;
  61286. /**
  61287. * Starts the particle system and begins to emit
  61288. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  61289. */
  61290. start(delay?: number): void;
  61291. /**
  61292. * Stops the particle system.
  61293. */
  61294. stop(): void;
  61295. /**
  61296. * Remove all active particles
  61297. */
  61298. reset(): void;
  61299. /**
  61300. * Returns the string "GPUParticleSystem"
  61301. * @returns a string containing the class name
  61302. */
  61303. getClassName(): string;
  61304. private _colorGradientsTexture;
  61305. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  61306. /**
  61307. * Adds a new color gradient
  61308. * @param gradient defines the gradient to use (between 0 and 1)
  61309. * @param color1 defines the color to affect to the specified gradient
  61310. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  61311. * @returns the current particle system
  61312. */
  61313. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  61314. /**
  61315. * Remove a specific color gradient
  61316. * @param gradient defines the gradient to remove
  61317. * @returns the current particle system
  61318. */
  61319. removeColorGradient(gradient: number): GPUParticleSystem;
  61320. private _angularSpeedGradientsTexture;
  61321. private _sizeGradientsTexture;
  61322. private _velocityGradientsTexture;
  61323. private _limitVelocityGradientsTexture;
  61324. private _dragGradientsTexture;
  61325. private _addFactorGradient;
  61326. /**
  61327. * Adds a new size gradient
  61328. * @param gradient defines the gradient to use (between 0 and 1)
  61329. * @param factor defines the size factor to affect to the specified gradient
  61330. * @returns the current particle system
  61331. */
  61332. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  61333. /**
  61334. * Remove a specific size gradient
  61335. * @param gradient defines the gradient to remove
  61336. * @returns the current particle system
  61337. */
  61338. removeSizeGradient(gradient: number): GPUParticleSystem;
  61339. /**
  61340. * Adds a new angular speed gradient
  61341. * @param gradient defines the gradient to use (between 0 and 1)
  61342. * @param factor defines the angular speed to affect to the specified gradient
  61343. * @returns the current particle system
  61344. */
  61345. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  61346. /**
  61347. * Remove a specific angular speed gradient
  61348. * @param gradient defines the gradient to remove
  61349. * @returns the current particle system
  61350. */
  61351. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  61352. /**
  61353. * Adds a new velocity gradient
  61354. * @param gradient defines the gradient to use (between 0 and 1)
  61355. * @param factor defines the velocity to affect to the specified gradient
  61356. * @returns the current particle system
  61357. */
  61358. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  61359. /**
  61360. * Remove a specific velocity gradient
  61361. * @param gradient defines the gradient to remove
  61362. * @returns the current particle system
  61363. */
  61364. removeVelocityGradient(gradient: number): GPUParticleSystem;
  61365. /**
  61366. * Adds a new limit velocity gradient
  61367. * @param gradient defines the gradient to use (between 0 and 1)
  61368. * @param factor defines the limit velocity value to affect to the specified gradient
  61369. * @returns the current particle system
  61370. */
  61371. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  61372. /**
  61373. * Remove a specific limit velocity gradient
  61374. * @param gradient defines the gradient to remove
  61375. * @returns the current particle system
  61376. */
  61377. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  61378. /**
  61379. * Adds a new drag gradient
  61380. * @param gradient defines the gradient to use (between 0 and 1)
  61381. * @param factor defines the drag value to affect to the specified gradient
  61382. * @returns the current particle system
  61383. */
  61384. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  61385. /**
  61386. * Remove a specific drag gradient
  61387. * @param gradient defines the gradient to remove
  61388. * @returns the current particle system
  61389. */
  61390. removeDragGradient(gradient: number): GPUParticleSystem;
  61391. /**
  61392. * Not supported by GPUParticleSystem
  61393. * @param gradient defines the gradient to use (between 0 and 1)
  61394. * @param factor defines the emit rate value to affect to the specified gradient
  61395. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  61396. * @returns the current particle system
  61397. */
  61398. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  61399. /**
  61400. * Not supported by GPUParticleSystem
  61401. * @param gradient defines the gradient to remove
  61402. * @returns the current particle system
  61403. */
  61404. removeEmitRateGradient(gradient: number): IParticleSystem;
  61405. /**
  61406. * Not supported by GPUParticleSystem
  61407. * @param gradient defines the gradient to use (between 0 and 1)
  61408. * @param factor defines the start size value to affect to the specified gradient
  61409. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  61410. * @returns the current particle system
  61411. */
  61412. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  61413. /**
  61414. * Not supported by GPUParticleSystem
  61415. * @param gradient defines the gradient to remove
  61416. * @returns the current particle system
  61417. */
  61418. removeStartSizeGradient(gradient: number): IParticleSystem;
  61419. /**
  61420. * Not supported by GPUParticleSystem
  61421. * @param gradient defines the gradient to use (between 0 and 1)
  61422. * @param min defines the color remap minimal range
  61423. * @param max defines the color remap maximal range
  61424. * @returns the current particle system
  61425. */
  61426. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  61427. /**
  61428. * Not supported by GPUParticleSystem
  61429. * @param gradient defines the gradient to remove
  61430. * @returns the current particle system
  61431. */
  61432. removeColorRemapGradient(): IParticleSystem;
  61433. /**
  61434. * Not supported by GPUParticleSystem
  61435. * @param gradient defines the gradient to use (between 0 and 1)
  61436. * @param min defines the alpha remap minimal range
  61437. * @param max defines the alpha remap maximal range
  61438. * @returns the current particle system
  61439. */
  61440. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  61441. /**
  61442. * Not supported by GPUParticleSystem
  61443. * @param gradient defines the gradient to remove
  61444. * @returns the current particle system
  61445. */
  61446. removeAlphaRemapGradient(): IParticleSystem;
  61447. /**
  61448. * Not supported by GPUParticleSystem
  61449. * @param gradient defines the gradient to use (between 0 and 1)
  61450. * @param color defines the color to affect to the specified gradient
  61451. * @returns the current particle system
  61452. */
  61453. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  61454. /**
  61455. * Not supported by GPUParticleSystem
  61456. * @param gradient defines the gradient to remove
  61457. * @returns the current particle system
  61458. */
  61459. removeRampGradient(): IParticleSystem;
  61460. /**
  61461. * Not supported by GPUParticleSystem
  61462. * @returns the list of ramp gradients
  61463. */
  61464. getRampGradients(): Nullable<Array<Color3Gradient>>;
  61465. /**
  61466. * Not supported by GPUParticleSystem
  61467. * Gets or sets a boolean indicating that ramp gradients must be used
  61468. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  61469. */
  61470. useRampGradients: boolean;
  61471. /**
  61472. * Not supported by GPUParticleSystem
  61473. * @param gradient defines the gradient to use (between 0 and 1)
  61474. * @param factor defines the life time factor to affect to the specified gradient
  61475. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  61476. * @returns the current particle system
  61477. */
  61478. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  61479. /**
  61480. * Not supported by GPUParticleSystem
  61481. * @param gradient defines the gradient to remove
  61482. * @returns the current particle system
  61483. */
  61484. removeLifeTimeGradient(gradient: number): IParticleSystem;
  61485. /**
  61486. * Instantiates a GPU particle system.
  61487. * 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.
  61488. * @param name The name of the particle system
  61489. * @param options The options used to create the system
  61490. * @param scene The scene the particle system belongs to
  61491. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  61492. */
  61493. constructor(name: string, options: Partial<{
  61494. capacity: number;
  61495. randomTextureSize: number;
  61496. }>, scene: Scene, isAnimationSheetEnabled?: boolean);
  61497. protected _reset(): void;
  61498. private _createUpdateVAO;
  61499. private _createRenderVAO;
  61500. private _initialize;
  61501. /** @hidden */
  61502. _recreateUpdateEffect(): void;
  61503. /** @hidden */
  61504. _recreateRenderEffect(): void;
  61505. /**
  61506. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  61507. * @param preWarm defines if we are in the pre-warmimg phase
  61508. */
  61509. animate(preWarm?: boolean): void;
  61510. private _createFactorGradientTexture;
  61511. private _createSizeGradientTexture;
  61512. private _createAngularSpeedGradientTexture;
  61513. private _createVelocityGradientTexture;
  61514. private _createLimitVelocityGradientTexture;
  61515. private _createDragGradientTexture;
  61516. private _createColorGradientTexture;
  61517. /**
  61518. * Renders the particle system in its current state
  61519. * @param preWarm defines if the system should only update the particles but not render them
  61520. * @returns the current number of particles
  61521. */
  61522. render(preWarm?: boolean): number;
  61523. /**
  61524. * Rebuilds the particle system
  61525. */
  61526. rebuild(): void;
  61527. private _releaseBuffers;
  61528. private _releaseVAOs;
  61529. /**
  61530. * Disposes the particle system and free the associated resources
  61531. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  61532. */
  61533. dispose(disposeTexture?: boolean): void;
  61534. /**
  61535. * Clones the particle system.
  61536. * @param name The name of the cloned object
  61537. * @param newEmitter The new emitter to use
  61538. * @returns the cloned particle system
  61539. */
  61540. clone(name: string, newEmitter: any): GPUParticleSystem;
  61541. /**
  61542. * Serializes the particle system to a JSON object.
  61543. * @returns the JSON object
  61544. */
  61545. serialize(): any;
  61546. /**
  61547. * Parses a JSON object to create a GPU particle system.
  61548. * @param parsedParticleSystem The JSON object to parse
  61549. * @param scene The scene to create the particle system in
  61550. * @param rootUrl The root url to use to load external dependencies like texture
  61551. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  61552. * @returns the parsed GPU particle system
  61553. */
  61554. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  61555. }
  61556. }
  61557. declare module "babylonjs/Particles/particleSystemSet" {
  61558. import { Nullable } from "babylonjs/types";
  61559. import { Color3 } from "babylonjs/Maths/math.color";
  61560. import { TransformNode } from "babylonjs/Meshes/transformNode";
  61561. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61562. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  61563. import { Scene, IDisposable } from "babylonjs/scene";
  61564. /**
  61565. * Represents a set of particle systems working together to create a specific effect
  61566. */
  61567. export class ParticleSystemSet implements IDisposable {
  61568. /**
  61569. * Gets or sets base Assets URL
  61570. */
  61571. static BaseAssetsUrl: string;
  61572. private _emitterCreationOptions;
  61573. private _emitterNode;
  61574. /**
  61575. * Gets the particle system list
  61576. */
  61577. systems: IParticleSystem[];
  61578. /**
  61579. * Gets the emitter node used with this set
  61580. */
  61581. readonly emitterNode: Nullable<TransformNode>;
  61582. /**
  61583. * Creates a new emitter mesh as a sphere
  61584. * @param options defines the options used to create the sphere
  61585. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  61586. * @param scene defines the hosting scene
  61587. */
  61588. setEmitterAsSphere(options: {
  61589. diameter: number;
  61590. segments: number;
  61591. color: Color3;
  61592. }, renderingGroupId: number, scene: Scene): void;
  61593. /**
  61594. * Starts all particle systems of the set
  61595. * @param emitter defines an optional mesh to use as emitter for the particle systems
  61596. */
  61597. start(emitter?: AbstractMesh): void;
  61598. /**
  61599. * Release all associated resources
  61600. */
  61601. dispose(): void;
  61602. /**
  61603. * Serialize the set into a JSON compatible object
  61604. * @returns a JSON compatible representation of the set
  61605. */
  61606. serialize(): any;
  61607. /**
  61608. * Parse a new ParticleSystemSet from a serialized source
  61609. * @param data defines a JSON compatible representation of the set
  61610. * @param scene defines the hosting scene
  61611. * @param gpu defines if we want GPU particles or CPU particles
  61612. * @returns a new ParticleSystemSet
  61613. */
  61614. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  61615. }
  61616. }
  61617. declare module "babylonjs/Particles/particleHelper" {
  61618. import { Nullable } from "babylonjs/types";
  61619. import { Scene } from "babylonjs/scene";
  61620. import { Vector3 } from "babylonjs/Maths/math.vector";
  61621. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61622. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  61623. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  61624. /**
  61625. * This class is made for on one-liner static method to help creating particle system set.
  61626. */
  61627. export class ParticleHelper {
  61628. /**
  61629. * Gets or sets base Assets URL
  61630. */
  61631. static BaseAssetsUrl: string;
  61632. /**
  61633. * Create a default particle system that you can tweak
  61634. * @param emitter defines the emitter to use
  61635. * @param capacity defines the system capacity (default is 500 particles)
  61636. * @param scene defines the hosting scene
  61637. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  61638. * @returns the new Particle system
  61639. */
  61640. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  61641. /**
  61642. * This is the main static method (one-liner) of this helper to create different particle systems
  61643. * @param type This string represents the type to the particle system to create
  61644. * @param scene The scene where the particle system should live
  61645. * @param gpu If the system will use gpu
  61646. * @returns the ParticleSystemSet created
  61647. */
  61648. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  61649. /**
  61650. * Static function used to export a particle system to a ParticleSystemSet variable.
  61651. * Please note that the emitter shape is not exported
  61652. * @param systems defines the particle systems to export
  61653. * @returns the created particle system set
  61654. */
  61655. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  61656. }
  61657. }
  61658. declare module "babylonjs/Particles/particleSystemComponent" {
  61659. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  61660. import { Effect } from "babylonjs/Materials/effect";
  61661. import "babylonjs/Shaders/particles.vertex";
  61662. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  61663. module "babylonjs/Engines/engine" {
  61664. interface Engine {
  61665. /**
  61666. * Create an effect to use with particle systems.
  61667. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration
  61668. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  61669. * @param uniformsNames defines a list of attribute names
  61670. * @param samplers defines an array of string used to represent textures
  61671. * @param defines defines the string containing the defines to use to compile the shaders
  61672. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  61673. * @param onCompiled defines a function to call when the effect creation is successful
  61674. * @param onError defines a function to call when the effect creation has failed
  61675. * @returns the new Effect
  61676. */
  61677. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): Effect;
  61678. }
  61679. }
  61680. module "babylonjs/Meshes/mesh" {
  61681. interface Mesh {
  61682. /**
  61683. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  61684. * @returns an array of IParticleSystem
  61685. */
  61686. getEmittedParticleSystems(): IParticleSystem[];
  61687. /**
  61688. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  61689. * @returns an array of IParticleSystem
  61690. */
  61691. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  61692. }
  61693. }
  61694. /**
  61695. * @hidden
  61696. */
  61697. export var _IDoNeedToBeInTheBuild: number;
  61698. }
  61699. declare module "babylonjs/Particles/pointsCloudSystem" {
  61700. import { Color4 } from "babylonjs/Maths/math";
  61701. import { Mesh } from "babylonjs/Meshes/mesh";
  61702. import { Scene, IDisposable } from "babylonjs/scene";
  61703. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  61704. /** Defines the 4 color options */
  61705. export enum PointColor {
  61706. /** color value */
  61707. Color = 2,
  61708. /** uv value */
  61709. UV = 1,
  61710. /** random value */
  61711. Random = 0,
  61712. /** stated value */
  61713. Stated = 3
  61714. }
  61715. /**
  61716. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  61717. * 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.
  61718. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  61719. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  61720. *
  61721. * Full documentation here : TO BE ENTERED
  61722. */
  61723. export class PointsCloudSystem implements IDisposable {
  61724. /**
  61725. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  61726. * Example : var p = SPS.particles[i];
  61727. */
  61728. particles: CloudPoint[];
  61729. /**
  61730. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  61731. */
  61732. nbParticles: number;
  61733. /**
  61734. * This a counter for your own usage. It's not set by any SPS functions.
  61735. */
  61736. counter: number;
  61737. /**
  61738. * The PCS name. This name is also given to the underlying mesh.
  61739. */
  61740. name: string;
  61741. /**
  61742. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  61743. */
  61744. mesh: Mesh;
  61745. /**
  61746. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  61747. * Please read :
  61748. */
  61749. vars: any;
  61750. /**
  61751. * @hidden
  61752. */
  61753. _size: number;
  61754. private _scene;
  61755. private _promises;
  61756. private _positions;
  61757. private _indices;
  61758. private _normals;
  61759. private _colors;
  61760. private _uvs;
  61761. private _indices32;
  61762. private _positions32;
  61763. private _colors32;
  61764. private _uvs32;
  61765. private _updatable;
  61766. private _isVisibilityBoxLocked;
  61767. private _alwaysVisible;
  61768. private _groups;
  61769. private _groupCounter;
  61770. private _computeParticleColor;
  61771. private _computeParticleTexture;
  61772. private _computeParticleRotation;
  61773. private _computeBoundingBox;
  61774. private _isReady;
  61775. /**
  61776. * Creates a PCS (Points Cloud System) object
  61777. * @param name (String) is the PCS name, this will be the underlying mesh name
  61778. * @param pointSize (number) is the size for each point
  61779. * @param scene (Scene) is the scene in which the PCS is added
  61780. * @param options defines the options of the PCS e.g.
  61781. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  61782. */
  61783. constructor(name: string, pointSize: number, scene: Scene, options?: {
  61784. updatable?: boolean;
  61785. });
  61786. /**
  61787. * Builds the PCS underlying mesh. Returns a standard Mesh.
  61788. * If no points were added to the PCS, the returned mesh is just a single point.
  61789. * @returns a promise for the created mesh
  61790. */
  61791. buildMeshAsync(): Promise<Mesh>;
  61792. /**
  61793. * @hidden
  61794. */
  61795. private _buildMesh;
  61796. private _addParticle;
  61797. private _randomUnitVector;
  61798. private _getColorIndicesForCoord;
  61799. private _setPointsColorOrUV;
  61800. private _colorFromTexture;
  61801. private _calculateDensity;
  61802. /**
  61803. * Adds points to the PCS in random positions within a unit sphere
  61804. * @param nb (positive integer) the number of particles to be created from this model
  61805. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  61806. * @returns the number of groups in the system
  61807. */
  61808. addPoints(nb: number, pointFunction?: any): number;
  61809. /**
  61810. * Adds points to the PCS from the surface of the model shape
  61811. * @param mesh is any Mesh object that will be used as a surface model for the points
  61812. * @param nb (positive integer) the number of particles to be created from this model
  61813. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  61814. * @param color (color3) to be used when colorWith is stated
  61815. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  61816. * @returns the number of groups in the system
  61817. */
  61818. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4, range?: number): number;
  61819. /**
  61820. * Adds points to the PCS inside the model shape
  61821. * @param mesh is any Mesh object that will be used as a surface model for the points
  61822. * @param nb (positive integer) the number of particles to be created from this model
  61823. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible),
  61824. * @param color (color4) to be used when colorWith is stated
  61825. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  61826. * @returns the number of groups in the system
  61827. */
  61828. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4, range?: number): number;
  61829. /**
  61830. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  61831. * This method calls `updateParticle()` for each particle of the SPS.
  61832. * For an animated SPS, it is usually called within the render loop.
  61833. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  61834. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  61835. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  61836. * @returns the PCS.
  61837. */
  61838. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  61839. /**
  61840. * Disposes the PCS.
  61841. */
  61842. dispose(): void;
  61843. /**
  61844. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  61845. * doc :
  61846. * @returns the PCS.
  61847. */
  61848. refreshVisibleSize(): PointsCloudSystem;
  61849. /**
  61850. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  61851. * @param size the size (float) of the visibility box
  61852. * note : this doesn't lock the PCS mesh bounding box.
  61853. * doc :
  61854. */
  61855. setVisibilityBox(size: number): void;
  61856. /**
  61857. * Gets whether the PCS is always visible or not
  61858. * doc :
  61859. */
  61860. /**
  61861. * Sets the PCS as always visible or not
  61862. * doc :
  61863. */
  61864. isAlwaysVisible: boolean;
  61865. /**
  61866. * Tells to `setParticles()` to compute the particle rotations or not
  61867. * Default value : false. The PCS is faster when it's set to false
  61868. * Note : particle rotations are only applied to parent particles
  61869. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  61870. */
  61871. computeParticleRotation: boolean;
  61872. /**
  61873. * Tells to `setParticles()` to compute the particle colors or not.
  61874. * Default value : true. The PCS is faster when it's set to false.
  61875. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  61876. */
  61877. /**
  61878. * Gets if `setParticles()` computes the particle colors or not.
  61879. * Default value : false. The PCS is faster when it's set to false.
  61880. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  61881. */
  61882. computeParticleColor: boolean;
  61883. /**
  61884. * Gets if `setParticles()` computes the particle textures or not.
  61885. * Default value : false. The PCS is faster when it's set to false.
  61886. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  61887. */
  61888. computeParticleTexture: boolean;
  61889. /**
  61890. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  61891. */
  61892. /**
  61893. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  61894. */
  61895. computeBoundingBox: boolean;
  61896. /**
  61897. * This function does nothing. It may be overwritten to set all the particle first values.
  61898. * The PCS doesn't call this function, you may have to call it by your own.
  61899. * doc :
  61900. */
  61901. initParticles(): void;
  61902. /**
  61903. * This function does nothing. It may be overwritten to recycle a particle
  61904. * The PCS doesn't call this function, you can to call it
  61905. * doc :
  61906. * @param particle The particle to recycle
  61907. * @returns the recycled particle
  61908. */
  61909. recycleParticle(particle: CloudPoint): CloudPoint;
  61910. /**
  61911. * Updates a particle : this function should be overwritten by the user.
  61912. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  61913. * doc :
  61914. * @example : just set a particle position or velocity and recycle conditions
  61915. * @param particle The particle to update
  61916. * @returns the updated particle
  61917. */
  61918. updateParticle(particle: CloudPoint): CloudPoint;
  61919. /**
  61920. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  61921. * This does nothing and may be overwritten by the user.
  61922. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  61923. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  61924. * @param update the boolean update value actually passed to setParticles()
  61925. */
  61926. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  61927. /**
  61928. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  61929. * This will be passed three parameters.
  61930. * This does nothing and may be overwritten by the user.
  61931. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  61932. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  61933. * @param update the boolean update value actually passed to setParticles()
  61934. */
  61935. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  61936. }
  61937. }
  61938. declare module "babylonjs/Particles/cloudPoint" {
  61939. import { Nullable } from "babylonjs/types";
  61940. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  61941. import { Mesh } from "babylonjs/Meshes/mesh";
  61942. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  61943. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  61944. /**
  61945. * Represents one particle of a points cloud system.
  61946. */
  61947. export class CloudPoint {
  61948. /**
  61949. * particle global index
  61950. */
  61951. idx: number;
  61952. /**
  61953. * The color of the particle
  61954. */
  61955. color: Nullable<Color4>;
  61956. /**
  61957. * The world space position of the particle.
  61958. */
  61959. position: Vector3;
  61960. /**
  61961. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  61962. */
  61963. rotation: Vector3;
  61964. /**
  61965. * The world space rotation quaternion of the particle.
  61966. */
  61967. rotationQuaternion: Nullable<Quaternion>;
  61968. /**
  61969. * The uv of the particle.
  61970. */
  61971. uv: Nullable<Vector2>;
  61972. /**
  61973. * The current speed of the particle.
  61974. */
  61975. velocity: Vector3;
  61976. /**
  61977. * The pivot point in the particle local space.
  61978. */
  61979. pivot: Vector3;
  61980. /**
  61981. * Must the particle be translated from its pivot point in its local space ?
  61982. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  61983. * Default : false
  61984. */
  61985. translateFromPivot: boolean;
  61986. /**
  61987. * Index of this particle in the global "positions" array (Internal use)
  61988. * @hidden
  61989. */
  61990. _pos: number;
  61991. /**
  61992. * @hidden Index of this particle in the global "indices" array (Internal use)
  61993. */
  61994. _ind: number;
  61995. /**
  61996. * Group this particle belongs to
  61997. */
  61998. _group: PointsGroup;
  61999. /**
  62000. * Group id of this particle
  62001. */
  62002. groupId: number;
  62003. /**
  62004. * Index of the particle in its group id (Internal use)
  62005. */
  62006. idxInGroup: number;
  62007. /**
  62008. * @hidden Particle BoundingInfo object (Internal use)
  62009. */
  62010. _boundingInfo: BoundingInfo;
  62011. /**
  62012. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  62013. */
  62014. _pcs: PointsCloudSystem;
  62015. /**
  62016. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  62017. */
  62018. _stillInvisible: boolean;
  62019. /**
  62020. * @hidden Last computed particle rotation matrix
  62021. */
  62022. _rotationMatrix: number[];
  62023. /**
  62024. * Parent particle Id, if any.
  62025. * Default null.
  62026. */
  62027. parentId: Nullable<number>;
  62028. /**
  62029. * @hidden Internal global position in the PCS.
  62030. */
  62031. _globalPosition: Vector3;
  62032. /**
  62033. * Creates a Point Cloud object.
  62034. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  62035. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  62036. * @param group (PointsGroup) is the group the particle belongs to
  62037. * @param groupId (integer) is the group identifier in the PCS.
  62038. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  62039. * @param pcs defines the PCS it is associated to
  62040. */
  62041. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  62042. /**
  62043. * get point size
  62044. */
  62045. /**
  62046. * Set point size
  62047. */
  62048. size: Vector3;
  62049. /**
  62050. * Legacy support, changed quaternion to rotationQuaternion
  62051. */
  62052. /**
  62053. * Legacy support, changed quaternion to rotationQuaternion
  62054. */
  62055. quaternion: Nullable<Quaternion>;
  62056. /**
  62057. * Returns a boolean. True if the particle intersects a mesh, else false
  62058. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  62059. * @param target is the object (point or mesh) what the intersection is computed against
  62060. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  62061. * @returns true if it intersects
  62062. */
  62063. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  62064. /**
  62065. * get the rotation matrix of the particle
  62066. * @hidden
  62067. */
  62068. getRotationMatrix(m: Matrix): void;
  62069. }
  62070. /**
  62071. * Represents a group of points in a points cloud system
  62072. * * PCS internal tool, don't use it manually.
  62073. */
  62074. export class PointsGroup {
  62075. /**
  62076. * The group id
  62077. * @hidden
  62078. */
  62079. groupID: number;
  62080. /**
  62081. * image data for group (internal use)
  62082. * @hidden
  62083. */
  62084. _groupImageData: Nullable<ArrayBufferView>;
  62085. /**
  62086. * Image Width (internal use)
  62087. * @hidden
  62088. */
  62089. _groupImgWidth: number;
  62090. /**
  62091. * Image Height (internal use)
  62092. * @hidden
  62093. */
  62094. _groupImgHeight: number;
  62095. /**
  62096. * Custom position function (internal use)
  62097. * @hidden
  62098. */
  62099. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  62100. /**
  62101. * density per facet for surface points
  62102. * @hidden
  62103. */
  62104. _groupDensity: number[];
  62105. /**
  62106. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  62107. * PCS internal tool, don't use it manually.
  62108. * @hidden
  62109. */
  62110. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  62111. }
  62112. }
  62113. declare module "babylonjs/Particles/index" {
  62114. export * from "babylonjs/Particles/baseParticleSystem";
  62115. export * from "babylonjs/Particles/EmitterTypes/index";
  62116. export * from "babylonjs/Particles/gpuParticleSystem";
  62117. export * from "babylonjs/Particles/IParticleSystem";
  62118. export * from "babylonjs/Particles/particle";
  62119. export * from "babylonjs/Particles/particleHelper";
  62120. export * from "babylonjs/Particles/particleSystem";
  62121. export * from "babylonjs/Particles/particleSystemComponent";
  62122. export * from "babylonjs/Particles/particleSystemSet";
  62123. export * from "babylonjs/Particles/solidParticle";
  62124. export * from "babylonjs/Particles/solidParticleSystem";
  62125. export * from "babylonjs/Particles/cloudPoint";
  62126. export * from "babylonjs/Particles/pointsCloudSystem";
  62127. export * from "babylonjs/Particles/subEmitter";
  62128. }
  62129. declare module "babylonjs/Physics/physicsEngineComponent" {
  62130. import { Nullable } from "babylonjs/types";
  62131. import { Observable, Observer } from "babylonjs/Misc/observable";
  62132. import { Vector3 } from "babylonjs/Maths/math.vector";
  62133. import { Mesh } from "babylonjs/Meshes/mesh";
  62134. import { ISceneComponent } from "babylonjs/sceneComponent";
  62135. import { Scene } from "babylonjs/scene";
  62136. import { Node } from "babylonjs/node";
  62137. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  62138. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62139. module "babylonjs/scene" {
  62140. interface Scene {
  62141. /** @hidden (Backing field) */
  62142. _physicsEngine: Nullable<IPhysicsEngine>;
  62143. /**
  62144. * Gets the current physics engine
  62145. * @returns a IPhysicsEngine or null if none attached
  62146. */
  62147. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  62148. /**
  62149. * Enables physics to the current scene
  62150. * @param gravity defines the scene's gravity for the physics engine
  62151. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  62152. * @return a boolean indicating if the physics engine was initialized
  62153. */
  62154. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  62155. /**
  62156. * Disables and disposes the physics engine associated with the scene
  62157. */
  62158. disablePhysicsEngine(): void;
  62159. /**
  62160. * Gets a boolean indicating if there is an active physics engine
  62161. * @returns a boolean indicating if there is an active physics engine
  62162. */
  62163. isPhysicsEnabled(): boolean;
  62164. /**
  62165. * Deletes a physics compound impostor
  62166. * @param compound defines the compound to delete
  62167. */
  62168. deleteCompoundImpostor(compound: any): void;
  62169. /**
  62170. * An event triggered when physic simulation is about to be run
  62171. */
  62172. onBeforePhysicsObservable: Observable<Scene>;
  62173. /**
  62174. * An event triggered when physic simulation has been done
  62175. */
  62176. onAfterPhysicsObservable: Observable<Scene>;
  62177. }
  62178. }
  62179. module "babylonjs/Meshes/abstractMesh" {
  62180. interface AbstractMesh {
  62181. /** @hidden */
  62182. _physicsImpostor: Nullable<PhysicsImpostor>;
  62183. /**
  62184. * Gets or sets impostor used for physic simulation
  62185. * @see http://doc.babylonjs.com/features/physics_engine
  62186. */
  62187. physicsImpostor: Nullable<PhysicsImpostor>;
  62188. /**
  62189. * Gets the current physics impostor
  62190. * @see http://doc.babylonjs.com/features/physics_engine
  62191. * @returns a physics impostor or null
  62192. */
  62193. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  62194. /** Apply a physic impulse to the mesh
  62195. * @param force defines the force to apply
  62196. * @param contactPoint defines where to apply the force
  62197. * @returns the current mesh
  62198. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  62199. */
  62200. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  62201. /**
  62202. * Creates a physic joint between two meshes
  62203. * @param otherMesh defines the other mesh to use
  62204. * @param pivot1 defines the pivot to use on this mesh
  62205. * @param pivot2 defines the pivot to use on the other mesh
  62206. * @param options defines additional options (can be plugin dependent)
  62207. * @returns the current mesh
  62208. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  62209. */
  62210. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  62211. /** @hidden */
  62212. _disposePhysicsObserver: Nullable<Observer<Node>>;
  62213. }
  62214. }
  62215. /**
  62216. * Defines the physics engine scene component responsible to manage a physics engine
  62217. */
  62218. export class PhysicsEngineSceneComponent implements ISceneComponent {
  62219. /**
  62220. * The component name helpful to identify the component in the list of scene components.
  62221. */
  62222. readonly name: string;
  62223. /**
  62224. * The scene the component belongs to.
  62225. */
  62226. scene: Scene;
  62227. /**
  62228. * Creates a new instance of the component for the given scene
  62229. * @param scene Defines the scene to register the component in
  62230. */
  62231. constructor(scene: Scene);
  62232. /**
  62233. * Registers the component in a given scene
  62234. */
  62235. register(): void;
  62236. /**
  62237. * Rebuilds the elements related to this component in case of
  62238. * context lost for instance.
  62239. */
  62240. rebuild(): void;
  62241. /**
  62242. * Disposes the component and the associated ressources
  62243. */
  62244. dispose(): void;
  62245. }
  62246. }
  62247. declare module "babylonjs/Physics/physicsHelper" {
  62248. import { Nullable } from "babylonjs/types";
  62249. import { Vector3 } from "babylonjs/Maths/math.vector";
  62250. import { Mesh } from "babylonjs/Meshes/mesh";
  62251. import { Scene } from "babylonjs/scene";
  62252. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62253. /**
  62254. * A helper for physics simulations
  62255. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62256. */
  62257. export class PhysicsHelper {
  62258. private _scene;
  62259. private _physicsEngine;
  62260. /**
  62261. * Initializes the Physics helper
  62262. * @param scene Babylon.js scene
  62263. */
  62264. constructor(scene: Scene);
  62265. /**
  62266. * Applies a radial explosion impulse
  62267. * @param origin the origin of the explosion
  62268. * @param radiusOrEventOptions the radius or the options of radial explosion
  62269. * @param strength the explosion strength
  62270. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62271. * @returns A physics radial explosion event, or null
  62272. */
  62273. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  62274. /**
  62275. * Applies a radial explosion force
  62276. * @param origin the origin of the explosion
  62277. * @param radiusOrEventOptions the radius or the options of radial explosion
  62278. * @param strength the explosion strength
  62279. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62280. * @returns A physics radial explosion event, or null
  62281. */
  62282. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  62283. /**
  62284. * Creates a gravitational field
  62285. * @param origin the origin of the explosion
  62286. * @param radiusOrEventOptions the radius or the options of radial explosion
  62287. * @param strength the explosion strength
  62288. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62289. * @returns A physics gravitational field event, or null
  62290. */
  62291. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  62292. /**
  62293. * Creates a physics updraft event
  62294. * @param origin the origin of the updraft
  62295. * @param radiusOrEventOptions the radius or the options of the updraft
  62296. * @param strength the strength of the updraft
  62297. * @param height the height of the updraft
  62298. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  62299. * @returns A physics updraft event, or null
  62300. */
  62301. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  62302. /**
  62303. * Creates a physics vortex event
  62304. * @param origin the of the vortex
  62305. * @param radiusOrEventOptions the radius or the options of the vortex
  62306. * @param strength the strength of the vortex
  62307. * @param height the height of the vortex
  62308. * @returns a Physics vortex event, or null
  62309. * A physics vortex event or null
  62310. */
  62311. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  62312. }
  62313. /**
  62314. * Represents a physics radial explosion event
  62315. */
  62316. class PhysicsRadialExplosionEvent {
  62317. private _scene;
  62318. private _options;
  62319. private _sphere;
  62320. private _dataFetched;
  62321. /**
  62322. * Initializes a radial explosioin event
  62323. * @param _scene BabylonJS scene
  62324. * @param _options The options for the vortex event
  62325. */
  62326. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  62327. /**
  62328. * Returns the data related to the radial explosion event (sphere).
  62329. * @returns The radial explosion event data
  62330. */
  62331. getData(): PhysicsRadialExplosionEventData;
  62332. /**
  62333. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  62334. * @param impostor A physics imposter
  62335. * @param origin the origin of the explosion
  62336. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  62337. */
  62338. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  62339. /**
  62340. * Triggers affecterd impostors callbacks
  62341. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  62342. */
  62343. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  62344. /**
  62345. * Disposes the sphere.
  62346. * @param force Specifies if the sphere should be disposed by force
  62347. */
  62348. dispose(force?: boolean): void;
  62349. /*** Helpers ***/
  62350. private _prepareSphere;
  62351. private _intersectsWithSphere;
  62352. }
  62353. /**
  62354. * Represents a gravitational field event
  62355. */
  62356. class PhysicsGravitationalFieldEvent {
  62357. private _physicsHelper;
  62358. private _scene;
  62359. private _origin;
  62360. private _options;
  62361. private _tickCallback;
  62362. private _sphere;
  62363. private _dataFetched;
  62364. /**
  62365. * Initializes the physics gravitational field event
  62366. * @param _physicsHelper A physics helper
  62367. * @param _scene BabylonJS scene
  62368. * @param _origin The origin position of the gravitational field event
  62369. * @param _options The options for the vortex event
  62370. */
  62371. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  62372. /**
  62373. * Returns the data related to the gravitational field event (sphere).
  62374. * @returns A gravitational field event
  62375. */
  62376. getData(): PhysicsGravitationalFieldEventData;
  62377. /**
  62378. * Enables the gravitational field.
  62379. */
  62380. enable(): void;
  62381. /**
  62382. * Disables the gravitational field.
  62383. */
  62384. disable(): void;
  62385. /**
  62386. * Disposes the sphere.
  62387. * @param force The force to dispose from the gravitational field event
  62388. */
  62389. dispose(force?: boolean): void;
  62390. private _tick;
  62391. }
  62392. /**
  62393. * Represents a physics updraft event
  62394. */
  62395. class PhysicsUpdraftEvent {
  62396. private _scene;
  62397. private _origin;
  62398. private _options;
  62399. private _physicsEngine;
  62400. private _originTop;
  62401. private _originDirection;
  62402. private _tickCallback;
  62403. private _cylinder;
  62404. private _cylinderPosition;
  62405. private _dataFetched;
  62406. /**
  62407. * Initializes the physics updraft event
  62408. * @param _scene BabylonJS scene
  62409. * @param _origin The origin position of the updraft
  62410. * @param _options The options for the updraft event
  62411. */
  62412. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  62413. /**
  62414. * Returns the data related to the updraft event (cylinder).
  62415. * @returns A physics updraft event
  62416. */
  62417. getData(): PhysicsUpdraftEventData;
  62418. /**
  62419. * Enables the updraft.
  62420. */
  62421. enable(): void;
  62422. /**
  62423. * Disables the updraft.
  62424. */
  62425. disable(): void;
  62426. /**
  62427. * Disposes the cylinder.
  62428. * @param force Specifies if the updraft should be disposed by force
  62429. */
  62430. dispose(force?: boolean): void;
  62431. private getImpostorHitData;
  62432. private _tick;
  62433. /*** Helpers ***/
  62434. private _prepareCylinder;
  62435. private _intersectsWithCylinder;
  62436. }
  62437. /**
  62438. * Represents a physics vortex event
  62439. */
  62440. class PhysicsVortexEvent {
  62441. private _scene;
  62442. private _origin;
  62443. private _options;
  62444. private _physicsEngine;
  62445. private _originTop;
  62446. private _tickCallback;
  62447. private _cylinder;
  62448. private _cylinderPosition;
  62449. private _dataFetched;
  62450. /**
  62451. * Initializes the physics vortex event
  62452. * @param _scene The BabylonJS scene
  62453. * @param _origin The origin position of the vortex
  62454. * @param _options The options for the vortex event
  62455. */
  62456. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  62457. /**
  62458. * Returns the data related to the vortex event (cylinder).
  62459. * @returns The physics vortex event data
  62460. */
  62461. getData(): PhysicsVortexEventData;
  62462. /**
  62463. * Enables the vortex.
  62464. */
  62465. enable(): void;
  62466. /**
  62467. * Disables the cortex.
  62468. */
  62469. disable(): void;
  62470. /**
  62471. * Disposes the sphere.
  62472. * @param force
  62473. */
  62474. dispose(force?: boolean): void;
  62475. private getImpostorHitData;
  62476. private _tick;
  62477. /*** Helpers ***/
  62478. private _prepareCylinder;
  62479. private _intersectsWithCylinder;
  62480. }
  62481. /**
  62482. * Options fot the radial explosion event
  62483. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62484. */
  62485. export class PhysicsRadialExplosionEventOptions {
  62486. /**
  62487. * The radius of the sphere for the radial explosion.
  62488. */
  62489. radius: number;
  62490. /**
  62491. * The strenth of the explosion.
  62492. */
  62493. strength: number;
  62494. /**
  62495. * The strenght of the force in correspondence to the distance of the affected object
  62496. */
  62497. falloff: PhysicsRadialImpulseFalloff;
  62498. /**
  62499. * Sphere options for the radial explosion.
  62500. */
  62501. sphere: {
  62502. segments: number;
  62503. diameter: number;
  62504. };
  62505. /**
  62506. * Sphere options for the radial explosion.
  62507. */
  62508. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  62509. }
  62510. /**
  62511. * Options fot the updraft event
  62512. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62513. */
  62514. export class PhysicsUpdraftEventOptions {
  62515. /**
  62516. * The radius of the cylinder for the vortex
  62517. */
  62518. radius: number;
  62519. /**
  62520. * The strenth of the updraft.
  62521. */
  62522. strength: number;
  62523. /**
  62524. * The height of the cylinder for the updraft.
  62525. */
  62526. height: number;
  62527. /**
  62528. * The mode for the the updraft.
  62529. */
  62530. updraftMode: PhysicsUpdraftMode;
  62531. }
  62532. /**
  62533. * Options fot the vortex event
  62534. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62535. */
  62536. export class PhysicsVortexEventOptions {
  62537. /**
  62538. * The radius of the cylinder for the vortex
  62539. */
  62540. radius: number;
  62541. /**
  62542. * The strenth of the vortex.
  62543. */
  62544. strength: number;
  62545. /**
  62546. * The height of the cylinder for the vortex.
  62547. */
  62548. height: number;
  62549. /**
  62550. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  62551. */
  62552. centripetalForceThreshold: number;
  62553. /**
  62554. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  62555. */
  62556. centripetalForceMultiplier: number;
  62557. /**
  62558. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  62559. */
  62560. centrifugalForceMultiplier: number;
  62561. /**
  62562. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  62563. */
  62564. updraftForceMultiplier: number;
  62565. }
  62566. /**
  62567. * The strenght of the force in correspondence to the distance of the affected object
  62568. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62569. */
  62570. export enum PhysicsRadialImpulseFalloff {
  62571. /** Defines that impulse is constant in strength across it's whole radius */
  62572. Constant = 0,
  62573. /** Defines that impulse gets weaker if it's further from the origin */
  62574. Linear = 1
  62575. }
  62576. /**
  62577. * The strength of the force in correspondence to the distance of the affected object
  62578. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62579. */
  62580. export enum PhysicsUpdraftMode {
  62581. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  62582. Center = 0,
  62583. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  62584. Perpendicular = 1
  62585. }
  62586. /**
  62587. * Interface for a physics hit data
  62588. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62589. */
  62590. export interface PhysicsHitData {
  62591. /**
  62592. * The force applied at the contact point
  62593. */
  62594. force: Vector3;
  62595. /**
  62596. * The contact point
  62597. */
  62598. contactPoint: Vector3;
  62599. /**
  62600. * The distance from the origin to the contact point
  62601. */
  62602. distanceFromOrigin: number;
  62603. }
  62604. /**
  62605. * Interface for radial explosion event data
  62606. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62607. */
  62608. export interface PhysicsRadialExplosionEventData {
  62609. /**
  62610. * A sphere used for the radial explosion event
  62611. */
  62612. sphere: Mesh;
  62613. }
  62614. /**
  62615. * Interface for gravitational field event data
  62616. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62617. */
  62618. export interface PhysicsGravitationalFieldEventData {
  62619. /**
  62620. * A sphere mesh used for the gravitational field event
  62621. */
  62622. sphere: Mesh;
  62623. }
  62624. /**
  62625. * Interface for updraft event data
  62626. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62627. */
  62628. export interface PhysicsUpdraftEventData {
  62629. /**
  62630. * A cylinder used for the updraft event
  62631. */
  62632. cylinder: Mesh;
  62633. }
  62634. /**
  62635. * Interface for vortex event data
  62636. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62637. */
  62638. export interface PhysicsVortexEventData {
  62639. /**
  62640. * A cylinder used for the vortex event
  62641. */
  62642. cylinder: Mesh;
  62643. }
  62644. /**
  62645. * Interface for an affected physics impostor
  62646. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62647. */
  62648. export interface PhysicsAffectedImpostorWithData {
  62649. /**
  62650. * The impostor affected by the effect
  62651. */
  62652. impostor: PhysicsImpostor;
  62653. /**
  62654. * The data about the hit/horce from the explosion
  62655. */
  62656. hitData: PhysicsHitData;
  62657. }
  62658. }
  62659. declare module "babylonjs/Physics/Plugins/index" {
  62660. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  62661. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  62662. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  62663. }
  62664. declare module "babylonjs/Physics/index" {
  62665. export * from "babylonjs/Physics/IPhysicsEngine";
  62666. export * from "babylonjs/Physics/physicsEngine";
  62667. export * from "babylonjs/Physics/physicsEngineComponent";
  62668. export * from "babylonjs/Physics/physicsHelper";
  62669. export * from "babylonjs/Physics/physicsImpostor";
  62670. export * from "babylonjs/Physics/physicsJoint";
  62671. export * from "babylonjs/Physics/Plugins/index";
  62672. }
  62673. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  62674. /** @hidden */
  62675. export var blackAndWhitePixelShader: {
  62676. name: string;
  62677. shader: string;
  62678. };
  62679. }
  62680. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  62681. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  62682. import { Camera } from "babylonjs/Cameras/camera";
  62683. import { Engine } from "babylonjs/Engines/engine";
  62684. import "babylonjs/Shaders/blackAndWhite.fragment";
  62685. /**
  62686. * Post process used to render in black and white
  62687. */
  62688. export class BlackAndWhitePostProcess extends PostProcess {
  62689. /**
  62690. * Linear about to convert he result to black and white (default: 1)
  62691. */
  62692. degree: number;
  62693. /**
  62694. * Creates a black and white post process
  62695. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  62696. * @param name The name of the effect.
  62697. * @param options The required width/height ratio to downsize to before computing the render pass.
  62698. * @param camera The camera to apply the render pass to.
  62699. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  62700. * @param engine The engine which the post process will be applied. (default: current engine)
  62701. * @param reusable If the post process can be reused on the same frame. (default: false)
  62702. */
  62703. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  62704. }
  62705. }
  62706. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  62707. import { Nullable } from "babylonjs/types";
  62708. import { Camera } from "babylonjs/Cameras/camera";
  62709. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62710. import { Engine } from "babylonjs/Engines/engine";
  62711. /**
  62712. * This represents a set of one or more post processes in Babylon.
  62713. * A post process can be used to apply a shader to a texture after it is rendered.
  62714. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  62715. */
  62716. export class PostProcessRenderEffect {
  62717. private _postProcesses;
  62718. private _getPostProcesses;
  62719. private _singleInstance;
  62720. private _cameras;
  62721. private _indicesForCamera;
  62722. /**
  62723. * Name of the effect
  62724. * @hidden
  62725. */
  62726. _name: string;
  62727. /**
  62728. * Instantiates a post process render effect.
  62729. * A post process can be used to apply a shader to a texture after it is rendered.
  62730. * @param engine The engine the effect is tied to
  62731. * @param name The name of the effect
  62732. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  62733. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  62734. */
  62735. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  62736. /**
  62737. * Checks if all the post processes in the effect are supported.
  62738. */
  62739. readonly isSupported: boolean;
  62740. /**
  62741. * Updates the current state of the effect
  62742. * @hidden
  62743. */
  62744. _update(): void;
  62745. /**
  62746. * Attaches the effect on cameras
  62747. * @param cameras The camera to attach to.
  62748. * @hidden
  62749. */
  62750. _attachCameras(cameras: Camera): void;
  62751. /**
  62752. * Attaches the effect on cameras
  62753. * @param cameras The camera to attach to.
  62754. * @hidden
  62755. */
  62756. _attachCameras(cameras: Camera[]): void;
  62757. /**
  62758. * Detaches the effect on cameras
  62759. * @param cameras The camera to detatch from.
  62760. * @hidden
  62761. */
  62762. _detachCameras(cameras: Camera): void;
  62763. /**
  62764. * Detatches the effect on cameras
  62765. * @param cameras The camera to detatch from.
  62766. * @hidden
  62767. */
  62768. _detachCameras(cameras: Camera[]): void;
  62769. /**
  62770. * Enables the effect on given cameras
  62771. * @param cameras The camera to enable.
  62772. * @hidden
  62773. */
  62774. _enable(cameras: Camera): void;
  62775. /**
  62776. * Enables the effect on given cameras
  62777. * @param cameras The camera to enable.
  62778. * @hidden
  62779. */
  62780. _enable(cameras: Nullable<Camera[]>): void;
  62781. /**
  62782. * Disables the effect on the given cameras
  62783. * @param cameras The camera to disable.
  62784. * @hidden
  62785. */
  62786. _disable(cameras: Camera): void;
  62787. /**
  62788. * Disables the effect on the given cameras
  62789. * @param cameras The camera to disable.
  62790. * @hidden
  62791. */
  62792. _disable(cameras: Nullable<Camera[]>): void;
  62793. /**
  62794. * Gets a list of the post processes contained in the effect.
  62795. * @param camera The camera to get the post processes on.
  62796. * @returns The list of the post processes in the effect.
  62797. */
  62798. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  62799. }
  62800. }
  62801. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  62802. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  62803. /** @hidden */
  62804. export var extractHighlightsPixelShader: {
  62805. name: string;
  62806. shader: string;
  62807. };
  62808. }
  62809. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  62810. import { Nullable } from "babylonjs/types";
  62811. import { Camera } from "babylonjs/Cameras/camera";
  62812. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  62813. import { Engine } from "babylonjs/Engines/engine";
  62814. import "babylonjs/Shaders/extractHighlights.fragment";
  62815. /**
  62816. * 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.
  62817. */
  62818. export class ExtractHighlightsPostProcess extends PostProcess {
  62819. /**
  62820. * The luminance threshold, pixels below this value will be set to black.
  62821. */
  62822. threshold: number;
  62823. /** @hidden */
  62824. _exposure: number;
  62825. /**
  62826. * Post process which has the input texture to be used when performing highlight extraction
  62827. * @hidden
  62828. */
  62829. _inputPostProcess: Nullable<PostProcess>;
  62830. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  62831. }
  62832. }
  62833. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  62834. /** @hidden */
  62835. export var bloomMergePixelShader: {
  62836. name: string;
  62837. shader: string;
  62838. };
  62839. }
  62840. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  62841. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  62842. import { Nullable } from "babylonjs/types";
  62843. import { Engine } from "babylonjs/Engines/engine";
  62844. import { Camera } from "babylonjs/Cameras/camera";
  62845. import "babylonjs/Shaders/bloomMerge.fragment";
  62846. /**
  62847. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  62848. */
  62849. export class BloomMergePostProcess extends PostProcess {
  62850. /** Weight of the bloom to be added to the original input. */
  62851. weight: number;
  62852. /**
  62853. * Creates a new instance of @see BloomMergePostProcess
  62854. * @param name The name of the effect.
  62855. * @param originalFromInput Post process which's input will be used for the merge.
  62856. * @param blurred Blurred highlights post process which's output will be used.
  62857. * @param weight Weight of the bloom to be added to the original input.
  62858. * @param options The required width/height ratio to downsize to before computing the render pass.
  62859. * @param camera The camera to apply the render pass to.
  62860. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  62861. * @param engine The engine which the post process will be applied. (default: current engine)
  62862. * @param reusable If the post process can be reused on the same frame. (default: false)
  62863. * @param textureType Type of textures used when performing the post process. (default: 0)
  62864. * @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)
  62865. */
  62866. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  62867. /** Weight of the bloom to be added to the original input. */
  62868. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  62869. }
  62870. }
  62871. declare module "babylonjs/PostProcesses/bloomEffect" {
  62872. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  62873. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62874. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  62875. import { Camera } from "babylonjs/Cameras/camera";
  62876. import { Scene } from "babylonjs/scene";
  62877. /**
  62878. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  62879. */
  62880. export class BloomEffect extends PostProcessRenderEffect {
  62881. private bloomScale;
  62882. /**
  62883. * @hidden Internal
  62884. */
  62885. _effects: Array<PostProcess>;
  62886. /**
  62887. * @hidden Internal
  62888. */
  62889. _downscale: ExtractHighlightsPostProcess;
  62890. private _blurX;
  62891. private _blurY;
  62892. private _merge;
  62893. /**
  62894. * The luminance threshold to find bright areas of the image to bloom.
  62895. */
  62896. threshold: number;
  62897. /**
  62898. * The strength of the bloom.
  62899. */
  62900. weight: number;
  62901. /**
  62902. * Specifies the size of the bloom blur kernel, relative to the final output size
  62903. */
  62904. kernel: number;
  62905. /**
  62906. * Creates a new instance of @see BloomEffect
  62907. * @param scene The scene the effect belongs to.
  62908. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  62909. * @param bloomKernel The size of the kernel to be used when applying the blur.
  62910. * @param bloomWeight The the strength of bloom.
  62911. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  62912. * @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)
  62913. */
  62914. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  62915. /**
  62916. * Disposes each of the internal effects for a given camera.
  62917. * @param camera The camera to dispose the effect on.
  62918. */
  62919. disposeEffects(camera: Camera): void;
  62920. /**
  62921. * @hidden Internal
  62922. */
  62923. _updateEffects(): void;
  62924. /**
  62925. * Internal
  62926. * @returns if all the contained post processes are ready.
  62927. * @hidden
  62928. */
  62929. _isReady(): boolean;
  62930. }
  62931. }
  62932. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  62933. /** @hidden */
  62934. export var chromaticAberrationPixelShader: {
  62935. name: string;
  62936. shader: string;
  62937. };
  62938. }
  62939. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  62940. import { Vector2 } from "babylonjs/Maths/math.vector";
  62941. import { Nullable } from "babylonjs/types";
  62942. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  62943. import { Camera } from "babylonjs/Cameras/camera";
  62944. import { Engine } from "babylonjs/Engines/engine";
  62945. import "babylonjs/Shaders/chromaticAberration.fragment";
  62946. /**
  62947. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  62948. */
  62949. export class ChromaticAberrationPostProcess extends PostProcess {
  62950. /**
  62951. * The amount of seperation of rgb channels (default: 30)
  62952. */
  62953. aberrationAmount: number;
  62954. /**
  62955. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  62956. */
  62957. radialIntensity: number;
  62958. /**
  62959. * 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))
  62960. */
  62961. direction: Vector2;
  62962. /**
  62963. * 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))
  62964. */
  62965. centerPosition: Vector2;
  62966. /**
  62967. * Creates a new instance ChromaticAberrationPostProcess
  62968. * @param name The name of the effect.
  62969. * @param screenWidth The width of the screen to apply the effect on.
  62970. * @param screenHeight The height of the screen to apply the effect on.
  62971. * @param options The required width/height ratio to downsize to before computing the render pass.
  62972. * @param camera The camera to apply the render pass to.
  62973. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  62974. * @param engine The engine which the post process will be applied. (default: current engine)
  62975. * @param reusable If the post process can be reused on the same frame. (default: false)
  62976. * @param textureType Type of textures used when performing the post process. (default: 0)
  62977. * @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)
  62978. */
  62979. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  62980. }
  62981. }
  62982. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  62983. /** @hidden */
  62984. export var circleOfConfusionPixelShader: {
  62985. name: string;
  62986. shader: string;
  62987. };
  62988. }
  62989. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  62990. import { Nullable } from "babylonjs/types";
  62991. import { Engine } from "babylonjs/Engines/engine";
  62992. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  62993. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62994. import { Camera } from "babylonjs/Cameras/camera";
  62995. import "babylonjs/Shaders/circleOfConfusion.fragment";
  62996. /**
  62997. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  62998. */
  62999. export class CircleOfConfusionPostProcess extends PostProcess {
  63000. /**
  63001. * 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.
  63002. */
  63003. lensSize: number;
  63004. /**
  63005. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  63006. */
  63007. fStop: number;
  63008. /**
  63009. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  63010. */
  63011. focusDistance: number;
  63012. /**
  63013. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  63014. */
  63015. focalLength: number;
  63016. private _depthTexture;
  63017. /**
  63018. * Creates a new instance CircleOfConfusionPostProcess
  63019. * @param name The name of the effect.
  63020. * @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.
  63021. * @param options The required width/height ratio to downsize to before computing the render pass.
  63022. * @param camera The camera to apply the render pass to.
  63023. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63024. * @param engine The engine which the post process will be applied. (default: current engine)
  63025. * @param reusable If the post process can be reused on the same frame. (default: false)
  63026. * @param textureType Type of textures used when performing the post process. (default: 0)
  63027. * @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)
  63028. */
  63029. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63030. /**
  63031. * 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.
  63032. */
  63033. depthTexture: RenderTargetTexture;
  63034. }
  63035. }
  63036. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  63037. /** @hidden */
  63038. export var colorCorrectionPixelShader: {
  63039. name: string;
  63040. shader: string;
  63041. };
  63042. }
  63043. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  63044. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63045. import { Engine } from "babylonjs/Engines/engine";
  63046. import { Camera } from "babylonjs/Cameras/camera";
  63047. import "babylonjs/Shaders/colorCorrection.fragment";
  63048. /**
  63049. *
  63050. * This post-process allows the modification of rendered colors by using
  63051. * a 'look-up table' (LUT). This effect is also called Color Grading.
  63052. *
  63053. * The object needs to be provided an url to a texture containing the color
  63054. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  63055. * Use an image editing software to tweak the LUT to match your needs.
  63056. *
  63057. * For an example of a color LUT, see here:
  63058. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  63059. * For explanations on color grading, see here:
  63060. * @see http://udn.epicgames.com/Three/ColorGrading.html
  63061. *
  63062. */
  63063. export class ColorCorrectionPostProcess extends PostProcess {
  63064. private _colorTableTexture;
  63065. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63066. }
  63067. }
  63068. declare module "babylonjs/Shaders/convolution.fragment" {
  63069. /** @hidden */
  63070. export var convolutionPixelShader: {
  63071. name: string;
  63072. shader: string;
  63073. };
  63074. }
  63075. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  63076. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63077. import { Nullable } from "babylonjs/types";
  63078. import { Camera } from "babylonjs/Cameras/camera";
  63079. import { Engine } from "babylonjs/Engines/engine";
  63080. import "babylonjs/Shaders/convolution.fragment";
  63081. /**
  63082. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  63083. * input texture to perform effects such as edge detection or sharpening
  63084. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  63085. */
  63086. export class ConvolutionPostProcess extends PostProcess {
  63087. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  63088. kernel: number[];
  63089. /**
  63090. * Creates a new instance ConvolutionPostProcess
  63091. * @param name The name of the effect.
  63092. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  63093. * @param options The required width/height ratio to downsize to before computing the render pass.
  63094. * @param camera The camera to apply the render pass to.
  63095. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63096. * @param engine The engine which the post process will be applied. (default: current engine)
  63097. * @param reusable If the post process can be reused on the same frame. (default: false)
  63098. * @param textureType Type of textures used when performing the post process. (default: 0)
  63099. */
  63100. constructor(name: string,
  63101. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  63102. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  63103. /**
  63104. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63105. */
  63106. static EdgeDetect0Kernel: number[];
  63107. /**
  63108. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63109. */
  63110. static EdgeDetect1Kernel: number[];
  63111. /**
  63112. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63113. */
  63114. static EdgeDetect2Kernel: number[];
  63115. /**
  63116. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63117. */
  63118. static SharpenKernel: number[];
  63119. /**
  63120. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63121. */
  63122. static EmbossKernel: number[];
  63123. /**
  63124. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63125. */
  63126. static GaussianKernel: number[];
  63127. }
  63128. }
  63129. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  63130. import { Nullable } from "babylonjs/types";
  63131. import { Vector2 } from "babylonjs/Maths/math.vector";
  63132. import { Camera } from "babylonjs/Cameras/camera";
  63133. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63134. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  63135. import { Engine } from "babylonjs/Engines/engine";
  63136. import { Scene } from "babylonjs/scene";
  63137. /**
  63138. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  63139. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  63140. * based on samples that have a large difference in distance than the center pixel.
  63141. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  63142. */
  63143. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  63144. direction: Vector2;
  63145. /**
  63146. * Creates a new instance CircleOfConfusionPostProcess
  63147. * @param name The name of the effect.
  63148. * @param scene The scene the effect belongs to.
  63149. * @param direction The direction the blur should be applied.
  63150. * @param kernel The size of the kernel used to blur.
  63151. * @param options The required width/height ratio to downsize to before computing the render pass.
  63152. * @param camera The camera to apply the render pass to.
  63153. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  63154. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  63155. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63156. * @param engine The engine which the post process will be applied. (default: current engine)
  63157. * @param reusable If the post process can be reused on the same frame. (default: false)
  63158. * @param textureType Type of textures used when performing the post process. (default: 0)
  63159. * @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)
  63160. */
  63161. 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);
  63162. }
  63163. }
  63164. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  63165. /** @hidden */
  63166. export var depthOfFieldMergePixelShader: {
  63167. name: string;
  63168. shader: string;
  63169. };
  63170. }
  63171. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  63172. import { Nullable } from "babylonjs/types";
  63173. import { Camera } from "babylonjs/Cameras/camera";
  63174. import { Effect } from "babylonjs/Materials/effect";
  63175. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63176. import { Engine } from "babylonjs/Engines/engine";
  63177. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  63178. /**
  63179. * Options to be set when merging outputs from the default pipeline.
  63180. */
  63181. export class DepthOfFieldMergePostProcessOptions {
  63182. /**
  63183. * The original image to merge on top of
  63184. */
  63185. originalFromInput: PostProcess;
  63186. /**
  63187. * Parameters to perform the merge of the depth of field effect
  63188. */
  63189. depthOfField?: {
  63190. circleOfConfusion: PostProcess;
  63191. blurSteps: Array<PostProcess>;
  63192. };
  63193. /**
  63194. * Parameters to perform the merge of bloom effect
  63195. */
  63196. bloom?: {
  63197. blurred: PostProcess;
  63198. weight: number;
  63199. };
  63200. }
  63201. /**
  63202. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  63203. */
  63204. export class DepthOfFieldMergePostProcess extends PostProcess {
  63205. private blurSteps;
  63206. /**
  63207. * Creates a new instance of DepthOfFieldMergePostProcess
  63208. * @param name The name of the effect.
  63209. * @param originalFromInput Post process which's input will be used for the merge.
  63210. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  63211. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  63212. * @param options The required width/height ratio to downsize to before computing the render pass.
  63213. * @param camera The camera to apply the render pass to.
  63214. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63215. * @param engine The engine which the post process will be applied. (default: current engine)
  63216. * @param reusable If the post process can be reused on the same frame. (default: false)
  63217. * @param textureType Type of textures used when performing the post process. (default: 0)
  63218. * @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)
  63219. */
  63220. 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);
  63221. /**
  63222. * Updates the effect with the current post process compile time values and recompiles the shader.
  63223. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  63224. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  63225. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  63226. * @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
  63227. * @param onCompiled Called when the shader has been compiled.
  63228. * @param onError Called if there is an error when compiling a shader.
  63229. */
  63230. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  63231. }
  63232. }
  63233. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  63234. import { Nullable } from "babylonjs/types";
  63235. import { Camera } from "babylonjs/Cameras/camera";
  63236. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63237. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  63238. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  63239. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  63240. import { Scene } from "babylonjs/scene";
  63241. /**
  63242. * Specifies the level of max blur that should be applied when using the depth of field effect
  63243. */
  63244. export enum DepthOfFieldEffectBlurLevel {
  63245. /**
  63246. * Subtle blur
  63247. */
  63248. Low = 0,
  63249. /**
  63250. * Medium blur
  63251. */
  63252. Medium = 1,
  63253. /**
  63254. * Large blur
  63255. */
  63256. High = 2
  63257. }
  63258. /**
  63259. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  63260. */
  63261. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  63262. private _circleOfConfusion;
  63263. /**
  63264. * @hidden Internal, blurs from high to low
  63265. */
  63266. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  63267. private _depthOfFieldBlurY;
  63268. private _dofMerge;
  63269. /**
  63270. * @hidden Internal post processes in depth of field effect
  63271. */
  63272. _effects: Array<PostProcess>;
  63273. /**
  63274. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  63275. */
  63276. focalLength: number;
  63277. /**
  63278. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  63279. */
  63280. fStop: number;
  63281. /**
  63282. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  63283. */
  63284. focusDistance: number;
  63285. /**
  63286. * 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.
  63287. */
  63288. lensSize: number;
  63289. /**
  63290. * Creates a new instance DepthOfFieldEffect
  63291. * @param scene The scene the effect belongs to.
  63292. * @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.
  63293. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  63294. * @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)
  63295. */
  63296. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  63297. /**
  63298. * Get the current class name of the current effet
  63299. * @returns "DepthOfFieldEffect"
  63300. */
  63301. getClassName(): string;
  63302. /**
  63303. * 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.
  63304. */
  63305. depthTexture: RenderTargetTexture;
  63306. /**
  63307. * Disposes each of the internal effects for a given camera.
  63308. * @param camera The camera to dispose the effect on.
  63309. */
  63310. disposeEffects(camera: Camera): void;
  63311. /**
  63312. * @hidden Internal
  63313. */
  63314. _updateEffects(): void;
  63315. /**
  63316. * Internal
  63317. * @returns if all the contained post processes are ready.
  63318. * @hidden
  63319. */
  63320. _isReady(): boolean;
  63321. }
  63322. }
  63323. declare module "babylonjs/Shaders/displayPass.fragment" {
  63324. /** @hidden */
  63325. export var displayPassPixelShader: {
  63326. name: string;
  63327. shader: string;
  63328. };
  63329. }
  63330. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  63331. import { Nullable } from "babylonjs/types";
  63332. import { Camera } from "babylonjs/Cameras/camera";
  63333. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63334. import { Engine } from "babylonjs/Engines/engine";
  63335. import "babylonjs/Shaders/displayPass.fragment";
  63336. /**
  63337. * DisplayPassPostProcess which produces an output the same as it's input
  63338. */
  63339. export class DisplayPassPostProcess extends PostProcess {
  63340. /**
  63341. * Creates the DisplayPassPostProcess
  63342. * @param name The name of the effect.
  63343. * @param options The required width/height ratio to downsize to before computing the render pass.
  63344. * @param camera The camera to apply the render pass to.
  63345. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63346. * @param engine The engine which the post process will be applied. (default: current engine)
  63347. * @param reusable If the post process can be reused on the same frame. (default: false)
  63348. */
  63349. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63350. }
  63351. }
  63352. declare module "babylonjs/Shaders/filter.fragment" {
  63353. /** @hidden */
  63354. export var filterPixelShader: {
  63355. name: string;
  63356. shader: string;
  63357. };
  63358. }
  63359. declare module "babylonjs/PostProcesses/filterPostProcess" {
  63360. import { Nullable } from "babylonjs/types";
  63361. import { Matrix } from "babylonjs/Maths/math.vector";
  63362. import { Camera } from "babylonjs/Cameras/camera";
  63363. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63364. import { Engine } from "babylonjs/Engines/engine";
  63365. import "babylonjs/Shaders/filter.fragment";
  63366. /**
  63367. * Applies a kernel filter to the image
  63368. */
  63369. export class FilterPostProcess extends PostProcess {
  63370. /** The matrix to be applied to the image */
  63371. kernelMatrix: Matrix;
  63372. /**
  63373. *
  63374. * @param name The name of the effect.
  63375. * @param kernelMatrix The matrix to be applied to the image
  63376. * @param options The required width/height ratio to downsize to before computing the render pass.
  63377. * @param camera The camera to apply the render pass to.
  63378. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63379. * @param engine The engine which the post process will be applied. (default: current engine)
  63380. * @param reusable If the post process can be reused on the same frame. (default: false)
  63381. */
  63382. constructor(name: string,
  63383. /** The matrix to be applied to the image */
  63384. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63385. }
  63386. }
  63387. declare module "babylonjs/Shaders/fxaa.fragment" {
  63388. /** @hidden */
  63389. export var fxaaPixelShader: {
  63390. name: string;
  63391. shader: string;
  63392. };
  63393. }
  63394. declare module "babylonjs/Shaders/fxaa.vertex" {
  63395. /** @hidden */
  63396. export var fxaaVertexShader: {
  63397. name: string;
  63398. shader: string;
  63399. };
  63400. }
  63401. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  63402. import { Nullable } from "babylonjs/types";
  63403. import { Camera } from "babylonjs/Cameras/camera";
  63404. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63405. import { Engine } from "babylonjs/Engines/engine";
  63406. import "babylonjs/Shaders/fxaa.fragment";
  63407. import "babylonjs/Shaders/fxaa.vertex";
  63408. /**
  63409. * Fxaa post process
  63410. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  63411. */
  63412. export class FxaaPostProcess extends PostProcess {
  63413. /** @hidden */
  63414. texelWidth: number;
  63415. /** @hidden */
  63416. texelHeight: number;
  63417. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  63418. private _getDefines;
  63419. }
  63420. }
  63421. declare module "babylonjs/Shaders/grain.fragment" {
  63422. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  63423. /** @hidden */
  63424. export var grainPixelShader: {
  63425. name: string;
  63426. shader: string;
  63427. };
  63428. }
  63429. declare module "babylonjs/PostProcesses/grainPostProcess" {
  63430. import { Nullable } from "babylonjs/types";
  63431. import { Camera } from "babylonjs/Cameras/camera";
  63432. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63433. import { Engine } from "babylonjs/Engines/engine";
  63434. import "babylonjs/Shaders/grain.fragment";
  63435. /**
  63436. * The GrainPostProcess adds noise to the image at mid luminance levels
  63437. */
  63438. export class GrainPostProcess extends PostProcess {
  63439. /**
  63440. * The intensity of the grain added (default: 30)
  63441. */
  63442. intensity: number;
  63443. /**
  63444. * If the grain should be randomized on every frame
  63445. */
  63446. animated: boolean;
  63447. /**
  63448. * Creates a new instance of @see GrainPostProcess
  63449. * @param name The name of the effect.
  63450. * @param options The required width/height ratio to downsize to before computing the render pass.
  63451. * @param camera The camera to apply the render pass to.
  63452. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63453. * @param engine The engine which the post process will be applied. (default: current engine)
  63454. * @param reusable If the post process can be reused on the same frame. (default: false)
  63455. * @param textureType Type of textures used when performing the post process. (default: 0)
  63456. * @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)
  63457. */
  63458. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63459. }
  63460. }
  63461. declare module "babylonjs/Shaders/highlights.fragment" {
  63462. /** @hidden */
  63463. export var highlightsPixelShader: {
  63464. name: string;
  63465. shader: string;
  63466. };
  63467. }
  63468. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  63469. import { Nullable } from "babylonjs/types";
  63470. import { Camera } from "babylonjs/Cameras/camera";
  63471. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63472. import { Engine } from "babylonjs/Engines/engine";
  63473. import "babylonjs/Shaders/highlights.fragment";
  63474. /**
  63475. * Extracts highlights from the image
  63476. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  63477. */
  63478. export class HighlightsPostProcess extends PostProcess {
  63479. /**
  63480. * Extracts highlights from the image
  63481. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  63482. * @param name The name of the effect.
  63483. * @param options The required width/height ratio to downsize to before computing the render pass.
  63484. * @param camera The camera to apply the render pass to.
  63485. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63486. * @param engine The engine which the post process will be applied. (default: current engine)
  63487. * @param reusable If the post process can be reused on the same frame. (default: false)
  63488. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  63489. */
  63490. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  63491. }
  63492. }
  63493. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  63494. /** @hidden */
  63495. export var mrtFragmentDeclaration: {
  63496. name: string;
  63497. shader: string;
  63498. };
  63499. }
  63500. declare module "babylonjs/Shaders/geometry.fragment" {
  63501. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  63502. /** @hidden */
  63503. export var geometryPixelShader: {
  63504. name: string;
  63505. shader: string;
  63506. };
  63507. }
  63508. declare module "babylonjs/Shaders/geometry.vertex" {
  63509. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  63510. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  63511. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  63512. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  63513. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  63514. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  63515. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  63516. /** @hidden */
  63517. export var geometryVertexShader: {
  63518. name: string;
  63519. shader: string;
  63520. };
  63521. }
  63522. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  63523. import { Matrix } from "babylonjs/Maths/math.vector";
  63524. import { SubMesh } from "babylonjs/Meshes/subMesh";
  63525. import { Mesh } from "babylonjs/Meshes/mesh";
  63526. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  63527. import { Effect } from "babylonjs/Materials/effect";
  63528. import { Scene } from "babylonjs/scene";
  63529. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63530. import "babylonjs/Shaders/geometry.fragment";
  63531. import "babylonjs/Shaders/geometry.vertex";
  63532. /** @hidden */
  63533. interface ISavedTransformationMatrix {
  63534. world: Matrix;
  63535. viewProjection: Matrix;
  63536. }
  63537. /**
  63538. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  63539. */
  63540. export class GeometryBufferRenderer {
  63541. /**
  63542. * Constant used to retrieve the position texture index in the G-Buffer textures array
  63543. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  63544. */
  63545. static readonly POSITION_TEXTURE_TYPE: number;
  63546. /**
  63547. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  63548. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  63549. */
  63550. static readonly VELOCITY_TEXTURE_TYPE: number;
  63551. /**
  63552. * Dictionary used to store the previous transformation matrices of each rendered mesh
  63553. * in order to compute objects velocities when enableVelocity is set to "true"
  63554. * @hidden
  63555. */
  63556. _previousTransformationMatrices: {
  63557. [index: number]: ISavedTransformationMatrix;
  63558. };
  63559. /**
  63560. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  63561. * in order to compute objects velocities when enableVelocity is set to "true"
  63562. * @hidden
  63563. */
  63564. _previousBonesTransformationMatrices: {
  63565. [index: number]: Float32Array;
  63566. };
  63567. /**
  63568. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  63569. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  63570. */
  63571. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  63572. private _scene;
  63573. private _multiRenderTarget;
  63574. private _ratio;
  63575. private _enablePosition;
  63576. private _enableVelocity;
  63577. private _positionIndex;
  63578. private _velocityIndex;
  63579. protected _effect: Effect;
  63580. protected _cachedDefines: string;
  63581. /**
  63582. * Set the render list (meshes to be rendered) used in the G buffer.
  63583. */
  63584. renderList: Mesh[];
  63585. /**
  63586. * Gets wether or not G buffer are supported by the running hardware.
  63587. * This requires draw buffer supports
  63588. */
  63589. readonly isSupported: boolean;
  63590. /**
  63591. * Returns the index of the given texture type in the G-Buffer textures array
  63592. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  63593. * @returns the index of the given texture type in the G-Buffer textures array
  63594. */
  63595. getTextureIndex(textureType: number): number;
  63596. /**
  63597. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  63598. */
  63599. /**
  63600. * Sets whether or not objects positions are enabled for the G buffer.
  63601. */
  63602. enablePosition: boolean;
  63603. /**
  63604. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  63605. */
  63606. /**
  63607. * Sets wether or not objects velocities are enabled for the G buffer.
  63608. */
  63609. enableVelocity: boolean;
  63610. /**
  63611. * Gets the scene associated with the buffer.
  63612. */
  63613. readonly scene: Scene;
  63614. /**
  63615. * Gets the ratio used by the buffer during its creation.
  63616. * How big is the buffer related to the main canvas.
  63617. */
  63618. readonly ratio: number;
  63619. /** @hidden */
  63620. static _SceneComponentInitialization: (scene: Scene) => void;
  63621. /**
  63622. * Creates a new G Buffer for the scene
  63623. * @param scene The scene the buffer belongs to
  63624. * @param ratio How big is the buffer related to the main canvas.
  63625. */
  63626. constructor(scene: Scene, ratio?: number);
  63627. /**
  63628. * Checks wether everything is ready to render a submesh to the G buffer.
  63629. * @param subMesh the submesh to check readiness for
  63630. * @param useInstances is the mesh drawn using instance or not
  63631. * @returns true if ready otherwise false
  63632. */
  63633. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  63634. /**
  63635. * Gets the current underlying G Buffer.
  63636. * @returns the buffer
  63637. */
  63638. getGBuffer(): MultiRenderTarget;
  63639. /**
  63640. * Gets the number of samples used to render the buffer (anti aliasing).
  63641. */
  63642. /**
  63643. * Sets the number of samples used to render the buffer (anti aliasing).
  63644. */
  63645. samples: number;
  63646. /**
  63647. * Disposes the renderer and frees up associated resources.
  63648. */
  63649. dispose(): void;
  63650. protected _createRenderTargets(): void;
  63651. private _copyBonesTransformationMatrices;
  63652. }
  63653. }
  63654. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  63655. import { Nullable } from "babylonjs/types";
  63656. import { Scene } from "babylonjs/scene";
  63657. import { ISceneComponent } from "babylonjs/sceneComponent";
  63658. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  63659. module "babylonjs/scene" {
  63660. interface Scene {
  63661. /** @hidden (Backing field) */
  63662. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  63663. /**
  63664. * Gets or Sets the current geometry buffer associated to the scene.
  63665. */
  63666. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  63667. /**
  63668. * Enables a GeometryBufferRender and associates it with the scene
  63669. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  63670. * @returns the GeometryBufferRenderer
  63671. */
  63672. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  63673. /**
  63674. * Disables the GeometryBufferRender associated with the scene
  63675. */
  63676. disableGeometryBufferRenderer(): void;
  63677. }
  63678. }
  63679. /**
  63680. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  63681. * in several rendering techniques.
  63682. */
  63683. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  63684. /**
  63685. * The component name helpful to identify the component in the list of scene components.
  63686. */
  63687. readonly name: string;
  63688. /**
  63689. * The scene the component belongs to.
  63690. */
  63691. scene: Scene;
  63692. /**
  63693. * Creates a new instance of the component for the given scene
  63694. * @param scene Defines the scene to register the component in
  63695. */
  63696. constructor(scene: Scene);
  63697. /**
  63698. * Registers the component in a given scene
  63699. */
  63700. register(): void;
  63701. /**
  63702. * Rebuilds the elements related to this component in case of
  63703. * context lost for instance.
  63704. */
  63705. rebuild(): void;
  63706. /**
  63707. * Disposes the component and the associated ressources
  63708. */
  63709. dispose(): void;
  63710. private _gatherRenderTargets;
  63711. }
  63712. }
  63713. declare module "babylonjs/Shaders/motionBlur.fragment" {
  63714. /** @hidden */
  63715. export var motionBlurPixelShader: {
  63716. name: string;
  63717. shader: string;
  63718. };
  63719. }
  63720. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  63721. import { Nullable } from "babylonjs/types";
  63722. import { Camera } from "babylonjs/Cameras/camera";
  63723. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63724. import { Scene } from "babylonjs/scene";
  63725. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63726. import "babylonjs/Animations/animatable";
  63727. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  63728. import "babylonjs/Shaders/motionBlur.fragment";
  63729. import { Engine } from "babylonjs/Engines/engine";
  63730. /**
  63731. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  63732. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  63733. * As an example, all you have to do is to create the post-process:
  63734. * var mb = new BABYLON.MotionBlurPostProcess(
  63735. * 'mb', // The name of the effect.
  63736. * scene, // The scene containing the objects to blur according to their velocity.
  63737. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  63738. * camera // The camera to apply the render pass to.
  63739. * );
  63740. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  63741. */
  63742. export class MotionBlurPostProcess extends PostProcess {
  63743. /**
  63744. * Defines how much the image is blurred by the movement. Default value is equal to 1
  63745. */
  63746. motionStrength: number;
  63747. /**
  63748. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  63749. */
  63750. /**
  63751. * Sets the number of iterations to be used for motion blur quality
  63752. */
  63753. motionBlurSamples: number;
  63754. private _motionBlurSamples;
  63755. private _geometryBufferRenderer;
  63756. /**
  63757. * Creates a new instance MotionBlurPostProcess
  63758. * @param name The name of the effect.
  63759. * @param scene The scene containing the objects to blur according to their velocity.
  63760. * @param options The required width/height ratio to downsize to before computing the render pass.
  63761. * @param camera The camera to apply the render pass to.
  63762. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63763. * @param engine The engine which the post process will be applied. (default: current engine)
  63764. * @param reusable If the post process can be reused on the same frame. (default: false)
  63765. * @param textureType Type of textures used when performing the post process. (default: 0)
  63766. * @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)
  63767. */
  63768. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63769. /**
  63770. * Excludes the given skinned mesh from computing bones velocities.
  63771. * 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.
  63772. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  63773. */
  63774. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  63775. /**
  63776. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  63777. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  63778. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  63779. */
  63780. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  63781. /**
  63782. * Disposes the post process.
  63783. * @param camera The camera to dispose the post process on.
  63784. */
  63785. dispose(camera?: Camera): void;
  63786. }
  63787. }
  63788. declare module "babylonjs/Shaders/refraction.fragment" {
  63789. /** @hidden */
  63790. export var refractionPixelShader: {
  63791. name: string;
  63792. shader: string;
  63793. };
  63794. }
  63795. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  63796. import { Color3 } from "babylonjs/Maths/math.color";
  63797. import { Camera } from "babylonjs/Cameras/camera";
  63798. import { Texture } from "babylonjs/Materials/Textures/texture";
  63799. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63800. import { Engine } from "babylonjs/Engines/engine";
  63801. import "babylonjs/Shaders/refraction.fragment";
  63802. /**
  63803. * Post process which applies a refractin texture
  63804. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  63805. */
  63806. export class RefractionPostProcess extends PostProcess {
  63807. /** the base color of the refraction (used to taint the rendering) */
  63808. color: Color3;
  63809. /** simulated refraction depth */
  63810. depth: number;
  63811. /** the coefficient of the base color (0 to remove base color tainting) */
  63812. colorLevel: number;
  63813. private _refTexture;
  63814. private _ownRefractionTexture;
  63815. /**
  63816. * Gets or sets the refraction texture
  63817. * Please note that you are responsible for disposing the texture if you set it manually
  63818. */
  63819. refractionTexture: Texture;
  63820. /**
  63821. * Initializes the RefractionPostProcess
  63822. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  63823. * @param name The name of the effect.
  63824. * @param refractionTextureUrl Url of the refraction texture to use
  63825. * @param color the base color of the refraction (used to taint the rendering)
  63826. * @param depth simulated refraction depth
  63827. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  63828. * @param camera The camera to apply the render pass to.
  63829. * @param options The required width/height ratio to downsize to before computing the render pass.
  63830. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63831. * @param engine The engine which the post process will be applied. (default: current engine)
  63832. * @param reusable If the post process can be reused on the same frame. (default: false)
  63833. */
  63834. constructor(name: string, refractionTextureUrl: string,
  63835. /** the base color of the refraction (used to taint the rendering) */
  63836. color: Color3,
  63837. /** simulated refraction depth */
  63838. depth: number,
  63839. /** the coefficient of the base color (0 to remove base color tainting) */
  63840. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63841. /**
  63842. * Disposes of the post process
  63843. * @param camera Camera to dispose post process on
  63844. */
  63845. dispose(camera: Camera): void;
  63846. }
  63847. }
  63848. declare module "babylonjs/Shaders/sharpen.fragment" {
  63849. /** @hidden */
  63850. export var sharpenPixelShader: {
  63851. name: string;
  63852. shader: string;
  63853. };
  63854. }
  63855. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  63856. import { Nullable } from "babylonjs/types";
  63857. import { Camera } from "babylonjs/Cameras/camera";
  63858. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63859. import "babylonjs/Shaders/sharpen.fragment";
  63860. import { Engine } from "babylonjs/Engines/engine";
  63861. /**
  63862. * The SharpenPostProcess applies a sharpen kernel to every pixel
  63863. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  63864. */
  63865. export class SharpenPostProcess extends PostProcess {
  63866. /**
  63867. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  63868. */
  63869. colorAmount: number;
  63870. /**
  63871. * How much sharpness should be applied (default: 0.3)
  63872. */
  63873. edgeAmount: number;
  63874. /**
  63875. * Creates a new instance ConvolutionPostProcess
  63876. * @param name The name of the effect.
  63877. * @param options The required width/height ratio to downsize to before computing the render pass.
  63878. * @param camera The camera to apply the render pass to.
  63879. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63880. * @param engine The engine which the post process will be applied. (default: current engine)
  63881. * @param reusable If the post process can be reused on the same frame. (default: false)
  63882. * @param textureType Type of textures used when performing the post process. (default: 0)
  63883. * @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)
  63884. */
  63885. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63886. }
  63887. }
  63888. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  63889. import { Nullable } from "babylonjs/types";
  63890. import { Camera } from "babylonjs/Cameras/camera";
  63891. import { Engine } from "babylonjs/Engines/engine";
  63892. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  63893. import { IInspectable } from "babylonjs/Misc/iInspectable";
  63894. /**
  63895. * PostProcessRenderPipeline
  63896. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  63897. */
  63898. export class PostProcessRenderPipeline {
  63899. private engine;
  63900. private _renderEffects;
  63901. private _renderEffectsForIsolatedPass;
  63902. /**
  63903. * List of inspectable custom properties (used by the Inspector)
  63904. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  63905. */
  63906. inspectableCustomProperties: IInspectable[];
  63907. /**
  63908. * @hidden
  63909. */
  63910. protected _cameras: Camera[];
  63911. /** @hidden */
  63912. _name: string;
  63913. /**
  63914. * Gets pipeline name
  63915. */
  63916. readonly name: string;
  63917. /**
  63918. * Initializes a PostProcessRenderPipeline
  63919. * @param engine engine to add the pipeline to
  63920. * @param name name of the pipeline
  63921. */
  63922. constructor(engine: Engine, name: string);
  63923. /**
  63924. * Gets the class name
  63925. * @returns "PostProcessRenderPipeline"
  63926. */
  63927. getClassName(): string;
  63928. /**
  63929. * If all the render effects in the pipeline are supported
  63930. */
  63931. readonly isSupported: boolean;
  63932. /**
  63933. * Adds an effect to the pipeline
  63934. * @param renderEffect the effect to add
  63935. */
  63936. addEffect(renderEffect: PostProcessRenderEffect): void;
  63937. /** @hidden */
  63938. _rebuild(): void;
  63939. /** @hidden */
  63940. _enableEffect(renderEffectName: string, cameras: Camera): void;
  63941. /** @hidden */
  63942. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  63943. /** @hidden */
  63944. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  63945. /** @hidden */
  63946. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  63947. /** @hidden */
  63948. _attachCameras(cameras: Camera, unique: boolean): void;
  63949. /** @hidden */
  63950. _attachCameras(cameras: Camera[], unique: boolean): void;
  63951. /** @hidden */
  63952. _detachCameras(cameras: Camera): void;
  63953. /** @hidden */
  63954. _detachCameras(cameras: Nullable<Camera[]>): void;
  63955. /** @hidden */
  63956. _update(): void;
  63957. /** @hidden */
  63958. _reset(): void;
  63959. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  63960. /**
  63961. * Disposes of the pipeline
  63962. */
  63963. dispose(): void;
  63964. }
  63965. }
  63966. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  63967. import { Camera } from "babylonjs/Cameras/camera";
  63968. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  63969. /**
  63970. * PostProcessRenderPipelineManager class
  63971. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  63972. */
  63973. export class PostProcessRenderPipelineManager {
  63974. private _renderPipelines;
  63975. /**
  63976. * Initializes a PostProcessRenderPipelineManager
  63977. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  63978. */
  63979. constructor();
  63980. /**
  63981. * Gets the list of supported render pipelines
  63982. */
  63983. readonly supportedPipelines: PostProcessRenderPipeline[];
  63984. /**
  63985. * Adds a pipeline to the manager
  63986. * @param renderPipeline The pipeline to add
  63987. */
  63988. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  63989. /**
  63990. * Attaches a camera to the pipeline
  63991. * @param renderPipelineName The name of the pipeline to attach to
  63992. * @param cameras the camera to attach
  63993. * @param unique if the camera can be attached multiple times to the pipeline
  63994. */
  63995. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  63996. /**
  63997. * Detaches a camera from the pipeline
  63998. * @param renderPipelineName The name of the pipeline to detach from
  63999. * @param cameras the camera to detach
  64000. */
  64001. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  64002. /**
  64003. * Enables an effect by name on a pipeline
  64004. * @param renderPipelineName the name of the pipeline to enable the effect in
  64005. * @param renderEffectName the name of the effect to enable
  64006. * @param cameras the cameras that the effect should be enabled on
  64007. */
  64008. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  64009. /**
  64010. * Disables an effect by name on a pipeline
  64011. * @param renderPipelineName the name of the pipeline to disable the effect in
  64012. * @param renderEffectName the name of the effect to disable
  64013. * @param cameras the cameras that the effect should be disabled on
  64014. */
  64015. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  64016. /**
  64017. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  64018. */
  64019. update(): void;
  64020. /** @hidden */
  64021. _rebuild(): void;
  64022. /**
  64023. * Disposes of the manager and pipelines
  64024. */
  64025. dispose(): void;
  64026. }
  64027. }
  64028. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  64029. import { ISceneComponent } from "babylonjs/sceneComponent";
  64030. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  64031. import { Scene } from "babylonjs/scene";
  64032. module "babylonjs/scene" {
  64033. interface Scene {
  64034. /** @hidden (Backing field) */
  64035. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  64036. /**
  64037. * Gets the postprocess render pipeline manager
  64038. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64039. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  64040. */
  64041. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  64042. }
  64043. }
  64044. /**
  64045. * Defines the Render Pipeline scene component responsible to rendering pipelines
  64046. */
  64047. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  64048. /**
  64049. * The component name helpfull to identify the component in the list of scene components.
  64050. */
  64051. readonly name: string;
  64052. /**
  64053. * The scene the component belongs to.
  64054. */
  64055. scene: Scene;
  64056. /**
  64057. * Creates a new instance of the component for the given scene
  64058. * @param scene Defines the scene to register the component in
  64059. */
  64060. constructor(scene: Scene);
  64061. /**
  64062. * Registers the component in a given scene
  64063. */
  64064. register(): void;
  64065. /**
  64066. * Rebuilds the elements related to this component in case of
  64067. * context lost for instance.
  64068. */
  64069. rebuild(): void;
  64070. /**
  64071. * Disposes the component and the associated ressources
  64072. */
  64073. dispose(): void;
  64074. private _gatherRenderTargets;
  64075. }
  64076. }
  64077. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  64078. import { Nullable } from "babylonjs/types";
  64079. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  64080. import { Camera } from "babylonjs/Cameras/camera";
  64081. import { IDisposable } from "babylonjs/scene";
  64082. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  64083. import { Scene } from "babylonjs/scene";
  64084. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  64085. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  64086. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  64087. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  64088. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  64089. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64090. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  64091. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64092. import { Animation } from "babylonjs/Animations/animation";
  64093. /**
  64094. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  64095. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  64096. */
  64097. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  64098. private _scene;
  64099. private _camerasToBeAttached;
  64100. /**
  64101. * ID of the sharpen post process,
  64102. */
  64103. private readonly SharpenPostProcessId;
  64104. /**
  64105. * @ignore
  64106. * ID of the image processing post process;
  64107. */
  64108. readonly ImageProcessingPostProcessId: string;
  64109. /**
  64110. * @ignore
  64111. * ID of the Fast Approximate Anti-Aliasing post process;
  64112. */
  64113. readonly FxaaPostProcessId: string;
  64114. /**
  64115. * ID of the chromatic aberration post process,
  64116. */
  64117. private readonly ChromaticAberrationPostProcessId;
  64118. /**
  64119. * ID of the grain post process
  64120. */
  64121. private readonly GrainPostProcessId;
  64122. /**
  64123. * Sharpen post process which will apply a sharpen convolution to enhance edges
  64124. */
  64125. sharpen: SharpenPostProcess;
  64126. private _sharpenEffect;
  64127. private bloom;
  64128. /**
  64129. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  64130. */
  64131. depthOfField: DepthOfFieldEffect;
  64132. /**
  64133. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  64134. */
  64135. fxaa: FxaaPostProcess;
  64136. /**
  64137. * Image post processing pass used to perform operations such as tone mapping or color grading.
  64138. */
  64139. imageProcessing: ImageProcessingPostProcess;
  64140. /**
  64141. * Chromatic aberration post process which will shift rgb colors in the image
  64142. */
  64143. chromaticAberration: ChromaticAberrationPostProcess;
  64144. private _chromaticAberrationEffect;
  64145. /**
  64146. * Grain post process which add noise to the image
  64147. */
  64148. grain: GrainPostProcess;
  64149. private _grainEffect;
  64150. /**
  64151. * Glow post process which adds a glow to emissive areas of the image
  64152. */
  64153. private _glowLayer;
  64154. /**
  64155. * Animations which can be used to tweak settings over a period of time
  64156. */
  64157. animations: Animation[];
  64158. private _imageProcessingConfigurationObserver;
  64159. private _sharpenEnabled;
  64160. private _bloomEnabled;
  64161. private _depthOfFieldEnabled;
  64162. private _depthOfFieldBlurLevel;
  64163. private _fxaaEnabled;
  64164. private _imageProcessingEnabled;
  64165. private _defaultPipelineTextureType;
  64166. private _bloomScale;
  64167. private _chromaticAberrationEnabled;
  64168. private _grainEnabled;
  64169. private _buildAllowed;
  64170. /**
  64171. * Gets active scene
  64172. */
  64173. readonly scene: Scene;
  64174. /**
  64175. * Enable or disable the sharpen process from the pipeline
  64176. */
  64177. sharpenEnabled: boolean;
  64178. private _resizeObserver;
  64179. private _hardwareScaleLevel;
  64180. private _bloomKernel;
  64181. /**
  64182. * Specifies the size of the bloom blur kernel, relative to the final output size
  64183. */
  64184. bloomKernel: number;
  64185. /**
  64186. * Specifies the weight of the bloom in the final rendering
  64187. */
  64188. private _bloomWeight;
  64189. /**
  64190. * Specifies the luma threshold for the area that will be blurred by the bloom
  64191. */
  64192. private _bloomThreshold;
  64193. private _hdr;
  64194. /**
  64195. * The strength of the bloom.
  64196. */
  64197. bloomWeight: number;
  64198. /**
  64199. * The strength of the bloom.
  64200. */
  64201. bloomThreshold: number;
  64202. /**
  64203. * The scale of the bloom, lower value will provide better performance.
  64204. */
  64205. bloomScale: number;
  64206. /**
  64207. * Enable or disable the bloom from the pipeline
  64208. */
  64209. bloomEnabled: boolean;
  64210. private _rebuildBloom;
  64211. /**
  64212. * If the depth of field is enabled.
  64213. */
  64214. depthOfFieldEnabled: boolean;
  64215. /**
  64216. * Blur level of the depth of field effect. (Higher blur will effect performance)
  64217. */
  64218. depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel;
  64219. /**
  64220. * If the anti aliasing is enabled.
  64221. */
  64222. fxaaEnabled: boolean;
  64223. private _samples;
  64224. /**
  64225. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  64226. */
  64227. samples: number;
  64228. /**
  64229. * If image processing is enabled.
  64230. */
  64231. imageProcessingEnabled: boolean;
  64232. /**
  64233. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  64234. */
  64235. glowLayerEnabled: boolean;
  64236. /**
  64237. * Gets the glow layer (or null if not defined)
  64238. */
  64239. readonly glowLayer: Nullable<GlowLayer>;
  64240. /**
  64241. * Enable or disable the chromaticAberration process from the pipeline
  64242. */
  64243. chromaticAberrationEnabled: boolean;
  64244. /**
  64245. * Enable or disable the grain process from the pipeline
  64246. */
  64247. grainEnabled: boolean;
  64248. /**
  64249. * @constructor
  64250. * @param name - The rendering pipeline name (default: "")
  64251. * @param hdr - If high dynamic range textures should be used (default: true)
  64252. * @param scene - The scene linked to this pipeline (default: the last created scene)
  64253. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  64254. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  64255. */
  64256. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  64257. /**
  64258. * Get the class name
  64259. * @returns "DefaultRenderingPipeline"
  64260. */
  64261. getClassName(): string;
  64262. /**
  64263. * Force the compilation of the entire pipeline.
  64264. */
  64265. prepare(): void;
  64266. private _hasCleared;
  64267. private _prevPostProcess;
  64268. private _prevPrevPostProcess;
  64269. private _setAutoClearAndTextureSharing;
  64270. private _depthOfFieldSceneObserver;
  64271. private _buildPipeline;
  64272. private _disposePostProcesses;
  64273. /**
  64274. * Adds a camera to the pipeline
  64275. * @param camera the camera to be added
  64276. */
  64277. addCamera(camera: Camera): void;
  64278. /**
  64279. * Removes a camera from the pipeline
  64280. * @param camera the camera to remove
  64281. */
  64282. removeCamera(camera: Camera): void;
  64283. /**
  64284. * Dispose of the pipeline and stop all post processes
  64285. */
  64286. dispose(): void;
  64287. /**
  64288. * Serialize the rendering pipeline (Used when exporting)
  64289. * @returns the serialized object
  64290. */
  64291. serialize(): any;
  64292. /**
  64293. * Parse the serialized pipeline
  64294. * @param source Source pipeline.
  64295. * @param scene The scene to load the pipeline to.
  64296. * @param rootUrl The URL of the serialized pipeline.
  64297. * @returns An instantiated pipeline from the serialized object.
  64298. */
  64299. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  64300. }
  64301. }
  64302. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  64303. /** @hidden */
  64304. export var lensHighlightsPixelShader: {
  64305. name: string;
  64306. shader: string;
  64307. };
  64308. }
  64309. declare module "babylonjs/Shaders/depthOfField.fragment" {
  64310. /** @hidden */
  64311. export var depthOfFieldPixelShader: {
  64312. name: string;
  64313. shader: string;
  64314. };
  64315. }
  64316. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  64317. import { Camera } from "babylonjs/Cameras/camera";
  64318. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64319. import { Scene } from "babylonjs/scene";
  64320. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64321. import "babylonjs/Shaders/chromaticAberration.fragment";
  64322. import "babylonjs/Shaders/lensHighlights.fragment";
  64323. import "babylonjs/Shaders/depthOfField.fragment";
  64324. /**
  64325. * BABYLON.JS Chromatic Aberration GLSL Shader
  64326. * Author: Olivier Guyot
  64327. * Separates very slightly R, G and B colors on the edges of the screen
  64328. * Inspired by Francois Tarlier & Martins Upitis
  64329. */
  64330. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  64331. /**
  64332. * @ignore
  64333. * The chromatic aberration PostProcess id in the pipeline
  64334. */
  64335. LensChromaticAberrationEffect: string;
  64336. /**
  64337. * @ignore
  64338. * The highlights enhancing PostProcess id in the pipeline
  64339. */
  64340. HighlightsEnhancingEffect: string;
  64341. /**
  64342. * @ignore
  64343. * The depth-of-field PostProcess id in the pipeline
  64344. */
  64345. LensDepthOfFieldEffect: string;
  64346. private _scene;
  64347. private _depthTexture;
  64348. private _grainTexture;
  64349. private _chromaticAberrationPostProcess;
  64350. private _highlightsPostProcess;
  64351. private _depthOfFieldPostProcess;
  64352. private _edgeBlur;
  64353. private _grainAmount;
  64354. private _chromaticAberration;
  64355. private _distortion;
  64356. private _highlightsGain;
  64357. private _highlightsThreshold;
  64358. private _dofDistance;
  64359. private _dofAperture;
  64360. private _dofDarken;
  64361. private _dofPentagon;
  64362. private _blurNoise;
  64363. /**
  64364. * @constructor
  64365. *
  64366. * Effect parameters are as follow:
  64367. * {
  64368. * chromatic_aberration: number; // from 0 to x (1 for realism)
  64369. * edge_blur: number; // from 0 to x (1 for realism)
  64370. * distortion: number; // from 0 to x (1 for realism)
  64371. * grain_amount: number; // from 0 to 1
  64372. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  64373. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  64374. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  64375. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  64376. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  64377. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  64378. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  64379. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  64380. * }
  64381. * Note: if an effect parameter is unset, effect is disabled
  64382. *
  64383. * @param name The rendering pipeline name
  64384. * @param parameters - An object containing all parameters (see above)
  64385. * @param scene The scene linked to this pipeline
  64386. * @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)
  64387. * @param cameras The array of cameras that the rendering pipeline will be attached to
  64388. */
  64389. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  64390. /**
  64391. * Get the class name
  64392. * @returns "LensRenderingPipeline"
  64393. */
  64394. getClassName(): string;
  64395. /**
  64396. * Gets associated scene
  64397. */
  64398. readonly scene: Scene;
  64399. /**
  64400. * Gets or sets the edge blur
  64401. */
  64402. edgeBlur: number;
  64403. /**
  64404. * Gets or sets the grain amount
  64405. */
  64406. grainAmount: number;
  64407. /**
  64408. * Gets or sets the chromatic aberration amount
  64409. */
  64410. chromaticAberration: number;
  64411. /**
  64412. * Gets or sets the depth of field aperture
  64413. */
  64414. dofAperture: number;
  64415. /**
  64416. * Gets or sets the edge distortion
  64417. */
  64418. edgeDistortion: number;
  64419. /**
  64420. * Gets or sets the depth of field distortion
  64421. */
  64422. dofDistortion: number;
  64423. /**
  64424. * Gets or sets the darken out of focus amount
  64425. */
  64426. darkenOutOfFocus: number;
  64427. /**
  64428. * Gets or sets a boolean indicating if blur noise is enabled
  64429. */
  64430. blurNoise: boolean;
  64431. /**
  64432. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  64433. */
  64434. pentagonBokeh: boolean;
  64435. /**
  64436. * Gets or sets the highlight grain amount
  64437. */
  64438. highlightsGain: number;
  64439. /**
  64440. * Gets or sets the highlight threshold
  64441. */
  64442. highlightsThreshold: number;
  64443. /**
  64444. * Sets the amount of blur at the edges
  64445. * @param amount blur amount
  64446. */
  64447. setEdgeBlur(amount: number): void;
  64448. /**
  64449. * Sets edge blur to 0
  64450. */
  64451. disableEdgeBlur(): void;
  64452. /**
  64453. * Sets the amout of grain
  64454. * @param amount Amount of grain
  64455. */
  64456. setGrainAmount(amount: number): void;
  64457. /**
  64458. * Set grain amount to 0
  64459. */
  64460. disableGrain(): void;
  64461. /**
  64462. * Sets the chromatic aberration amount
  64463. * @param amount amount of chromatic aberration
  64464. */
  64465. setChromaticAberration(amount: number): void;
  64466. /**
  64467. * Sets chromatic aberration amount to 0
  64468. */
  64469. disableChromaticAberration(): void;
  64470. /**
  64471. * Sets the EdgeDistortion amount
  64472. * @param amount amount of EdgeDistortion
  64473. */
  64474. setEdgeDistortion(amount: number): void;
  64475. /**
  64476. * Sets edge distortion to 0
  64477. */
  64478. disableEdgeDistortion(): void;
  64479. /**
  64480. * Sets the FocusDistance amount
  64481. * @param amount amount of FocusDistance
  64482. */
  64483. setFocusDistance(amount: number): void;
  64484. /**
  64485. * Disables depth of field
  64486. */
  64487. disableDepthOfField(): void;
  64488. /**
  64489. * Sets the Aperture amount
  64490. * @param amount amount of Aperture
  64491. */
  64492. setAperture(amount: number): void;
  64493. /**
  64494. * Sets the DarkenOutOfFocus amount
  64495. * @param amount amount of DarkenOutOfFocus
  64496. */
  64497. setDarkenOutOfFocus(amount: number): void;
  64498. private _pentagonBokehIsEnabled;
  64499. /**
  64500. * Creates a pentagon bokeh effect
  64501. */
  64502. enablePentagonBokeh(): void;
  64503. /**
  64504. * Disables the pentagon bokeh effect
  64505. */
  64506. disablePentagonBokeh(): void;
  64507. /**
  64508. * Enables noise blur
  64509. */
  64510. enableNoiseBlur(): void;
  64511. /**
  64512. * Disables noise blur
  64513. */
  64514. disableNoiseBlur(): void;
  64515. /**
  64516. * Sets the HighlightsGain amount
  64517. * @param amount amount of HighlightsGain
  64518. */
  64519. setHighlightsGain(amount: number): void;
  64520. /**
  64521. * Sets the HighlightsThreshold amount
  64522. * @param amount amount of HighlightsThreshold
  64523. */
  64524. setHighlightsThreshold(amount: number): void;
  64525. /**
  64526. * Disables highlights
  64527. */
  64528. disableHighlights(): void;
  64529. /**
  64530. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  64531. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  64532. */
  64533. dispose(disableDepthRender?: boolean): void;
  64534. private _createChromaticAberrationPostProcess;
  64535. private _createHighlightsPostProcess;
  64536. private _createDepthOfFieldPostProcess;
  64537. private _createGrainTexture;
  64538. }
  64539. }
  64540. declare module "babylonjs/Shaders/ssao2.fragment" {
  64541. /** @hidden */
  64542. export var ssao2PixelShader: {
  64543. name: string;
  64544. shader: string;
  64545. };
  64546. }
  64547. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  64548. /** @hidden */
  64549. export var ssaoCombinePixelShader: {
  64550. name: string;
  64551. shader: string;
  64552. };
  64553. }
  64554. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  64555. import { Camera } from "babylonjs/Cameras/camera";
  64556. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64557. import { Scene } from "babylonjs/scene";
  64558. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64559. import "babylonjs/Shaders/ssao2.fragment";
  64560. import "babylonjs/Shaders/ssaoCombine.fragment";
  64561. /**
  64562. * Render pipeline to produce ssao effect
  64563. */
  64564. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  64565. /**
  64566. * @ignore
  64567. * The PassPostProcess id in the pipeline that contains the original scene color
  64568. */
  64569. SSAOOriginalSceneColorEffect: string;
  64570. /**
  64571. * @ignore
  64572. * The SSAO PostProcess id in the pipeline
  64573. */
  64574. SSAORenderEffect: string;
  64575. /**
  64576. * @ignore
  64577. * The horizontal blur PostProcess id in the pipeline
  64578. */
  64579. SSAOBlurHRenderEffect: string;
  64580. /**
  64581. * @ignore
  64582. * The vertical blur PostProcess id in the pipeline
  64583. */
  64584. SSAOBlurVRenderEffect: string;
  64585. /**
  64586. * @ignore
  64587. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  64588. */
  64589. SSAOCombineRenderEffect: string;
  64590. /**
  64591. * The output strength of the SSAO post-process. Default value is 1.0.
  64592. */
  64593. totalStrength: number;
  64594. /**
  64595. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  64596. */
  64597. maxZ: number;
  64598. /**
  64599. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  64600. */
  64601. minZAspect: number;
  64602. private _samples;
  64603. /**
  64604. * Number of samples used for the SSAO calculations. Default value is 8
  64605. */
  64606. samples: number;
  64607. private _textureSamples;
  64608. /**
  64609. * Number of samples to use for antialiasing
  64610. */
  64611. textureSamples: number;
  64612. /**
  64613. * Ratio object used for SSAO ratio and blur ratio
  64614. */
  64615. private _ratio;
  64616. /**
  64617. * Dynamically generated sphere sampler.
  64618. */
  64619. private _sampleSphere;
  64620. /**
  64621. * Blur filter offsets
  64622. */
  64623. private _samplerOffsets;
  64624. private _expensiveBlur;
  64625. /**
  64626. * If bilateral blur should be used
  64627. */
  64628. expensiveBlur: boolean;
  64629. /**
  64630. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  64631. */
  64632. radius: number;
  64633. /**
  64634. * The base color of the SSAO post-process
  64635. * The final result is "base + ssao" between [0, 1]
  64636. */
  64637. base: number;
  64638. /**
  64639. * Support test.
  64640. */
  64641. static readonly IsSupported: boolean;
  64642. private _scene;
  64643. private _depthTexture;
  64644. private _normalTexture;
  64645. private _randomTexture;
  64646. private _originalColorPostProcess;
  64647. private _ssaoPostProcess;
  64648. private _blurHPostProcess;
  64649. private _blurVPostProcess;
  64650. private _ssaoCombinePostProcess;
  64651. private _firstUpdate;
  64652. /**
  64653. * Gets active scene
  64654. */
  64655. readonly scene: Scene;
  64656. /**
  64657. * @constructor
  64658. * @param name The rendering pipeline name
  64659. * @param scene The scene linked to this pipeline
  64660. * @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 }
  64661. * @param cameras The array of cameras that the rendering pipeline will be attached to
  64662. */
  64663. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  64664. /**
  64665. * Get the class name
  64666. * @returns "SSAO2RenderingPipeline"
  64667. */
  64668. getClassName(): string;
  64669. /**
  64670. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  64671. */
  64672. dispose(disableGeometryBufferRenderer?: boolean): void;
  64673. private _createBlurPostProcess;
  64674. /** @hidden */
  64675. _rebuild(): void;
  64676. private _bits;
  64677. private _radicalInverse_VdC;
  64678. private _hammersley;
  64679. private _hemisphereSample_uniform;
  64680. private _generateHemisphere;
  64681. private _createSSAOPostProcess;
  64682. private _createSSAOCombinePostProcess;
  64683. private _createRandomTexture;
  64684. /**
  64685. * Serialize the rendering pipeline (Used when exporting)
  64686. * @returns the serialized object
  64687. */
  64688. serialize(): any;
  64689. /**
  64690. * Parse the serialized pipeline
  64691. * @param source Source pipeline.
  64692. * @param scene The scene to load the pipeline to.
  64693. * @param rootUrl The URL of the serialized pipeline.
  64694. * @returns An instantiated pipeline from the serialized object.
  64695. */
  64696. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  64697. }
  64698. }
  64699. declare module "babylonjs/Shaders/ssao.fragment" {
  64700. /** @hidden */
  64701. export var ssaoPixelShader: {
  64702. name: string;
  64703. shader: string;
  64704. };
  64705. }
  64706. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  64707. import { Camera } from "babylonjs/Cameras/camera";
  64708. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64709. import { Scene } from "babylonjs/scene";
  64710. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64711. import "babylonjs/Shaders/ssao.fragment";
  64712. import "babylonjs/Shaders/ssaoCombine.fragment";
  64713. /**
  64714. * Render pipeline to produce ssao effect
  64715. */
  64716. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  64717. /**
  64718. * @ignore
  64719. * The PassPostProcess id in the pipeline that contains the original scene color
  64720. */
  64721. SSAOOriginalSceneColorEffect: string;
  64722. /**
  64723. * @ignore
  64724. * The SSAO PostProcess id in the pipeline
  64725. */
  64726. SSAORenderEffect: string;
  64727. /**
  64728. * @ignore
  64729. * The horizontal blur PostProcess id in the pipeline
  64730. */
  64731. SSAOBlurHRenderEffect: string;
  64732. /**
  64733. * @ignore
  64734. * The vertical blur PostProcess id in the pipeline
  64735. */
  64736. SSAOBlurVRenderEffect: string;
  64737. /**
  64738. * @ignore
  64739. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  64740. */
  64741. SSAOCombineRenderEffect: string;
  64742. /**
  64743. * The output strength of the SSAO post-process. Default value is 1.0.
  64744. */
  64745. totalStrength: number;
  64746. /**
  64747. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  64748. */
  64749. radius: number;
  64750. /**
  64751. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  64752. * Must not be equal to fallOff and superior to fallOff.
  64753. * Default value is 0.0075
  64754. */
  64755. area: number;
  64756. /**
  64757. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  64758. * Must not be equal to area and inferior to area.
  64759. * Default value is 0.000001
  64760. */
  64761. fallOff: number;
  64762. /**
  64763. * The base color of the SSAO post-process
  64764. * The final result is "base + ssao" between [0, 1]
  64765. */
  64766. base: number;
  64767. private _scene;
  64768. private _depthTexture;
  64769. private _randomTexture;
  64770. private _originalColorPostProcess;
  64771. private _ssaoPostProcess;
  64772. private _blurHPostProcess;
  64773. private _blurVPostProcess;
  64774. private _ssaoCombinePostProcess;
  64775. private _firstUpdate;
  64776. /**
  64777. * Gets active scene
  64778. */
  64779. readonly scene: Scene;
  64780. /**
  64781. * @constructor
  64782. * @param name - The rendering pipeline name
  64783. * @param scene - The scene linked to this pipeline
  64784. * @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 }
  64785. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  64786. */
  64787. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  64788. /**
  64789. * Get the class name
  64790. * @returns "SSAORenderingPipeline"
  64791. */
  64792. getClassName(): string;
  64793. /**
  64794. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  64795. */
  64796. dispose(disableDepthRender?: boolean): void;
  64797. private _createBlurPostProcess;
  64798. /** @hidden */
  64799. _rebuild(): void;
  64800. private _createSSAOPostProcess;
  64801. private _createSSAOCombinePostProcess;
  64802. private _createRandomTexture;
  64803. }
  64804. }
  64805. declare module "babylonjs/Shaders/standard.fragment" {
  64806. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  64807. /** @hidden */
  64808. export var standardPixelShader: {
  64809. name: string;
  64810. shader: string;
  64811. };
  64812. }
  64813. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  64814. import { Nullable } from "babylonjs/types";
  64815. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  64816. import { Camera } from "babylonjs/Cameras/camera";
  64817. import { Texture } from "babylonjs/Materials/Textures/texture";
  64818. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  64819. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64820. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  64821. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  64822. import { IDisposable } from "babylonjs/scene";
  64823. import { SpotLight } from "babylonjs/Lights/spotLight";
  64824. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  64825. import { Scene } from "babylonjs/scene";
  64826. import { Animation } from "babylonjs/Animations/animation";
  64827. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64828. import "babylonjs/Shaders/standard.fragment";
  64829. /**
  64830. * Standard rendering pipeline
  64831. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  64832. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  64833. */
  64834. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  64835. /**
  64836. * Public members
  64837. */
  64838. /**
  64839. * Post-process which contains the original scene color before the pipeline applies all the effects
  64840. */
  64841. originalPostProcess: Nullable<PostProcess>;
  64842. /**
  64843. * Post-process used to down scale an image x4
  64844. */
  64845. downSampleX4PostProcess: Nullable<PostProcess>;
  64846. /**
  64847. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  64848. */
  64849. brightPassPostProcess: Nullable<PostProcess>;
  64850. /**
  64851. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  64852. */
  64853. blurHPostProcesses: PostProcess[];
  64854. /**
  64855. * Post-process array storing all the vertical blur post-processes used by the pipeline
  64856. */
  64857. blurVPostProcesses: PostProcess[];
  64858. /**
  64859. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  64860. */
  64861. textureAdderPostProcess: Nullable<PostProcess>;
  64862. /**
  64863. * Post-process used to create volumetric lighting effect
  64864. */
  64865. volumetricLightPostProcess: Nullable<PostProcess>;
  64866. /**
  64867. * Post-process used to smooth the previous volumetric light post-process on the X axis
  64868. */
  64869. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  64870. /**
  64871. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  64872. */
  64873. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  64874. /**
  64875. * Post-process used to merge the volumetric light effect and the real scene color
  64876. */
  64877. volumetricLightMergePostProces: Nullable<PostProcess>;
  64878. /**
  64879. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  64880. */
  64881. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  64882. /**
  64883. * Base post-process used to calculate the average luminance of the final image for HDR
  64884. */
  64885. luminancePostProcess: Nullable<PostProcess>;
  64886. /**
  64887. * Post-processes used to create down sample post-processes in order to get
  64888. * the average luminance of the final image for HDR
  64889. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  64890. */
  64891. luminanceDownSamplePostProcesses: PostProcess[];
  64892. /**
  64893. * Post-process used to create a HDR effect (light adaptation)
  64894. */
  64895. hdrPostProcess: Nullable<PostProcess>;
  64896. /**
  64897. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  64898. */
  64899. textureAdderFinalPostProcess: Nullable<PostProcess>;
  64900. /**
  64901. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  64902. */
  64903. lensFlareFinalPostProcess: Nullable<PostProcess>;
  64904. /**
  64905. * Post-process used to merge the final HDR post-process and the real scene color
  64906. */
  64907. hdrFinalPostProcess: Nullable<PostProcess>;
  64908. /**
  64909. * Post-process used to create a lens flare effect
  64910. */
  64911. lensFlarePostProcess: Nullable<PostProcess>;
  64912. /**
  64913. * Post-process that merges the result of the lens flare post-process and the real scene color
  64914. */
  64915. lensFlareComposePostProcess: Nullable<PostProcess>;
  64916. /**
  64917. * Post-process used to create a motion blur effect
  64918. */
  64919. motionBlurPostProcess: Nullable<PostProcess>;
  64920. /**
  64921. * Post-process used to create a depth of field effect
  64922. */
  64923. depthOfFieldPostProcess: Nullable<PostProcess>;
  64924. /**
  64925. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  64926. */
  64927. fxaaPostProcess: Nullable<FxaaPostProcess>;
  64928. /**
  64929. * Represents the brightness threshold in order to configure the illuminated surfaces
  64930. */
  64931. brightThreshold: number;
  64932. /**
  64933. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  64934. */
  64935. blurWidth: number;
  64936. /**
  64937. * Sets if the blur for highlighted surfaces must be only horizontal
  64938. */
  64939. horizontalBlur: boolean;
  64940. /**
  64941. * Gets the overall exposure used by the pipeline
  64942. */
  64943. /**
  64944. * Sets the overall exposure used by the pipeline
  64945. */
  64946. exposure: number;
  64947. /**
  64948. * Texture used typically to simulate "dirty" on camera lens
  64949. */
  64950. lensTexture: Nullable<Texture>;
  64951. /**
  64952. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  64953. */
  64954. volumetricLightCoefficient: number;
  64955. /**
  64956. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  64957. */
  64958. volumetricLightPower: number;
  64959. /**
  64960. * Used the set the blur intensity to smooth the volumetric lights
  64961. */
  64962. volumetricLightBlurScale: number;
  64963. /**
  64964. * Light (spot or directional) used to generate the volumetric lights rays
  64965. * The source light must have a shadow generate so the pipeline can get its
  64966. * depth map
  64967. */
  64968. sourceLight: Nullable<SpotLight | DirectionalLight>;
  64969. /**
  64970. * For eye adaptation, represents the minimum luminance the eye can see
  64971. */
  64972. hdrMinimumLuminance: number;
  64973. /**
  64974. * For eye adaptation, represents the decrease luminance speed
  64975. */
  64976. hdrDecreaseRate: number;
  64977. /**
  64978. * For eye adaptation, represents the increase luminance speed
  64979. */
  64980. hdrIncreaseRate: number;
  64981. /**
  64982. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  64983. */
  64984. /**
  64985. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  64986. */
  64987. hdrAutoExposure: boolean;
  64988. /**
  64989. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  64990. */
  64991. lensColorTexture: Nullable<Texture>;
  64992. /**
  64993. * The overall strengh for the lens flare effect
  64994. */
  64995. lensFlareStrength: number;
  64996. /**
  64997. * Dispersion coefficient for lens flare ghosts
  64998. */
  64999. lensFlareGhostDispersal: number;
  65000. /**
  65001. * Main lens flare halo width
  65002. */
  65003. lensFlareHaloWidth: number;
  65004. /**
  65005. * Based on the lens distortion effect, defines how much the lens flare result
  65006. * is distorted
  65007. */
  65008. lensFlareDistortionStrength: number;
  65009. /**
  65010. * Configures the blur intensity used for for lens flare (halo)
  65011. */
  65012. lensFlareBlurWidth: number;
  65013. /**
  65014. * Lens star texture must be used to simulate rays on the flares and is available
  65015. * in the documentation
  65016. */
  65017. lensStarTexture: Nullable<Texture>;
  65018. /**
  65019. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  65020. * flare effect by taking account of the dirt texture
  65021. */
  65022. lensFlareDirtTexture: Nullable<Texture>;
  65023. /**
  65024. * Represents the focal length for the depth of field effect
  65025. */
  65026. depthOfFieldDistance: number;
  65027. /**
  65028. * Represents the blur intensity for the blurred part of the depth of field effect
  65029. */
  65030. depthOfFieldBlurWidth: number;
  65031. /**
  65032. * Gets how much the image is blurred by the movement while using the motion blur post-process
  65033. */
  65034. /**
  65035. * Sets how much the image is blurred by the movement while using the motion blur post-process
  65036. */
  65037. motionStrength: number;
  65038. /**
  65039. * Gets wether or not the motion blur post-process is object based or screen based.
  65040. */
  65041. /**
  65042. * Sets wether or not the motion blur post-process should be object based or screen based
  65043. */
  65044. objectBasedMotionBlur: boolean;
  65045. /**
  65046. * List of animations for the pipeline (IAnimatable implementation)
  65047. */
  65048. animations: Animation[];
  65049. /**
  65050. * Private members
  65051. */
  65052. private _scene;
  65053. private _currentDepthOfFieldSource;
  65054. private _basePostProcess;
  65055. private _fixedExposure;
  65056. private _currentExposure;
  65057. private _hdrAutoExposure;
  65058. private _hdrCurrentLuminance;
  65059. private _motionStrength;
  65060. private _isObjectBasedMotionBlur;
  65061. private _floatTextureType;
  65062. private _camerasToBeAttached;
  65063. private _ratio;
  65064. private _bloomEnabled;
  65065. private _depthOfFieldEnabled;
  65066. private _vlsEnabled;
  65067. private _lensFlareEnabled;
  65068. private _hdrEnabled;
  65069. private _motionBlurEnabled;
  65070. private _fxaaEnabled;
  65071. private _motionBlurSamples;
  65072. private _volumetricLightStepsCount;
  65073. private _samples;
  65074. /**
  65075. * @ignore
  65076. * Specifies if the bloom pipeline is enabled
  65077. */
  65078. BloomEnabled: boolean;
  65079. /**
  65080. * @ignore
  65081. * Specifies if the depth of field pipeline is enabed
  65082. */
  65083. DepthOfFieldEnabled: boolean;
  65084. /**
  65085. * @ignore
  65086. * Specifies if the lens flare pipeline is enabed
  65087. */
  65088. LensFlareEnabled: boolean;
  65089. /**
  65090. * @ignore
  65091. * Specifies if the HDR pipeline is enabled
  65092. */
  65093. HDREnabled: boolean;
  65094. /**
  65095. * @ignore
  65096. * Specifies if the volumetric lights scattering effect is enabled
  65097. */
  65098. VLSEnabled: boolean;
  65099. /**
  65100. * @ignore
  65101. * Specifies if the motion blur effect is enabled
  65102. */
  65103. MotionBlurEnabled: boolean;
  65104. /**
  65105. * Specifies if anti-aliasing is enabled
  65106. */
  65107. fxaaEnabled: boolean;
  65108. /**
  65109. * Specifies the number of steps used to calculate the volumetric lights
  65110. * Typically in interval [50, 200]
  65111. */
  65112. volumetricLightStepsCount: number;
  65113. /**
  65114. * Specifies the number of samples used for the motion blur effect
  65115. * Typically in interval [16, 64]
  65116. */
  65117. motionBlurSamples: number;
  65118. /**
  65119. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  65120. */
  65121. samples: number;
  65122. /**
  65123. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  65124. * @constructor
  65125. * @param name The rendering pipeline name
  65126. * @param scene The scene linked to this pipeline
  65127. * @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)
  65128. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  65129. * @param cameras The array of cameras that the rendering pipeline will be attached to
  65130. */
  65131. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  65132. private _buildPipeline;
  65133. private _createDownSampleX4PostProcess;
  65134. private _createBrightPassPostProcess;
  65135. private _createBlurPostProcesses;
  65136. private _createTextureAdderPostProcess;
  65137. private _createVolumetricLightPostProcess;
  65138. private _createLuminancePostProcesses;
  65139. private _createHdrPostProcess;
  65140. private _createLensFlarePostProcess;
  65141. private _createDepthOfFieldPostProcess;
  65142. private _createMotionBlurPostProcess;
  65143. private _getDepthTexture;
  65144. private _disposePostProcesses;
  65145. /**
  65146. * Dispose of the pipeline and stop all post processes
  65147. */
  65148. dispose(): void;
  65149. /**
  65150. * Serialize the rendering pipeline (Used when exporting)
  65151. * @returns the serialized object
  65152. */
  65153. serialize(): any;
  65154. /**
  65155. * Parse the serialized pipeline
  65156. * @param source Source pipeline.
  65157. * @param scene The scene to load the pipeline to.
  65158. * @param rootUrl The URL of the serialized pipeline.
  65159. * @returns An instantiated pipeline from the serialized object.
  65160. */
  65161. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  65162. /**
  65163. * Luminance steps
  65164. */
  65165. static LuminanceSteps: number;
  65166. }
  65167. }
  65168. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  65169. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  65170. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  65171. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  65172. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  65173. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  65174. }
  65175. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  65176. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  65177. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  65178. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  65179. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  65180. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  65181. }
  65182. declare module "babylonjs/Shaders/tonemap.fragment" {
  65183. /** @hidden */
  65184. export var tonemapPixelShader: {
  65185. name: string;
  65186. shader: string;
  65187. };
  65188. }
  65189. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  65190. import { Camera } from "babylonjs/Cameras/camera";
  65191. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  65192. import "babylonjs/Shaders/tonemap.fragment";
  65193. import { Engine } from "babylonjs/Engines/engine";
  65194. /** Defines operator used for tonemapping */
  65195. export enum TonemappingOperator {
  65196. /** Hable */
  65197. Hable = 0,
  65198. /** Reinhard */
  65199. Reinhard = 1,
  65200. /** HejiDawson */
  65201. HejiDawson = 2,
  65202. /** Photographic */
  65203. Photographic = 3
  65204. }
  65205. /**
  65206. * Defines a post process to apply tone mapping
  65207. */
  65208. export class TonemapPostProcess extends PostProcess {
  65209. private _operator;
  65210. /** Defines the required exposure adjustement */
  65211. exposureAdjustment: number;
  65212. /**
  65213. * Creates a new TonemapPostProcess
  65214. * @param name defines the name of the postprocess
  65215. * @param _operator defines the operator to use
  65216. * @param exposureAdjustment defines the required exposure adjustement
  65217. * @param camera defines the camera to use (can be null)
  65218. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  65219. * @param engine defines the hosting engine (can be ignore if camera is set)
  65220. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  65221. */
  65222. constructor(name: string, _operator: TonemappingOperator,
  65223. /** Defines the required exposure adjustement */
  65224. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  65225. }
  65226. }
  65227. declare module "babylonjs/Shaders/depth.vertex" {
  65228. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65229. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65230. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65231. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  65232. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  65233. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  65234. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65235. /** @hidden */
  65236. export var depthVertexShader: {
  65237. name: string;
  65238. shader: string;
  65239. };
  65240. }
  65241. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  65242. /** @hidden */
  65243. export var volumetricLightScatteringPixelShader: {
  65244. name: string;
  65245. shader: string;
  65246. };
  65247. }
  65248. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  65249. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65250. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65251. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65252. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  65253. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  65254. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  65255. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65256. /** @hidden */
  65257. export var volumetricLightScatteringPassVertexShader: {
  65258. name: string;
  65259. shader: string;
  65260. };
  65261. }
  65262. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  65263. /** @hidden */
  65264. export var volumetricLightScatteringPassPixelShader: {
  65265. name: string;
  65266. shader: string;
  65267. };
  65268. }
  65269. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  65270. import { Vector3 } from "babylonjs/Maths/math.vector";
  65271. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65272. import { Mesh } from "babylonjs/Meshes/mesh";
  65273. import { Camera } from "babylonjs/Cameras/camera";
  65274. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65275. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  65276. import { Scene } from "babylonjs/scene";
  65277. import "babylonjs/Meshes/Builders/planeBuilder";
  65278. import "babylonjs/Shaders/depth.vertex";
  65279. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  65280. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  65281. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  65282. import { Engine } from "babylonjs/Engines/engine";
  65283. /**
  65284. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  65285. */
  65286. export class VolumetricLightScatteringPostProcess extends PostProcess {
  65287. private _volumetricLightScatteringPass;
  65288. private _volumetricLightScatteringRTT;
  65289. private _viewPort;
  65290. private _screenCoordinates;
  65291. private _cachedDefines;
  65292. /**
  65293. * If not undefined, the mesh position is computed from the attached node position
  65294. */
  65295. attachedNode: {
  65296. position: Vector3;
  65297. };
  65298. /**
  65299. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  65300. */
  65301. customMeshPosition: Vector3;
  65302. /**
  65303. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  65304. */
  65305. useCustomMeshPosition: boolean;
  65306. /**
  65307. * If the post-process should inverse the light scattering direction
  65308. */
  65309. invert: boolean;
  65310. /**
  65311. * The internal mesh used by the post-process
  65312. */
  65313. mesh: Mesh;
  65314. /**
  65315. * @hidden
  65316. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  65317. */
  65318. useDiffuseColor: boolean;
  65319. /**
  65320. * Array containing the excluded meshes not rendered in the internal pass
  65321. */
  65322. excludedMeshes: AbstractMesh[];
  65323. /**
  65324. * Controls the overall intensity of the post-process
  65325. */
  65326. exposure: number;
  65327. /**
  65328. * Dissipates each sample's contribution in range [0, 1]
  65329. */
  65330. decay: number;
  65331. /**
  65332. * Controls the overall intensity of each sample
  65333. */
  65334. weight: number;
  65335. /**
  65336. * Controls the density of each sample
  65337. */
  65338. density: number;
  65339. /**
  65340. * @constructor
  65341. * @param name The post-process name
  65342. * @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)
  65343. * @param camera The camera that the post-process will be attached to
  65344. * @param mesh The mesh used to create the light scattering
  65345. * @param samples The post-process quality, default 100
  65346. * @param samplingModeThe post-process filtering mode
  65347. * @param engine The babylon engine
  65348. * @param reusable If the post-process is reusable
  65349. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  65350. */
  65351. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  65352. /**
  65353. * Returns the string "VolumetricLightScatteringPostProcess"
  65354. * @returns "VolumetricLightScatteringPostProcess"
  65355. */
  65356. getClassName(): string;
  65357. private _isReady;
  65358. /**
  65359. * Sets the new light position for light scattering effect
  65360. * @param position The new custom light position
  65361. */
  65362. setCustomMeshPosition(position: Vector3): void;
  65363. /**
  65364. * Returns the light position for light scattering effect
  65365. * @return Vector3 The custom light position
  65366. */
  65367. getCustomMeshPosition(): Vector3;
  65368. /**
  65369. * Disposes the internal assets and detaches the post-process from the camera
  65370. */
  65371. dispose(camera: Camera): void;
  65372. /**
  65373. * Returns the render target texture used by the post-process
  65374. * @return the render target texture used by the post-process
  65375. */
  65376. getPass(): RenderTargetTexture;
  65377. private _meshExcluded;
  65378. private _createPass;
  65379. private _updateMeshScreenCoordinates;
  65380. /**
  65381. * Creates a default mesh for the Volumeric Light Scattering post-process
  65382. * @param name The mesh name
  65383. * @param scene The scene where to create the mesh
  65384. * @return the default mesh
  65385. */
  65386. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  65387. }
  65388. }
  65389. declare module "babylonjs/PostProcesses/index" {
  65390. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  65391. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  65392. export * from "babylonjs/PostProcesses/bloomEffect";
  65393. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  65394. export * from "babylonjs/PostProcesses/blurPostProcess";
  65395. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  65396. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  65397. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  65398. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  65399. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  65400. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  65401. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  65402. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  65403. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  65404. export * from "babylonjs/PostProcesses/filterPostProcess";
  65405. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  65406. export * from "babylonjs/PostProcesses/grainPostProcess";
  65407. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  65408. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  65409. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  65410. export * from "babylonjs/PostProcesses/passPostProcess";
  65411. export * from "babylonjs/PostProcesses/postProcess";
  65412. export * from "babylonjs/PostProcesses/postProcessManager";
  65413. export * from "babylonjs/PostProcesses/refractionPostProcess";
  65414. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  65415. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  65416. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  65417. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  65418. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  65419. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  65420. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  65421. }
  65422. declare module "babylonjs/Probes/index" {
  65423. export * from "babylonjs/Probes/reflectionProbe";
  65424. }
  65425. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  65426. import { Scene } from "babylonjs/scene";
  65427. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65428. import { SmartArray } from "babylonjs/Misc/smartArray";
  65429. import { ISceneComponent } from "babylonjs/sceneComponent";
  65430. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  65431. import "babylonjs/Meshes/Builders/boxBuilder";
  65432. import "babylonjs/Shaders/color.fragment";
  65433. import "babylonjs/Shaders/color.vertex";
  65434. import { Color3 } from "babylonjs/Maths/math.color";
  65435. module "babylonjs/scene" {
  65436. interface Scene {
  65437. /** @hidden (Backing field) */
  65438. _boundingBoxRenderer: BoundingBoxRenderer;
  65439. /** @hidden (Backing field) */
  65440. _forceShowBoundingBoxes: boolean;
  65441. /**
  65442. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  65443. */
  65444. forceShowBoundingBoxes: boolean;
  65445. /**
  65446. * Gets the bounding box renderer associated with the scene
  65447. * @returns a BoundingBoxRenderer
  65448. */
  65449. getBoundingBoxRenderer(): BoundingBoxRenderer;
  65450. }
  65451. }
  65452. module "babylonjs/Meshes/abstractMesh" {
  65453. interface AbstractMesh {
  65454. /** @hidden (Backing field) */
  65455. _showBoundingBox: boolean;
  65456. /**
  65457. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  65458. */
  65459. showBoundingBox: boolean;
  65460. }
  65461. }
  65462. /**
  65463. * Component responsible of rendering the bounding box of the meshes in a scene.
  65464. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  65465. */
  65466. export class BoundingBoxRenderer implements ISceneComponent {
  65467. /**
  65468. * The component name helpfull to identify the component in the list of scene components.
  65469. */
  65470. readonly name: string;
  65471. /**
  65472. * The scene the component belongs to.
  65473. */
  65474. scene: Scene;
  65475. /**
  65476. * Color of the bounding box lines placed in front of an object
  65477. */
  65478. frontColor: Color3;
  65479. /**
  65480. * Color of the bounding box lines placed behind an object
  65481. */
  65482. backColor: Color3;
  65483. /**
  65484. * Defines if the renderer should show the back lines or not
  65485. */
  65486. showBackLines: boolean;
  65487. /**
  65488. * @hidden
  65489. */
  65490. renderList: SmartArray<BoundingBox>;
  65491. private _colorShader;
  65492. private _vertexBuffers;
  65493. private _indexBuffer;
  65494. private _fillIndexBuffer;
  65495. private _fillIndexData;
  65496. /**
  65497. * Instantiates a new bounding box renderer in a scene.
  65498. * @param scene the scene the renderer renders in
  65499. */
  65500. constructor(scene: Scene);
  65501. /**
  65502. * Registers the component in a given scene
  65503. */
  65504. register(): void;
  65505. private _evaluateSubMesh;
  65506. private _activeMesh;
  65507. private _prepareRessources;
  65508. private _createIndexBuffer;
  65509. /**
  65510. * Rebuilds the elements related to this component in case of
  65511. * context lost for instance.
  65512. */
  65513. rebuild(): void;
  65514. /**
  65515. * @hidden
  65516. */
  65517. reset(): void;
  65518. /**
  65519. * Render the bounding boxes of a specific rendering group
  65520. * @param renderingGroupId defines the rendering group to render
  65521. */
  65522. render(renderingGroupId: number): void;
  65523. /**
  65524. * In case of occlusion queries, we can render the occlusion bounding box through this method
  65525. * @param mesh Define the mesh to render the occlusion bounding box for
  65526. */
  65527. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  65528. /**
  65529. * Dispose and release the resources attached to this renderer.
  65530. */
  65531. dispose(): void;
  65532. }
  65533. }
  65534. declare module "babylonjs/Shaders/depth.fragment" {
  65535. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  65536. /** @hidden */
  65537. export var depthPixelShader: {
  65538. name: string;
  65539. shader: string;
  65540. };
  65541. }
  65542. declare module "babylonjs/Rendering/depthRenderer" {
  65543. import { Nullable } from "babylonjs/types";
  65544. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65545. import { Scene } from "babylonjs/scene";
  65546. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65547. import { Camera } from "babylonjs/Cameras/camera";
  65548. import "babylonjs/Shaders/depth.fragment";
  65549. import "babylonjs/Shaders/depth.vertex";
  65550. /**
  65551. * This represents a depth renderer in Babylon.
  65552. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  65553. */
  65554. export class DepthRenderer {
  65555. private _scene;
  65556. private _depthMap;
  65557. private _effect;
  65558. private readonly _storeNonLinearDepth;
  65559. private readonly _clearColor;
  65560. /** Get if the depth renderer is using packed depth or not */
  65561. readonly isPacked: boolean;
  65562. private _cachedDefines;
  65563. private _camera;
  65564. /**
  65565. * Specifiess that the depth renderer will only be used within
  65566. * the camera it is created for.
  65567. * This can help forcing its rendering during the camera processing.
  65568. */
  65569. useOnlyInActiveCamera: boolean;
  65570. /** @hidden */
  65571. static _SceneComponentInitialization: (scene: Scene) => void;
  65572. /**
  65573. * Instantiates a depth renderer
  65574. * @param scene The scene the renderer belongs to
  65575. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  65576. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  65577. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  65578. */
  65579. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  65580. /**
  65581. * Creates the depth rendering effect and checks if the effect is ready.
  65582. * @param subMesh The submesh to be used to render the depth map of
  65583. * @param useInstances If multiple world instances should be used
  65584. * @returns if the depth renderer is ready to render the depth map
  65585. */
  65586. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  65587. /**
  65588. * Gets the texture which the depth map will be written to.
  65589. * @returns The depth map texture
  65590. */
  65591. getDepthMap(): RenderTargetTexture;
  65592. /**
  65593. * Disposes of the depth renderer.
  65594. */
  65595. dispose(): void;
  65596. }
  65597. }
  65598. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  65599. import { Nullable } from "babylonjs/types";
  65600. import { Scene } from "babylonjs/scene";
  65601. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  65602. import { Camera } from "babylonjs/Cameras/camera";
  65603. import { ISceneComponent } from "babylonjs/sceneComponent";
  65604. module "babylonjs/scene" {
  65605. interface Scene {
  65606. /** @hidden (Backing field) */
  65607. _depthRenderer: {
  65608. [id: string]: DepthRenderer;
  65609. };
  65610. /**
  65611. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  65612. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  65613. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  65614. * @returns the created depth renderer
  65615. */
  65616. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  65617. /**
  65618. * Disables a depth renderer for a given camera
  65619. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  65620. */
  65621. disableDepthRenderer(camera?: Nullable<Camera>): void;
  65622. }
  65623. }
  65624. /**
  65625. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  65626. * in several rendering techniques.
  65627. */
  65628. export class DepthRendererSceneComponent implements ISceneComponent {
  65629. /**
  65630. * The component name helpfull to identify the component in the list of scene components.
  65631. */
  65632. readonly name: string;
  65633. /**
  65634. * The scene the component belongs to.
  65635. */
  65636. scene: Scene;
  65637. /**
  65638. * Creates a new instance of the component for the given scene
  65639. * @param scene Defines the scene to register the component in
  65640. */
  65641. constructor(scene: Scene);
  65642. /**
  65643. * Registers the component in a given scene
  65644. */
  65645. register(): void;
  65646. /**
  65647. * Rebuilds the elements related to this component in case of
  65648. * context lost for instance.
  65649. */
  65650. rebuild(): void;
  65651. /**
  65652. * Disposes the component and the associated ressources
  65653. */
  65654. dispose(): void;
  65655. private _gatherRenderTargets;
  65656. private _gatherActiveCameraRenderTargets;
  65657. }
  65658. }
  65659. declare module "babylonjs/Shaders/outline.fragment" {
  65660. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  65661. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  65662. /** @hidden */
  65663. export var outlinePixelShader: {
  65664. name: string;
  65665. shader: string;
  65666. };
  65667. }
  65668. declare module "babylonjs/Shaders/outline.vertex" {
  65669. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65670. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65671. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65672. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  65673. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  65674. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  65675. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  65676. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65677. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  65678. /** @hidden */
  65679. export var outlineVertexShader: {
  65680. name: string;
  65681. shader: string;
  65682. };
  65683. }
  65684. declare module "babylonjs/Rendering/outlineRenderer" {
  65685. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65686. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  65687. import { Scene } from "babylonjs/scene";
  65688. import { ISceneComponent } from "babylonjs/sceneComponent";
  65689. import "babylonjs/Shaders/outline.fragment";
  65690. import "babylonjs/Shaders/outline.vertex";
  65691. module "babylonjs/scene" {
  65692. interface Scene {
  65693. /** @hidden */
  65694. _outlineRenderer: OutlineRenderer;
  65695. /**
  65696. * Gets the outline renderer associated with the scene
  65697. * @returns a OutlineRenderer
  65698. */
  65699. getOutlineRenderer(): OutlineRenderer;
  65700. }
  65701. }
  65702. module "babylonjs/Meshes/abstractMesh" {
  65703. interface AbstractMesh {
  65704. /** @hidden (Backing field) */
  65705. _renderOutline: boolean;
  65706. /**
  65707. * Gets or sets a boolean indicating if the outline must be rendered as well
  65708. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  65709. */
  65710. renderOutline: boolean;
  65711. /** @hidden (Backing field) */
  65712. _renderOverlay: boolean;
  65713. /**
  65714. * Gets or sets a boolean indicating if the overlay must be rendered as well
  65715. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  65716. */
  65717. renderOverlay: boolean;
  65718. }
  65719. }
  65720. /**
  65721. * This class is responsible to draw bothe outline/overlay of meshes.
  65722. * It should not be used directly but through the available method on mesh.
  65723. */
  65724. export class OutlineRenderer implements ISceneComponent {
  65725. /**
  65726. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  65727. */
  65728. private static _StencilReference;
  65729. /**
  65730. * The name of the component. Each component must have a unique name.
  65731. */
  65732. name: string;
  65733. /**
  65734. * The scene the component belongs to.
  65735. */
  65736. scene: Scene;
  65737. /**
  65738. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  65739. */
  65740. zOffset: number;
  65741. private _engine;
  65742. private _effect;
  65743. private _cachedDefines;
  65744. private _savedDepthWrite;
  65745. /**
  65746. * Instantiates a new outline renderer. (There could be only one per scene).
  65747. * @param scene Defines the scene it belongs to
  65748. */
  65749. constructor(scene: Scene);
  65750. /**
  65751. * Register the component to one instance of a scene.
  65752. */
  65753. register(): void;
  65754. /**
  65755. * Rebuilds the elements related to this component in case of
  65756. * context lost for instance.
  65757. */
  65758. rebuild(): void;
  65759. /**
  65760. * Disposes the component and the associated ressources.
  65761. */
  65762. dispose(): void;
  65763. /**
  65764. * Renders the outline in the canvas.
  65765. * @param subMesh Defines the sumesh to render
  65766. * @param batch Defines the batch of meshes in case of instances
  65767. * @param useOverlay Defines if the rendering is for the overlay or the outline
  65768. */
  65769. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  65770. /**
  65771. * Returns whether or not the outline renderer is ready for a given submesh.
  65772. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  65773. * @param subMesh Defines the submesh to check readyness for
  65774. * @param useInstances Defines wheter wee are trying to render instances or not
  65775. * @returns true if ready otherwise false
  65776. */
  65777. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  65778. private _beforeRenderingMesh;
  65779. private _afterRenderingMesh;
  65780. }
  65781. }
  65782. declare module "babylonjs/Rendering/index" {
  65783. export * from "babylonjs/Rendering/boundingBoxRenderer";
  65784. export * from "babylonjs/Rendering/depthRenderer";
  65785. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  65786. export * from "babylonjs/Rendering/edgesRenderer";
  65787. export * from "babylonjs/Rendering/geometryBufferRenderer";
  65788. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  65789. export * from "babylonjs/Rendering/outlineRenderer";
  65790. export * from "babylonjs/Rendering/renderingGroup";
  65791. export * from "babylonjs/Rendering/renderingManager";
  65792. export * from "babylonjs/Rendering/utilityLayerRenderer";
  65793. }
  65794. declare module "babylonjs/Sprites/spritePackedManager" {
  65795. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  65796. import { Scene } from "babylonjs/scene";
  65797. /**
  65798. * Class used to manage multiple sprites of different sizes on the same spritesheet
  65799. * @see http://doc.babylonjs.com/babylon101/sprites
  65800. */
  65801. export class SpritePackedManager extends SpriteManager {
  65802. /** defines the packed manager's name */
  65803. name: string;
  65804. /**
  65805. * Creates a new sprite manager from a packed sprite sheet
  65806. * @param name defines the manager's name
  65807. * @param imgUrl defines the sprite sheet url
  65808. * @param capacity defines the maximum allowed number of sprites
  65809. * @param scene defines the hosting scene
  65810. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  65811. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  65812. * @param samplingMode defines the smapling mode to use with spritesheet
  65813. * @param fromPacked set to true; do not alter
  65814. */
  65815. constructor(
  65816. /** defines the packed manager's name */
  65817. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  65818. }
  65819. }
  65820. declare module "babylonjs/Sprites/index" {
  65821. export * from "babylonjs/Sprites/sprite";
  65822. export * from "babylonjs/Sprites/spriteManager";
  65823. export * from "babylonjs/Sprites/spritePackedManager";
  65824. export * from "babylonjs/Sprites/spriteSceneComponent";
  65825. }
  65826. declare module "babylonjs/States/index" {
  65827. export * from "babylonjs/States/alphaCullingState";
  65828. export * from "babylonjs/States/depthCullingState";
  65829. export * from "babylonjs/States/stencilState";
  65830. }
  65831. declare module "babylonjs/Misc/assetsManager" {
  65832. import { Scene } from "babylonjs/scene";
  65833. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65834. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  65835. import { Skeleton } from "babylonjs/Bones/skeleton";
  65836. import { Observable } from "babylonjs/Misc/observable";
  65837. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  65838. import { Texture } from "babylonjs/Materials/Textures/texture";
  65839. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  65840. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  65841. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  65842. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  65843. /**
  65844. * Defines the list of states available for a task inside a AssetsManager
  65845. */
  65846. export enum AssetTaskState {
  65847. /**
  65848. * Initialization
  65849. */
  65850. INIT = 0,
  65851. /**
  65852. * Running
  65853. */
  65854. RUNNING = 1,
  65855. /**
  65856. * Done
  65857. */
  65858. DONE = 2,
  65859. /**
  65860. * Error
  65861. */
  65862. ERROR = 3
  65863. }
  65864. /**
  65865. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  65866. */
  65867. export abstract class AbstractAssetTask {
  65868. /**
  65869. * Task name
  65870. */ name: string;
  65871. /**
  65872. * Callback called when the task is successful
  65873. */
  65874. onSuccess: (task: any) => void;
  65875. /**
  65876. * Callback called when the task is not successful
  65877. */
  65878. onError: (task: any, message?: string, exception?: any) => void;
  65879. /**
  65880. * Creates a new AssetsManager
  65881. * @param name defines the name of the task
  65882. */
  65883. constructor(
  65884. /**
  65885. * Task name
  65886. */ name: string);
  65887. private _isCompleted;
  65888. private _taskState;
  65889. private _errorObject;
  65890. /**
  65891. * Get if the task is completed
  65892. */
  65893. readonly isCompleted: boolean;
  65894. /**
  65895. * Gets the current state of the task
  65896. */
  65897. readonly taskState: AssetTaskState;
  65898. /**
  65899. * Gets the current error object (if task is in error)
  65900. */
  65901. readonly errorObject: {
  65902. message?: string;
  65903. exception?: any;
  65904. };
  65905. /**
  65906. * Internal only
  65907. * @hidden
  65908. */
  65909. _setErrorObject(message?: string, exception?: any): void;
  65910. /**
  65911. * Execute the current task
  65912. * @param scene defines the scene where you want your assets to be loaded
  65913. * @param onSuccess is a callback called when the task is successfully executed
  65914. * @param onError is a callback called if an error occurs
  65915. */
  65916. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  65917. /**
  65918. * Execute the current task
  65919. * @param scene defines the scene where you want your assets to be loaded
  65920. * @param onSuccess is a callback called when the task is successfully executed
  65921. * @param onError is a callback called if an error occurs
  65922. */
  65923. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  65924. /**
  65925. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  65926. * This can be used with failed tasks that have the reason for failure fixed.
  65927. */
  65928. reset(): void;
  65929. private onErrorCallback;
  65930. private onDoneCallback;
  65931. }
  65932. /**
  65933. * Define the interface used by progress events raised during assets loading
  65934. */
  65935. export interface IAssetsProgressEvent {
  65936. /**
  65937. * Defines the number of remaining tasks to process
  65938. */
  65939. remainingCount: number;
  65940. /**
  65941. * Defines the total number of tasks
  65942. */
  65943. totalCount: number;
  65944. /**
  65945. * Defines the task that was just processed
  65946. */
  65947. task: AbstractAssetTask;
  65948. }
  65949. /**
  65950. * Class used to share progress information about assets loading
  65951. */
  65952. export class AssetsProgressEvent implements IAssetsProgressEvent {
  65953. /**
  65954. * Defines the number of remaining tasks to process
  65955. */
  65956. remainingCount: number;
  65957. /**
  65958. * Defines the total number of tasks
  65959. */
  65960. totalCount: number;
  65961. /**
  65962. * Defines the task that was just processed
  65963. */
  65964. task: AbstractAssetTask;
  65965. /**
  65966. * Creates a AssetsProgressEvent
  65967. * @param remainingCount defines the number of remaining tasks to process
  65968. * @param totalCount defines the total number of tasks
  65969. * @param task defines the task that was just processed
  65970. */
  65971. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  65972. }
  65973. /**
  65974. * Define a task used by AssetsManager to load meshes
  65975. */
  65976. export class MeshAssetTask extends AbstractAssetTask {
  65977. /**
  65978. * Defines the name of the task
  65979. */
  65980. name: string;
  65981. /**
  65982. * Defines the list of mesh's names you want to load
  65983. */
  65984. meshesNames: any;
  65985. /**
  65986. * Defines the root url to use as a base to load your meshes and associated resources
  65987. */
  65988. rootUrl: string;
  65989. /**
  65990. * Defines the filename of the scene to load from
  65991. */
  65992. sceneFilename: string;
  65993. /**
  65994. * Gets the list of loaded meshes
  65995. */
  65996. loadedMeshes: Array<AbstractMesh>;
  65997. /**
  65998. * Gets the list of loaded particle systems
  65999. */
  66000. loadedParticleSystems: Array<IParticleSystem>;
  66001. /**
  66002. * Gets the list of loaded skeletons
  66003. */
  66004. loadedSkeletons: Array<Skeleton>;
  66005. /**
  66006. * Gets the list of loaded animation groups
  66007. */
  66008. loadedAnimationGroups: Array<AnimationGroup>;
  66009. /**
  66010. * Callback called when the task is successful
  66011. */
  66012. onSuccess: (task: MeshAssetTask) => void;
  66013. /**
  66014. * Callback called when the task is successful
  66015. */
  66016. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  66017. /**
  66018. * Creates a new MeshAssetTask
  66019. * @param name defines the name of the task
  66020. * @param meshesNames defines the list of mesh's names you want to load
  66021. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  66022. * @param sceneFilename defines the filename of the scene to load from
  66023. */
  66024. constructor(
  66025. /**
  66026. * Defines the name of the task
  66027. */
  66028. name: string,
  66029. /**
  66030. * Defines the list of mesh's names you want to load
  66031. */
  66032. meshesNames: any,
  66033. /**
  66034. * Defines the root url to use as a base to load your meshes and associated resources
  66035. */
  66036. rootUrl: string,
  66037. /**
  66038. * Defines the filename of the scene to load from
  66039. */
  66040. sceneFilename: string);
  66041. /**
  66042. * Execute the current task
  66043. * @param scene defines the scene where you want your assets to be loaded
  66044. * @param onSuccess is a callback called when the task is successfully executed
  66045. * @param onError is a callback called if an error occurs
  66046. */
  66047. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66048. }
  66049. /**
  66050. * Define a task used by AssetsManager to load text content
  66051. */
  66052. export class TextFileAssetTask extends AbstractAssetTask {
  66053. /**
  66054. * Defines the name of the task
  66055. */
  66056. name: string;
  66057. /**
  66058. * Defines the location of the file to load
  66059. */
  66060. url: string;
  66061. /**
  66062. * Gets the loaded text string
  66063. */
  66064. text: string;
  66065. /**
  66066. * Callback called when the task is successful
  66067. */
  66068. onSuccess: (task: TextFileAssetTask) => void;
  66069. /**
  66070. * Callback called when the task is successful
  66071. */
  66072. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  66073. /**
  66074. * Creates a new TextFileAssetTask object
  66075. * @param name defines the name of the task
  66076. * @param url defines the location of the file to load
  66077. */
  66078. constructor(
  66079. /**
  66080. * Defines the name of the task
  66081. */
  66082. name: string,
  66083. /**
  66084. * Defines the location of the file to load
  66085. */
  66086. url: string);
  66087. /**
  66088. * Execute the current task
  66089. * @param scene defines the scene where you want your assets to be loaded
  66090. * @param onSuccess is a callback called when the task is successfully executed
  66091. * @param onError is a callback called if an error occurs
  66092. */
  66093. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66094. }
  66095. /**
  66096. * Define a task used by AssetsManager to load binary data
  66097. */
  66098. export class BinaryFileAssetTask extends AbstractAssetTask {
  66099. /**
  66100. * Defines the name of the task
  66101. */
  66102. name: string;
  66103. /**
  66104. * Defines the location of the file to load
  66105. */
  66106. url: string;
  66107. /**
  66108. * Gets the lodaded data (as an array buffer)
  66109. */
  66110. data: ArrayBuffer;
  66111. /**
  66112. * Callback called when the task is successful
  66113. */
  66114. onSuccess: (task: BinaryFileAssetTask) => void;
  66115. /**
  66116. * Callback called when the task is successful
  66117. */
  66118. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  66119. /**
  66120. * Creates a new BinaryFileAssetTask object
  66121. * @param name defines the name of the new task
  66122. * @param url defines the location of the file to load
  66123. */
  66124. constructor(
  66125. /**
  66126. * Defines the name of the task
  66127. */
  66128. name: string,
  66129. /**
  66130. * Defines the location of the file to load
  66131. */
  66132. url: string);
  66133. /**
  66134. * Execute the current task
  66135. * @param scene defines the scene where you want your assets to be loaded
  66136. * @param onSuccess is a callback called when the task is successfully executed
  66137. * @param onError is a callback called if an error occurs
  66138. */
  66139. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66140. }
  66141. /**
  66142. * Define a task used by AssetsManager to load images
  66143. */
  66144. export class ImageAssetTask extends AbstractAssetTask {
  66145. /**
  66146. * Defines the name of the task
  66147. */
  66148. name: string;
  66149. /**
  66150. * Defines the location of the image to load
  66151. */
  66152. url: string;
  66153. /**
  66154. * Gets the loaded images
  66155. */
  66156. image: HTMLImageElement;
  66157. /**
  66158. * Callback called when the task is successful
  66159. */
  66160. onSuccess: (task: ImageAssetTask) => void;
  66161. /**
  66162. * Callback called when the task is successful
  66163. */
  66164. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  66165. /**
  66166. * Creates a new ImageAssetTask
  66167. * @param name defines the name of the task
  66168. * @param url defines the location of the image to load
  66169. */
  66170. constructor(
  66171. /**
  66172. * Defines the name of the task
  66173. */
  66174. name: string,
  66175. /**
  66176. * Defines the location of the image to load
  66177. */
  66178. url: string);
  66179. /**
  66180. * Execute the current task
  66181. * @param scene defines the scene where you want your assets to be loaded
  66182. * @param onSuccess is a callback called when the task is successfully executed
  66183. * @param onError is a callback called if an error occurs
  66184. */
  66185. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66186. }
  66187. /**
  66188. * Defines the interface used by texture loading tasks
  66189. */
  66190. export interface ITextureAssetTask<TEX extends BaseTexture> {
  66191. /**
  66192. * Gets the loaded texture
  66193. */
  66194. texture: TEX;
  66195. }
  66196. /**
  66197. * Define a task used by AssetsManager to load 2D textures
  66198. */
  66199. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  66200. /**
  66201. * Defines the name of the task
  66202. */
  66203. name: string;
  66204. /**
  66205. * Defines the location of the file to load
  66206. */
  66207. url: string;
  66208. /**
  66209. * Defines if mipmap should not be generated (default is false)
  66210. */
  66211. noMipmap?: boolean | undefined;
  66212. /**
  66213. * Defines if texture must be inverted on Y axis (default is false)
  66214. */
  66215. invertY?: boolean | undefined;
  66216. /**
  66217. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66218. */
  66219. samplingMode: number;
  66220. /**
  66221. * Gets the loaded texture
  66222. */
  66223. texture: Texture;
  66224. /**
  66225. * Callback called when the task is successful
  66226. */
  66227. onSuccess: (task: TextureAssetTask) => void;
  66228. /**
  66229. * Callback called when the task is successful
  66230. */
  66231. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  66232. /**
  66233. * Creates a new TextureAssetTask object
  66234. * @param name defines the name of the task
  66235. * @param url defines the location of the file to load
  66236. * @param noMipmap defines if mipmap should not be generated (default is false)
  66237. * @param invertY defines if texture must be inverted on Y axis (default is false)
  66238. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66239. */
  66240. constructor(
  66241. /**
  66242. * Defines the name of the task
  66243. */
  66244. name: string,
  66245. /**
  66246. * Defines the location of the file to load
  66247. */
  66248. url: string,
  66249. /**
  66250. * Defines if mipmap should not be generated (default is false)
  66251. */
  66252. noMipmap?: boolean | undefined,
  66253. /**
  66254. * Defines if texture must be inverted on Y axis (default is false)
  66255. */
  66256. invertY?: boolean | undefined,
  66257. /**
  66258. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66259. */
  66260. samplingMode?: number);
  66261. /**
  66262. * Execute the current task
  66263. * @param scene defines the scene where you want your assets to be loaded
  66264. * @param onSuccess is a callback called when the task is successfully executed
  66265. * @param onError is a callback called if an error occurs
  66266. */
  66267. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66268. }
  66269. /**
  66270. * Define a task used by AssetsManager to load cube textures
  66271. */
  66272. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  66273. /**
  66274. * Defines the name of the task
  66275. */
  66276. name: string;
  66277. /**
  66278. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  66279. */
  66280. url: string;
  66281. /**
  66282. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  66283. */
  66284. extensions?: string[] | undefined;
  66285. /**
  66286. * Defines if mipmaps should not be generated (default is false)
  66287. */
  66288. noMipmap?: boolean | undefined;
  66289. /**
  66290. * Defines the explicit list of files (undefined by default)
  66291. */
  66292. files?: string[] | undefined;
  66293. /**
  66294. * Gets the loaded texture
  66295. */
  66296. texture: CubeTexture;
  66297. /**
  66298. * Callback called when the task is successful
  66299. */
  66300. onSuccess: (task: CubeTextureAssetTask) => void;
  66301. /**
  66302. * Callback called when the task is successful
  66303. */
  66304. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  66305. /**
  66306. * Creates a new CubeTextureAssetTask
  66307. * @param name defines the name of the task
  66308. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  66309. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  66310. * @param noMipmap defines if mipmaps should not be generated (default is false)
  66311. * @param files defines the explicit list of files (undefined by default)
  66312. */
  66313. constructor(
  66314. /**
  66315. * Defines the name of the task
  66316. */
  66317. name: string,
  66318. /**
  66319. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  66320. */
  66321. url: string,
  66322. /**
  66323. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  66324. */
  66325. extensions?: string[] | undefined,
  66326. /**
  66327. * Defines if mipmaps should not be generated (default is false)
  66328. */
  66329. noMipmap?: boolean | undefined,
  66330. /**
  66331. * Defines the explicit list of files (undefined by default)
  66332. */
  66333. files?: string[] | undefined);
  66334. /**
  66335. * Execute the current task
  66336. * @param scene defines the scene where you want your assets to be loaded
  66337. * @param onSuccess is a callback called when the task is successfully executed
  66338. * @param onError is a callback called if an error occurs
  66339. */
  66340. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66341. }
  66342. /**
  66343. * Define a task used by AssetsManager to load HDR cube textures
  66344. */
  66345. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  66346. /**
  66347. * Defines the name of the task
  66348. */
  66349. name: string;
  66350. /**
  66351. * Defines the location of the file to load
  66352. */
  66353. url: string;
  66354. /**
  66355. * Defines the desired size (the more it increases the longer the generation will be)
  66356. */
  66357. size: number;
  66358. /**
  66359. * Defines if mipmaps should not be generated (default is false)
  66360. */
  66361. noMipmap: boolean;
  66362. /**
  66363. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  66364. */
  66365. generateHarmonics: boolean;
  66366. /**
  66367. * 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)
  66368. */
  66369. gammaSpace: boolean;
  66370. /**
  66371. * Internal Use Only
  66372. */
  66373. reserved: boolean;
  66374. /**
  66375. * Gets the loaded texture
  66376. */
  66377. texture: HDRCubeTexture;
  66378. /**
  66379. * Callback called when the task is successful
  66380. */
  66381. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  66382. /**
  66383. * Callback called when the task is successful
  66384. */
  66385. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  66386. /**
  66387. * Creates a new HDRCubeTextureAssetTask object
  66388. * @param name defines the name of the task
  66389. * @param url defines the location of the file to load
  66390. * @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.
  66391. * @param noMipmap defines if mipmaps should not be generated (default is false)
  66392. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  66393. * @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)
  66394. * @param reserved Internal use only
  66395. */
  66396. constructor(
  66397. /**
  66398. * Defines the name of the task
  66399. */
  66400. name: string,
  66401. /**
  66402. * Defines the location of the file to load
  66403. */
  66404. url: string,
  66405. /**
  66406. * Defines the desired size (the more it increases the longer the generation will be)
  66407. */
  66408. size: number,
  66409. /**
  66410. * Defines if mipmaps should not be generated (default is false)
  66411. */
  66412. noMipmap?: boolean,
  66413. /**
  66414. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  66415. */
  66416. generateHarmonics?: boolean,
  66417. /**
  66418. * 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)
  66419. */
  66420. gammaSpace?: boolean,
  66421. /**
  66422. * Internal Use Only
  66423. */
  66424. reserved?: boolean);
  66425. /**
  66426. * Execute the current task
  66427. * @param scene defines the scene where you want your assets to be loaded
  66428. * @param onSuccess is a callback called when the task is successfully executed
  66429. * @param onError is a callback called if an error occurs
  66430. */
  66431. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66432. }
  66433. /**
  66434. * Define a task used by AssetsManager to load Equirectangular cube textures
  66435. */
  66436. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  66437. /**
  66438. * Defines the name of the task
  66439. */
  66440. name: string;
  66441. /**
  66442. * Defines the location of the file to load
  66443. */
  66444. url: string;
  66445. /**
  66446. * Defines the desired size (the more it increases the longer the generation will be)
  66447. */
  66448. size: number;
  66449. /**
  66450. * Defines if mipmaps should not be generated (default is false)
  66451. */
  66452. noMipmap: boolean;
  66453. /**
  66454. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  66455. * but the standard material would require them in Gamma space) (default is true)
  66456. */
  66457. gammaSpace: boolean;
  66458. /**
  66459. * Gets the loaded texture
  66460. */
  66461. texture: EquiRectangularCubeTexture;
  66462. /**
  66463. * Callback called when the task is successful
  66464. */
  66465. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  66466. /**
  66467. * Callback called when the task is successful
  66468. */
  66469. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  66470. /**
  66471. * Creates a new EquiRectangularCubeTextureAssetTask object
  66472. * @param name defines the name of the task
  66473. * @param url defines the location of the file to load
  66474. * @param size defines the desired size (the more it increases the longer the generation will be)
  66475. * If the size is omitted this implies you are using a preprocessed cubemap.
  66476. * @param noMipmap defines if mipmaps should not be generated (default is false)
  66477. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  66478. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  66479. * (default is true)
  66480. */
  66481. constructor(
  66482. /**
  66483. * Defines the name of the task
  66484. */
  66485. name: string,
  66486. /**
  66487. * Defines the location of the file to load
  66488. */
  66489. url: string,
  66490. /**
  66491. * Defines the desired size (the more it increases the longer the generation will be)
  66492. */
  66493. size: number,
  66494. /**
  66495. * Defines if mipmaps should not be generated (default is false)
  66496. */
  66497. noMipmap?: boolean,
  66498. /**
  66499. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  66500. * but the standard material would require them in Gamma space) (default is true)
  66501. */
  66502. gammaSpace?: boolean);
  66503. /**
  66504. * Execute the current task
  66505. * @param scene defines the scene where you want your assets to be loaded
  66506. * @param onSuccess is a callback called when the task is successfully executed
  66507. * @param onError is a callback called if an error occurs
  66508. */
  66509. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66510. }
  66511. /**
  66512. * This class can be used to easily import assets into a scene
  66513. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  66514. */
  66515. export class AssetsManager {
  66516. private _scene;
  66517. private _isLoading;
  66518. protected _tasks: AbstractAssetTask[];
  66519. protected _waitingTasksCount: number;
  66520. protected _totalTasksCount: number;
  66521. /**
  66522. * Callback called when all tasks are processed
  66523. */
  66524. onFinish: (tasks: AbstractAssetTask[]) => void;
  66525. /**
  66526. * Callback called when a task is successful
  66527. */
  66528. onTaskSuccess: (task: AbstractAssetTask) => void;
  66529. /**
  66530. * Callback called when a task had an error
  66531. */
  66532. onTaskError: (task: AbstractAssetTask) => void;
  66533. /**
  66534. * Callback called when a task is done (whatever the result is)
  66535. */
  66536. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  66537. /**
  66538. * Observable called when all tasks are processed
  66539. */
  66540. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  66541. /**
  66542. * Observable called when a task had an error
  66543. */
  66544. onTaskErrorObservable: Observable<AbstractAssetTask>;
  66545. /**
  66546. * Observable called when all tasks were executed
  66547. */
  66548. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  66549. /**
  66550. * Observable called when a task is done (whatever the result is)
  66551. */
  66552. onProgressObservable: Observable<IAssetsProgressEvent>;
  66553. /**
  66554. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  66555. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  66556. */
  66557. useDefaultLoadingScreen: boolean;
  66558. /**
  66559. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  66560. * when all assets have been downloaded.
  66561. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  66562. */
  66563. autoHideLoadingUI: boolean;
  66564. /**
  66565. * Creates a new AssetsManager
  66566. * @param scene defines the scene to work on
  66567. */
  66568. constructor(scene: Scene);
  66569. /**
  66570. * Add a MeshAssetTask to the list of active tasks
  66571. * @param taskName defines the name of the new task
  66572. * @param meshesNames defines the name of meshes to load
  66573. * @param rootUrl defines the root url to use to locate files
  66574. * @param sceneFilename defines the filename of the scene file
  66575. * @returns a new MeshAssetTask object
  66576. */
  66577. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  66578. /**
  66579. * Add a TextFileAssetTask to the list of active tasks
  66580. * @param taskName defines the name of the new task
  66581. * @param url defines the url of the file to load
  66582. * @returns a new TextFileAssetTask object
  66583. */
  66584. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  66585. /**
  66586. * Add a BinaryFileAssetTask to the list of active tasks
  66587. * @param taskName defines the name of the new task
  66588. * @param url defines the url of the file to load
  66589. * @returns a new BinaryFileAssetTask object
  66590. */
  66591. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  66592. /**
  66593. * Add a ImageAssetTask to the list of active tasks
  66594. * @param taskName defines the name of the new task
  66595. * @param url defines the url of the file to load
  66596. * @returns a new ImageAssetTask object
  66597. */
  66598. addImageTask(taskName: string, url: string): ImageAssetTask;
  66599. /**
  66600. * Add a TextureAssetTask to the list of active tasks
  66601. * @param taskName defines the name of the new task
  66602. * @param url defines the url of the file to load
  66603. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  66604. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  66605. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  66606. * @returns a new TextureAssetTask object
  66607. */
  66608. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  66609. /**
  66610. * Add a CubeTextureAssetTask to the list of active tasks
  66611. * @param taskName defines the name of the new task
  66612. * @param url defines the url of the file to load
  66613. * @param extensions defines the extension to use to load the cube map (can be null)
  66614. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  66615. * @param files defines the list of files to load (can be null)
  66616. * @returns a new CubeTextureAssetTask object
  66617. */
  66618. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  66619. /**
  66620. *
  66621. * Add a HDRCubeTextureAssetTask to the list of active tasks
  66622. * @param taskName defines the name of the new task
  66623. * @param url defines the url of the file to load
  66624. * @param size defines the size you want for the cubemap (can be null)
  66625. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  66626. * @param generateHarmonics defines if you want to automatically generate (true by default)
  66627. * @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)
  66628. * @param reserved Internal use only
  66629. * @returns a new HDRCubeTextureAssetTask object
  66630. */
  66631. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  66632. /**
  66633. *
  66634. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  66635. * @param taskName defines the name of the new task
  66636. * @param url defines the url of the file to load
  66637. * @param size defines the size you want for the cubemap (can be null)
  66638. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  66639. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  66640. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  66641. * @returns a new EquiRectangularCubeTextureAssetTask object
  66642. */
  66643. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  66644. /**
  66645. * Remove a task from the assets manager.
  66646. * @param task the task to remove
  66647. */
  66648. removeTask(task: AbstractAssetTask): void;
  66649. private _decreaseWaitingTasksCount;
  66650. private _runTask;
  66651. /**
  66652. * Reset the AssetsManager and remove all tasks
  66653. * @return the current instance of the AssetsManager
  66654. */
  66655. reset(): AssetsManager;
  66656. /**
  66657. * Start the loading process
  66658. * @return the current instance of the AssetsManager
  66659. */
  66660. load(): AssetsManager;
  66661. /**
  66662. * Start the loading process as an async operation
  66663. * @return a promise returning the list of failed tasks
  66664. */
  66665. loadAsync(): Promise<void>;
  66666. }
  66667. }
  66668. declare module "babylonjs/Misc/deferred" {
  66669. /**
  66670. * Wrapper class for promise with external resolve and reject.
  66671. */
  66672. export class Deferred<T> {
  66673. /**
  66674. * The promise associated with this deferred object.
  66675. */
  66676. readonly promise: Promise<T>;
  66677. private _resolve;
  66678. private _reject;
  66679. /**
  66680. * The resolve method of the promise associated with this deferred object.
  66681. */
  66682. readonly resolve: (value?: T | PromiseLike<T> | undefined) => void;
  66683. /**
  66684. * The reject method of the promise associated with this deferred object.
  66685. */
  66686. readonly reject: (reason?: any) => void;
  66687. /**
  66688. * Constructor for this deferred object.
  66689. */
  66690. constructor();
  66691. }
  66692. }
  66693. declare module "babylonjs/Misc/meshExploder" {
  66694. import { Mesh } from "babylonjs/Meshes/mesh";
  66695. /**
  66696. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  66697. */
  66698. export class MeshExploder {
  66699. private _centerMesh;
  66700. private _meshes;
  66701. private _meshesOrigins;
  66702. private _toCenterVectors;
  66703. private _scaledDirection;
  66704. private _newPosition;
  66705. private _centerPosition;
  66706. /**
  66707. * Explodes meshes from a center mesh.
  66708. * @param meshes The meshes to explode.
  66709. * @param centerMesh The mesh to be center of explosion.
  66710. */
  66711. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  66712. private _setCenterMesh;
  66713. /**
  66714. * Get class name
  66715. * @returns "MeshExploder"
  66716. */
  66717. getClassName(): string;
  66718. /**
  66719. * "Exploded meshes"
  66720. * @returns Array of meshes with the centerMesh at index 0.
  66721. */
  66722. getMeshes(): Array<Mesh>;
  66723. /**
  66724. * Explodes meshes giving a specific direction
  66725. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  66726. */
  66727. explode(direction?: number): void;
  66728. }
  66729. }
  66730. declare module "babylonjs/Misc/filesInput" {
  66731. import { Engine } from "babylonjs/Engines/engine";
  66732. import { Scene } from "babylonjs/scene";
  66733. import { SceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  66734. /**
  66735. * Class used to help managing file picking and drag'n'drop
  66736. */
  66737. export class FilesInput {
  66738. /**
  66739. * List of files ready to be loaded
  66740. */
  66741. static readonly FilesToLoad: {
  66742. [key: string]: File;
  66743. };
  66744. /**
  66745. * Callback called when a file is processed
  66746. */
  66747. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  66748. private _engine;
  66749. private _currentScene;
  66750. private _sceneLoadedCallback;
  66751. private _progressCallback;
  66752. private _additionalRenderLoopLogicCallback;
  66753. private _textureLoadingCallback;
  66754. private _startingProcessingFilesCallback;
  66755. private _onReloadCallback;
  66756. private _errorCallback;
  66757. private _elementToMonitor;
  66758. private _sceneFileToLoad;
  66759. private _filesToLoad;
  66760. /**
  66761. * Creates a new FilesInput
  66762. * @param engine defines the rendering engine
  66763. * @param scene defines the hosting scene
  66764. * @param sceneLoadedCallback callback called when scene is loaded
  66765. * @param progressCallback callback called to track progress
  66766. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  66767. * @param textureLoadingCallback callback called when a texture is loading
  66768. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  66769. * @param onReloadCallback callback called when a reload is requested
  66770. * @param errorCallback callback call if an error occurs
  66771. */
  66772. constructor(engine: Engine, scene: Scene, sceneLoadedCallback: (sceneFile: File, scene: Scene) => void, progressCallback: (progress: SceneLoaderProgressEvent) => void, additionalRenderLoopLogicCallback: () => void, textureLoadingCallback: (remaining: number) => void, startingProcessingFilesCallback: (files?: File[]) => void, onReloadCallback: (sceneFile: File) => void, errorCallback: (sceneFile: File, scene: Scene, message: string) => void);
  66773. private _dragEnterHandler;
  66774. private _dragOverHandler;
  66775. private _dropHandler;
  66776. /**
  66777. * Calls this function to listen to drag'n'drop events on a specific DOM element
  66778. * @param elementToMonitor defines the DOM element to track
  66779. */
  66780. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  66781. /**
  66782. * Release all associated resources
  66783. */
  66784. dispose(): void;
  66785. private renderFunction;
  66786. private drag;
  66787. private drop;
  66788. private _traverseFolder;
  66789. private _processFiles;
  66790. /**
  66791. * Load files from a drop event
  66792. * @param event defines the drop event to use as source
  66793. */
  66794. loadFiles(event: any): void;
  66795. private _processReload;
  66796. /**
  66797. * Reload the current scene from the loaded files
  66798. */
  66799. reload(): void;
  66800. }
  66801. }
  66802. declare module "babylonjs/Misc/HighDynamicRange/index" {
  66803. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  66804. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  66805. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  66806. }
  66807. declare module "babylonjs/Misc/sceneOptimizer" {
  66808. import { Scene, IDisposable } from "babylonjs/scene";
  66809. import { Observable } from "babylonjs/Misc/observable";
  66810. /**
  66811. * Defines the root class used to create scene optimization to use with SceneOptimizer
  66812. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  66813. */
  66814. export class SceneOptimization {
  66815. /**
  66816. * Defines the priority of this optimization (0 by default which means first in the list)
  66817. */
  66818. priority: number;
  66819. /**
  66820. * Gets a string describing the action executed by the current optimization
  66821. * @returns description string
  66822. */
  66823. getDescription(): string;
  66824. /**
  66825. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  66826. * @param scene defines the current scene where to apply this optimization
  66827. * @param optimizer defines the current optimizer
  66828. * @returns true if everything that can be done was applied
  66829. */
  66830. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  66831. /**
  66832. * Creates the SceneOptimization object
  66833. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  66834. * @param desc defines the description associated with the optimization
  66835. */
  66836. constructor(
  66837. /**
  66838. * Defines the priority of this optimization (0 by default which means first in the list)
  66839. */
  66840. priority?: number);
  66841. }
  66842. /**
  66843. * Defines an optimization used to reduce the size of render target textures
  66844. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  66845. */
  66846. export class TextureOptimization extends SceneOptimization {
  66847. /**
  66848. * Defines the priority of this optimization (0 by default which means first in the list)
  66849. */
  66850. priority: number;
  66851. /**
  66852. * 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
  66853. */
  66854. maximumSize: number;
  66855. /**
  66856. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  66857. */
  66858. step: number;
  66859. /**
  66860. * Gets a string describing the action executed by the current optimization
  66861. * @returns description string
  66862. */
  66863. getDescription(): string;
  66864. /**
  66865. * Creates the TextureOptimization object
  66866. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  66867. * @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
  66868. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  66869. */
  66870. constructor(
  66871. /**
  66872. * Defines the priority of this optimization (0 by default which means first in the list)
  66873. */
  66874. priority?: number,
  66875. /**
  66876. * 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
  66877. */
  66878. maximumSize?: number,
  66879. /**
  66880. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  66881. */
  66882. step?: number);
  66883. /**
  66884. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  66885. * @param scene defines the current scene where to apply this optimization
  66886. * @param optimizer defines the current optimizer
  66887. * @returns true if everything that can be done was applied
  66888. */
  66889. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  66890. }
  66891. /**
  66892. * Defines an optimization used to increase or decrease the rendering resolution
  66893. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  66894. */
  66895. export class HardwareScalingOptimization extends SceneOptimization {
  66896. /**
  66897. * Defines the priority of this optimization (0 by default which means first in the list)
  66898. */
  66899. priority: number;
  66900. /**
  66901. * Defines the maximum scale to use (2 by default)
  66902. */
  66903. maximumScale: number;
  66904. /**
  66905. * Defines the step to use between two passes (0.5 by default)
  66906. */
  66907. step: number;
  66908. private _currentScale;
  66909. private _directionOffset;
  66910. /**
  66911. * Gets a string describing the action executed by the current optimization
  66912. * @return description string
  66913. */
  66914. getDescription(): string;
  66915. /**
  66916. * Creates the HardwareScalingOptimization object
  66917. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  66918. * @param maximumScale defines the maximum scale to use (2 by default)
  66919. * @param step defines the step to use between two passes (0.5 by default)
  66920. */
  66921. constructor(
  66922. /**
  66923. * Defines the priority of this optimization (0 by default which means first in the list)
  66924. */
  66925. priority?: number,
  66926. /**
  66927. * Defines the maximum scale to use (2 by default)
  66928. */
  66929. maximumScale?: number,
  66930. /**
  66931. * Defines the step to use between two passes (0.5 by default)
  66932. */
  66933. step?: number);
  66934. /**
  66935. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  66936. * @param scene defines the current scene where to apply this optimization
  66937. * @param optimizer defines the current optimizer
  66938. * @returns true if everything that can be done was applied
  66939. */
  66940. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  66941. }
  66942. /**
  66943. * Defines an optimization used to remove shadows
  66944. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  66945. */
  66946. export class ShadowsOptimization extends SceneOptimization {
  66947. /**
  66948. * Gets a string describing the action executed by the current optimization
  66949. * @return description string
  66950. */
  66951. getDescription(): string;
  66952. /**
  66953. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  66954. * @param scene defines the current scene where to apply this optimization
  66955. * @param optimizer defines the current optimizer
  66956. * @returns true if everything that can be done was applied
  66957. */
  66958. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  66959. }
  66960. /**
  66961. * Defines an optimization used to turn post-processes off
  66962. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  66963. */
  66964. export class PostProcessesOptimization extends SceneOptimization {
  66965. /**
  66966. * Gets a string describing the action executed by the current optimization
  66967. * @return description string
  66968. */
  66969. getDescription(): string;
  66970. /**
  66971. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  66972. * @param scene defines the current scene where to apply this optimization
  66973. * @param optimizer defines the current optimizer
  66974. * @returns true if everything that can be done was applied
  66975. */
  66976. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  66977. }
  66978. /**
  66979. * Defines an optimization used to turn lens flares off
  66980. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  66981. */
  66982. export class LensFlaresOptimization extends SceneOptimization {
  66983. /**
  66984. * Gets a string describing the action executed by the current optimization
  66985. * @return description string
  66986. */
  66987. getDescription(): string;
  66988. /**
  66989. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  66990. * @param scene defines the current scene where to apply this optimization
  66991. * @param optimizer defines the current optimizer
  66992. * @returns true if everything that can be done was applied
  66993. */
  66994. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  66995. }
  66996. /**
  66997. * Defines an optimization based on user defined callback.
  66998. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  66999. */
  67000. export class CustomOptimization extends SceneOptimization {
  67001. /**
  67002. * Callback called to apply the custom optimization.
  67003. */
  67004. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  67005. /**
  67006. * Callback called to get custom description
  67007. */
  67008. onGetDescription: () => string;
  67009. /**
  67010. * Gets a string describing the action executed by the current optimization
  67011. * @returns description string
  67012. */
  67013. getDescription(): string;
  67014. /**
  67015. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67016. * @param scene defines the current scene where to apply this optimization
  67017. * @param optimizer defines the current optimizer
  67018. * @returns true if everything that can be done was applied
  67019. */
  67020. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67021. }
  67022. /**
  67023. * Defines an optimization used to turn particles off
  67024. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67025. */
  67026. export class ParticlesOptimization extends SceneOptimization {
  67027. /**
  67028. * Gets a string describing the action executed by the current optimization
  67029. * @return description string
  67030. */
  67031. getDescription(): string;
  67032. /**
  67033. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67034. * @param scene defines the current scene where to apply this optimization
  67035. * @param optimizer defines the current optimizer
  67036. * @returns true if everything that can be done was applied
  67037. */
  67038. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67039. }
  67040. /**
  67041. * Defines an optimization used to turn render targets off
  67042. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67043. */
  67044. export class RenderTargetsOptimization extends SceneOptimization {
  67045. /**
  67046. * Gets a string describing the action executed by the current optimization
  67047. * @return description string
  67048. */
  67049. getDescription(): string;
  67050. /**
  67051. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67052. * @param scene defines the current scene where to apply this optimization
  67053. * @param optimizer defines the current optimizer
  67054. * @returns true if everything that can be done was applied
  67055. */
  67056. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67057. }
  67058. /**
  67059. * Defines an optimization used to merge meshes with compatible materials
  67060. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67061. */
  67062. export class MergeMeshesOptimization extends SceneOptimization {
  67063. private static _UpdateSelectionTree;
  67064. /**
  67065. * Gets or sets a boolean which defines if optimization octree has to be updated
  67066. */
  67067. /**
  67068. * Gets or sets a boolean which defines if optimization octree has to be updated
  67069. */
  67070. static UpdateSelectionTree: boolean;
  67071. /**
  67072. * Gets a string describing the action executed by the current optimization
  67073. * @return description string
  67074. */
  67075. getDescription(): string;
  67076. private _canBeMerged;
  67077. /**
  67078. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67079. * @param scene defines the current scene where to apply this optimization
  67080. * @param optimizer defines the current optimizer
  67081. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  67082. * @returns true if everything that can be done was applied
  67083. */
  67084. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  67085. }
  67086. /**
  67087. * Defines a list of options used by SceneOptimizer
  67088. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67089. */
  67090. export class SceneOptimizerOptions {
  67091. /**
  67092. * Defines the target frame rate to reach (60 by default)
  67093. */
  67094. targetFrameRate: number;
  67095. /**
  67096. * Defines the interval between two checkes (2000ms by default)
  67097. */
  67098. trackerDuration: number;
  67099. /**
  67100. * Gets the list of optimizations to apply
  67101. */
  67102. optimizations: SceneOptimization[];
  67103. /**
  67104. * Creates a new list of options used by SceneOptimizer
  67105. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  67106. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  67107. */
  67108. constructor(
  67109. /**
  67110. * Defines the target frame rate to reach (60 by default)
  67111. */
  67112. targetFrameRate?: number,
  67113. /**
  67114. * Defines the interval between two checkes (2000ms by default)
  67115. */
  67116. trackerDuration?: number);
  67117. /**
  67118. * Add a new optimization
  67119. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  67120. * @returns the current SceneOptimizerOptions
  67121. */
  67122. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  67123. /**
  67124. * Add a new custom optimization
  67125. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  67126. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  67127. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  67128. * @returns the current SceneOptimizerOptions
  67129. */
  67130. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  67131. /**
  67132. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  67133. * @param targetFrameRate defines the target frame rate (60 by default)
  67134. * @returns a SceneOptimizerOptions object
  67135. */
  67136. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67137. /**
  67138. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  67139. * @param targetFrameRate defines the target frame rate (60 by default)
  67140. * @returns a SceneOptimizerOptions object
  67141. */
  67142. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67143. /**
  67144. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  67145. * @param targetFrameRate defines the target frame rate (60 by default)
  67146. * @returns a SceneOptimizerOptions object
  67147. */
  67148. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67149. }
  67150. /**
  67151. * Class used to run optimizations in order to reach a target frame rate
  67152. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67153. */
  67154. export class SceneOptimizer implements IDisposable {
  67155. private _isRunning;
  67156. private _options;
  67157. private _scene;
  67158. private _currentPriorityLevel;
  67159. private _targetFrameRate;
  67160. private _trackerDuration;
  67161. private _currentFrameRate;
  67162. private _sceneDisposeObserver;
  67163. private _improvementMode;
  67164. /**
  67165. * Defines an observable called when the optimizer reaches the target frame rate
  67166. */
  67167. onSuccessObservable: Observable<SceneOptimizer>;
  67168. /**
  67169. * Defines an observable called when the optimizer enables an optimization
  67170. */
  67171. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  67172. /**
  67173. * Defines an observable called when the optimizer is not able to reach the target frame rate
  67174. */
  67175. onFailureObservable: Observable<SceneOptimizer>;
  67176. /**
  67177. * Gets a boolean indicating if the optimizer is in improvement mode
  67178. */
  67179. readonly isInImprovementMode: boolean;
  67180. /**
  67181. * Gets the current priority level (0 at start)
  67182. */
  67183. readonly currentPriorityLevel: number;
  67184. /**
  67185. * Gets the current frame rate checked by the SceneOptimizer
  67186. */
  67187. readonly currentFrameRate: number;
  67188. /**
  67189. * Gets or sets the current target frame rate (60 by default)
  67190. */
  67191. /**
  67192. * Gets or sets the current target frame rate (60 by default)
  67193. */
  67194. targetFrameRate: number;
  67195. /**
  67196. * Gets or sets the current interval between two checks (every 2000ms by default)
  67197. */
  67198. /**
  67199. * Gets or sets the current interval between two checks (every 2000ms by default)
  67200. */
  67201. trackerDuration: number;
  67202. /**
  67203. * Gets the list of active optimizations
  67204. */
  67205. readonly optimizations: SceneOptimization[];
  67206. /**
  67207. * Creates a new SceneOptimizer
  67208. * @param scene defines the scene to work on
  67209. * @param options defines the options to use with the SceneOptimizer
  67210. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  67211. * @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)
  67212. */
  67213. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  67214. /**
  67215. * Stops the current optimizer
  67216. */
  67217. stop(): void;
  67218. /**
  67219. * Reset the optimizer to initial step (current priority level = 0)
  67220. */
  67221. reset(): void;
  67222. /**
  67223. * Start the optimizer. By default it will try to reach a specific framerate
  67224. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  67225. */
  67226. start(): void;
  67227. private _checkCurrentState;
  67228. /**
  67229. * Release all resources
  67230. */
  67231. dispose(): void;
  67232. /**
  67233. * Helper function to create a SceneOptimizer with one single line of code
  67234. * @param scene defines the scene to work on
  67235. * @param options defines the options to use with the SceneOptimizer
  67236. * @param onSuccess defines a callback to call on success
  67237. * @param onFailure defines a callback to call on failure
  67238. * @returns the new SceneOptimizer object
  67239. */
  67240. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  67241. }
  67242. }
  67243. declare module "babylonjs/Misc/sceneSerializer" {
  67244. import { Scene } from "babylonjs/scene";
  67245. /**
  67246. * Class used to serialize a scene into a string
  67247. */
  67248. export class SceneSerializer {
  67249. /**
  67250. * Clear cache used by a previous serialization
  67251. */
  67252. static ClearCache(): void;
  67253. /**
  67254. * Serialize a scene into a JSON compatible object
  67255. * @param scene defines the scene to serialize
  67256. * @returns a JSON compatible object
  67257. */
  67258. static Serialize(scene: Scene): any;
  67259. /**
  67260. * Serialize a mesh into a JSON compatible object
  67261. * @param toSerialize defines the mesh to serialize
  67262. * @param withParents defines if parents must be serialized as well
  67263. * @param withChildren defines if children must be serialized as well
  67264. * @returns a JSON compatible object
  67265. */
  67266. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  67267. }
  67268. }
  67269. declare module "babylonjs/Misc/textureTools" {
  67270. import { Texture } from "babylonjs/Materials/Textures/texture";
  67271. /**
  67272. * Class used to host texture specific utilities
  67273. */
  67274. export class TextureTools {
  67275. /**
  67276. * Uses the GPU to create a copy texture rescaled at a given size
  67277. * @param texture Texture to copy from
  67278. * @param width defines the desired width
  67279. * @param height defines the desired height
  67280. * @param useBilinearMode defines if bilinear mode has to be used
  67281. * @return the generated texture
  67282. */
  67283. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  67284. }
  67285. }
  67286. declare module "babylonjs/Misc/videoRecorder" {
  67287. import { Nullable } from "babylonjs/types";
  67288. import { Engine } from "babylonjs/Engines/engine";
  67289. /**
  67290. * This represents the different options available for the video capture.
  67291. */
  67292. export interface VideoRecorderOptions {
  67293. /** Defines the mime type of the video. */
  67294. mimeType: string;
  67295. /** Defines the FPS the video should be recorded at. */
  67296. fps: number;
  67297. /** Defines the chunk size for the recording data. */
  67298. recordChunckSize: number;
  67299. /** The audio tracks to attach to the recording. */
  67300. audioTracks?: MediaStreamTrack[];
  67301. }
  67302. /**
  67303. * This can help with recording videos from BabylonJS.
  67304. * This is based on the available WebRTC functionalities of the browser.
  67305. *
  67306. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  67307. */
  67308. export class VideoRecorder {
  67309. private static readonly _defaultOptions;
  67310. /**
  67311. * Returns whether or not the VideoRecorder is available in your browser.
  67312. * @param engine Defines the Babylon Engine.
  67313. * @returns true if supported otherwise false.
  67314. */
  67315. static IsSupported(engine: Engine): boolean;
  67316. private readonly _options;
  67317. private _canvas;
  67318. private _mediaRecorder;
  67319. private _recordedChunks;
  67320. private _fileName;
  67321. private _resolve;
  67322. private _reject;
  67323. /**
  67324. * True when a recording is already in progress.
  67325. */
  67326. readonly isRecording: boolean;
  67327. /**
  67328. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  67329. * @param engine Defines the BabylonJS Engine you wish to record.
  67330. * @param options Defines options that can be used to customize the capture.
  67331. */
  67332. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  67333. /**
  67334. * Stops the current recording before the default capture timeout passed in the startRecording function.
  67335. */
  67336. stopRecording(): void;
  67337. /**
  67338. * Starts recording the canvas for a max duration specified in parameters.
  67339. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  67340. * If null no automatic download will start and you can rely on the promise to get the data back.
  67341. * @param maxDuration Defines the maximum recording time in seconds.
  67342. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  67343. * @return A promise callback at the end of the recording with the video data in Blob.
  67344. */
  67345. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  67346. /**
  67347. * Releases internal resources used during the recording.
  67348. */
  67349. dispose(): void;
  67350. private _handleDataAvailable;
  67351. private _handleError;
  67352. private _handleStop;
  67353. }
  67354. }
  67355. declare module "babylonjs/Misc/screenshotTools" {
  67356. import { Camera } from "babylonjs/Cameras/camera";
  67357. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  67358. import { Engine } from "babylonjs/Engines/engine";
  67359. /**
  67360. * Class containing a set of static utilities functions for screenshots
  67361. */
  67362. export class ScreenshotTools {
  67363. /**
  67364. * Captures a screenshot of the current rendering
  67365. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  67366. * @param engine defines the rendering engine
  67367. * @param camera defines the source camera
  67368. * @param size This parameter can be set to a single number or to an object with the
  67369. * following (optional) properties: precision, width, height. If a single number is passed,
  67370. * it will be used for both width and height. If an object is passed, the screenshot size
  67371. * will be derived from the parameters. The precision property is a multiplier allowing
  67372. * rendering at a higher or lower resolution
  67373. * @param successCallback defines the callback receives a single parameter which contains the
  67374. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  67375. * src parameter of an <img> to display it
  67376. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  67377. * Check your browser for supported MIME types
  67378. */
  67379. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  67380. /**
  67381. * Captures a screenshot of the current rendering
  67382. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  67383. * @param engine defines the rendering engine
  67384. * @param camera defines the source camera
  67385. * @param size This parameter can be set to a single number or to an object with the
  67386. * following (optional) properties: precision, width, height. If a single number is passed,
  67387. * it will be used for both width and height. If an object is passed, the screenshot size
  67388. * will be derived from the parameters. The precision property is a multiplier allowing
  67389. * rendering at a higher or lower resolution
  67390. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  67391. * Check your browser for supported MIME types
  67392. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  67393. * to the src parameter of an <img> to display it
  67394. */
  67395. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  67396. /**
  67397. * Generates an image screenshot from the specified camera.
  67398. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  67399. * @param engine The engine to use for rendering
  67400. * @param camera The camera to use for rendering
  67401. * @param size This parameter can be set to a single number or to an object with the
  67402. * following (optional) properties: precision, width, height. If a single number is passed,
  67403. * it will be used for both width and height. If an object is passed, the screenshot size
  67404. * will be derived from the parameters. The precision property is a multiplier allowing
  67405. * rendering at a higher or lower resolution
  67406. * @param successCallback The callback receives a single parameter which contains the
  67407. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  67408. * src parameter of an <img> to display it
  67409. * @param mimeType The MIME type of the screenshot image (default: image/png).
  67410. * Check your browser for supported MIME types
  67411. * @param samples Texture samples (default: 1)
  67412. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  67413. * @param fileName A name for for the downloaded file.
  67414. */
  67415. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  67416. /**
  67417. * Generates an image screenshot from the specified camera.
  67418. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  67419. * @param engine The engine to use for rendering
  67420. * @param camera The camera to use for rendering
  67421. * @param size This parameter can be set to a single number or to an object with the
  67422. * following (optional) properties: precision, width, height. If a single number is passed,
  67423. * it will be used for both width and height. If an object is passed, the screenshot size
  67424. * will be derived from the parameters. The precision property is a multiplier allowing
  67425. * rendering at a higher or lower resolution
  67426. * @param mimeType The MIME type of the screenshot image (default: image/png).
  67427. * Check your browser for supported MIME types
  67428. * @param samples Texture samples (default: 1)
  67429. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  67430. * @param fileName A name for for the downloaded file.
  67431. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  67432. * to the src parameter of an <img> to display it
  67433. */
  67434. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  67435. /**
  67436. * Gets height and width for screenshot size
  67437. * @private
  67438. */
  67439. private static _getScreenshotSize;
  67440. }
  67441. }
  67442. declare module "babylonjs/Misc/dataReader" {
  67443. /**
  67444. * Interface for a data buffer
  67445. */
  67446. export interface IDataBuffer {
  67447. /**
  67448. * Reads bytes from the data buffer.
  67449. * @param byteOffset The byte offset to read
  67450. * @param byteLength The byte length to read
  67451. * @returns A promise that resolves when the bytes are read
  67452. */
  67453. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  67454. /**
  67455. * The byte length of the buffer.
  67456. */
  67457. readonly byteLength: number;
  67458. }
  67459. /**
  67460. * Utility class for reading from a data buffer
  67461. */
  67462. export class DataReader {
  67463. /**
  67464. * The data buffer associated with this data reader.
  67465. */
  67466. readonly buffer: IDataBuffer;
  67467. /**
  67468. * The current byte offset from the beginning of the data buffer.
  67469. */
  67470. byteOffset: number;
  67471. private _dataView;
  67472. private _dataByteOffset;
  67473. /**
  67474. * Constructor
  67475. * @param buffer The buffer to read
  67476. */
  67477. constructor(buffer: IDataBuffer);
  67478. /**
  67479. * Loads the given byte length.
  67480. * @param byteLength The byte length to load
  67481. * @returns A promise that resolves when the load is complete
  67482. */
  67483. loadAsync(byteLength: number): Promise<void>;
  67484. /**
  67485. * Read a unsigned 32-bit integer from the currently loaded data range.
  67486. * @returns The 32-bit integer read
  67487. */
  67488. readUint32(): number;
  67489. /**
  67490. * Read a byte array from the currently loaded data range.
  67491. * @param byteLength The byte length to read
  67492. * @returns The byte array read
  67493. */
  67494. readUint8Array(byteLength: number): Uint8Array;
  67495. /**
  67496. * Read a string from the currently loaded data range.
  67497. * @param byteLength The byte length to read
  67498. * @returns The string read
  67499. */
  67500. readString(byteLength: number): string;
  67501. /**
  67502. * Skips the given byte length the currently loaded data range.
  67503. * @param byteLength The byte length to skip
  67504. */
  67505. skipBytes(byteLength: number): void;
  67506. }
  67507. }
  67508. declare module "babylonjs/Misc/index" {
  67509. export * from "babylonjs/Misc/andOrNotEvaluator";
  67510. export * from "babylonjs/Misc/assetsManager";
  67511. export * from "babylonjs/Misc/dds";
  67512. export * from "babylonjs/Misc/decorators";
  67513. export * from "babylonjs/Misc/deferred";
  67514. export * from "babylonjs/Misc/environmentTextureTools";
  67515. export * from "babylonjs/Misc/meshExploder";
  67516. export * from "babylonjs/Misc/filesInput";
  67517. export * from "babylonjs/Misc/HighDynamicRange/index";
  67518. export * from "babylonjs/Misc/khronosTextureContainer";
  67519. export * from "babylonjs/Misc/observable";
  67520. export * from "babylonjs/Misc/performanceMonitor";
  67521. export * from "babylonjs/Misc/promise";
  67522. export * from "babylonjs/Misc/sceneOptimizer";
  67523. export * from "babylonjs/Misc/sceneSerializer";
  67524. export * from "babylonjs/Misc/smartArray";
  67525. export * from "babylonjs/Misc/stringDictionary";
  67526. export * from "babylonjs/Misc/tags";
  67527. export * from "babylonjs/Misc/textureTools";
  67528. export * from "babylonjs/Misc/tga";
  67529. export * from "babylonjs/Misc/tools";
  67530. export * from "babylonjs/Misc/videoRecorder";
  67531. export * from "babylonjs/Misc/virtualJoystick";
  67532. export * from "babylonjs/Misc/workerPool";
  67533. export * from "babylonjs/Misc/logger";
  67534. export * from "babylonjs/Misc/typeStore";
  67535. export * from "babylonjs/Misc/filesInputStore";
  67536. export * from "babylonjs/Misc/deepCopier";
  67537. export * from "babylonjs/Misc/pivotTools";
  67538. export * from "babylonjs/Misc/precisionDate";
  67539. export * from "babylonjs/Misc/screenshotTools";
  67540. export * from "babylonjs/Misc/typeStore";
  67541. export * from "babylonjs/Misc/webRequest";
  67542. export * from "babylonjs/Misc/iInspectable";
  67543. export * from "babylonjs/Misc/brdfTextureTools";
  67544. export * from "babylonjs/Misc/rgbdTextureTools";
  67545. export * from "babylonjs/Misc/gradients";
  67546. export * from "babylonjs/Misc/perfCounter";
  67547. export * from "babylonjs/Misc/fileRequest";
  67548. export * from "babylonjs/Misc/customAnimationFrameRequester";
  67549. export * from "babylonjs/Misc/retryStrategy";
  67550. export * from "babylonjs/Misc/interfaces/screenshotSize";
  67551. export * from "babylonjs/Misc/canvasGenerator";
  67552. export * from "babylonjs/Misc/fileTools";
  67553. export * from "babylonjs/Misc/stringTools";
  67554. export * from "babylonjs/Misc/dataReader";
  67555. }
  67556. declare module "babylonjs/index" {
  67557. export * from "babylonjs/abstractScene";
  67558. export * from "babylonjs/Actions/index";
  67559. export * from "babylonjs/Animations/index";
  67560. export * from "babylonjs/assetContainer";
  67561. export * from "babylonjs/Audio/index";
  67562. export * from "babylonjs/Behaviors/index";
  67563. export * from "babylonjs/Bones/index";
  67564. export * from "babylonjs/Cameras/index";
  67565. export * from "babylonjs/Collisions/index";
  67566. export * from "babylonjs/Culling/index";
  67567. export * from "babylonjs/Debug/index";
  67568. export * from "babylonjs/Engines/index";
  67569. export * from "babylonjs/Events/index";
  67570. export * from "babylonjs/Gamepads/index";
  67571. export * from "babylonjs/Gizmos/index";
  67572. export * from "babylonjs/Helpers/index";
  67573. export * from "babylonjs/Instrumentation/index";
  67574. export * from "babylonjs/Layers/index";
  67575. export * from "babylonjs/LensFlares/index";
  67576. export * from "babylonjs/Lights/index";
  67577. export * from "babylonjs/Loading/index";
  67578. export * from "babylonjs/Materials/index";
  67579. export * from "babylonjs/Maths/index";
  67580. export * from "babylonjs/Meshes/index";
  67581. export * from "babylonjs/Morph/index";
  67582. export * from "babylonjs/Navigation/index";
  67583. export * from "babylonjs/node";
  67584. export * from "babylonjs/Offline/index";
  67585. export * from "babylonjs/Particles/index";
  67586. export * from "babylonjs/Physics/index";
  67587. export * from "babylonjs/PostProcesses/index";
  67588. export * from "babylonjs/Probes/index";
  67589. export * from "babylonjs/Rendering/index";
  67590. export * from "babylonjs/scene";
  67591. export * from "babylonjs/sceneComponent";
  67592. export * from "babylonjs/Sprites/index";
  67593. export * from "babylonjs/States/index";
  67594. export * from "babylonjs/Misc/index";
  67595. export * from "babylonjs/types";
  67596. }
  67597. declare module "babylonjs/Animations/pathCursor" {
  67598. import { Vector3 } from "babylonjs/Maths/math.vector";
  67599. import { Path2 } from "babylonjs/Maths/math.path";
  67600. /**
  67601. * A cursor which tracks a point on a path
  67602. */
  67603. export class PathCursor {
  67604. private path;
  67605. /**
  67606. * Stores path cursor callbacks for when an onchange event is triggered
  67607. */
  67608. private _onchange;
  67609. /**
  67610. * The value of the path cursor
  67611. */
  67612. value: number;
  67613. /**
  67614. * The animation array of the path cursor
  67615. */
  67616. animations: Animation[];
  67617. /**
  67618. * Initializes the path cursor
  67619. * @param path The path to track
  67620. */
  67621. constructor(path: Path2);
  67622. /**
  67623. * Gets the cursor point on the path
  67624. * @returns A point on the path cursor at the cursor location
  67625. */
  67626. getPoint(): Vector3;
  67627. /**
  67628. * Moves the cursor ahead by the step amount
  67629. * @param step The amount to move the cursor forward
  67630. * @returns This path cursor
  67631. */
  67632. moveAhead(step?: number): PathCursor;
  67633. /**
  67634. * Moves the cursor behind by the step amount
  67635. * @param step The amount to move the cursor back
  67636. * @returns This path cursor
  67637. */
  67638. moveBack(step?: number): PathCursor;
  67639. /**
  67640. * Moves the cursor by the step amount
  67641. * If the step amount is greater than one, an exception is thrown
  67642. * @param step The amount to move the cursor
  67643. * @returns This path cursor
  67644. */
  67645. move(step: number): PathCursor;
  67646. /**
  67647. * Ensures that the value is limited between zero and one
  67648. * @returns This path cursor
  67649. */
  67650. private ensureLimits;
  67651. /**
  67652. * Runs onchange callbacks on change (used by the animation engine)
  67653. * @returns This path cursor
  67654. */
  67655. private raiseOnChange;
  67656. /**
  67657. * Executes a function on change
  67658. * @param f A path cursor onchange callback
  67659. * @returns This path cursor
  67660. */
  67661. onchange(f: (cursor: PathCursor) => void): PathCursor;
  67662. }
  67663. }
  67664. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  67665. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  67666. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  67667. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  67668. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  67669. }
  67670. declare module "babylonjs/Engines/Processors/Expressions/index" {
  67671. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  67672. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  67673. }
  67674. declare module "babylonjs/Engines/Processors/index" {
  67675. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  67676. export * from "babylonjs/Engines/Processors/Expressions/index";
  67677. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  67678. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  67679. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  67680. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  67681. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  67682. export * from "babylonjs/Engines/Processors/shaderProcessor";
  67683. }
  67684. declare module "babylonjs/Legacy/legacy" {
  67685. import * as Babylon from "babylonjs/index";
  67686. export * from "babylonjs/index";
  67687. }
  67688. declare module "babylonjs/Shaders/blur.fragment" {
  67689. /** @hidden */
  67690. export var blurPixelShader: {
  67691. name: string;
  67692. shader: string;
  67693. };
  67694. }
  67695. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  67696. /** @hidden */
  67697. export var pointCloudVertexDeclaration: {
  67698. name: string;
  67699. shader: string;
  67700. };
  67701. }
  67702. declare module "babylonjs" {
  67703. export * from "babylonjs/Legacy/legacy";
  67704. }
  67705. declare module BABYLON {
  67706. /** Alias type for value that can be null */
  67707. export type Nullable<T> = T | null;
  67708. /**
  67709. * Alias type for number that are floats
  67710. * @ignorenaming
  67711. */
  67712. export type float = number;
  67713. /**
  67714. * Alias type for number that are doubles.
  67715. * @ignorenaming
  67716. */
  67717. export type double = number;
  67718. /**
  67719. * Alias type for number that are integer
  67720. * @ignorenaming
  67721. */
  67722. export type int = number;
  67723. /** Alias type for number array or Float32Array */
  67724. export type FloatArray = number[] | Float32Array;
  67725. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  67726. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  67727. /**
  67728. * Alias for types that can be used by a Buffer or VertexBuffer.
  67729. */
  67730. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  67731. /**
  67732. * Alias type for primitive types
  67733. * @ignorenaming
  67734. */
  67735. type Primitive = undefined | null | boolean | string | number | Function;
  67736. /**
  67737. * Type modifier to make all the properties of an object Readonly
  67738. */
  67739. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  67740. /**
  67741. * Type modifier to make all the properties of an object Readonly recursively
  67742. */
  67743. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  67744. /**
  67745. * Type modifier to make object properties readonly.
  67746. */
  67747. export type DeepImmutableObject<T> = {
  67748. readonly [K in keyof T]: DeepImmutable<T[K]>;
  67749. };
  67750. /** @hidden */
  67751. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  67752. }
  67753. }
  67754. declare module BABYLON {
  67755. /**
  67756. * A class serves as a medium between the observable and its observers
  67757. */
  67758. export class EventState {
  67759. /**
  67760. * Create a new EventState
  67761. * @param mask defines the mask associated with this state
  67762. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  67763. * @param target defines the original target of the state
  67764. * @param currentTarget defines the current target of the state
  67765. */
  67766. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  67767. /**
  67768. * Initialize the current event state
  67769. * @param mask defines the mask associated with this state
  67770. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  67771. * @param target defines the original target of the state
  67772. * @param currentTarget defines the current target of the state
  67773. * @returns the current event state
  67774. */
  67775. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  67776. /**
  67777. * An Observer can set this property to true to prevent subsequent observers of being notified
  67778. */
  67779. skipNextObservers: boolean;
  67780. /**
  67781. * Get the mask value that were used to trigger the event corresponding to this EventState object
  67782. */
  67783. mask: number;
  67784. /**
  67785. * The object that originally notified the event
  67786. */
  67787. target?: any;
  67788. /**
  67789. * The current object in the bubbling phase
  67790. */
  67791. currentTarget?: any;
  67792. /**
  67793. * This will be populated with the return value of the last function that was executed.
  67794. * If it is the first function in the callback chain it will be the event data.
  67795. */
  67796. lastReturnValue?: any;
  67797. }
  67798. /**
  67799. * Represent an Observer registered to a given Observable object.
  67800. */
  67801. export class Observer<T> {
  67802. /**
  67803. * Defines the callback to call when the observer is notified
  67804. */
  67805. callback: (eventData: T, eventState: EventState) => void;
  67806. /**
  67807. * Defines the mask of the observer (used to filter notifications)
  67808. */
  67809. mask: number;
  67810. /**
  67811. * Defines the current scope used to restore the JS context
  67812. */
  67813. scope: any;
  67814. /** @hidden */
  67815. _willBeUnregistered: boolean;
  67816. /**
  67817. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  67818. */
  67819. unregisterOnNextCall: boolean;
  67820. /**
  67821. * Creates a new observer
  67822. * @param callback defines the callback to call when the observer is notified
  67823. * @param mask defines the mask of the observer (used to filter notifications)
  67824. * @param scope defines the current scope used to restore the JS context
  67825. */
  67826. constructor(
  67827. /**
  67828. * Defines the callback to call when the observer is notified
  67829. */
  67830. callback: (eventData: T, eventState: EventState) => void,
  67831. /**
  67832. * Defines the mask of the observer (used to filter notifications)
  67833. */
  67834. mask: number,
  67835. /**
  67836. * Defines the current scope used to restore the JS context
  67837. */
  67838. scope?: any);
  67839. }
  67840. /**
  67841. * Represent a list of observers registered to multiple Observables object.
  67842. */
  67843. export class MultiObserver<T> {
  67844. private _observers;
  67845. private _observables;
  67846. /**
  67847. * Release associated resources
  67848. */
  67849. dispose(): void;
  67850. /**
  67851. * Raise a callback when one of the observable will notify
  67852. * @param observables defines a list of observables to watch
  67853. * @param callback defines the callback to call on notification
  67854. * @param mask defines the mask used to filter notifications
  67855. * @param scope defines the current scope used to restore the JS context
  67856. * @returns the new MultiObserver
  67857. */
  67858. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  67859. }
  67860. /**
  67861. * The Observable class is a simple implementation of the Observable pattern.
  67862. *
  67863. * 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.
  67864. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  67865. * 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).
  67866. * 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.
  67867. */
  67868. export class Observable<T> {
  67869. private _observers;
  67870. private _eventState;
  67871. private _onObserverAdded;
  67872. /**
  67873. * Gets the list of observers
  67874. */
  67875. readonly observers: Array<Observer<T>>;
  67876. /**
  67877. * Creates a new observable
  67878. * @param onObserverAdded defines a callback to call when a new observer is added
  67879. */
  67880. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  67881. /**
  67882. * Create a new Observer with the specified callback
  67883. * @param callback the callback that will be executed for that Observer
  67884. * @param mask the mask used to filter observers
  67885. * @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.
  67886. * @param scope optional scope for the callback to be called from
  67887. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  67888. * @returns the new observer created for the callback
  67889. */
  67890. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  67891. /**
  67892. * Create a new Observer with the specified callback and unregisters after the next notification
  67893. * @param callback the callback that will be executed for that Observer
  67894. * @returns the new observer created for the callback
  67895. */
  67896. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  67897. /**
  67898. * Remove an Observer from the Observable object
  67899. * @param observer the instance of the Observer to remove
  67900. * @returns false if it doesn't belong to this Observable
  67901. */
  67902. remove(observer: Nullable<Observer<T>>): boolean;
  67903. /**
  67904. * Remove a callback from the Observable object
  67905. * @param callback the callback to remove
  67906. * @param scope optional scope. If used only the callbacks with this scope will be removed
  67907. * @returns false if it doesn't belong to this Observable
  67908. */
  67909. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  67910. private _deferUnregister;
  67911. private _remove;
  67912. /**
  67913. * Moves the observable to the top of the observer list making it get called first when notified
  67914. * @param observer the observer to move
  67915. */
  67916. makeObserverTopPriority(observer: Observer<T>): void;
  67917. /**
  67918. * Moves the observable to the bottom of the observer list making it get called last when notified
  67919. * @param observer the observer to move
  67920. */
  67921. makeObserverBottomPriority(observer: Observer<T>): void;
  67922. /**
  67923. * Notify all Observers by calling their respective callback with the given data
  67924. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  67925. * @param eventData defines the data to send to all observers
  67926. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  67927. * @param target defines the original target of the state
  67928. * @param currentTarget defines the current target of the state
  67929. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  67930. */
  67931. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  67932. /**
  67933. * Calling this will execute each callback, expecting it to be a promise or return a value.
  67934. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  67935. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  67936. * and it is crucial that all callbacks will be executed.
  67937. * The order of the callbacks is kept, callbacks are not executed parallel.
  67938. *
  67939. * @param eventData The data to be sent to each callback
  67940. * @param mask is used to filter observers defaults to -1
  67941. * @param target defines the callback target (see EventState)
  67942. * @param currentTarget defines he current object in the bubbling phase
  67943. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  67944. */
  67945. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  67946. /**
  67947. * Notify a specific observer
  67948. * @param observer defines the observer to notify
  67949. * @param eventData defines the data to be sent to each callback
  67950. * @param mask is used to filter observers defaults to -1
  67951. */
  67952. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  67953. /**
  67954. * Gets a boolean indicating if the observable has at least one observer
  67955. * @returns true is the Observable has at least one Observer registered
  67956. */
  67957. hasObservers(): boolean;
  67958. /**
  67959. * Clear the list of observers
  67960. */
  67961. clear(): void;
  67962. /**
  67963. * Clone the current observable
  67964. * @returns a new observable
  67965. */
  67966. clone(): Observable<T>;
  67967. /**
  67968. * Does this observable handles observer registered with a given mask
  67969. * @param mask defines the mask to be tested
  67970. * @return whether or not one observer registered with the given mask is handeled
  67971. **/
  67972. hasSpecificMask(mask?: number): boolean;
  67973. }
  67974. }
  67975. declare module BABYLON {
  67976. /**
  67977. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  67978. * Babylon.js
  67979. */
  67980. export class DomManagement {
  67981. /**
  67982. * Checks if the window object exists
  67983. * @returns true if the window object exists
  67984. */
  67985. static IsWindowObjectExist(): boolean;
  67986. /**
  67987. * Checks if the navigator object exists
  67988. * @returns true if the navigator object exists
  67989. */
  67990. static IsNavigatorAvailable(): boolean;
  67991. /**
  67992. * Extracts text content from a DOM element hierarchy
  67993. * @param element defines the root element
  67994. * @returns a string
  67995. */
  67996. static GetDOMTextContent(element: HTMLElement): string;
  67997. }
  67998. }
  67999. declare module BABYLON {
  68000. /**
  68001. * Logger used througouht the application to allow configuration of
  68002. * the log level required for the messages.
  68003. */
  68004. export class Logger {
  68005. /**
  68006. * No log
  68007. */
  68008. static readonly NoneLogLevel: number;
  68009. /**
  68010. * Only message logs
  68011. */
  68012. static readonly MessageLogLevel: number;
  68013. /**
  68014. * Only warning logs
  68015. */
  68016. static readonly WarningLogLevel: number;
  68017. /**
  68018. * Only error logs
  68019. */
  68020. static readonly ErrorLogLevel: number;
  68021. /**
  68022. * All logs
  68023. */
  68024. static readonly AllLogLevel: number;
  68025. private static _LogCache;
  68026. /**
  68027. * Gets a value indicating the number of loading errors
  68028. * @ignorenaming
  68029. */
  68030. static errorsCount: number;
  68031. /**
  68032. * Callback called when a new log is added
  68033. */
  68034. static OnNewCacheEntry: (entry: string) => void;
  68035. private static _AddLogEntry;
  68036. private static _FormatMessage;
  68037. private static _LogDisabled;
  68038. private static _LogEnabled;
  68039. private static _WarnDisabled;
  68040. private static _WarnEnabled;
  68041. private static _ErrorDisabled;
  68042. private static _ErrorEnabled;
  68043. /**
  68044. * Log a message to the console
  68045. */
  68046. static Log: (message: string) => void;
  68047. /**
  68048. * Write a warning message to the console
  68049. */
  68050. static Warn: (message: string) => void;
  68051. /**
  68052. * Write an error message to the console
  68053. */
  68054. static Error: (message: string) => void;
  68055. /**
  68056. * Gets current log cache (list of logs)
  68057. */
  68058. static readonly LogCache: string;
  68059. /**
  68060. * Clears the log cache
  68061. */
  68062. static ClearLogCache(): void;
  68063. /**
  68064. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  68065. */
  68066. static LogLevels: number;
  68067. }
  68068. }
  68069. declare module BABYLON {
  68070. /** @hidden */
  68071. export class _TypeStore {
  68072. /** @hidden */
  68073. static RegisteredTypes: {
  68074. [key: string]: Object;
  68075. };
  68076. /** @hidden */
  68077. static GetClass(fqdn: string): any;
  68078. }
  68079. }
  68080. declare module BABYLON {
  68081. /**
  68082. * Helper to manipulate strings
  68083. */
  68084. export class StringTools {
  68085. /**
  68086. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  68087. * @param str Source string
  68088. * @param suffix Suffix to search for in the source string
  68089. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  68090. */
  68091. static EndsWith(str: string, suffix: string): boolean;
  68092. /**
  68093. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  68094. * @param str Source string
  68095. * @param suffix Suffix to search for in the source string
  68096. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  68097. */
  68098. static StartsWith(str: string, suffix: string): boolean;
  68099. /**
  68100. * Decodes a buffer into a string
  68101. * @param buffer The buffer to decode
  68102. * @returns The decoded string
  68103. */
  68104. static Decode(buffer: Uint8Array | Uint16Array): string;
  68105. /**
  68106. * Encode a buffer to a base64 string
  68107. * @param buffer defines the buffer to encode
  68108. * @returns the encoded string
  68109. */
  68110. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  68111. }
  68112. }
  68113. declare module BABYLON {
  68114. /**
  68115. * Class containing a set of static utilities functions for deep copy.
  68116. */
  68117. export class DeepCopier {
  68118. /**
  68119. * Tries to copy an object by duplicating every property
  68120. * @param source defines the source object
  68121. * @param destination defines the target object
  68122. * @param doNotCopyList defines a list of properties to avoid
  68123. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  68124. */
  68125. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  68126. }
  68127. }
  68128. declare module BABYLON {
  68129. /**
  68130. * Class containing a set of static utilities functions for precision date
  68131. */
  68132. export class PrecisionDate {
  68133. /**
  68134. * Gets either window.performance.now() if supported or Date.now() else
  68135. */
  68136. static readonly Now: number;
  68137. }
  68138. }
  68139. declare module BABYLON {
  68140. /** @hidden */
  68141. export class _DevTools {
  68142. static WarnImport(name: string): string;
  68143. }
  68144. }
  68145. declare module BABYLON {
  68146. /**
  68147. * Interface used to define the mechanism to get data from the network
  68148. */
  68149. export interface IWebRequest {
  68150. /**
  68151. * Returns client's response url
  68152. */
  68153. responseURL: string;
  68154. /**
  68155. * Returns client's status
  68156. */
  68157. status: number;
  68158. /**
  68159. * Returns client's status as a text
  68160. */
  68161. statusText: string;
  68162. }
  68163. }
  68164. declare module BABYLON {
  68165. /**
  68166. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  68167. */
  68168. export class WebRequest implements IWebRequest {
  68169. private _xhr;
  68170. /**
  68171. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  68172. * i.e. when loading files, where the server/service expects an Authorization header
  68173. */
  68174. static CustomRequestHeaders: {
  68175. [key: string]: string;
  68176. };
  68177. /**
  68178. * Add callback functions in this array to update all the requests before they get sent to the network
  68179. */
  68180. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  68181. private _injectCustomRequestHeaders;
  68182. /**
  68183. * Gets or sets a function to be called when loading progress changes
  68184. */
  68185. onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  68186. /**
  68187. * Returns client's state
  68188. */
  68189. readonly readyState: number;
  68190. /**
  68191. * Returns client's status
  68192. */
  68193. readonly status: number;
  68194. /**
  68195. * Returns client's status as a text
  68196. */
  68197. readonly statusText: string;
  68198. /**
  68199. * Returns client's response
  68200. */
  68201. readonly response: any;
  68202. /**
  68203. * Returns client's response url
  68204. */
  68205. readonly responseURL: string;
  68206. /**
  68207. * Returns client's response as text
  68208. */
  68209. readonly responseText: string;
  68210. /**
  68211. * Gets or sets the expected response type
  68212. */
  68213. responseType: XMLHttpRequestResponseType;
  68214. /** @hidden */
  68215. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  68216. /** @hidden */
  68217. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  68218. /**
  68219. * Cancels any network activity
  68220. */
  68221. abort(): void;
  68222. /**
  68223. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  68224. * @param body defines an optional request body
  68225. */
  68226. send(body?: Document | BodyInit | null): void;
  68227. /**
  68228. * Sets the request method, request URL
  68229. * @param method defines the method to use (GET, POST, etc..)
  68230. * @param url defines the url to connect with
  68231. */
  68232. open(method: string, url: string): void;
  68233. /**
  68234. * Sets the value of a request header.
  68235. * @param name The name of the header whose value is to be set
  68236. * @param value The value to set as the body of the header
  68237. */
  68238. setRequestHeader(name: string, value: string): void;
  68239. /**
  68240. * Get the string containing the text of a particular header's value.
  68241. * @param name The name of the header
  68242. * @returns The string containing the text of the given header name
  68243. */
  68244. getResponseHeader(name: string): Nullable<string>;
  68245. }
  68246. }
  68247. declare module BABYLON {
  68248. /**
  68249. * File request interface
  68250. */
  68251. export interface IFileRequest {
  68252. /**
  68253. * Raised when the request is complete (success or error).
  68254. */
  68255. onCompleteObservable: Observable<IFileRequest>;
  68256. /**
  68257. * Aborts the request for a file.
  68258. */
  68259. abort: () => void;
  68260. }
  68261. }
  68262. declare module BABYLON {
  68263. /**
  68264. * Define options used to create a render target texture
  68265. */
  68266. export class RenderTargetCreationOptions {
  68267. /**
  68268. * Specifies is mipmaps must be generated
  68269. */
  68270. generateMipMaps?: boolean;
  68271. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  68272. generateDepthBuffer?: boolean;
  68273. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  68274. generateStencilBuffer?: boolean;
  68275. /** Defines texture type (int by default) */
  68276. type?: number;
  68277. /** Defines sampling mode (trilinear by default) */
  68278. samplingMode?: number;
  68279. /** Defines format (RGBA by default) */
  68280. format?: number;
  68281. }
  68282. }
  68283. declare module BABYLON {
  68284. /**
  68285. * @hidden
  68286. **/
  68287. export class _TimeToken {
  68288. _startTimeQuery: Nullable<WebGLQuery>;
  68289. _endTimeQuery: Nullable<WebGLQuery>;
  68290. _timeElapsedQuery: Nullable<WebGLQuery>;
  68291. _timeElapsedQueryEnded: boolean;
  68292. }
  68293. }
  68294. declare module BABYLON {
  68295. /** Defines the cross module used constants to avoid circular dependncies */
  68296. export class Constants {
  68297. /** Defines that alpha blending is disabled */
  68298. static readonly ALPHA_DISABLE: number;
  68299. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  68300. static readonly ALPHA_ADD: number;
  68301. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  68302. static readonly ALPHA_COMBINE: number;
  68303. /** Defines that alpha blending to DEST - SRC * DEST */
  68304. static readonly ALPHA_SUBTRACT: number;
  68305. /** Defines that alpha blending to SRC * DEST */
  68306. static readonly ALPHA_MULTIPLY: number;
  68307. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  68308. static readonly ALPHA_MAXIMIZED: number;
  68309. /** Defines that alpha blending to SRC + DEST */
  68310. static readonly ALPHA_ONEONE: number;
  68311. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  68312. static readonly ALPHA_PREMULTIPLIED: number;
  68313. /**
  68314. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  68315. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  68316. */
  68317. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  68318. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  68319. static readonly ALPHA_INTERPOLATE: number;
  68320. /**
  68321. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  68322. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  68323. */
  68324. static readonly ALPHA_SCREENMODE: number;
  68325. /**
  68326. * Defines that alpha blending to SRC + DST
  68327. * Alpha will be set to SRC ALPHA + DST ALPHA
  68328. */
  68329. static readonly ALPHA_ONEONE_ONEONE: number;
  68330. /**
  68331. * Defines that alpha blending to SRC * DST ALPHA + DST
  68332. * Alpha will be set to 0
  68333. */
  68334. static readonly ALPHA_ALPHATOCOLOR: number;
  68335. /**
  68336. * Defines that alpha blending to SRC * (1 - DST) + DST * (1 - SRC)
  68337. */
  68338. static readonly ALPHA_REVERSEONEMINUS: number;
  68339. /**
  68340. * Defines that alpha blending to SRC + DST * (1 - SRC ALPHA)
  68341. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  68342. */
  68343. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  68344. /**
  68345. * Defines that alpha blending to SRC + DST
  68346. * Alpha will be set to SRC ALPHA
  68347. */
  68348. static readonly ALPHA_ONEONE_ONEZERO: number;
  68349. /** Defines that alpha blending equation a SUM */
  68350. static readonly ALPHA_EQUATION_ADD: number;
  68351. /** Defines that alpha blending equation a SUBSTRACTION */
  68352. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  68353. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  68354. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  68355. /** Defines that alpha blending equation a MAX operation */
  68356. static readonly ALPHA_EQUATION_MAX: number;
  68357. /** Defines that alpha blending equation a MIN operation */
  68358. static readonly ALPHA_EQUATION_MIN: number;
  68359. /**
  68360. * Defines that alpha blending equation a DARKEN operation:
  68361. * It takes the min of the src and sums the alpha channels.
  68362. */
  68363. static readonly ALPHA_EQUATION_DARKEN: number;
  68364. /** Defines that the ressource is not delayed*/
  68365. static readonly DELAYLOADSTATE_NONE: number;
  68366. /** Defines that the ressource was successfully delay loaded */
  68367. static readonly DELAYLOADSTATE_LOADED: number;
  68368. /** Defines that the ressource is currently delay loading */
  68369. static readonly DELAYLOADSTATE_LOADING: number;
  68370. /** Defines that the ressource is delayed and has not started loading */
  68371. static readonly DELAYLOADSTATE_NOTLOADED: number;
  68372. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  68373. static readonly NEVER: number;
  68374. /** 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 */
  68375. static readonly ALWAYS: number;
  68376. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  68377. static readonly LESS: number;
  68378. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  68379. static readonly EQUAL: number;
  68380. /** 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 */
  68381. static readonly LEQUAL: number;
  68382. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  68383. static readonly GREATER: number;
  68384. /** 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 */
  68385. static readonly GEQUAL: number;
  68386. /** 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 */
  68387. static readonly NOTEQUAL: number;
  68388. /** Passed to stencilOperation to specify that stencil value must be kept */
  68389. static readonly KEEP: number;
  68390. /** Passed to stencilOperation to specify that stencil value must be replaced */
  68391. static readonly REPLACE: number;
  68392. /** Passed to stencilOperation to specify that stencil value must be incremented */
  68393. static readonly INCR: number;
  68394. /** Passed to stencilOperation to specify that stencil value must be decremented */
  68395. static readonly DECR: number;
  68396. /** Passed to stencilOperation to specify that stencil value must be inverted */
  68397. static readonly INVERT: number;
  68398. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  68399. static readonly INCR_WRAP: number;
  68400. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  68401. static readonly DECR_WRAP: number;
  68402. /** Texture is not repeating outside of 0..1 UVs */
  68403. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  68404. /** Texture is repeating outside of 0..1 UVs */
  68405. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  68406. /** Texture is repeating and mirrored */
  68407. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  68408. /** ALPHA */
  68409. static readonly TEXTUREFORMAT_ALPHA: number;
  68410. /** LUMINANCE */
  68411. static readonly TEXTUREFORMAT_LUMINANCE: number;
  68412. /** LUMINANCE_ALPHA */
  68413. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  68414. /** RGB */
  68415. static readonly TEXTUREFORMAT_RGB: number;
  68416. /** RGBA */
  68417. static readonly TEXTUREFORMAT_RGBA: number;
  68418. /** RED */
  68419. static readonly TEXTUREFORMAT_RED: number;
  68420. /** RED (2nd reference) */
  68421. static readonly TEXTUREFORMAT_R: number;
  68422. /** RG */
  68423. static readonly TEXTUREFORMAT_RG: number;
  68424. /** RED_INTEGER */
  68425. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  68426. /** RED_INTEGER (2nd reference) */
  68427. static readonly TEXTUREFORMAT_R_INTEGER: number;
  68428. /** RG_INTEGER */
  68429. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  68430. /** RGB_INTEGER */
  68431. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  68432. /** RGBA_INTEGER */
  68433. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  68434. /** UNSIGNED_BYTE */
  68435. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  68436. /** UNSIGNED_BYTE (2nd reference) */
  68437. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  68438. /** FLOAT */
  68439. static readonly TEXTURETYPE_FLOAT: number;
  68440. /** HALF_FLOAT */
  68441. static readonly TEXTURETYPE_HALF_FLOAT: number;
  68442. /** BYTE */
  68443. static readonly TEXTURETYPE_BYTE: number;
  68444. /** SHORT */
  68445. static readonly TEXTURETYPE_SHORT: number;
  68446. /** UNSIGNED_SHORT */
  68447. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  68448. /** INT */
  68449. static readonly TEXTURETYPE_INT: number;
  68450. /** UNSIGNED_INT */
  68451. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  68452. /** UNSIGNED_SHORT_4_4_4_4 */
  68453. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  68454. /** UNSIGNED_SHORT_5_5_5_1 */
  68455. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  68456. /** UNSIGNED_SHORT_5_6_5 */
  68457. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  68458. /** UNSIGNED_INT_2_10_10_10_REV */
  68459. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  68460. /** UNSIGNED_INT_24_8 */
  68461. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  68462. /** UNSIGNED_INT_10F_11F_11F_REV */
  68463. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  68464. /** UNSIGNED_INT_5_9_9_9_REV */
  68465. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  68466. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  68467. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  68468. /** nearest is mag = nearest and min = nearest and mip = linear */
  68469. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  68470. /** Bilinear is mag = linear and min = linear and mip = nearest */
  68471. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  68472. /** Trilinear is mag = linear and min = linear and mip = linear */
  68473. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  68474. /** nearest is mag = nearest and min = nearest and mip = linear */
  68475. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  68476. /** Bilinear is mag = linear and min = linear and mip = nearest */
  68477. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  68478. /** Trilinear is mag = linear and min = linear and mip = linear */
  68479. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  68480. /** mag = nearest and min = nearest and mip = nearest */
  68481. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  68482. /** mag = nearest and min = linear and mip = nearest */
  68483. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  68484. /** mag = nearest and min = linear and mip = linear */
  68485. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  68486. /** mag = nearest and min = linear and mip = none */
  68487. static readonly TEXTURE_NEAREST_LINEAR: number;
  68488. /** mag = nearest and min = nearest and mip = none */
  68489. static readonly TEXTURE_NEAREST_NEAREST: number;
  68490. /** mag = linear and min = nearest and mip = nearest */
  68491. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  68492. /** mag = linear and min = nearest and mip = linear */
  68493. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  68494. /** mag = linear and min = linear and mip = none */
  68495. static readonly TEXTURE_LINEAR_LINEAR: number;
  68496. /** mag = linear and min = nearest and mip = none */
  68497. static readonly TEXTURE_LINEAR_NEAREST: number;
  68498. /** Explicit coordinates mode */
  68499. static readonly TEXTURE_EXPLICIT_MODE: number;
  68500. /** Spherical coordinates mode */
  68501. static readonly TEXTURE_SPHERICAL_MODE: number;
  68502. /** Planar coordinates mode */
  68503. static readonly TEXTURE_PLANAR_MODE: number;
  68504. /** Cubic coordinates mode */
  68505. static readonly TEXTURE_CUBIC_MODE: number;
  68506. /** Projection coordinates mode */
  68507. static readonly TEXTURE_PROJECTION_MODE: number;
  68508. /** Skybox coordinates mode */
  68509. static readonly TEXTURE_SKYBOX_MODE: number;
  68510. /** Inverse Cubic coordinates mode */
  68511. static readonly TEXTURE_INVCUBIC_MODE: number;
  68512. /** Equirectangular coordinates mode */
  68513. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  68514. /** Equirectangular Fixed coordinates mode */
  68515. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  68516. /** Equirectangular Fixed Mirrored coordinates mode */
  68517. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  68518. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  68519. static readonly SCALEMODE_FLOOR: number;
  68520. /** Defines that texture rescaling will look for the nearest power of 2 size */
  68521. static readonly SCALEMODE_NEAREST: number;
  68522. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  68523. static readonly SCALEMODE_CEILING: number;
  68524. /**
  68525. * The dirty texture flag value
  68526. */
  68527. static readonly MATERIAL_TextureDirtyFlag: number;
  68528. /**
  68529. * The dirty light flag value
  68530. */
  68531. static readonly MATERIAL_LightDirtyFlag: number;
  68532. /**
  68533. * The dirty fresnel flag value
  68534. */
  68535. static readonly MATERIAL_FresnelDirtyFlag: number;
  68536. /**
  68537. * The dirty attribute flag value
  68538. */
  68539. static readonly MATERIAL_AttributesDirtyFlag: number;
  68540. /**
  68541. * The dirty misc flag value
  68542. */
  68543. static readonly MATERIAL_MiscDirtyFlag: number;
  68544. /**
  68545. * The all dirty flag value
  68546. */
  68547. static readonly MATERIAL_AllDirtyFlag: number;
  68548. /**
  68549. * Returns the triangle fill mode
  68550. */
  68551. static readonly MATERIAL_TriangleFillMode: number;
  68552. /**
  68553. * Returns the wireframe mode
  68554. */
  68555. static readonly MATERIAL_WireFrameFillMode: number;
  68556. /**
  68557. * Returns the point fill mode
  68558. */
  68559. static readonly MATERIAL_PointFillMode: number;
  68560. /**
  68561. * Returns the point list draw mode
  68562. */
  68563. static readonly MATERIAL_PointListDrawMode: number;
  68564. /**
  68565. * Returns the line list draw mode
  68566. */
  68567. static readonly MATERIAL_LineListDrawMode: number;
  68568. /**
  68569. * Returns the line loop draw mode
  68570. */
  68571. static readonly MATERIAL_LineLoopDrawMode: number;
  68572. /**
  68573. * Returns the line strip draw mode
  68574. */
  68575. static readonly MATERIAL_LineStripDrawMode: number;
  68576. /**
  68577. * Returns the triangle strip draw mode
  68578. */
  68579. static readonly MATERIAL_TriangleStripDrawMode: number;
  68580. /**
  68581. * Returns the triangle fan draw mode
  68582. */
  68583. static readonly MATERIAL_TriangleFanDrawMode: number;
  68584. /**
  68585. * Stores the clock-wise side orientation
  68586. */
  68587. static readonly MATERIAL_ClockWiseSideOrientation: number;
  68588. /**
  68589. * Stores the counter clock-wise side orientation
  68590. */
  68591. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  68592. /**
  68593. * Nothing
  68594. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68595. */
  68596. static readonly ACTION_NothingTrigger: number;
  68597. /**
  68598. * On pick
  68599. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68600. */
  68601. static readonly ACTION_OnPickTrigger: number;
  68602. /**
  68603. * On left pick
  68604. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68605. */
  68606. static readonly ACTION_OnLeftPickTrigger: number;
  68607. /**
  68608. * On right pick
  68609. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68610. */
  68611. static readonly ACTION_OnRightPickTrigger: number;
  68612. /**
  68613. * On center pick
  68614. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68615. */
  68616. static readonly ACTION_OnCenterPickTrigger: number;
  68617. /**
  68618. * On pick down
  68619. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68620. */
  68621. static readonly ACTION_OnPickDownTrigger: number;
  68622. /**
  68623. * On double pick
  68624. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68625. */
  68626. static readonly ACTION_OnDoublePickTrigger: number;
  68627. /**
  68628. * On pick up
  68629. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68630. */
  68631. static readonly ACTION_OnPickUpTrigger: number;
  68632. /**
  68633. * On pick out.
  68634. * This trigger will only be raised if you also declared a OnPickDown
  68635. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68636. */
  68637. static readonly ACTION_OnPickOutTrigger: number;
  68638. /**
  68639. * On long press
  68640. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68641. */
  68642. static readonly ACTION_OnLongPressTrigger: number;
  68643. /**
  68644. * On pointer over
  68645. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68646. */
  68647. static readonly ACTION_OnPointerOverTrigger: number;
  68648. /**
  68649. * On pointer out
  68650. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68651. */
  68652. static readonly ACTION_OnPointerOutTrigger: number;
  68653. /**
  68654. * On every frame
  68655. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68656. */
  68657. static readonly ACTION_OnEveryFrameTrigger: number;
  68658. /**
  68659. * On intersection enter
  68660. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68661. */
  68662. static readonly ACTION_OnIntersectionEnterTrigger: number;
  68663. /**
  68664. * On intersection exit
  68665. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68666. */
  68667. static readonly ACTION_OnIntersectionExitTrigger: number;
  68668. /**
  68669. * On key down
  68670. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68671. */
  68672. static readonly ACTION_OnKeyDownTrigger: number;
  68673. /**
  68674. * On key up
  68675. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68676. */
  68677. static readonly ACTION_OnKeyUpTrigger: number;
  68678. /**
  68679. * Billboard mode will only apply to Y axis
  68680. */
  68681. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  68682. /**
  68683. * Billboard mode will apply to all axes
  68684. */
  68685. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  68686. /**
  68687. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  68688. */
  68689. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  68690. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  68691. * Test order :
  68692. * Is the bounding sphere outside the frustum ?
  68693. * If not, are the bounding box vertices outside the frustum ?
  68694. * It not, then the cullable object is in the frustum.
  68695. */
  68696. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  68697. /** Culling strategy : Bounding Sphere Only.
  68698. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  68699. * It's also less accurate than the standard because some not visible objects can still be selected.
  68700. * Test : is the bounding sphere outside the frustum ?
  68701. * If not, then the cullable object is in the frustum.
  68702. */
  68703. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  68704. /** Culling strategy : Optimistic Inclusion.
  68705. * This in an inclusion test first, then the standard exclusion test.
  68706. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  68707. * 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.
  68708. * Anyway, it's as accurate as the standard strategy.
  68709. * Test :
  68710. * Is the cullable object bounding sphere center in the frustum ?
  68711. * If not, apply the default culling strategy.
  68712. */
  68713. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  68714. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  68715. * This in an inclusion test first, then the bounding sphere only exclusion test.
  68716. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  68717. * 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.
  68718. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  68719. * Test :
  68720. * Is the cullable object bounding sphere center in the frustum ?
  68721. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  68722. */
  68723. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  68724. /**
  68725. * No logging while loading
  68726. */
  68727. static readonly SCENELOADER_NO_LOGGING: number;
  68728. /**
  68729. * Minimal logging while loading
  68730. */
  68731. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  68732. /**
  68733. * Summary logging while loading
  68734. */
  68735. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  68736. /**
  68737. * Detailled logging while loading
  68738. */
  68739. static readonly SCENELOADER_DETAILED_LOGGING: number;
  68740. }
  68741. }
  68742. declare module BABYLON {
  68743. /**
  68744. * This represents the required contract to create a new type of texture loader.
  68745. */
  68746. export interface IInternalTextureLoader {
  68747. /**
  68748. * Defines wether the loader supports cascade loading the different faces.
  68749. */
  68750. supportCascades: boolean;
  68751. /**
  68752. * This returns if the loader support the current file information.
  68753. * @param extension defines the file extension of the file being loaded
  68754. * @param textureFormatInUse defines the current compressed format in use iun the engine
  68755. * @param fallback defines the fallback internal texture if any
  68756. * @param isBase64 defines whether the texture is encoded as a base64
  68757. * @param isBuffer defines whether the texture data are stored as a buffer
  68758. * @returns true if the loader can load the specified file
  68759. */
  68760. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  68761. /**
  68762. * Transform the url before loading if required.
  68763. * @param rootUrl the url of the texture
  68764. * @param textureFormatInUse defines the current compressed format in use iun the engine
  68765. * @returns the transformed texture
  68766. */
  68767. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  68768. /**
  68769. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  68770. * @param rootUrl the url of the texture
  68771. * @param textureFormatInUse defines the current compressed format in use iun the engine
  68772. * @returns the fallback texture
  68773. */
  68774. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  68775. /**
  68776. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  68777. * @param data contains the texture data
  68778. * @param texture defines the BabylonJS internal texture
  68779. * @param createPolynomials will be true if polynomials have been requested
  68780. * @param onLoad defines the callback to trigger once the texture is ready
  68781. * @param onError defines the callback to trigger in case of error
  68782. */
  68783. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  68784. /**
  68785. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  68786. * @param data contains the texture data
  68787. * @param texture defines the BabylonJS internal texture
  68788. * @param callback defines the method to call once ready to upload
  68789. */
  68790. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  68791. }
  68792. }
  68793. declare module BABYLON {
  68794. /**
  68795. * Class used to store and describe the pipeline context associated with an effect
  68796. */
  68797. export interface IPipelineContext {
  68798. /**
  68799. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  68800. */
  68801. isAsync: boolean;
  68802. /**
  68803. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  68804. */
  68805. isReady: boolean;
  68806. /** @hidden */
  68807. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  68808. }
  68809. }
  68810. declare module BABYLON {
  68811. /**
  68812. * Class used to store gfx data (like WebGLBuffer)
  68813. */
  68814. export class DataBuffer {
  68815. /**
  68816. * Gets or sets the number of objects referencing this buffer
  68817. */
  68818. references: number;
  68819. /** Gets or sets the size of the underlying buffer */
  68820. capacity: number;
  68821. /**
  68822. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  68823. */
  68824. is32Bits: boolean;
  68825. /**
  68826. * Gets the underlying buffer
  68827. */
  68828. readonly underlyingResource: any;
  68829. }
  68830. }
  68831. declare module BABYLON {
  68832. /** @hidden */
  68833. export interface IShaderProcessor {
  68834. attributeProcessor?: (attribute: string) => string;
  68835. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  68836. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  68837. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  68838. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  68839. lineProcessor?: (line: string, isFragment: boolean) => string;
  68840. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  68841. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  68842. }
  68843. }
  68844. declare module BABYLON {
  68845. /** @hidden */
  68846. export interface ProcessingOptions {
  68847. defines: string[];
  68848. indexParameters: any;
  68849. isFragment: boolean;
  68850. shouldUseHighPrecisionShader: boolean;
  68851. supportsUniformBuffers: boolean;
  68852. shadersRepository: string;
  68853. includesShadersStore: {
  68854. [key: string]: string;
  68855. };
  68856. processor?: IShaderProcessor;
  68857. version: string;
  68858. platformName: string;
  68859. lookForClosingBracketForUniformBuffer?: boolean;
  68860. }
  68861. }
  68862. declare module BABYLON {
  68863. /** @hidden */
  68864. export class ShaderCodeNode {
  68865. line: string;
  68866. children: ShaderCodeNode[];
  68867. additionalDefineKey?: string;
  68868. additionalDefineValue?: string;
  68869. isValid(preprocessors: {
  68870. [key: string]: string;
  68871. }): boolean;
  68872. process(preprocessors: {
  68873. [key: string]: string;
  68874. }, options: ProcessingOptions): string;
  68875. }
  68876. }
  68877. declare module BABYLON {
  68878. /** @hidden */
  68879. export class ShaderCodeCursor {
  68880. private _lines;
  68881. lineIndex: number;
  68882. readonly currentLine: string;
  68883. readonly canRead: boolean;
  68884. lines: string[];
  68885. }
  68886. }
  68887. declare module BABYLON {
  68888. /** @hidden */
  68889. export class ShaderCodeConditionNode extends ShaderCodeNode {
  68890. process(preprocessors: {
  68891. [key: string]: string;
  68892. }, options: ProcessingOptions): string;
  68893. }
  68894. }
  68895. declare module BABYLON {
  68896. /** @hidden */
  68897. export class ShaderDefineExpression {
  68898. isTrue(preprocessors: {
  68899. [key: string]: string;
  68900. }): boolean;
  68901. }
  68902. }
  68903. declare module BABYLON {
  68904. /** @hidden */
  68905. export class ShaderCodeTestNode extends ShaderCodeNode {
  68906. testExpression: ShaderDefineExpression;
  68907. isValid(preprocessors: {
  68908. [key: string]: string;
  68909. }): boolean;
  68910. }
  68911. }
  68912. declare module BABYLON {
  68913. /** @hidden */
  68914. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  68915. define: string;
  68916. not: boolean;
  68917. constructor(define: string, not?: boolean);
  68918. isTrue(preprocessors: {
  68919. [key: string]: string;
  68920. }): boolean;
  68921. }
  68922. }
  68923. declare module BABYLON {
  68924. /** @hidden */
  68925. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  68926. leftOperand: ShaderDefineExpression;
  68927. rightOperand: ShaderDefineExpression;
  68928. isTrue(preprocessors: {
  68929. [key: string]: string;
  68930. }): boolean;
  68931. }
  68932. }
  68933. declare module BABYLON {
  68934. /** @hidden */
  68935. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  68936. leftOperand: ShaderDefineExpression;
  68937. rightOperand: ShaderDefineExpression;
  68938. isTrue(preprocessors: {
  68939. [key: string]: string;
  68940. }): boolean;
  68941. }
  68942. }
  68943. declare module BABYLON {
  68944. /** @hidden */
  68945. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  68946. define: string;
  68947. operand: string;
  68948. testValue: string;
  68949. constructor(define: string, operand: string, testValue: string);
  68950. isTrue(preprocessors: {
  68951. [key: string]: string;
  68952. }): boolean;
  68953. }
  68954. }
  68955. declare module BABYLON {
  68956. /**
  68957. * Class used to enable access to offline support
  68958. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  68959. */
  68960. export interface IOfflineProvider {
  68961. /**
  68962. * Gets a boolean indicating if scene must be saved in the database
  68963. */
  68964. enableSceneOffline: boolean;
  68965. /**
  68966. * Gets a boolean indicating if textures must be saved in the database
  68967. */
  68968. enableTexturesOffline: boolean;
  68969. /**
  68970. * Open the offline support and make it available
  68971. * @param successCallback defines the callback to call on success
  68972. * @param errorCallback defines the callback to call on error
  68973. */
  68974. open(successCallback: () => void, errorCallback: () => void): void;
  68975. /**
  68976. * Loads an image from the offline support
  68977. * @param url defines the url to load from
  68978. * @param image defines the target DOM image
  68979. */
  68980. loadImage(url: string, image: HTMLImageElement): void;
  68981. /**
  68982. * Loads a file from offline support
  68983. * @param url defines the URL to load from
  68984. * @param sceneLoaded defines a callback to call on success
  68985. * @param progressCallBack defines a callback to call when progress changed
  68986. * @param errorCallback defines a callback to call on error
  68987. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  68988. */
  68989. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  68990. }
  68991. }
  68992. declare module BABYLON {
  68993. /**
  68994. * Class used to help managing file picking and drag'n'drop
  68995. * File Storage
  68996. */
  68997. export class FilesInputStore {
  68998. /**
  68999. * List of files ready to be loaded
  69000. */
  69001. static FilesToLoad: {
  69002. [key: string]: File;
  69003. };
  69004. }
  69005. }
  69006. declare module BABYLON {
  69007. /**
  69008. * Class used to define a retry strategy when error happens while loading assets
  69009. */
  69010. export class RetryStrategy {
  69011. /**
  69012. * Function used to defines an exponential back off strategy
  69013. * @param maxRetries defines the maximum number of retries (3 by default)
  69014. * @param baseInterval defines the interval between retries
  69015. * @returns the strategy function to use
  69016. */
  69017. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  69018. }
  69019. }
  69020. declare module BABYLON {
  69021. /**
  69022. * @ignore
  69023. * Application error to support additional information when loading a file
  69024. */
  69025. export abstract class BaseError extends Error {
  69026. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  69027. }
  69028. }
  69029. declare module BABYLON {
  69030. /** @ignore */
  69031. export class LoadFileError extends BaseError {
  69032. request?: WebRequest;
  69033. file?: File;
  69034. /**
  69035. * Creates a new LoadFileError
  69036. * @param message defines the message of the error
  69037. * @param request defines the optional web request
  69038. * @param file defines the optional file
  69039. */
  69040. constructor(message: string, object?: WebRequest | File);
  69041. }
  69042. /** @ignore */
  69043. export class RequestFileError extends BaseError {
  69044. request: WebRequest;
  69045. /**
  69046. * Creates a new LoadFileError
  69047. * @param message defines the message of the error
  69048. * @param request defines the optional web request
  69049. */
  69050. constructor(message: string, request: WebRequest);
  69051. }
  69052. /** @ignore */
  69053. export class ReadFileError extends BaseError {
  69054. file: File;
  69055. /**
  69056. * Creates a new ReadFileError
  69057. * @param message defines the message of the error
  69058. * @param file defines the optional file
  69059. */
  69060. constructor(message: string, file: File);
  69061. }
  69062. /**
  69063. * @hidden
  69064. */
  69065. export class FileTools {
  69066. /**
  69067. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  69068. */
  69069. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  69070. /**
  69071. * Gets or sets the base URL to use to load assets
  69072. */
  69073. static BaseUrl: string;
  69074. /**
  69075. * Default behaviour for cors in the application.
  69076. * It can be a string if the expected behavior is identical in the entire app.
  69077. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  69078. */
  69079. static CorsBehavior: string | ((url: string | string[]) => string);
  69080. /**
  69081. * Gets or sets a function used to pre-process url before using them to load assets
  69082. */
  69083. static PreprocessUrl: (url: string) => string;
  69084. /**
  69085. * Removes unwanted characters from an url
  69086. * @param url defines the url to clean
  69087. * @returns the cleaned url
  69088. */
  69089. private static _CleanUrl;
  69090. /**
  69091. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  69092. * @param url define the url we are trying
  69093. * @param element define the dom element where to configure the cors policy
  69094. */
  69095. static SetCorsBehavior(url: string | string[], element: {
  69096. crossOrigin: string | null;
  69097. }): void;
  69098. /**
  69099. * Loads an image as an HTMLImageElement.
  69100. * @param input url string, ArrayBuffer, or Blob to load
  69101. * @param onLoad callback called when the image successfully loads
  69102. * @param onError callback called when the image fails to load
  69103. * @param offlineProvider offline provider for caching
  69104. * @param mimeType optional mime type
  69105. * @returns the HTMLImageElement of the loaded image
  69106. */
  69107. 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>;
  69108. /**
  69109. * Reads a file from a File object
  69110. * @param file defines the file to load
  69111. * @param onSuccess defines the callback to call when data is loaded
  69112. * @param onProgress defines the callback to call during loading process
  69113. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  69114. * @param onError defines the callback to call when an error occurs
  69115. * @returns a file request object
  69116. */
  69117. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  69118. /**
  69119. * Loads a file from a url
  69120. * @param url url to load
  69121. * @param onSuccess callback called when the file successfully loads
  69122. * @param onProgress callback called while file is loading (if the server supports this mode)
  69123. * @param offlineProvider defines the offline provider for caching
  69124. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  69125. * @param onError callback called when the file fails to load
  69126. * @returns a file request object
  69127. */
  69128. 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;
  69129. /**
  69130. * Loads a file
  69131. * @param url url to load
  69132. * @param onSuccess callback called when the file successfully loads
  69133. * @param onProgress callback called while file is loading (if the server supports this mode)
  69134. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  69135. * @param onError callback called when the file fails to load
  69136. * @param onOpened callback called when the web request is opened
  69137. * @returns a file request object
  69138. */
  69139. 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;
  69140. /**
  69141. * Checks if the loaded document was accessed via `file:`-Protocol.
  69142. * @returns boolean
  69143. */
  69144. static IsFileURL(): boolean;
  69145. }
  69146. }
  69147. declare module BABYLON {
  69148. /** @hidden */
  69149. export class ShaderProcessor {
  69150. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  69151. private static _ProcessPrecision;
  69152. private static _ExtractOperation;
  69153. private static _BuildSubExpression;
  69154. private static _BuildExpression;
  69155. private static _MoveCursorWithinIf;
  69156. private static _MoveCursor;
  69157. private static _EvaluatePreProcessors;
  69158. private static _PreparePreProcessors;
  69159. private static _ProcessShaderConversion;
  69160. private static _ProcessIncludes;
  69161. }
  69162. }
  69163. declare module BABYLON {
  69164. /**
  69165. * @hidden
  69166. */
  69167. export interface IColor4Like {
  69168. r: float;
  69169. g: float;
  69170. b: float;
  69171. a: float;
  69172. }
  69173. /**
  69174. * @hidden
  69175. */
  69176. export interface IColor3Like {
  69177. r: float;
  69178. g: float;
  69179. b: float;
  69180. }
  69181. /**
  69182. * @hidden
  69183. */
  69184. export interface IVector4Like {
  69185. x: float;
  69186. y: float;
  69187. z: float;
  69188. w: float;
  69189. }
  69190. /**
  69191. * @hidden
  69192. */
  69193. export interface IVector3Like {
  69194. x: float;
  69195. y: float;
  69196. z: float;
  69197. }
  69198. /**
  69199. * @hidden
  69200. */
  69201. export interface IVector2Like {
  69202. x: float;
  69203. y: float;
  69204. }
  69205. /**
  69206. * @hidden
  69207. */
  69208. export interface IMatrixLike {
  69209. toArray(): DeepImmutable<Float32Array>;
  69210. updateFlag: int;
  69211. }
  69212. /**
  69213. * @hidden
  69214. */
  69215. export interface IViewportLike {
  69216. x: float;
  69217. y: float;
  69218. width: float;
  69219. height: float;
  69220. }
  69221. /**
  69222. * @hidden
  69223. */
  69224. export interface IPlaneLike {
  69225. normal: IVector3Like;
  69226. d: float;
  69227. normalize(): void;
  69228. }
  69229. }
  69230. declare module BABYLON {
  69231. /**
  69232. * Interface used to define common properties for effect fallbacks
  69233. */
  69234. export interface IEffectFallbacks {
  69235. /**
  69236. * Removes the defines that should be removed when falling back.
  69237. * @param currentDefines defines the current define statements for the shader.
  69238. * @param effect defines the current effect we try to compile
  69239. * @returns The resulting defines with defines of the current rank removed.
  69240. */
  69241. reduce(currentDefines: string, effect: Effect): string;
  69242. /**
  69243. * Removes the fallback from the bound mesh.
  69244. */
  69245. unBindMesh(): void;
  69246. /**
  69247. * Checks to see if more fallbacks are still availible.
  69248. */
  69249. hasMoreFallbacks: boolean;
  69250. }
  69251. }
  69252. declare module BABYLON {
  69253. /**
  69254. * Class used to evalaute queries containing `and` and `or` operators
  69255. */
  69256. export class AndOrNotEvaluator {
  69257. /**
  69258. * Evaluate a query
  69259. * @param query defines the query to evaluate
  69260. * @param evaluateCallback defines the callback used to filter result
  69261. * @returns true if the query matches
  69262. */
  69263. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  69264. private static _HandleParenthesisContent;
  69265. private static _SimplifyNegation;
  69266. }
  69267. }
  69268. declare module BABYLON {
  69269. /**
  69270. * Class used to store custom tags
  69271. */
  69272. export class Tags {
  69273. /**
  69274. * Adds support for tags on the given object
  69275. * @param obj defines the object to use
  69276. */
  69277. static EnableFor(obj: any): void;
  69278. /**
  69279. * Removes tags support
  69280. * @param obj defines the object to use
  69281. */
  69282. static DisableFor(obj: any): void;
  69283. /**
  69284. * Gets a boolean indicating if the given object has tags
  69285. * @param obj defines the object to use
  69286. * @returns a boolean
  69287. */
  69288. static HasTags(obj: any): boolean;
  69289. /**
  69290. * Gets the tags available on a given object
  69291. * @param obj defines the object to use
  69292. * @param asString defines if the tags must be returned as a string instead of an array of strings
  69293. * @returns the tags
  69294. */
  69295. static GetTags(obj: any, asString?: boolean): any;
  69296. /**
  69297. * Adds tags to an object
  69298. * @param obj defines the object to use
  69299. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  69300. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  69301. */
  69302. static AddTagsTo(obj: any, tagsString: string): void;
  69303. /**
  69304. * @hidden
  69305. */
  69306. static _AddTagTo(obj: any, tag: string): void;
  69307. /**
  69308. * Removes specific tags from a specific object
  69309. * @param obj defines the object to use
  69310. * @param tagsString defines the tags to remove
  69311. */
  69312. static RemoveTagsFrom(obj: any, tagsString: string): void;
  69313. /**
  69314. * @hidden
  69315. */
  69316. static _RemoveTagFrom(obj: any, tag: string): void;
  69317. /**
  69318. * Defines if tags hosted on an object match a given query
  69319. * @param obj defines the object to use
  69320. * @param tagsQuery defines the tag query
  69321. * @returns a boolean
  69322. */
  69323. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  69324. }
  69325. }
  69326. declare module BABYLON {
  69327. /**
  69328. * Scalar computation library
  69329. */
  69330. export class Scalar {
  69331. /**
  69332. * Two pi constants convenient for computation.
  69333. */
  69334. static TwoPi: number;
  69335. /**
  69336. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  69337. * @param a number
  69338. * @param b number
  69339. * @param epsilon (default = 1.401298E-45)
  69340. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  69341. */
  69342. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  69343. /**
  69344. * Returns a string : the upper case translation of the number i to hexadecimal.
  69345. * @param i number
  69346. * @returns the upper case translation of the number i to hexadecimal.
  69347. */
  69348. static ToHex(i: number): string;
  69349. /**
  69350. * Returns -1 if value is negative and +1 is value is positive.
  69351. * @param value the value
  69352. * @returns the value itself if it's equal to zero.
  69353. */
  69354. static Sign(value: number): number;
  69355. /**
  69356. * Returns the value itself if it's between min and max.
  69357. * Returns min if the value is lower than min.
  69358. * Returns max if the value is greater than max.
  69359. * @param value the value to clmap
  69360. * @param min the min value to clamp to (default: 0)
  69361. * @param max the max value to clamp to (default: 1)
  69362. * @returns the clamped value
  69363. */
  69364. static Clamp(value: number, min?: number, max?: number): number;
  69365. /**
  69366. * the log2 of value.
  69367. * @param value the value to compute log2 of
  69368. * @returns the log2 of value.
  69369. */
  69370. static Log2(value: number): number;
  69371. /**
  69372. * Loops the value, so that it is never larger than length and never smaller than 0.
  69373. *
  69374. * This is similar to the modulo operator but it works with floating point numbers.
  69375. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  69376. * With t = 5 and length = 2.5, the result would be 0.0.
  69377. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  69378. * @param value the value
  69379. * @param length the length
  69380. * @returns the looped value
  69381. */
  69382. static Repeat(value: number, length: number): number;
  69383. /**
  69384. * Normalize the value between 0.0 and 1.0 using min and max values
  69385. * @param value value to normalize
  69386. * @param min max to normalize between
  69387. * @param max min to normalize between
  69388. * @returns the normalized value
  69389. */
  69390. static Normalize(value: number, min: number, max: number): number;
  69391. /**
  69392. * Denormalize the value from 0.0 and 1.0 using min and max values
  69393. * @param normalized value to denormalize
  69394. * @param min max to denormalize between
  69395. * @param max min to denormalize between
  69396. * @returns the denormalized value
  69397. */
  69398. static Denormalize(normalized: number, min: number, max: number): number;
  69399. /**
  69400. * Calculates the shortest difference between two given angles given in degrees.
  69401. * @param current current angle in degrees
  69402. * @param target target angle in degrees
  69403. * @returns the delta
  69404. */
  69405. static DeltaAngle(current: number, target: number): number;
  69406. /**
  69407. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  69408. * @param tx value
  69409. * @param length length
  69410. * @returns The returned value will move back and forth between 0 and length
  69411. */
  69412. static PingPong(tx: number, length: number): number;
  69413. /**
  69414. * Interpolates between min and max with smoothing at the limits.
  69415. *
  69416. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  69417. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  69418. * @param from from
  69419. * @param to to
  69420. * @param tx value
  69421. * @returns the smooth stepped value
  69422. */
  69423. static SmoothStep(from: number, to: number, tx: number): number;
  69424. /**
  69425. * Moves a value current towards target.
  69426. *
  69427. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  69428. * Negative values of maxDelta pushes the value away from target.
  69429. * @param current current value
  69430. * @param target target value
  69431. * @param maxDelta max distance to move
  69432. * @returns resulting value
  69433. */
  69434. static MoveTowards(current: number, target: number, maxDelta: number): number;
  69435. /**
  69436. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  69437. *
  69438. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  69439. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  69440. * @param current current value
  69441. * @param target target value
  69442. * @param maxDelta max distance to move
  69443. * @returns resulting angle
  69444. */
  69445. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  69446. /**
  69447. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  69448. * @param start start value
  69449. * @param end target value
  69450. * @param amount amount to lerp between
  69451. * @returns the lerped value
  69452. */
  69453. static Lerp(start: number, end: number, amount: number): number;
  69454. /**
  69455. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  69456. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  69457. * @param start start value
  69458. * @param end target value
  69459. * @param amount amount to lerp between
  69460. * @returns the lerped value
  69461. */
  69462. static LerpAngle(start: number, end: number, amount: number): number;
  69463. /**
  69464. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  69465. * @param a start value
  69466. * @param b target value
  69467. * @param value value between a and b
  69468. * @returns the inverseLerp value
  69469. */
  69470. static InverseLerp(a: number, b: number, value: number): number;
  69471. /**
  69472. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  69473. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  69474. * @param value1 spline value
  69475. * @param tangent1 spline value
  69476. * @param value2 spline value
  69477. * @param tangent2 spline value
  69478. * @param amount input value
  69479. * @returns hermite result
  69480. */
  69481. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  69482. /**
  69483. * Returns a random float number between and min and max values
  69484. * @param min min value of random
  69485. * @param max max value of random
  69486. * @returns random value
  69487. */
  69488. static RandomRange(min: number, max: number): number;
  69489. /**
  69490. * This function returns percentage of a number in a given range.
  69491. *
  69492. * RangeToPercent(40,20,60) will return 0.5 (50%)
  69493. * RangeToPercent(34,0,100) will return 0.34 (34%)
  69494. * @param number to convert to percentage
  69495. * @param min min range
  69496. * @param max max range
  69497. * @returns the percentage
  69498. */
  69499. static RangeToPercent(number: number, min: number, max: number): number;
  69500. /**
  69501. * This function returns number that corresponds to the percentage in a given range.
  69502. *
  69503. * PercentToRange(0.34,0,100) will return 34.
  69504. * @param percent to convert to number
  69505. * @param min min range
  69506. * @param max max range
  69507. * @returns the number
  69508. */
  69509. static PercentToRange(percent: number, min: number, max: number): number;
  69510. /**
  69511. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  69512. * @param angle The angle to normalize in radian.
  69513. * @return The converted angle.
  69514. */
  69515. static NormalizeRadians(angle: number): number;
  69516. }
  69517. }
  69518. declare module BABYLON {
  69519. /**
  69520. * Constant used to convert a value to gamma space
  69521. * @ignorenaming
  69522. */
  69523. export const ToGammaSpace: number;
  69524. /**
  69525. * Constant used to convert a value to linear space
  69526. * @ignorenaming
  69527. */
  69528. export const ToLinearSpace = 2.2;
  69529. /**
  69530. * Constant used to define the minimal number value in Babylon.js
  69531. * @ignorenaming
  69532. */
  69533. let Epsilon: number;
  69534. }
  69535. declare module BABYLON {
  69536. /**
  69537. * Class used to represent a viewport on screen
  69538. */
  69539. export class Viewport {
  69540. /** viewport left coordinate */
  69541. x: number;
  69542. /** viewport top coordinate */
  69543. y: number;
  69544. /**viewport width */
  69545. width: number;
  69546. /** viewport height */
  69547. height: number;
  69548. /**
  69549. * Creates a Viewport object located at (x, y) and sized (width, height)
  69550. * @param x defines viewport left coordinate
  69551. * @param y defines viewport top coordinate
  69552. * @param width defines the viewport width
  69553. * @param height defines the viewport height
  69554. */
  69555. constructor(
  69556. /** viewport left coordinate */
  69557. x: number,
  69558. /** viewport top coordinate */
  69559. y: number,
  69560. /**viewport width */
  69561. width: number,
  69562. /** viewport height */
  69563. height: number);
  69564. /**
  69565. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  69566. * @param renderWidth defines the rendering width
  69567. * @param renderHeight defines the rendering height
  69568. * @returns a new Viewport
  69569. */
  69570. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  69571. /**
  69572. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  69573. * @param renderWidth defines the rendering width
  69574. * @param renderHeight defines the rendering height
  69575. * @param ref defines the target viewport
  69576. * @returns the current viewport
  69577. */
  69578. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  69579. /**
  69580. * Returns a new Viewport copied from the current one
  69581. * @returns a new Viewport
  69582. */
  69583. clone(): Viewport;
  69584. }
  69585. }
  69586. declare module BABYLON {
  69587. /**
  69588. * Class containing a set of static utilities functions for arrays.
  69589. */
  69590. export class ArrayTools {
  69591. /**
  69592. * Returns an array of the given size filled with element built from the given constructor and the paramters
  69593. * @param size the number of element to construct and put in the array
  69594. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  69595. * @returns a new array filled with new objects
  69596. */
  69597. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  69598. }
  69599. }
  69600. declare module BABYLON {
  69601. /**
  69602. * Class representing a vector containing 2 coordinates
  69603. */
  69604. export class Vector2 {
  69605. /** defines the first coordinate */
  69606. x: number;
  69607. /** defines the second coordinate */
  69608. y: number;
  69609. /**
  69610. * Creates a new Vector2 from the given x and y coordinates
  69611. * @param x defines the first coordinate
  69612. * @param y defines the second coordinate
  69613. */
  69614. constructor(
  69615. /** defines the first coordinate */
  69616. x?: number,
  69617. /** defines the second coordinate */
  69618. y?: number);
  69619. /**
  69620. * Gets a string with the Vector2 coordinates
  69621. * @returns a string with the Vector2 coordinates
  69622. */
  69623. toString(): string;
  69624. /**
  69625. * Gets class name
  69626. * @returns the string "Vector2"
  69627. */
  69628. getClassName(): string;
  69629. /**
  69630. * Gets current vector hash code
  69631. * @returns the Vector2 hash code as a number
  69632. */
  69633. getHashCode(): number;
  69634. /**
  69635. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  69636. * @param array defines the source array
  69637. * @param index defines the offset in source array
  69638. * @returns the current Vector2
  69639. */
  69640. toArray(array: FloatArray, index?: number): Vector2;
  69641. /**
  69642. * Copy the current vector to an array
  69643. * @returns a new array with 2 elements: the Vector2 coordinates.
  69644. */
  69645. asArray(): number[];
  69646. /**
  69647. * Sets the Vector2 coordinates with the given Vector2 coordinates
  69648. * @param source defines the source Vector2
  69649. * @returns the current updated Vector2
  69650. */
  69651. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  69652. /**
  69653. * Sets the Vector2 coordinates with the given floats
  69654. * @param x defines the first coordinate
  69655. * @param y defines the second coordinate
  69656. * @returns the current updated Vector2
  69657. */
  69658. copyFromFloats(x: number, y: number): Vector2;
  69659. /**
  69660. * Sets the Vector2 coordinates with the given floats
  69661. * @param x defines the first coordinate
  69662. * @param y defines the second coordinate
  69663. * @returns the current updated Vector2
  69664. */
  69665. set(x: number, y: number): Vector2;
  69666. /**
  69667. * Add another vector with the current one
  69668. * @param otherVector defines the other vector
  69669. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  69670. */
  69671. add(otherVector: DeepImmutable<Vector2>): Vector2;
  69672. /**
  69673. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  69674. * @param otherVector defines the other vector
  69675. * @param result defines the target vector
  69676. * @returns the unmodified current Vector2
  69677. */
  69678. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  69679. /**
  69680. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  69681. * @param otherVector defines the other vector
  69682. * @returns the current updated Vector2
  69683. */
  69684. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  69685. /**
  69686. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  69687. * @param otherVector defines the other vector
  69688. * @returns a new Vector2
  69689. */
  69690. addVector3(otherVector: Vector3): Vector2;
  69691. /**
  69692. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  69693. * @param otherVector defines the other vector
  69694. * @returns a new Vector2
  69695. */
  69696. subtract(otherVector: Vector2): Vector2;
  69697. /**
  69698. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  69699. * @param otherVector defines the other vector
  69700. * @param result defines the target vector
  69701. * @returns the unmodified current Vector2
  69702. */
  69703. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  69704. /**
  69705. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  69706. * @param otherVector defines the other vector
  69707. * @returns the current updated Vector2
  69708. */
  69709. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  69710. /**
  69711. * Multiplies in place the current Vector2 coordinates by the given ones
  69712. * @param otherVector defines the other vector
  69713. * @returns the current updated Vector2
  69714. */
  69715. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  69716. /**
  69717. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  69718. * @param otherVector defines the other vector
  69719. * @returns a new Vector2
  69720. */
  69721. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  69722. /**
  69723. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  69724. * @param otherVector defines the other vector
  69725. * @param result defines the target vector
  69726. * @returns the unmodified current Vector2
  69727. */
  69728. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  69729. /**
  69730. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  69731. * @param x defines the first coordinate
  69732. * @param y defines the second coordinate
  69733. * @returns a new Vector2
  69734. */
  69735. multiplyByFloats(x: number, y: number): Vector2;
  69736. /**
  69737. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  69738. * @param otherVector defines the other vector
  69739. * @returns a new Vector2
  69740. */
  69741. divide(otherVector: Vector2): Vector2;
  69742. /**
  69743. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  69744. * @param otherVector defines the other vector
  69745. * @param result defines the target vector
  69746. * @returns the unmodified current Vector2
  69747. */
  69748. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  69749. /**
  69750. * Divides the current Vector2 coordinates by the given ones
  69751. * @param otherVector defines the other vector
  69752. * @returns the current updated Vector2
  69753. */
  69754. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  69755. /**
  69756. * Gets a new Vector2 with current Vector2 negated coordinates
  69757. * @returns a new Vector2
  69758. */
  69759. negate(): Vector2;
  69760. /**
  69761. * Multiply the Vector2 coordinates by scale
  69762. * @param scale defines the scaling factor
  69763. * @returns the current updated Vector2
  69764. */
  69765. scaleInPlace(scale: number): Vector2;
  69766. /**
  69767. * Returns a new Vector2 scaled by "scale" from the current Vector2
  69768. * @param scale defines the scaling factor
  69769. * @returns a new Vector2
  69770. */
  69771. scale(scale: number): Vector2;
  69772. /**
  69773. * Scale the current Vector2 values by a factor to a given Vector2
  69774. * @param scale defines the scale factor
  69775. * @param result defines the Vector2 object where to store the result
  69776. * @returns the unmodified current Vector2
  69777. */
  69778. scaleToRef(scale: number, result: Vector2): Vector2;
  69779. /**
  69780. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  69781. * @param scale defines the scale factor
  69782. * @param result defines the Vector2 object where to store the result
  69783. * @returns the unmodified current Vector2
  69784. */
  69785. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  69786. /**
  69787. * Gets a boolean if two vectors are equals
  69788. * @param otherVector defines the other vector
  69789. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  69790. */
  69791. equals(otherVector: DeepImmutable<Vector2>): boolean;
  69792. /**
  69793. * Gets a boolean if two vectors are equals (using an epsilon value)
  69794. * @param otherVector defines the other vector
  69795. * @param epsilon defines the minimal distance to consider equality
  69796. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  69797. */
  69798. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  69799. /**
  69800. * Gets a new Vector2 from current Vector2 floored values
  69801. * @returns a new Vector2
  69802. */
  69803. floor(): Vector2;
  69804. /**
  69805. * Gets a new Vector2 from current Vector2 floored values
  69806. * @returns a new Vector2
  69807. */
  69808. fract(): Vector2;
  69809. /**
  69810. * Gets the length of the vector
  69811. * @returns the vector length (float)
  69812. */
  69813. length(): number;
  69814. /**
  69815. * Gets the vector squared length
  69816. * @returns the vector squared length (float)
  69817. */
  69818. lengthSquared(): number;
  69819. /**
  69820. * Normalize the vector
  69821. * @returns the current updated Vector2
  69822. */
  69823. normalize(): Vector2;
  69824. /**
  69825. * Gets a new Vector2 copied from the Vector2
  69826. * @returns a new Vector2
  69827. */
  69828. clone(): Vector2;
  69829. /**
  69830. * Gets a new Vector2(0, 0)
  69831. * @returns a new Vector2
  69832. */
  69833. static Zero(): Vector2;
  69834. /**
  69835. * Gets a new Vector2(1, 1)
  69836. * @returns a new Vector2
  69837. */
  69838. static One(): Vector2;
  69839. /**
  69840. * Gets a new Vector2 set from the given index element of the given array
  69841. * @param array defines the data source
  69842. * @param offset defines the offset in the data source
  69843. * @returns a new Vector2
  69844. */
  69845. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  69846. /**
  69847. * Sets "result" from the given index element of the given array
  69848. * @param array defines the data source
  69849. * @param offset defines the offset in the data source
  69850. * @param result defines the target vector
  69851. */
  69852. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  69853. /**
  69854. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  69855. * @param value1 defines 1st point of control
  69856. * @param value2 defines 2nd point of control
  69857. * @param value3 defines 3rd point of control
  69858. * @param value4 defines 4th point of control
  69859. * @param amount defines the interpolation factor
  69860. * @returns a new Vector2
  69861. */
  69862. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  69863. /**
  69864. * 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".
  69865. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  69866. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  69867. * @param value defines the value to clamp
  69868. * @param min defines the lower limit
  69869. * @param max defines the upper limit
  69870. * @returns a new Vector2
  69871. */
  69872. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  69873. /**
  69874. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  69875. * @param value1 defines the 1st control point
  69876. * @param tangent1 defines the outgoing tangent
  69877. * @param value2 defines the 2nd control point
  69878. * @param tangent2 defines the incoming tangent
  69879. * @param amount defines the interpolation factor
  69880. * @returns a new Vector2
  69881. */
  69882. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  69883. /**
  69884. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  69885. * @param start defines the start vector
  69886. * @param end defines the end vector
  69887. * @param amount defines the interpolation factor
  69888. * @returns a new Vector2
  69889. */
  69890. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  69891. /**
  69892. * Gets the dot product of the vector "left" and the vector "right"
  69893. * @param left defines first vector
  69894. * @param right defines second vector
  69895. * @returns the dot product (float)
  69896. */
  69897. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  69898. /**
  69899. * Returns a new Vector2 equal to the normalized given vector
  69900. * @param vector defines the vector to normalize
  69901. * @returns a new Vector2
  69902. */
  69903. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  69904. /**
  69905. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  69906. * @param left defines 1st vector
  69907. * @param right defines 2nd vector
  69908. * @returns a new Vector2
  69909. */
  69910. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  69911. /**
  69912. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  69913. * @param left defines 1st vector
  69914. * @param right defines 2nd vector
  69915. * @returns a new Vector2
  69916. */
  69917. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  69918. /**
  69919. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  69920. * @param vector defines the vector to transform
  69921. * @param transformation defines the matrix to apply
  69922. * @returns a new Vector2
  69923. */
  69924. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  69925. /**
  69926. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  69927. * @param vector defines the vector to transform
  69928. * @param transformation defines the matrix to apply
  69929. * @param result defines the target vector
  69930. */
  69931. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  69932. /**
  69933. * Determines if a given vector is included in a triangle
  69934. * @param p defines the vector to test
  69935. * @param p0 defines 1st triangle point
  69936. * @param p1 defines 2nd triangle point
  69937. * @param p2 defines 3rd triangle point
  69938. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  69939. */
  69940. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  69941. /**
  69942. * Gets the distance between the vectors "value1" and "value2"
  69943. * @param value1 defines first vector
  69944. * @param value2 defines second vector
  69945. * @returns the distance between vectors
  69946. */
  69947. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  69948. /**
  69949. * Returns the squared distance between the vectors "value1" and "value2"
  69950. * @param value1 defines first vector
  69951. * @param value2 defines second vector
  69952. * @returns the squared distance between vectors
  69953. */
  69954. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  69955. /**
  69956. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  69957. * @param value1 defines first vector
  69958. * @param value2 defines second vector
  69959. * @returns a new Vector2
  69960. */
  69961. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  69962. /**
  69963. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  69964. * @param p defines the middle point
  69965. * @param segA defines one point of the segment
  69966. * @param segB defines the other point of the segment
  69967. * @returns the shortest distance
  69968. */
  69969. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  69970. }
  69971. /**
  69972. * Classed used to store (x,y,z) vector representation
  69973. * A Vector3 is the main object used in 3D geometry
  69974. * It can represent etiher the coordinates of a point the space, either a direction
  69975. * Reminder: js uses a left handed forward facing system
  69976. */
  69977. export class Vector3 {
  69978. /**
  69979. * Defines the first coordinates (on X axis)
  69980. */
  69981. x: number;
  69982. /**
  69983. * Defines the second coordinates (on Y axis)
  69984. */
  69985. y: number;
  69986. /**
  69987. * Defines the third coordinates (on Z axis)
  69988. */
  69989. z: number;
  69990. private static _UpReadOnly;
  69991. private static _ZeroReadOnly;
  69992. /**
  69993. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  69994. * @param x defines the first coordinates (on X axis)
  69995. * @param y defines the second coordinates (on Y axis)
  69996. * @param z defines the third coordinates (on Z axis)
  69997. */
  69998. constructor(
  69999. /**
  70000. * Defines the first coordinates (on X axis)
  70001. */
  70002. x?: number,
  70003. /**
  70004. * Defines the second coordinates (on Y axis)
  70005. */
  70006. y?: number,
  70007. /**
  70008. * Defines the third coordinates (on Z axis)
  70009. */
  70010. z?: number);
  70011. /**
  70012. * Creates a string representation of the Vector3
  70013. * @returns a string with the Vector3 coordinates.
  70014. */
  70015. toString(): string;
  70016. /**
  70017. * Gets the class name
  70018. * @returns the string "Vector3"
  70019. */
  70020. getClassName(): string;
  70021. /**
  70022. * Creates the Vector3 hash code
  70023. * @returns a number which tends to be unique between Vector3 instances
  70024. */
  70025. getHashCode(): number;
  70026. /**
  70027. * Creates an array containing three elements : the coordinates of the Vector3
  70028. * @returns a new array of numbers
  70029. */
  70030. asArray(): number[];
  70031. /**
  70032. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  70033. * @param array defines the destination array
  70034. * @param index defines the offset in the destination array
  70035. * @returns the current Vector3
  70036. */
  70037. toArray(array: FloatArray, index?: number): Vector3;
  70038. /**
  70039. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  70040. * @returns a new Quaternion object, computed from the Vector3 coordinates
  70041. */
  70042. toQuaternion(): Quaternion;
  70043. /**
  70044. * Adds the given vector to the current Vector3
  70045. * @param otherVector defines the second operand
  70046. * @returns the current updated Vector3
  70047. */
  70048. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70049. /**
  70050. * Adds the given coordinates to the current Vector3
  70051. * @param x defines the x coordinate of the operand
  70052. * @param y defines the y coordinate of the operand
  70053. * @param z defines the z coordinate of the operand
  70054. * @returns the current updated Vector3
  70055. */
  70056. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70057. /**
  70058. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  70059. * @param otherVector defines the second operand
  70060. * @returns the resulting Vector3
  70061. */
  70062. add(otherVector: DeepImmutable<Vector3>): Vector3;
  70063. /**
  70064. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  70065. * @param otherVector defines the second operand
  70066. * @param result defines the Vector3 object where to store the result
  70067. * @returns the current Vector3
  70068. */
  70069. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70070. /**
  70071. * Subtract the given vector from the current Vector3
  70072. * @param otherVector defines the second operand
  70073. * @returns the current updated Vector3
  70074. */
  70075. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70076. /**
  70077. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  70078. * @param otherVector defines the second operand
  70079. * @returns the resulting Vector3
  70080. */
  70081. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  70082. /**
  70083. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  70084. * @param otherVector defines the second operand
  70085. * @param result defines the Vector3 object where to store the result
  70086. * @returns the current Vector3
  70087. */
  70088. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70089. /**
  70090. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  70091. * @param x defines the x coordinate of the operand
  70092. * @param y defines the y coordinate of the operand
  70093. * @param z defines the z coordinate of the operand
  70094. * @returns the resulting Vector3
  70095. */
  70096. subtractFromFloats(x: number, y: number, z: number): Vector3;
  70097. /**
  70098. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  70099. * @param x defines the x coordinate of the operand
  70100. * @param y defines the y coordinate of the operand
  70101. * @param z defines the z coordinate of the operand
  70102. * @param result defines the Vector3 object where to store the result
  70103. * @returns the current Vector3
  70104. */
  70105. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  70106. /**
  70107. * Gets a new Vector3 set with the current Vector3 negated coordinates
  70108. * @returns a new Vector3
  70109. */
  70110. negate(): Vector3;
  70111. /**
  70112. * Multiplies the Vector3 coordinates by the float "scale"
  70113. * @param scale defines the multiplier factor
  70114. * @returns the current updated Vector3
  70115. */
  70116. scaleInPlace(scale: number): Vector3;
  70117. /**
  70118. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  70119. * @param scale defines the multiplier factor
  70120. * @returns a new Vector3
  70121. */
  70122. scale(scale: number): Vector3;
  70123. /**
  70124. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  70125. * @param scale defines the multiplier factor
  70126. * @param result defines the Vector3 object where to store the result
  70127. * @returns the current Vector3
  70128. */
  70129. scaleToRef(scale: number, result: Vector3): Vector3;
  70130. /**
  70131. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  70132. * @param scale defines the scale factor
  70133. * @param result defines the Vector3 object where to store the result
  70134. * @returns the unmodified current Vector3
  70135. */
  70136. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  70137. /**
  70138. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  70139. * @param otherVector defines the second operand
  70140. * @returns true if both vectors are equals
  70141. */
  70142. equals(otherVector: DeepImmutable<Vector3>): boolean;
  70143. /**
  70144. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  70145. * @param otherVector defines the second operand
  70146. * @param epsilon defines the minimal distance to define values as equals
  70147. * @returns true if both vectors are distant less than epsilon
  70148. */
  70149. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  70150. /**
  70151. * Returns true if the current Vector3 coordinates equals the given floats
  70152. * @param x defines the x coordinate of the operand
  70153. * @param y defines the y coordinate of the operand
  70154. * @param z defines the z coordinate of the operand
  70155. * @returns true if both vectors are equals
  70156. */
  70157. equalsToFloats(x: number, y: number, z: number): boolean;
  70158. /**
  70159. * Multiplies the current Vector3 coordinates by the given ones
  70160. * @param otherVector defines the second operand
  70161. * @returns the current updated Vector3
  70162. */
  70163. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70164. /**
  70165. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  70166. * @param otherVector defines the second operand
  70167. * @returns the new Vector3
  70168. */
  70169. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  70170. /**
  70171. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  70172. * @param otherVector defines the second operand
  70173. * @param result defines the Vector3 object where to store the result
  70174. * @returns the current Vector3
  70175. */
  70176. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70177. /**
  70178. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  70179. * @param x defines the x coordinate of the operand
  70180. * @param y defines the y coordinate of the operand
  70181. * @param z defines the z coordinate of the operand
  70182. * @returns the new Vector3
  70183. */
  70184. multiplyByFloats(x: number, y: number, z: number): Vector3;
  70185. /**
  70186. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  70187. * @param otherVector defines the second operand
  70188. * @returns the new Vector3
  70189. */
  70190. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  70191. /**
  70192. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  70193. * @param otherVector defines the second operand
  70194. * @param result defines the Vector3 object where to store the result
  70195. * @returns the current Vector3
  70196. */
  70197. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70198. /**
  70199. * Divides the current Vector3 coordinates by the given ones.
  70200. * @param otherVector defines the second operand
  70201. * @returns the current updated Vector3
  70202. */
  70203. divideInPlace(otherVector: Vector3): Vector3;
  70204. /**
  70205. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  70206. * @param other defines the second operand
  70207. * @returns the current updated Vector3
  70208. */
  70209. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  70210. /**
  70211. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  70212. * @param other defines the second operand
  70213. * @returns the current updated Vector3
  70214. */
  70215. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  70216. /**
  70217. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  70218. * @param x defines the x coordinate of the operand
  70219. * @param y defines the y coordinate of the operand
  70220. * @param z defines the z coordinate of the operand
  70221. * @returns the current updated Vector3
  70222. */
  70223. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70224. /**
  70225. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  70226. * @param x defines the x coordinate of the operand
  70227. * @param y defines the y coordinate of the operand
  70228. * @param z defines the z coordinate of the operand
  70229. * @returns the current updated Vector3
  70230. */
  70231. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70232. /**
  70233. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  70234. * Check if is non uniform within a certain amount of decimal places to account for this
  70235. * @param epsilon the amount the values can differ
  70236. * @returns if the the vector is non uniform to a certain number of decimal places
  70237. */
  70238. isNonUniformWithinEpsilon(epsilon: number): boolean;
  70239. /**
  70240. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  70241. */
  70242. readonly isNonUniform: boolean;
  70243. /**
  70244. * Gets a new Vector3 from current Vector3 floored values
  70245. * @returns a new Vector3
  70246. */
  70247. floor(): Vector3;
  70248. /**
  70249. * Gets a new Vector3 from current Vector3 floored values
  70250. * @returns a new Vector3
  70251. */
  70252. fract(): Vector3;
  70253. /**
  70254. * Gets the length of the Vector3
  70255. * @returns the length of the Vector3
  70256. */
  70257. length(): number;
  70258. /**
  70259. * Gets the squared length of the Vector3
  70260. * @returns squared length of the Vector3
  70261. */
  70262. lengthSquared(): number;
  70263. /**
  70264. * Normalize the current Vector3.
  70265. * Please note that this is an in place operation.
  70266. * @returns the current updated Vector3
  70267. */
  70268. normalize(): Vector3;
  70269. /**
  70270. * Reorders the x y z properties of the vector in place
  70271. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  70272. * @returns the current updated vector
  70273. */
  70274. reorderInPlace(order: string): this;
  70275. /**
  70276. * Rotates the vector around 0,0,0 by a quaternion
  70277. * @param quaternion the rotation quaternion
  70278. * @param result vector to store the result
  70279. * @returns the resulting vector
  70280. */
  70281. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  70282. /**
  70283. * Rotates a vector around a given point
  70284. * @param quaternion the rotation quaternion
  70285. * @param point the point to rotate around
  70286. * @param result vector to store the result
  70287. * @returns the resulting vector
  70288. */
  70289. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  70290. /**
  70291. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  70292. * The cross product is then orthogonal to both current and "other"
  70293. * @param other defines the right operand
  70294. * @returns the cross product
  70295. */
  70296. cross(other: Vector3): Vector3;
  70297. /**
  70298. * Normalize the current Vector3 with the given input length.
  70299. * Please note that this is an in place operation.
  70300. * @param len the length of the vector
  70301. * @returns the current updated Vector3
  70302. */
  70303. normalizeFromLength(len: number): Vector3;
  70304. /**
  70305. * Normalize the current Vector3 to a new vector
  70306. * @returns the new Vector3
  70307. */
  70308. normalizeToNew(): Vector3;
  70309. /**
  70310. * Normalize the current Vector3 to the reference
  70311. * @param reference define the Vector3 to update
  70312. * @returns the updated Vector3
  70313. */
  70314. normalizeToRef(reference: DeepImmutable<Vector3>): Vector3;
  70315. /**
  70316. * Creates a new Vector3 copied from the current Vector3
  70317. * @returns the new Vector3
  70318. */
  70319. clone(): Vector3;
  70320. /**
  70321. * Copies the given vector coordinates to the current Vector3 ones
  70322. * @param source defines the source Vector3
  70323. * @returns the current updated Vector3
  70324. */
  70325. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  70326. /**
  70327. * Copies the given floats to the current Vector3 coordinates
  70328. * @param x defines the x coordinate of the operand
  70329. * @param y defines the y coordinate of the operand
  70330. * @param z defines the z coordinate of the operand
  70331. * @returns the current updated Vector3
  70332. */
  70333. copyFromFloats(x: number, y: number, z: number): Vector3;
  70334. /**
  70335. * Copies the given floats to the current Vector3 coordinates
  70336. * @param x defines the x coordinate of the operand
  70337. * @param y defines the y coordinate of the operand
  70338. * @param z defines the z coordinate of the operand
  70339. * @returns the current updated Vector3
  70340. */
  70341. set(x: number, y: number, z: number): Vector3;
  70342. /**
  70343. * Copies the given float to the current Vector3 coordinates
  70344. * @param v defines the x, y and z coordinates of the operand
  70345. * @returns the current updated Vector3
  70346. */
  70347. setAll(v: number): Vector3;
  70348. /**
  70349. * Get the clip factor between two vectors
  70350. * @param vector0 defines the first operand
  70351. * @param vector1 defines the second operand
  70352. * @param axis defines the axis to use
  70353. * @param size defines the size along the axis
  70354. * @returns the clip factor
  70355. */
  70356. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  70357. /**
  70358. * Get angle between two vectors
  70359. * @param vector0 angle between vector0 and vector1
  70360. * @param vector1 angle between vector0 and vector1
  70361. * @param normal direction of the normal
  70362. * @return the angle between vector0 and vector1
  70363. */
  70364. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  70365. /**
  70366. * Returns a new Vector3 set from the index "offset" of the given array
  70367. * @param array defines the source array
  70368. * @param offset defines the offset in the source array
  70369. * @returns the new Vector3
  70370. */
  70371. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  70372. /**
  70373. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  70374. * This function is deprecated. Use FromArray instead
  70375. * @param array defines the source array
  70376. * @param offset defines the offset in the source array
  70377. * @returns the new Vector3
  70378. */
  70379. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  70380. /**
  70381. * Sets the given vector "result" with the element values from the index "offset" of the given array
  70382. * @param array defines the source array
  70383. * @param offset defines the offset in the source array
  70384. * @param result defines the Vector3 where to store the result
  70385. */
  70386. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  70387. /**
  70388. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  70389. * This function is deprecated. Use FromArrayToRef instead.
  70390. * @param array defines the source array
  70391. * @param offset defines the offset in the source array
  70392. * @param result defines the Vector3 where to store the result
  70393. */
  70394. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  70395. /**
  70396. * Sets the given vector "result" with the given floats.
  70397. * @param x defines the x coordinate of the source
  70398. * @param y defines the y coordinate of the source
  70399. * @param z defines the z coordinate of the source
  70400. * @param result defines the Vector3 where to store the result
  70401. */
  70402. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  70403. /**
  70404. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  70405. * @returns a new empty Vector3
  70406. */
  70407. static Zero(): Vector3;
  70408. /**
  70409. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  70410. * @returns a new unit Vector3
  70411. */
  70412. static One(): Vector3;
  70413. /**
  70414. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  70415. * @returns a new up Vector3
  70416. */
  70417. static Up(): Vector3;
  70418. /**
  70419. * Gets a up Vector3 that must not be updated
  70420. */
  70421. static readonly UpReadOnly: DeepImmutable<Vector3>;
  70422. /**
  70423. * Gets a zero Vector3 that must not be updated
  70424. */
  70425. static readonly ZeroReadOnly: DeepImmutable<Vector3>;
  70426. /**
  70427. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  70428. * @returns a new down Vector3
  70429. */
  70430. static Down(): Vector3;
  70431. /**
  70432. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  70433. * @returns a new forward Vector3
  70434. */
  70435. static Forward(): Vector3;
  70436. /**
  70437. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  70438. * @returns a new forward Vector3
  70439. */
  70440. static Backward(): Vector3;
  70441. /**
  70442. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  70443. * @returns a new right Vector3
  70444. */
  70445. static Right(): Vector3;
  70446. /**
  70447. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  70448. * @returns a new left Vector3
  70449. */
  70450. static Left(): Vector3;
  70451. /**
  70452. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  70453. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  70454. * @param vector defines the Vector3 to transform
  70455. * @param transformation defines the transformation matrix
  70456. * @returns the transformed Vector3
  70457. */
  70458. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  70459. /**
  70460. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  70461. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  70462. * @param vector defines the Vector3 to transform
  70463. * @param transformation defines the transformation matrix
  70464. * @param result defines the Vector3 where to store the result
  70465. */
  70466. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  70467. /**
  70468. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  70469. * This method computes tranformed coordinates only, not transformed direction vectors
  70470. * @param x define the x coordinate of the source vector
  70471. * @param y define the y coordinate of the source vector
  70472. * @param z define the z coordinate of the source vector
  70473. * @param transformation defines the transformation matrix
  70474. * @param result defines the Vector3 where to store the result
  70475. */
  70476. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  70477. /**
  70478. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  70479. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  70480. * @param vector defines the Vector3 to transform
  70481. * @param transformation defines the transformation matrix
  70482. * @returns the new Vector3
  70483. */
  70484. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  70485. /**
  70486. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  70487. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  70488. * @param vector defines the Vector3 to transform
  70489. * @param transformation defines the transformation matrix
  70490. * @param result defines the Vector3 where to store the result
  70491. */
  70492. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  70493. /**
  70494. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  70495. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  70496. * @param x define the x coordinate of the source vector
  70497. * @param y define the y coordinate of the source vector
  70498. * @param z define the z coordinate of the source vector
  70499. * @param transformation defines the transformation matrix
  70500. * @param result defines the Vector3 where to store the result
  70501. */
  70502. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  70503. /**
  70504. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  70505. * @param value1 defines the first control point
  70506. * @param value2 defines the second control point
  70507. * @param value3 defines the third control point
  70508. * @param value4 defines the fourth control point
  70509. * @param amount defines the amount on the spline to use
  70510. * @returns the new Vector3
  70511. */
  70512. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  70513. /**
  70514. * 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"
  70515. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  70516. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  70517. * @param value defines the current value
  70518. * @param min defines the lower range value
  70519. * @param max defines the upper range value
  70520. * @returns the new Vector3
  70521. */
  70522. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  70523. /**
  70524. * 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"
  70525. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  70526. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  70527. * @param value defines the current value
  70528. * @param min defines the lower range value
  70529. * @param max defines the upper range value
  70530. * @param result defines the Vector3 where to store the result
  70531. */
  70532. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  70533. /**
  70534. * Checks if a given vector is inside a specific range
  70535. * @param v defines the vector to test
  70536. * @param min defines the minimum range
  70537. * @param max defines the maximum range
  70538. */
  70539. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  70540. /**
  70541. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  70542. * @param value1 defines the first control point
  70543. * @param tangent1 defines the first tangent vector
  70544. * @param value2 defines the second control point
  70545. * @param tangent2 defines the second tangent vector
  70546. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  70547. * @returns the new Vector3
  70548. */
  70549. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  70550. /**
  70551. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  70552. * @param start defines the start value
  70553. * @param end defines the end value
  70554. * @param amount max defines amount between both (between 0 and 1)
  70555. * @returns the new Vector3
  70556. */
  70557. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  70558. /**
  70559. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  70560. * @param start defines the start value
  70561. * @param end defines the end value
  70562. * @param amount max defines amount between both (between 0 and 1)
  70563. * @param result defines the Vector3 where to store the result
  70564. */
  70565. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  70566. /**
  70567. * Returns the dot product (float) between the vectors "left" and "right"
  70568. * @param left defines the left operand
  70569. * @param right defines the right operand
  70570. * @returns the dot product
  70571. */
  70572. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  70573. /**
  70574. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  70575. * The cross product is then orthogonal to both "left" and "right"
  70576. * @param left defines the left operand
  70577. * @param right defines the right operand
  70578. * @returns the cross product
  70579. */
  70580. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  70581. /**
  70582. * Sets the given vector "result" with the cross product of "left" and "right"
  70583. * The cross product is then orthogonal to both "left" and "right"
  70584. * @param left defines the left operand
  70585. * @param right defines the right operand
  70586. * @param result defines the Vector3 where to store the result
  70587. */
  70588. static CrossToRef(left: Vector3, right: Vector3, result: Vector3): void;
  70589. /**
  70590. * Returns a new Vector3 as the normalization of the given vector
  70591. * @param vector defines the Vector3 to normalize
  70592. * @returns the new Vector3
  70593. */
  70594. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  70595. /**
  70596. * Sets the given vector "result" with the normalization of the given first vector
  70597. * @param vector defines the Vector3 to normalize
  70598. * @param result defines the Vector3 where to store the result
  70599. */
  70600. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  70601. /**
  70602. * Project a Vector3 onto screen space
  70603. * @param vector defines the Vector3 to project
  70604. * @param world defines the world matrix to use
  70605. * @param transform defines the transform (view x projection) matrix to use
  70606. * @param viewport defines the screen viewport to use
  70607. * @returns the new Vector3
  70608. */
  70609. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  70610. /** @hidden */
  70611. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  70612. /**
  70613. * Unproject from screen space to object space
  70614. * @param source defines the screen space Vector3 to use
  70615. * @param viewportWidth defines the current width of the viewport
  70616. * @param viewportHeight defines the current height of the viewport
  70617. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  70618. * @param transform defines the transform (view x projection) matrix to use
  70619. * @returns the new Vector3
  70620. */
  70621. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  70622. /**
  70623. * Unproject from screen space to object space
  70624. * @param source defines the screen space Vector3 to use
  70625. * @param viewportWidth defines the current width of the viewport
  70626. * @param viewportHeight defines the current height of the viewport
  70627. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  70628. * @param view defines the view matrix to use
  70629. * @param projection defines the projection matrix to use
  70630. * @returns the new Vector3
  70631. */
  70632. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  70633. /**
  70634. * Unproject from screen space to object space
  70635. * @param source defines the screen space Vector3 to use
  70636. * @param viewportWidth defines the current width of the viewport
  70637. * @param viewportHeight defines the current height of the viewport
  70638. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  70639. * @param view defines the view matrix to use
  70640. * @param projection defines the projection matrix to use
  70641. * @param result defines the Vector3 where to store the result
  70642. */
  70643. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  70644. /**
  70645. * Unproject from screen space to object space
  70646. * @param sourceX defines the screen space x coordinate to use
  70647. * @param sourceY defines the screen space y coordinate to use
  70648. * @param sourceZ defines the screen space z coordinate to use
  70649. * @param viewportWidth defines the current width of the viewport
  70650. * @param viewportHeight defines the current height of the viewport
  70651. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  70652. * @param view defines the view matrix to use
  70653. * @param projection defines the projection matrix to use
  70654. * @param result defines the Vector3 where to store the result
  70655. */
  70656. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  70657. /**
  70658. * Gets the minimal coordinate values between two Vector3
  70659. * @param left defines the first operand
  70660. * @param right defines the second operand
  70661. * @returns the new Vector3
  70662. */
  70663. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  70664. /**
  70665. * Gets the maximal coordinate values between two Vector3
  70666. * @param left defines the first operand
  70667. * @param right defines the second operand
  70668. * @returns the new Vector3
  70669. */
  70670. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  70671. /**
  70672. * Returns the distance between the vectors "value1" and "value2"
  70673. * @param value1 defines the first operand
  70674. * @param value2 defines the second operand
  70675. * @returns the distance
  70676. */
  70677. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  70678. /**
  70679. * Returns the squared distance between the vectors "value1" and "value2"
  70680. * @param value1 defines the first operand
  70681. * @param value2 defines the second operand
  70682. * @returns the squared distance
  70683. */
  70684. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  70685. /**
  70686. * Returns a new Vector3 located at the center between "value1" and "value2"
  70687. * @param value1 defines the first operand
  70688. * @param value2 defines the second operand
  70689. * @returns the new Vector3
  70690. */
  70691. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  70692. /**
  70693. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  70694. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  70695. * to something in order to rotate it from its local system to the given target system
  70696. * Note: axis1, axis2 and axis3 are normalized during this operation
  70697. * @param axis1 defines the first axis
  70698. * @param axis2 defines the second axis
  70699. * @param axis3 defines the third axis
  70700. * @returns a new Vector3
  70701. */
  70702. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  70703. /**
  70704. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  70705. * @param axis1 defines the first axis
  70706. * @param axis2 defines the second axis
  70707. * @param axis3 defines the third axis
  70708. * @param ref defines the Vector3 where to store the result
  70709. */
  70710. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  70711. }
  70712. /**
  70713. * Vector4 class created for EulerAngle class conversion to Quaternion
  70714. */
  70715. export class Vector4 {
  70716. /** x value of the vector */
  70717. x: number;
  70718. /** y value of the vector */
  70719. y: number;
  70720. /** z value of the vector */
  70721. z: number;
  70722. /** w value of the vector */
  70723. w: number;
  70724. /**
  70725. * Creates a Vector4 object from the given floats.
  70726. * @param x x value of the vector
  70727. * @param y y value of the vector
  70728. * @param z z value of the vector
  70729. * @param w w value of the vector
  70730. */
  70731. constructor(
  70732. /** x value of the vector */
  70733. x: number,
  70734. /** y value of the vector */
  70735. y: number,
  70736. /** z value of the vector */
  70737. z: number,
  70738. /** w value of the vector */
  70739. w: number);
  70740. /**
  70741. * Returns the string with the Vector4 coordinates.
  70742. * @returns a string containing all the vector values
  70743. */
  70744. toString(): string;
  70745. /**
  70746. * Returns the string "Vector4".
  70747. * @returns "Vector4"
  70748. */
  70749. getClassName(): string;
  70750. /**
  70751. * Returns the Vector4 hash code.
  70752. * @returns a unique hash code
  70753. */
  70754. getHashCode(): number;
  70755. /**
  70756. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  70757. * @returns the resulting array
  70758. */
  70759. asArray(): number[];
  70760. /**
  70761. * Populates the given array from the given index with the Vector4 coordinates.
  70762. * @param array array to populate
  70763. * @param index index of the array to start at (default: 0)
  70764. * @returns the Vector4.
  70765. */
  70766. toArray(array: FloatArray, index?: number): Vector4;
  70767. /**
  70768. * Adds the given vector to the current Vector4.
  70769. * @param otherVector the vector to add
  70770. * @returns the updated Vector4.
  70771. */
  70772. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  70773. /**
  70774. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  70775. * @param otherVector the vector to add
  70776. * @returns the resulting vector
  70777. */
  70778. add(otherVector: DeepImmutable<Vector4>): Vector4;
  70779. /**
  70780. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  70781. * @param otherVector the vector to add
  70782. * @param result the vector to store the result
  70783. * @returns the current Vector4.
  70784. */
  70785. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  70786. /**
  70787. * Subtract in place the given vector from the current Vector4.
  70788. * @param otherVector the vector to subtract
  70789. * @returns the updated Vector4.
  70790. */
  70791. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  70792. /**
  70793. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  70794. * @param otherVector the vector to add
  70795. * @returns the new vector with the result
  70796. */
  70797. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  70798. /**
  70799. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  70800. * @param otherVector the vector to subtract
  70801. * @param result the vector to store the result
  70802. * @returns the current Vector4.
  70803. */
  70804. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  70805. /**
  70806. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  70807. */
  70808. /**
  70809. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  70810. * @param x value to subtract
  70811. * @param y value to subtract
  70812. * @param z value to subtract
  70813. * @param w value to subtract
  70814. * @returns new vector containing the result
  70815. */
  70816. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  70817. /**
  70818. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  70819. * @param x value to subtract
  70820. * @param y value to subtract
  70821. * @param z value to subtract
  70822. * @param w value to subtract
  70823. * @param result the vector to store the result in
  70824. * @returns the current Vector4.
  70825. */
  70826. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  70827. /**
  70828. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  70829. * @returns a new vector with the negated values
  70830. */
  70831. negate(): Vector4;
  70832. /**
  70833. * Multiplies the current Vector4 coordinates by scale (float).
  70834. * @param scale the number to scale with
  70835. * @returns the updated Vector4.
  70836. */
  70837. scaleInPlace(scale: number): Vector4;
  70838. /**
  70839. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  70840. * @param scale the number to scale with
  70841. * @returns a new vector with the result
  70842. */
  70843. scale(scale: number): Vector4;
  70844. /**
  70845. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  70846. * @param scale the number to scale with
  70847. * @param result a vector to store the result in
  70848. * @returns the current Vector4.
  70849. */
  70850. scaleToRef(scale: number, result: Vector4): Vector4;
  70851. /**
  70852. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  70853. * @param scale defines the scale factor
  70854. * @param result defines the Vector4 object where to store the result
  70855. * @returns the unmodified current Vector4
  70856. */
  70857. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  70858. /**
  70859. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  70860. * @param otherVector the vector to compare against
  70861. * @returns true if they are equal
  70862. */
  70863. equals(otherVector: DeepImmutable<Vector4>): boolean;
  70864. /**
  70865. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  70866. * @param otherVector vector to compare against
  70867. * @param epsilon (Default: very small number)
  70868. * @returns true if they are equal
  70869. */
  70870. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  70871. /**
  70872. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  70873. * @param x x value to compare against
  70874. * @param y y value to compare against
  70875. * @param z z value to compare against
  70876. * @param w w value to compare against
  70877. * @returns true if equal
  70878. */
  70879. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  70880. /**
  70881. * Multiplies in place the current Vector4 by the given one.
  70882. * @param otherVector vector to multiple with
  70883. * @returns the updated Vector4.
  70884. */
  70885. multiplyInPlace(otherVector: Vector4): Vector4;
  70886. /**
  70887. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  70888. * @param otherVector vector to multiple with
  70889. * @returns resulting new vector
  70890. */
  70891. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  70892. /**
  70893. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  70894. * @param otherVector vector to multiple with
  70895. * @param result vector to store the result
  70896. * @returns the current Vector4.
  70897. */
  70898. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  70899. /**
  70900. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  70901. * @param x x value multiply with
  70902. * @param y y value multiply with
  70903. * @param z z value multiply with
  70904. * @param w w value multiply with
  70905. * @returns resulting new vector
  70906. */
  70907. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  70908. /**
  70909. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  70910. * @param otherVector vector to devide with
  70911. * @returns resulting new vector
  70912. */
  70913. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  70914. /**
  70915. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  70916. * @param otherVector vector to devide with
  70917. * @param result vector to store the result
  70918. * @returns the current Vector4.
  70919. */
  70920. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  70921. /**
  70922. * Divides the current Vector3 coordinates by the given ones.
  70923. * @param otherVector vector to devide with
  70924. * @returns the updated Vector3.
  70925. */
  70926. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  70927. /**
  70928. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  70929. * @param other defines the second operand
  70930. * @returns the current updated Vector4
  70931. */
  70932. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  70933. /**
  70934. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  70935. * @param other defines the second operand
  70936. * @returns the current updated Vector4
  70937. */
  70938. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  70939. /**
  70940. * Gets a new Vector4 from current Vector4 floored values
  70941. * @returns a new Vector4
  70942. */
  70943. floor(): Vector4;
  70944. /**
  70945. * Gets a new Vector4 from current Vector3 floored values
  70946. * @returns a new Vector4
  70947. */
  70948. fract(): Vector4;
  70949. /**
  70950. * Returns the Vector4 length (float).
  70951. * @returns the length
  70952. */
  70953. length(): number;
  70954. /**
  70955. * Returns the Vector4 squared length (float).
  70956. * @returns the length squared
  70957. */
  70958. lengthSquared(): number;
  70959. /**
  70960. * Normalizes in place the Vector4.
  70961. * @returns the updated Vector4.
  70962. */
  70963. normalize(): Vector4;
  70964. /**
  70965. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  70966. * @returns this converted to a new vector3
  70967. */
  70968. toVector3(): Vector3;
  70969. /**
  70970. * Returns a new Vector4 copied from the current one.
  70971. * @returns the new cloned vector
  70972. */
  70973. clone(): Vector4;
  70974. /**
  70975. * Updates the current Vector4 with the given one coordinates.
  70976. * @param source the source vector to copy from
  70977. * @returns the updated Vector4.
  70978. */
  70979. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  70980. /**
  70981. * Updates the current Vector4 coordinates with the given floats.
  70982. * @param x float to copy from
  70983. * @param y float to copy from
  70984. * @param z float to copy from
  70985. * @param w float to copy from
  70986. * @returns the updated Vector4.
  70987. */
  70988. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  70989. /**
  70990. * Updates the current Vector4 coordinates with the given floats.
  70991. * @param x float to set from
  70992. * @param y float to set from
  70993. * @param z float to set from
  70994. * @param w float to set from
  70995. * @returns the updated Vector4.
  70996. */
  70997. set(x: number, y: number, z: number, w: number): Vector4;
  70998. /**
  70999. * Copies the given float to the current Vector3 coordinates
  71000. * @param v defines the x, y, z and w coordinates of the operand
  71001. * @returns the current updated Vector3
  71002. */
  71003. setAll(v: number): Vector4;
  71004. /**
  71005. * Returns a new Vector4 set from the starting index of the given array.
  71006. * @param array the array to pull values from
  71007. * @param offset the offset into the array to start at
  71008. * @returns the new vector
  71009. */
  71010. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  71011. /**
  71012. * Updates the given vector "result" from the starting index of the given array.
  71013. * @param array the array to pull values from
  71014. * @param offset the offset into the array to start at
  71015. * @param result the vector to store the result in
  71016. */
  71017. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  71018. /**
  71019. * Updates the given vector "result" from the starting index of the given Float32Array.
  71020. * @param array the array to pull values from
  71021. * @param offset the offset into the array to start at
  71022. * @param result the vector to store the result in
  71023. */
  71024. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  71025. /**
  71026. * Updates the given vector "result" coordinates from the given floats.
  71027. * @param x float to set from
  71028. * @param y float to set from
  71029. * @param z float to set from
  71030. * @param w float to set from
  71031. * @param result the vector to the floats in
  71032. */
  71033. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  71034. /**
  71035. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  71036. * @returns the new vector
  71037. */
  71038. static Zero(): Vector4;
  71039. /**
  71040. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  71041. * @returns the new vector
  71042. */
  71043. static One(): Vector4;
  71044. /**
  71045. * Returns a new normalized Vector4 from the given one.
  71046. * @param vector the vector to normalize
  71047. * @returns the vector
  71048. */
  71049. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  71050. /**
  71051. * Updates the given vector "result" from the normalization of the given one.
  71052. * @param vector the vector to normalize
  71053. * @param result the vector to store the result in
  71054. */
  71055. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  71056. /**
  71057. * Returns a vector with the minimum values from the left and right vectors
  71058. * @param left left vector to minimize
  71059. * @param right right vector to minimize
  71060. * @returns a new vector with the minimum of the left and right vector values
  71061. */
  71062. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  71063. /**
  71064. * Returns a vector with the maximum values from the left and right vectors
  71065. * @param left left vector to maximize
  71066. * @param right right vector to maximize
  71067. * @returns a new vector with the maximum of the left and right vector values
  71068. */
  71069. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  71070. /**
  71071. * Returns the distance (float) between the vectors "value1" and "value2".
  71072. * @param value1 value to calulate the distance between
  71073. * @param value2 value to calulate the distance between
  71074. * @return the distance between the two vectors
  71075. */
  71076. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  71077. /**
  71078. * Returns the squared distance (float) between the vectors "value1" and "value2".
  71079. * @param value1 value to calulate the distance between
  71080. * @param value2 value to calulate the distance between
  71081. * @return the distance between the two vectors squared
  71082. */
  71083. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  71084. /**
  71085. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  71086. * @param value1 value to calulate the center between
  71087. * @param value2 value to calulate the center between
  71088. * @return the center between the two vectors
  71089. */
  71090. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  71091. /**
  71092. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  71093. * This methods computes transformed normalized direction vectors only.
  71094. * @param vector the vector to transform
  71095. * @param transformation the transformation matrix to apply
  71096. * @returns the new vector
  71097. */
  71098. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  71099. /**
  71100. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  71101. * This methods computes transformed normalized direction vectors only.
  71102. * @param vector the vector to transform
  71103. * @param transformation the transformation matrix to apply
  71104. * @param result the vector to store the result in
  71105. */
  71106. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  71107. /**
  71108. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  71109. * This methods computes transformed normalized direction vectors only.
  71110. * @param x value to transform
  71111. * @param y value to transform
  71112. * @param z value to transform
  71113. * @param w value to transform
  71114. * @param transformation the transformation matrix to apply
  71115. * @param result the vector to store the results in
  71116. */
  71117. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  71118. /**
  71119. * Creates a new Vector4 from a Vector3
  71120. * @param source defines the source data
  71121. * @param w defines the 4th component (default is 0)
  71122. * @returns a new Vector4
  71123. */
  71124. static FromVector3(source: Vector3, w?: number): Vector4;
  71125. }
  71126. /**
  71127. * Class used to store quaternion data
  71128. * @see https://en.wikipedia.org/wiki/Quaternion
  71129. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  71130. */
  71131. export class Quaternion {
  71132. /** defines the first component (0 by default) */
  71133. x: number;
  71134. /** defines the second component (0 by default) */
  71135. y: number;
  71136. /** defines the third component (0 by default) */
  71137. z: number;
  71138. /** defines the fourth component (1.0 by default) */
  71139. w: number;
  71140. /**
  71141. * Creates a new Quaternion from the given floats
  71142. * @param x defines the first component (0 by default)
  71143. * @param y defines the second component (0 by default)
  71144. * @param z defines the third component (0 by default)
  71145. * @param w defines the fourth component (1.0 by default)
  71146. */
  71147. constructor(
  71148. /** defines the first component (0 by default) */
  71149. x?: number,
  71150. /** defines the second component (0 by default) */
  71151. y?: number,
  71152. /** defines the third component (0 by default) */
  71153. z?: number,
  71154. /** defines the fourth component (1.0 by default) */
  71155. w?: number);
  71156. /**
  71157. * Gets a string representation for the current quaternion
  71158. * @returns a string with the Quaternion coordinates
  71159. */
  71160. toString(): string;
  71161. /**
  71162. * Gets the class name of the quaternion
  71163. * @returns the string "Quaternion"
  71164. */
  71165. getClassName(): string;
  71166. /**
  71167. * Gets a hash code for this quaternion
  71168. * @returns the quaternion hash code
  71169. */
  71170. getHashCode(): number;
  71171. /**
  71172. * Copy the quaternion to an array
  71173. * @returns a new array populated with 4 elements from the quaternion coordinates
  71174. */
  71175. asArray(): number[];
  71176. /**
  71177. * Check if two quaternions are equals
  71178. * @param otherQuaternion defines the second operand
  71179. * @return true if the current quaternion and the given one coordinates are strictly equals
  71180. */
  71181. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  71182. /**
  71183. * Clone the current quaternion
  71184. * @returns a new quaternion copied from the current one
  71185. */
  71186. clone(): Quaternion;
  71187. /**
  71188. * Copy a quaternion to the current one
  71189. * @param other defines the other quaternion
  71190. * @returns the updated current quaternion
  71191. */
  71192. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  71193. /**
  71194. * Updates the current quaternion with the given float coordinates
  71195. * @param x defines the x coordinate
  71196. * @param y defines the y coordinate
  71197. * @param z defines the z coordinate
  71198. * @param w defines the w coordinate
  71199. * @returns the updated current quaternion
  71200. */
  71201. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  71202. /**
  71203. * Updates the current quaternion from the given float coordinates
  71204. * @param x defines the x coordinate
  71205. * @param y defines the y coordinate
  71206. * @param z defines the z coordinate
  71207. * @param w defines the w coordinate
  71208. * @returns the updated current quaternion
  71209. */
  71210. set(x: number, y: number, z: number, w: number): Quaternion;
  71211. /**
  71212. * Adds two quaternions
  71213. * @param other defines the second operand
  71214. * @returns a new quaternion as the addition result of the given one and the current quaternion
  71215. */
  71216. add(other: DeepImmutable<Quaternion>): Quaternion;
  71217. /**
  71218. * Add a quaternion to the current one
  71219. * @param other defines the quaternion to add
  71220. * @returns the current quaternion
  71221. */
  71222. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  71223. /**
  71224. * Subtract two quaternions
  71225. * @param other defines the second operand
  71226. * @returns a new quaternion as the subtraction result of the given one from the current one
  71227. */
  71228. subtract(other: Quaternion): Quaternion;
  71229. /**
  71230. * Multiplies the current quaternion by a scale factor
  71231. * @param value defines the scale factor
  71232. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  71233. */
  71234. scale(value: number): Quaternion;
  71235. /**
  71236. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  71237. * @param scale defines the scale factor
  71238. * @param result defines the Quaternion object where to store the result
  71239. * @returns the unmodified current quaternion
  71240. */
  71241. scaleToRef(scale: number, result: Quaternion): Quaternion;
  71242. /**
  71243. * Multiplies in place the current quaternion by a scale factor
  71244. * @param value defines the scale factor
  71245. * @returns the current modified quaternion
  71246. */
  71247. scaleInPlace(value: number): Quaternion;
  71248. /**
  71249. * Scale the current quaternion values by a factor and add the result to a given quaternion
  71250. * @param scale defines the scale factor
  71251. * @param result defines the Quaternion object where to store the result
  71252. * @returns the unmodified current quaternion
  71253. */
  71254. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  71255. /**
  71256. * Multiplies two quaternions
  71257. * @param q1 defines the second operand
  71258. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  71259. */
  71260. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  71261. /**
  71262. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  71263. * @param q1 defines the second operand
  71264. * @param result defines the target quaternion
  71265. * @returns the current quaternion
  71266. */
  71267. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  71268. /**
  71269. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  71270. * @param q1 defines the second operand
  71271. * @returns the currentupdated quaternion
  71272. */
  71273. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  71274. /**
  71275. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  71276. * @param ref defines the target quaternion
  71277. * @returns the current quaternion
  71278. */
  71279. conjugateToRef(ref: Quaternion): Quaternion;
  71280. /**
  71281. * Conjugates in place (1-q) the current quaternion
  71282. * @returns the current updated quaternion
  71283. */
  71284. conjugateInPlace(): Quaternion;
  71285. /**
  71286. * Conjugates in place (1-q) the current quaternion
  71287. * @returns a new quaternion
  71288. */
  71289. conjugate(): Quaternion;
  71290. /**
  71291. * Gets length of current quaternion
  71292. * @returns the quaternion length (float)
  71293. */
  71294. length(): number;
  71295. /**
  71296. * Normalize in place the current quaternion
  71297. * @returns the current updated quaternion
  71298. */
  71299. normalize(): Quaternion;
  71300. /**
  71301. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  71302. * @param order is a reserved parameter and is ignore for now
  71303. * @returns a new Vector3 containing the Euler angles
  71304. */
  71305. toEulerAngles(order?: string): Vector3;
  71306. /**
  71307. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  71308. * @param result defines the vector which will be filled with the Euler angles
  71309. * @param order is a reserved parameter and is ignore for now
  71310. * @returns the current unchanged quaternion
  71311. */
  71312. toEulerAnglesToRef(result: Vector3): Quaternion;
  71313. /**
  71314. * Updates the given rotation matrix with the current quaternion values
  71315. * @param result defines the target matrix
  71316. * @returns the current unchanged quaternion
  71317. */
  71318. toRotationMatrix(result: Matrix): Quaternion;
  71319. /**
  71320. * Updates the current quaternion from the given rotation matrix values
  71321. * @param matrix defines the source matrix
  71322. * @returns the current updated quaternion
  71323. */
  71324. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  71325. /**
  71326. * Creates a new quaternion from a rotation matrix
  71327. * @param matrix defines the source matrix
  71328. * @returns a new quaternion created from the given rotation matrix values
  71329. */
  71330. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  71331. /**
  71332. * Updates the given quaternion with the given rotation matrix values
  71333. * @param matrix defines the source matrix
  71334. * @param result defines the target quaternion
  71335. */
  71336. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  71337. /**
  71338. * Returns the dot product (float) between the quaternions "left" and "right"
  71339. * @param left defines the left operand
  71340. * @param right defines the right operand
  71341. * @returns the dot product
  71342. */
  71343. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  71344. /**
  71345. * Checks if the two quaternions are close to each other
  71346. * @param quat0 defines the first quaternion to check
  71347. * @param quat1 defines the second quaternion to check
  71348. * @returns true if the two quaternions are close to each other
  71349. */
  71350. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  71351. /**
  71352. * Creates an empty quaternion
  71353. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  71354. */
  71355. static Zero(): Quaternion;
  71356. /**
  71357. * Inverse a given quaternion
  71358. * @param q defines the source quaternion
  71359. * @returns a new quaternion as the inverted current quaternion
  71360. */
  71361. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  71362. /**
  71363. * Inverse a given quaternion
  71364. * @param q defines the source quaternion
  71365. * @param result the quaternion the result will be stored in
  71366. * @returns the result quaternion
  71367. */
  71368. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  71369. /**
  71370. * Creates an identity quaternion
  71371. * @returns the identity quaternion
  71372. */
  71373. static Identity(): Quaternion;
  71374. /**
  71375. * Gets a boolean indicating if the given quaternion is identity
  71376. * @param quaternion defines the quaternion to check
  71377. * @returns true if the quaternion is identity
  71378. */
  71379. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  71380. /**
  71381. * Creates a quaternion from a rotation around an axis
  71382. * @param axis defines the axis to use
  71383. * @param angle defines the angle to use
  71384. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  71385. */
  71386. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  71387. /**
  71388. * Creates a rotation around an axis and stores it into the given quaternion
  71389. * @param axis defines the axis to use
  71390. * @param angle defines the angle to use
  71391. * @param result defines the target quaternion
  71392. * @returns the target quaternion
  71393. */
  71394. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  71395. /**
  71396. * Creates a new quaternion from data stored into an array
  71397. * @param array defines the data source
  71398. * @param offset defines the offset in the source array where the data starts
  71399. * @returns a new quaternion
  71400. */
  71401. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  71402. /**
  71403. * Create a quaternion from Euler rotation angles
  71404. * @param x Pitch
  71405. * @param y Yaw
  71406. * @param z Roll
  71407. * @returns the new Quaternion
  71408. */
  71409. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  71410. /**
  71411. * Updates a quaternion from Euler rotation angles
  71412. * @param x Pitch
  71413. * @param y Yaw
  71414. * @param z Roll
  71415. * @param result the quaternion to store the result
  71416. * @returns the updated quaternion
  71417. */
  71418. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  71419. /**
  71420. * Create a quaternion from Euler rotation vector
  71421. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  71422. * @returns the new Quaternion
  71423. */
  71424. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  71425. /**
  71426. * Updates a quaternion from Euler rotation vector
  71427. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  71428. * @param result the quaternion to store the result
  71429. * @returns the updated quaternion
  71430. */
  71431. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  71432. /**
  71433. * Creates a new quaternion from the given Euler float angles (y, x, z)
  71434. * @param yaw defines the rotation around Y axis
  71435. * @param pitch defines the rotation around X axis
  71436. * @param roll defines the rotation around Z axis
  71437. * @returns the new quaternion
  71438. */
  71439. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  71440. /**
  71441. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  71442. * @param yaw defines the rotation around Y axis
  71443. * @param pitch defines the rotation around X axis
  71444. * @param roll defines the rotation around Z axis
  71445. * @param result defines the target quaternion
  71446. */
  71447. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  71448. /**
  71449. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  71450. * @param alpha defines the rotation around first axis
  71451. * @param beta defines the rotation around second axis
  71452. * @param gamma defines the rotation around third axis
  71453. * @returns the new quaternion
  71454. */
  71455. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  71456. /**
  71457. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  71458. * @param alpha defines the rotation around first axis
  71459. * @param beta defines the rotation around second axis
  71460. * @param gamma defines the rotation around third axis
  71461. * @param result defines the target quaternion
  71462. */
  71463. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  71464. /**
  71465. * 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)
  71466. * @param axis1 defines the first axis
  71467. * @param axis2 defines the second axis
  71468. * @param axis3 defines the third axis
  71469. * @returns the new quaternion
  71470. */
  71471. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  71472. /**
  71473. * 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
  71474. * @param axis1 defines the first axis
  71475. * @param axis2 defines the second axis
  71476. * @param axis3 defines the third axis
  71477. * @param ref defines the target quaternion
  71478. */
  71479. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  71480. /**
  71481. * Interpolates between two quaternions
  71482. * @param left defines first quaternion
  71483. * @param right defines second quaternion
  71484. * @param amount defines the gradient to use
  71485. * @returns the new interpolated quaternion
  71486. */
  71487. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  71488. /**
  71489. * Interpolates between two quaternions and stores it into a target quaternion
  71490. * @param left defines first quaternion
  71491. * @param right defines second quaternion
  71492. * @param amount defines the gradient to use
  71493. * @param result defines the target quaternion
  71494. */
  71495. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  71496. /**
  71497. * Interpolate between two quaternions using Hermite interpolation
  71498. * @param value1 defines first quaternion
  71499. * @param tangent1 defines the incoming tangent
  71500. * @param value2 defines second quaternion
  71501. * @param tangent2 defines the outgoing tangent
  71502. * @param amount defines the target quaternion
  71503. * @returns the new interpolated quaternion
  71504. */
  71505. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  71506. }
  71507. /**
  71508. * Class used to store matrix data (4x4)
  71509. */
  71510. export class Matrix {
  71511. private static _updateFlagSeed;
  71512. private static _identityReadOnly;
  71513. private _isIdentity;
  71514. private _isIdentityDirty;
  71515. private _isIdentity3x2;
  71516. private _isIdentity3x2Dirty;
  71517. /**
  71518. * Gets the update flag of the matrix which is an unique number for the matrix.
  71519. * It will be incremented every time the matrix data change.
  71520. * You can use it to speed the comparison between two versions of the same matrix.
  71521. */
  71522. updateFlag: number;
  71523. private readonly _m;
  71524. /**
  71525. * Gets the internal data of the matrix
  71526. */
  71527. readonly m: DeepImmutable<Float32Array>;
  71528. /** @hidden */
  71529. _markAsUpdated(): void;
  71530. /** @hidden */
  71531. private _updateIdentityStatus;
  71532. /**
  71533. * Creates an empty matrix (filled with zeros)
  71534. */
  71535. constructor();
  71536. /**
  71537. * Check if the current matrix is identity
  71538. * @returns true is the matrix is the identity matrix
  71539. */
  71540. isIdentity(): boolean;
  71541. /**
  71542. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  71543. * @returns true is the matrix is the identity matrix
  71544. */
  71545. isIdentityAs3x2(): boolean;
  71546. /**
  71547. * Gets the determinant of the matrix
  71548. * @returns the matrix determinant
  71549. */
  71550. determinant(): number;
  71551. /**
  71552. * Returns the matrix as a Float32Array
  71553. * @returns the matrix underlying array
  71554. */
  71555. toArray(): DeepImmutable<Float32Array>;
  71556. /**
  71557. * Returns the matrix as a Float32Array
  71558. * @returns the matrix underlying array.
  71559. */
  71560. asArray(): DeepImmutable<Float32Array>;
  71561. /**
  71562. * Inverts the current matrix in place
  71563. * @returns the current inverted matrix
  71564. */
  71565. invert(): Matrix;
  71566. /**
  71567. * Sets all the matrix elements to zero
  71568. * @returns the current matrix
  71569. */
  71570. reset(): Matrix;
  71571. /**
  71572. * Adds the current matrix with a second one
  71573. * @param other defines the matrix to add
  71574. * @returns a new matrix as the addition of the current matrix and the given one
  71575. */
  71576. add(other: DeepImmutable<Matrix>): Matrix;
  71577. /**
  71578. * Sets the given matrix "result" to the addition of the current matrix and the given one
  71579. * @param other defines the matrix to add
  71580. * @param result defines the target matrix
  71581. * @returns the current matrix
  71582. */
  71583. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  71584. /**
  71585. * Adds in place the given matrix to the current matrix
  71586. * @param other defines the second operand
  71587. * @returns the current updated matrix
  71588. */
  71589. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  71590. /**
  71591. * Sets the given matrix to the current inverted Matrix
  71592. * @param other defines the target matrix
  71593. * @returns the unmodified current matrix
  71594. */
  71595. invertToRef(other: Matrix): Matrix;
  71596. /**
  71597. * add a value at the specified position in the current Matrix
  71598. * @param index the index of the value within the matrix. between 0 and 15.
  71599. * @param value the value to be added
  71600. * @returns the current updated matrix
  71601. */
  71602. addAtIndex(index: number, value: number): Matrix;
  71603. /**
  71604. * mutiply the specified position in the current Matrix by a value
  71605. * @param index the index of the value within the matrix. between 0 and 15.
  71606. * @param value the value to be added
  71607. * @returns the current updated matrix
  71608. */
  71609. multiplyAtIndex(index: number, value: number): Matrix;
  71610. /**
  71611. * Inserts the translation vector (using 3 floats) in the current matrix
  71612. * @param x defines the 1st component of the translation
  71613. * @param y defines the 2nd component of the translation
  71614. * @param z defines the 3rd component of the translation
  71615. * @returns the current updated matrix
  71616. */
  71617. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  71618. /**
  71619. * Adds the translation vector (using 3 floats) in the current matrix
  71620. * @param x defines the 1st component of the translation
  71621. * @param y defines the 2nd component of the translation
  71622. * @param z defines the 3rd component of the translation
  71623. * @returns the current updated matrix
  71624. */
  71625. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  71626. /**
  71627. * Inserts the translation vector in the current matrix
  71628. * @param vector3 defines the translation to insert
  71629. * @returns the current updated matrix
  71630. */
  71631. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  71632. /**
  71633. * Gets the translation value of the current matrix
  71634. * @returns a new Vector3 as the extracted translation from the matrix
  71635. */
  71636. getTranslation(): Vector3;
  71637. /**
  71638. * Fill a Vector3 with the extracted translation from the matrix
  71639. * @param result defines the Vector3 where to store the translation
  71640. * @returns the current matrix
  71641. */
  71642. getTranslationToRef(result: Vector3): Matrix;
  71643. /**
  71644. * Remove rotation and scaling part from the matrix
  71645. * @returns the updated matrix
  71646. */
  71647. removeRotationAndScaling(): Matrix;
  71648. /**
  71649. * Multiply two matrices
  71650. * @param other defines the second operand
  71651. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  71652. */
  71653. multiply(other: DeepImmutable<Matrix>): Matrix;
  71654. /**
  71655. * Copy the current matrix from the given one
  71656. * @param other defines the source matrix
  71657. * @returns the current updated matrix
  71658. */
  71659. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  71660. /**
  71661. * Populates the given array from the starting index with the current matrix values
  71662. * @param array defines the target array
  71663. * @param offset defines the offset in the target array where to start storing values
  71664. * @returns the current matrix
  71665. */
  71666. copyToArray(array: Float32Array, offset?: number): Matrix;
  71667. /**
  71668. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  71669. * @param other defines the second operand
  71670. * @param result defines the matrix where to store the multiplication
  71671. * @returns the current matrix
  71672. */
  71673. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  71674. /**
  71675. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  71676. * @param other defines the second operand
  71677. * @param result defines the array where to store the multiplication
  71678. * @param offset defines the offset in the target array where to start storing values
  71679. * @returns the current matrix
  71680. */
  71681. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  71682. /**
  71683. * Check equality between this matrix and a second one
  71684. * @param value defines the second matrix to compare
  71685. * @returns true is the current matrix and the given one values are strictly equal
  71686. */
  71687. equals(value: DeepImmutable<Matrix>): boolean;
  71688. /**
  71689. * Clone the current matrix
  71690. * @returns a new matrix from the current matrix
  71691. */
  71692. clone(): Matrix;
  71693. /**
  71694. * Returns the name of the current matrix class
  71695. * @returns the string "Matrix"
  71696. */
  71697. getClassName(): string;
  71698. /**
  71699. * Gets the hash code of the current matrix
  71700. * @returns the hash code
  71701. */
  71702. getHashCode(): number;
  71703. /**
  71704. * Decomposes the current Matrix into a translation, rotation and scaling components
  71705. * @param scale defines the scale vector3 given as a reference to update
  71706. * @param rotation defines the rotation quaternion given as a reference to update
  71707. * @param translation defines the translation vector3 given as a reference to update
  71708. * @returns true if operation was successful
  71709. */
  71710. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  71711. /**
  71712. * Gets specific row of the matrix
  71713. * @param index defines the number of the row to get
  71714. * @returns the index-th row of the current matrix as a new Vector4
  71715. */
  71716. getRow(index: number): Nullable<Vector4>;
  71717. /**
  71718. * Sets the index-th row of the current matrix to the vector4 values
  71719. * @param index defines the number of the row to set
  71720. * @param row defines the target vector4
  71721. * @returns the updated current matrix
  71722. */
  71723. setRow(index: number, row: Vector4): Matrix;
  71724. /**
  71725. * Compute the transpose of the matrix
  71726. * @returns the new transposed matrix
  71727. */
  71728. transpose(): Matrix;
  71729. /**
  71730. * Compute the transpose of the matrix and store it in a given matrix
  71731. * @param result defines the target matrix
  71732. * @returns the current matrix
  71733. */
  71734. transposeToRef(result: Matrix): Matrix;
  71735. /**
  71736. * Sets the index-th row of the current matrix with the given 4 x float values
  71737. * @param index defines the row index
  71738. * @param x defines the x component to set
  71739. * @param y defines the y component to set
  71740. * @param z defines the z component to set
  71741. * @param w defines the w component to set
  71742. * @returns the updated current matrix
  71743. */
  71744. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  71745. /**
  71746. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  71747. * @param scale defines the scale factor
  71748. * @returns a new matrix
  71749. */
  71750. scale(scale: number): Matrix;
  71751. /**
  71752. * Scale the current matrix values by a factor to a given result matrix
  71753. * @param scale defines the scale factor
  71754. * @param result defines the matrix to store the result
  71755. * @returns the current matrix
  71756. */
  71757. scaleToRef(scale: number, result: Matrix): Matrix;
  71758. /**
  71759. * Scale the current matrix values by a factor and add the result to a given matrix
  71760. * @param scale defines the scale factor
  71761. * @param result defines the Matrix to store the result
  71762. * @returns the current matrix
  71763. */
  71764. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  71765. /**
  71766. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  71767. * @param ref matrix to store the result
  71768. */
  71769. toNormalMatrix(ref: Matrix): void;
  71770. /**
  71771. * Gets only rotation part of the current matrix
  71772. * @returns a new matrix sets to the extracted rotation matrix from the current one
  71773. */
  71774. getRotationMatrix(): Matrix;
  71775. /**
  71776. * Extracts the rotation matrix from the current one and sets it as the given "result"
  71777. * @param result defines the target matrix to store data to
  71778. * @returns the current matrix
  71779. */
  71780. getRotationMatrixToRef(result: Matrix): Matrix;
  71781. /**
  71782. * Toggles model matrix from being right handed to left handed in place and vice versa
  71783. */
  71784. toggleModelMatrixHandInPlace(): void;
  71785. /**
  71786. * Toggles projection matrix from being right handed to left handed in place and vice versa
  71787. */
  71788. toggleProjectionMatrixHandInPlace(): void;
  71789. /**
  71790. * Creates a matrix from an array
  71791. * @param array defines the source array
  71792. * @param offset defines an offset in the source array
  71793. * @returns a new Matrix set from the starting index of the given array
  71794. */
  71795. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  71796. /**
  71797. * Copy the content of an array into a given matrix
  71798. * @param array defines the source array
  71799. * @param offset defines an offset in the source array
  71800. * @param result defines the target matrix
  71801. */
  71802. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  71803. /**
  71804. * Stores an array into a matrix after having multiplied each component by a given factor
  71805. * @param array defines the source array
  71806. * @param offset defines the offset in the source array
  71807. * @param scale defines the scaling factor
  71808. * @param result defines the target matrix
  71809. */
  71810. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  71811. /**
  71812. * Gets an identity matrix that must not be updated
  71813. */
  71814. static readonly IdentityReadOnly: DeepImmutable<Matrix>;
  71815. /**
  71816. * Stores a list of values (16) inside a given matrix
  71817. * @param initialM11 defines 1st value of 1st row
  71818. * @param initialM12 defines 2nd value of 1st row
  71819. * @param initialM13 defines 3rd value of 1st row
  71820. * @param initialM14 defines 4th value of 1st row
  71821. * @param initialM21 defines 1st value of 2nd row
  71822. * @param initialM22 defines 2nd value of 2nd row
  71823. * @param initialM23 defines 3rd value of 2nd row
  71824. * @param initialM24 defines 4th value of 2nd row
  71825. * @param initialM31 defines 1st value of 3rd row
  71826. * @param initialM32 defines 2nd value of 3rd row
  71827. * @param initialM33 defines 3rd value of 3rd row
  71828. * @param initialM34 defines 4th value of 3rd row
  71829. * @param initialM41 defines 1st value of 4th row
  71830. * @param initialM42 defines 2nd value of 4th row
  71831. * @param initialM43 defines 3rd value of 4th row
  71832. * @param initialM44 defines 4th value of 4th row
  71833. * @param result defines the target matrix
  71834. */
  71835. 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;
  71836. /**
  71837. * Creates new matrix from a list of values (16)
  71838. * @param initialM11 defines 1st value of 1st row
  71839. * @param initialM12 defines 2nd value of 1st row
  71840. * @param initialM13 defines 3rd value of 1st row
  71841. * @param initialM14 defines 4th value of 1st row
  71842. * @param initialM21 defines 1st value of 2nd row
  71843. * @param initialM22 defines 2nd value of 2nd row
  71844. * @param initialM23 defines 3rd value of 2nd row
  71845. * @param initialM24 defines 4th value of 2nd row
  71846. * @param initialM31 defines 1st value of 3rd row
  71847. * @param initialM32 defines 2nd value of 3rd row
  71848. * @param initialM33 defines 3rd value of 3rd row
  71849. * @param initialM34 defines 4th value of 3rd row
  71850. * @param initialM41 defines 1st value of 4th row
  71851. * @param initialM42 defines 2nd value of 4th row
  71852. * @param initialM43 defines 3rd value of 4th row
  71853. * @param initialM44 defines 4th value of 4th row
  71854. * @returns the new matrix
  71855. */
  71856. 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;
  71857. /**
  71858. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  71859. * @param scale defines the scale vector3
  71860. * @param rotation defines the rotation quaternion
  71861. * @param translation defines the translation vector3
  71862. * @returns a new matrix
  71863. */
  71864. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  71865. /**
  71866. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  71867. * @param scale defines the scale vector3
  71868. * @param rotation defines the rotation quaternion
  71869. * @param translation defines the translation vector3
  71870. * @param result defines the target matrix
  71871. */
  71872. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  71873. /**
  71874. * Creates a new identity matrix
  71875. * @returns a new identity matrix
  71876. */
  71877. static Identity(): Matrix;
  71878. /**
  71879. * Creates a new identity matrix and stores the result in a given matrix
  71880. * @param result defines the target matrix
  71881. */
  71882. static IdentityToRef(result: Matrix): void;
  71883. /**
  71884. * Creates a new zero matrix
  71885. * @returns a new zero matrix
  71886. */
  71887. static Zero(): Matrix;
  71888. /**
  71889. * Creates a new rotation matrix for "angle" radians around the X axis
  71890. * @param angle defines the angle (in radians) to use
  71891. * @return the new matrix
  71892. */
  71893. static RotationX(angle: number): Matrix;
  71894. /**
  71895. * Creates a new matrix as the invert of a given matrix
  71896. * @param source defines the source matrix
  71897. * @returns the new matrix
  71898. */
  71899. static Invert(source: DeepImmutable<Matrix>): Matrix;
  71900. /**
  71901. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  71902. * @param angle defines the angle (in radians) to use
  71903. * @param result defines the target matrix
  71904. */
  71905. static RotationXToRef(angle: number, result: Matrix): void;
  71906. /**
  71907. * Creates a new rotation matrix for "angle" radians around the Y axis
  71908. * @param angle defines the angle (in radians) to use
  71909. * @return the new matrix
  71910. */
  71911. static RotationY(angle: number): Matrix;
  71912. /**
  71913. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  71914. * @param angle defines the angle (in radians) to use
  71915. * @param result defines the target matrix
  71916. */
  71917. static RotationYToRef(angle: number, result: Matrix): void;
  71918. /**
  71919. * Creates a new rotation matrix for "angle" radians around the Z axis
  71920. * @param angle defines the angle (in radians) to use
  71921. * @return the new matrix
  71922. */
  71923. static RotationZ(angle: number): Matrix;
  71924. /**
  71925. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  71926. * @param angle defines the angle (in radians) to use
  71927. * @param result defines the target matrix
  71928. */
  71929. static RotationZToRef(angle: number, result: Matrix): void;
  71930. /**
  71931. * Creates a new rotation matrix for "angle" radians around the given axis
  71932. * @param axis defines the axis to use
  71933. * @param angle defines the angle (in radians) to use
  71934. * @return the new matrix
  71935. */
  71936. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  71937. /**
  71938. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  71939. * @param axis defines the axis to use
  71940. * @param angle defines the angle (in radians) to use
  71941. * @param result defines the target matrix
  71942. */
  71943. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  71944. /**
  71945. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  71946. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  71947. * @param from defines the vector to align
  71948. * @param to defines the vector to align to
  71949. * @param result defines the target matrix
  71950. */
  71951. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  71952. /**
  71953. * Creates a rotation matrix
  71954. * @param yaw defines the yaw angle in radians (Y axis)
  71955. * @param pitch defines the pitch angle in radians (X axis)
  71956. * @param roll defines the roll angle in radians (X axis)
  71957. * @returns the new rotation matrix
  71958. */
  71959. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  71960. /**
  71961. * Creates a rotation matrix and stores it in a given matrix
  71962. * @param yaw defines the yaw angle in radians (Y axis)
  71963. * @param pitch defines the pitch angle in radians (X axis)
  71964. * @param roll defines the roll angle in radians (X axis)
  71965. * @param result defines the target matrix
  71966. */
  71967. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  71968. /**
  71969. * Creates a scaling matrix
  71970. * @param x defines the scale factor on X axis
  71971. * @param y defines the scale factor on Y axis
  71972. * @param z defines the scale factor on Z axis
  71973. * @returns the new matrix
  71974. */
  71975. static Scaling(x: number, y: number, z: number): Matrix;
  71976. /**
  71977. * Creates a scaling matrix and stores it in a given matrix
  71978. * @param x defines the scale factor on X axis
  71979. * @param y defines the scale factor on Y axis
  71980. * @param z defines the scale factor on Z axis
  71981. * @param result defines the target matrix
  71982. */
  71983. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  71984. /**
  71985. * Creates a translation matrix
  71986. * @param x defines the translation on X axis
  71987. * @param y defines the translation on Y axis
  71988. * @param z defines the translationon Z axis
  71989. * @returns the new matrix
  71990. */
  71991. static Translation(x: number, y: number, z: number): Matrix;
  71992. /**
  71993. * Creates a translation matrix and stores it in a given matrix
  71994. * @param x defines the translation on X axis
  71995. * @param y defines the translation on Y axis
  71996. * @param z defines the translationon Z axis
  71997. * @param result defines the target matrix
  71998. */
  71999. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  72000. /**
  72001. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  72002. * @param startValue defines the start value
  72003. * @param endValue defines the end value
  72004. * @param gradient defines the gradient factor
  72005. * @returns the new matrix
  72006. */
  72007. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  72008. /**
  72009. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  72010. * @param startValue defines the start value
  72011. * @param endValue defines the end value
  72012. * @param gradient defines the gradient factor
  72013. * @param result defines the Matrix object where to store data
  72014. */
  72015. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  72016. /**
  72017. * Builds a new matrix whose values are computed by:
  72018. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  72019. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  72020. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  72021. * @param startValue defines the first matrix
  72022. * @param endValue defines the second matrix
  72023. * @param gradient defines the gradient between the two matrices
  72024. * @returns the new matrix
  72025. */
  72026. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  72027. /**
  72028. * Update a matrix to values which are computed by:
  72029. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  72030. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  72031. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  72032. * @param startValue defines the first matrix
  72033. * @param endValue defines the second matrix
  72034. * @param gradient defines the gradient between the two matrices
  72035. * @param result defines the target matrix
  72036. */
  72037. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  72038. /**
  72039. * 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"
  72040. * This function works in left handed mode
  72041. * @param eye defines the final position of the entity
  72042. * @param target defines where the entity should look at
  72043. * @param up defines the up vector for the entity
  72044. * @returns the new matrix
  72045. */
  72046. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  72047. /**
  72048. * 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".
  72049. * This function works in left handed mode
  72050. * @param eye defines the final position of the entity
  72051. * @param target defines where the entity should look at
  72052. * @param up defines the up vector for the entity
  72053. * @param result defines the target matrix
  72054. */
  72055. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  72056. /**
  72057. * 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"
  72058. * This function works in right handed mode
  72059. * @param eye defines the final position of the entity
  72060. * @param target defines where the entity should look at
  72061. * @param up defines the up vector for the entity
  72062. * @returns the new matrix
  72063. */
  72064. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  72065. /**
  72066. * 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".
  72067. * This function works in right handed mode
  72068. * @param eye defines the final position of the entity
  72069. * @param target defines where the entity should look at
  72070. * @param up defines the up vector for the entity
  72071. * @param result defines the target matrix
  72072. */
  72073. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  72074. /**
  72075. * Create a left-handed orthographic projection matrix
  72076. * @param width defines the viewport width
  72077. * @param height defines the viewport height
  72078. * @param znear defines the near clip plane
  72079. * @param zfar defines the far clip plane
  72080. * @returns a new matrix as a left-handed orthographic projection matrix
  72081. */
  72082. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  72083. /**
  72084. * Store a left-handed orthographic projection to a given matrix
  72085. * @param width defines the viewport width
  72086. * @param height defines the viewport height
  72087. * @param znear defines the near clip plane
  72088. * @param zfar defines the far clip plane
  72089. * @param result defines the target matrix
  72090. */
  72091. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  72092. /**
  72093. * Create a left-handed orthographic projection matrix
  72094. * @param left defines the viewport left coordinate
  72095. * @param right defines the viewport right coordinate
  72096. * @param bottom defines the viewport bottom coordinate
  72097. * @param top defines the viewport top coordinate
  72098. * @param znear defines the near clip plane
  72099. * @param zfar defines the far clip plane
  72100. * @returns a new matrix as a left-handed orthographic projection matrix
  72101. */
  72102. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  72103. /**
  72104. * Stores a left-handed orthographic projection into a given matrix
  72105. * @param left defines the viewport left coordinate
  72106. * @param right defines the viewport right coordinate
  72107. * @param bottom defines the viewport bottom coordinate
  72108. * @param top defines the viewport top coordinate
  72109. * @param znear defines the near clip plane
  72110. * @param zfar defines the far clip plane
  72111. * @param result defines the target matrix
  72112. */
  72113. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  72114. /**
  72115. * Creates a right-handed orthographic projection matrix
  72116. * @param left defines the viewport left coordinate
  72117. * @param right defines the viewport right coordinate
  72118. * @param bottom defines the viewport bottom coordinate
  72119. * @param top defines the viewport top coordinate
  72120. * @param znear defines the near clip plane
  72121. * @param zfar defines the far clip plane
  72122. * @returns a new matrix as a right-handed orthographic projection matrix
  72123. */
  72124. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  72125. /**
  72126. * Stores a right-handed orthographic projection into a given matrix
  72127. * @param left defines the viewport left coordinate
  72128. * @param right defines the viewport right coordinate
  72129. * @param bottom defines the viewport bottom coordinate
  72130. * @param top defines the viewport top coordinate
  72131. * @param znear defines the near clip plane
  72132. * @param zfar defines the far clip plane
  72133. * @param result defines the target matrix
  72134. */
  72135. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  72136. /**
  72137. * Creates a left-handed perspective projection matrix
  72138. * @param width defines the viewport width
  72139. * @param height defines the viewport height
  72140. * @param znear defines the near clip plane
  72141. * @param zfar defines the far clip plane
  72142. * @returns a new matrix as a left-handed perspective projection matrix
  72143. */
  72144. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  72145. /**
  72146. * Creates a left-handed perspective projection matrix
  72147. * @param fov defines the horizontal field of view
  72148. * @param aspect defines the aspect ratio
  72149. * @param znear defines the near clip plane
  72150. * @param zfar defines the far clip plane
  72151. * @returns a new matrix as a left-handed perspective projection matrix
  72152. */
  72153. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  72154. /**
  72155. * Stores a left-handed perspective projection into a given matrix
  72156. * @param fov defines the horizontal field of view
  72157. * @param aspect defines the aspect ratio
  72158. * @param znear defines the near clip plane
  72159. * @param zfar defines the far clip plane
  72160. * @param result defines the target matrix
  72161. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  72162. */
  72163. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  72164. /**
  72165. * Creates a right-handed perspective projection matrix
  72166. * @param fov defines the horizontal field of view
  72167. * @param aspect defines the aspect ratio
  72168. * @param znear defines the near clip plane
  72169. * @param zfar defines the far clip plane
  72170. * @returns a new matrix as a right-handed perspective projection matrix
  72171. */
  72172. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  72173. /**
  72174. * Stores a right-handed perspective projection into a given matrix
  72175. * @param fov defines the horizontal field of view
  72176. * @param aspect defines the aspect ratio
  72177. * @param znear defines the near clip plane
  72178. * @param zfar defines the far clip plane
  72179. * @param result defines the target matrix
  72180. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  72181. */
  72182. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  72183. /**
  72184. * Stores a perspective projection for WebVR info a given matrix
  72185. * @param fov defines the field of view
  72186. * @param znear defines the near clip plane
  72187. * @param zfar defines the far clip plane
  72188. * @param result defines the target matrix
  72189. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  72190. */
  72191. static PerspectiveFovWebVRToRef(fov: {
  72192. upDegrees: number;
  72193. downDegrees: number;
  72194. leftDegrees: number;
  72195. rightDegrees: number;
  72196. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  72197. /**
  72198. * Computes a complete transformation matrix
  72199. * @param viewport defines the viewport to use
  72200. * @param world defines the world matrix
  72201. * @param view defines the view matrix
  72202. * @param projection defines the projection matrix
  72203. * @param zmin defines the near clip plane
  72204. * @param zmax defines the far clip plane
  72205. * @returns the transformation matrix
  72206. */
  72207. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  72208. /**
  72209. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  72210. * @param matrix defines the matrix to use
  72211. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  72212. */
  72213. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  72214. /**
  72215. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  72216. * @param matrix defines the matrix to use
  72217. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  72218. */
  72219. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  72220. /**
  72221. * Compute the transpose of a given matrix
  72222. * @param matrix defines the matrix to transpose
  72223. * @returns the new matrix
  72224. */
  72225. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  72226. /**
  72227. * Compute the transpose of a matrix and store it in a target matrix
  72228. * @param matrix defines the matrix to transpose
  72229. * @param result defines the target matrix
  72230. */
  72231. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  72232. /**
  72233. * Computes a reflection matrix from a plane
  72234. * @param plane defines the reflection plane
  72235. * @returns a new matrix
  72236. */
  72237. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  72238. /**
  72239. * Computes a reflection matrix from a plane
  72240. * @param plane defines the reflection plane
  72241. * @param result defines the target matrix
  72242. */
  72243. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  72244. /**
  72245. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  72246. * @param xaxis defines the value of the 1st axis
  72247. * @param yaxis defines the value of the 2nd axis
  72248. * @param zaxis defines the value of the 3rd axis
  72249. * @param result defines the target matrix
  72250. */
  72251. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  72252. /**
  72253. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  72254. * @param quat defines the quaternion to use
  72255. * @param result defines the target matrix
  72256. */
  72257. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  72258. }
  72259. /**
  72260. * @hidden
  72261. */
  72262. export class TmpVectors {
  72263. static Vector2: Vector2[];
  72264. static Vector3: Vector3[];
  72265. static Vector4: Vector4[];
  72266. static Quaternion: Quaternion[];
  72267. static Matrix: Matrix[];
  72268. }
  72269. }
  72270. declare module BABYLON {
  72271. /**
  72272. * Defines potential orientation for back face culling
  72273. */
  72274. export enum Orientation {
  72275. /**
  72276. * Clockwise
  72277. */
  72278. CW = 0,
  72279. /** Counter clockwise */
  72280. CCW = 1
  72281. }
  72282. /** Class used to represent a Bezier curve */
  72283. export class BezierCurve {
  72284. /**
  72285. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  72286. * @param t defines the time
  72287. * @param x1 defines the left coordinate on X axis
  72288. * @param y1 defines the left coordinate on Y axis
  72289. * @param x2 defines the right coordinate on X axis
  72290. * @param y2 defines the right coordinate on Y axis
  72291. * @returns the interpolated value
  72292. */
  72293. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  72294. }
  72295. /**
  72296. * Defines angle representation
  72297. */
  72298. export class Angle {
  72299. private _radians;
  72300. /**
  72301. * Creates an Angle object of "radians" radians (float).
  72302. * @param radians the angle in radians
  72303. */
  72304. constructor(radians: number);
  72305. /**
  72306. * Get value in degrees
  72307. * @returns the Angle value in degrees (float)
  72308. */
  72309. degrees(): number;
  72310. /**
  72311. * Get value in radians
  72312. * @returns the Angle value in radians (float)
  72313. */
  72314. radians(): number;
  72315. /**
  72316. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  72317. * @param a defines first vector
  72318. * @param b defines second vector
  72319. * @returns a new Angle
  72320. */
  72321. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  72322. /**
  72323. * Gets a new Angle object from the given float in radians
  72324. * @param radians defines the angle value in radians
  72325. * @returns a new Angle
  72326. */
  72327. static FromRadians(radians: number): Angle;
  72328. /**
  72329. * Gets a new Angle object from the given float in degrees
  72330. * @param degrees defines the angle value in degrees
  72331. * @returns a new Angle
  72332. */
  72333. static FromDegrees(degrees: number): Angle;
  72334. }
  72335. /**
  72336. * This represents an arc in a 2d space.
  72337. */
  72338. export class Arc2 {
  72339. /** Defines the start point of the arc */
  72340. startPoint: Vector2;
  72341. /** Defines the mid point of the arc */
  72342. midPoint: Vector2;
  72343. /** Defines the end point of the arc */
  72344. endPoint: Vector2;
  72345. /**
  72346. * Defines the center point of the arc.
  72347. */
  72348. centerPoint: Vector2;
  72349. /**
  72350. * Defines the radius of the arc.
  72351. */
  72352. radius: number;
  72353. /**
  72354. * Defines the angle of the arc (from mid point to end point).
  72355. */
  72356. angle: Angle;
  72357. /**
  72358. * Defines the start angle of the arc (from start point to middle point).
  72359. */
  72360. startAngle: Angle;
  72361. /**
  72362. * Defines the orientation of the arc (clock wise/counter clock wise).
  72363. */
  72364. orientation: Orientation;
  72365. /**
  72366. * Creates an Arc object from the three given points : start, middle and end.
  72367. * @param startPoint Defines the start point of the arc
  72368. * @param midPoint Defines the midlle point of the arc
  72369. * @param endPoint Defines the end point of the arc
  72370. */
  72371. constructor(
  72372. /** Defines the start point of the arc */
  72373. startPoint: Vector2,
  72374. /** Defines the mid point of the arc */
  72375. midPoint: Vector2,
  72376. /** Defines the end point of the arc */
  72377. endPoint: Vector2);
  72378. }
  72379. /**
  72380. * Represents a 2D path made up of multiple 2D points
  72381. */
  72382. export class Path2 {
  72383. private _points;
  72384. private _length;
  72385. /**
  72386. * If the path start and end point are the same
  72387. */
  72388. closed: boolean;
  72389. /**
  72390. * Creates a Path2 object from the starting 2D coordinates x and y.
  72391. * @param x the starting points x value
  72392. * @param y the starting points y value
  72393. */
  72394. constructor(x: number, y: number);
  72395. /**
  72396. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  72397. * @param x the added points x value
  72398. * @param y the added points y value
  72399. * @returns the updated Path2.
  72400. */
  72401. addLineTo(x: number, y: number): Path2;
  72402. /**
  72403. * 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.
  72404. * @param midX middle point x value
  72405. * @param midY middle point y value
  72406. * @param endX end point x value
  72407. * @param endY end point y value
  72408. * @param numberOfSegments (default: 36)
  72409. * @returns the updated Path2.
  72410. */
  72411. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  72412. /**
  72413. * Closes the Path2.
  72414. * @returns the Path2.
  72415. */
  72416. close(): Path2;
  72417. /**
  72418. * Gets the sum of the distance between each sequential point in the path
  72419. * @returns the Path2 total length (float).
  72420. */
  72421. length(): number;
  72422. /**
  72423. * Gets the points which construct the path
  72424. * @returns the Path2 internal array of points.
  72425. */
  72426. getPoints(): Vector2[];
  72427. /**
  72428. * Retreives the point at the distance aways from the starting point
  72429. * @param normalizedLengthPosition the length along the path to retreive the point from
  72430. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  72431. */
  72432. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  72433. /**
  72434. * Creates a new path starting from an x and y position
  72435. * @param x starting x value
  72436. * @param y starting y value
  72437. * @returns a new Path2 starting at the coordinates (x, y).
  72438. */
  72439. static StartingAt(x: number, y: number): Path2;
  72440. }
  72441. /**
  72442. * Represents a 3D path made up of multiple 3D points
  72443. */
  72444. export class Path3D {
  72445. /**
  72446. * an array of Vector3, the curve axis of the Path3D
  72447. */
  72448. path: Vector3[];
  72449. private _curve;
  72450. private _distances;
  72451. private _tangents;
  72452. private _normals;
  72453. private _binormals;
  72454. private _raw;
  72455. /**
  72456. * new Path3D(path, normal, raw)
  72457. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  72458. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  72459. * @param path an array of Vector3, the curve axis of the Path3D
  72460. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  72461. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  72462. */
  72463. constructor(
  72464. /**
  72465. * an array of Vector3, the curve axis of the Path3D
  72466. */
  72467. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean);
  72468. /**
  72469. * Returns the Path3D array of successive Vector3 designing its curve.
  72470. * @returns the Path3D array of successive Vector3 designing its curve.
  72471. */
  72472. getCurve(): Vector3[];
  72473. /**
  72474. * Returns an array populated with tangent vectors on each Path3D curve point.
  72475. * @returns an array populated with tangent vectors on each Path3D curve point.
  72476. */
  72477. getTangents(): Vector3[];
  72478. /**
  72479. * Returns an array populated with normal vectors on each Path3D curve point.
  72480. * @returns an array populated with normal vectors on each Path3D curve point.
  72481. */
  72482. getNormals(): Vector3[];
  72483. /**
  72484. * Returns an array populated with binormal vectors on each Path3D curve point.
  72485. * @returns an array populated with binormal vectors on each Path3D curve point.
  72486. */
  72487. getBinormals(): Vector3[];
  72488. /**
  72489. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  72490. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  72491. */
  72492. getDistances(): number[];
  72493. /**
  72494. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  72495. * @param path path which all values are copied into the curves points
  72496. * @param firstNormal which should be projected onto the curve
  72497. * @returns the same object updated.
  72498. */
  72499. update(path: Vector3[], firstNormal?: Nullable<Vector3>): Path3D;
  72500. private _compute;
  72501. private _getFirstNonNullVector;
  72502. private _getLastNonNullVector;
  72503. private _normalVector;
  72504. }
  72505. /**
  72506. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  72507. * A Curve3 is designed from a series of successive Vector3.
  72508. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  72509. */
  72510. export class Curve3 {
  72511. private _points;
  72512. private _length;
  72513. /**
  72514. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  72515. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  72516. * @param v1 (Vector3) the control point
  72517. * @param v2 (Vector3) the end point of the Quadratic Bezier
  72518. * @param nbPoints (integer) the wanted number of points in the curve
  72519. * @returns the created Curve3
  72520. */
  72521. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  72522. /**
  72523. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  72524. * @param v0 (Vector3) the origin point of the Cubic Bezier
  72525. * @param v1 (Vector3) the first control point
  72526. * @param v2 (Vector3) the second control point
  72527. * @param v3 (Vector3) the end point of the Cubic Bezier
  72528. * @param nbPoints (integer) the wanted number of points in the curve
  72529. * @returns the created Curve3
  72530. */
  72531. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  72532. /**
  72533. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  72534. * @param p1 (Vector3) the origin point of the Hermite Spline
  72535. * @param t1 (Vector3) the tangent vector at the origin point
  72536. * @param p2 (Vector3) the end point of the Hermite Spline
  72537. * @param t2 (Vector3) the tangent vector at the end point
  72538. * @param nbPoints (integer) the wanted number of points in the curve
  72539. * @returns the created Curve3
  72540. */
  72541. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  72542. /**
  72543. * Returns a Curve3 object along a CatmullRom Spline curve :
  72544. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  72545. * @param nbPoints (integer) the wanted number of points between each curve control points
  72546. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  72547. * @returns the created Curve3
  72548. */
  72549. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  72550. /**
  72551. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  72552. * A Curve3 is designed from a series of successive Vector3.
  72553. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  72554. * @param points points which make up the curve
  72555. */
  72556. constructor(points: Vector3[]);
  72557. /**
  72558. * @returns the Curve3 stored array of successive Vector3
  72559. */
  72560. getPoints(): Vector3[];
  72561. /**
  72562. * @returns the computed length (float) of the curve.
  72563. */
  72564. length(): number;
  72565. /**
  72566. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  72567. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  72568. * curveA and curveB keep unchanged.
  72569. * @param curve the curve to continue from this curve
  72570. * @returns the newly constructed curve
  72571. */
  72572. continue(curve: DeepImmutable<Curve3>): Curve3;
  72573. private _computeLength;
  72574. }
  72575. }
  72576. declare module BABYLON {
  72577. /**
  72578. * This represents the main contract an easing function should follow.
  72579. * Easing functions are used throughout the animation system.
  72580. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72581. */
  72582. export interface IEasingFunction {
  72583. /**
  72584. * Given an input gradient between 0 and 1, this returns the corrseponding value
  72585. * of the easing function.
  72586. * The link below provides some of the most common examples of easing functions.
  72587. * @see https://easings.net/
  72588. * @param gradient Defines the value between 0 and 1 we want the easing value for
  72589. * @returns the corresponding value on the curve defined by the easing function
  72590. */
  72591. ease(gradient: number): number;
  72592. }
  72593. /**
  72594. * Base class used for every default easing function.
  72595. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72596. */
  72597. export class EasingFunction implements IEasingFunction {
  72598. /**
  72599. * Interpolation follows the mathematical formula associated with the easing function.
  72600. */
  72601. static readonly EASINGMODE_EASEIN: number;
  72602. /**
  72603. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  72604. */
  72605. static readonly EASINGMODE_EASEOUT: number;
  72606. /**
  72607. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  72608. */
  72609. static readonly EASINGMODE_EASEINOUT: number;
  72610. private _easingMode;
  72611. /**
  72612. * Sets the easing mode of the current function.
  72613. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  72614. */
  72615. setEasingMode(easingMode: number): void;
  72616. /**
  72617. * Gets the current easing mode.
  72618. * @returns the easing mode
  72619. */
  72620. getEasingMode(): number;
  72621. /**
  72622. * @hidden
  72623. */
  72624. easeInCore(gradient: number): number;
  72625. /**
  72626. * Given an input gradient between 0 and 1, this returns the corresponding value
  72627. * of the easing function.
  72628. * @param gradient Defines the value between 0 and 1 we want the easing value for
  72629. * @returns the corresponding value on the curve defined by the easing function
  72630. */
  72631. ease(gradient: number): number;
  72632. }
  72633. /**
  72634. * Easing function with a circle shape (see link below).
  72635. * @see https://easings.net/#easeInCirc
  72636. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72637. */
  72638. export class CircleEase extends EasingFunction implements IEasingFunction {
  72639. /** @hidden */
  72640. easeInCore(gradient: number): number;
  72641. }
  72642. /**
  72643. * Easing function with a ease back shape (see link below).
  72644. * @see https://easings.net/#easeInBack
  72645. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72646. */
  72647. export class BackEase extends EasingFunction implements IEasingFunction {
  72648. /** Defines the amplitude of the function */
  72649. amplitude: number;
  72650. /**
  72651. * Instantiates a back ease easing
  72652. * @see https://easings.net/#easeInBack
  72653. * @param amplitude Defines the amplitude of the function
  72654. */
  72655. constructor(
  72656. /** Defines the amplitude of the function */
  72657. amplitude?: number);
  72658. /** @hidden */
  72659. easeInCore(gradient: number): number;
  72660. }
  72661. /**
  72662. * Easing function with a bouncing shape (see link below).
  72663. * @see https://easings.net/#easeInBounce
  72664. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72665. */
  72666. export class BounceEase extends EasingFunction implements IEasingFunction {
  72667. /** Defines the number of bounces */
  72668. bounces: number;
  72669. /** Defines the amplitude of the bounce */
  72670. bounciness: number;
  72671. /**
  72672. * Instantiates a bounce easing
  72673. * @see https://easings.net/#easeInBounce
  72674. * @param bounces Defines the number of bounces
  72675. * @param bounciness Defines the amplitude of the bounce
  72676. */
  72677. constructor(
  72678. /** Defines the number of bounces */
  72679. bounces?: number,
  72680. /** Defines the amplitude of the bounce */
  72681. bounciness?: number);
  72682. /** @hidden */
  72683. easeInCore(gradient: number): number;
  72684. }
  72685. /**
  72686. * Easing function with a power of 3 shape (see link below).
  72687. * @see https://easings.net/#easeInCubic
  72688. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72689. */
  72690. export class CubicEase extends EasingFunction implements IEasingFunction {
  72691. /** @hidden */
  72692. easeInCore(gradient: number): number;
  72693. }
  72694. /**
  72695. * Easing function with an elastic shape (see link below).
  72696. * @see https://easings.net/#easeInElastic
  72697. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72698. */
  72699. export class ElasticEase extends EasingFunction implements IEasingFunction {
  72700. /** Defines the number of oscillations*/
  72701. oscillations: number;
  72702. /** Defines the amplitude of the oscillations*/
  72703. springiness: number;
  72704. /**
  72705. * Instantiates an elastic easing function
  72706. * @see https://easings.net/#easeInElastic
  72707. * @param oscillations Defines the number of oscillations
  72708. * @param springiness Defines the amplitude of the oscillations
  72709. */
  72710. constructor(
  72711. /** Defines the number of oscillations*/
  72712. oscillations?: number,
  72713. /** Defines the amplitude of the oscillations*/
  72714. springiness?: number);
  72715. /** @hidden */
  72716. easeInCore(gradient: number): number;
  72717. }
  72718. /**
  72719. * Easing function with an exponential shape (see link below).
  72720. * @see https://easings.net/#easeInExpo
  72721. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72722. */
  72723. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  72724. /** Defines the exponent of the function */
  72725. exponent: number;
  72726. /**
  72727. * Instantiates an exponential easing function
  72728. * @see https://easings.net/#easeInExpo
  72729. * @param exponent Defines the exponent of the function
  72730. */
  72731. constructor(
  72732. /** Defines the exponent of the function */
  72733. exponent?: number);
  72734. /** @hidden */
  72735. easeInCore(gradient: number): number;
  72736. }
  72737. /**
  72738. * Easing function with a power shape (see link below).
  72739. * @see https://easings.net/#easeInQuad
  72740. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72741. */
  72742. export class PowerEase extends EasingFunction implements IEasingFunction {
  72743. /** Defines the power of the function */
  72744. power: number;
  72745. /**
  72746. * Instantiates an power base easing function
  72747. * @see https://easings.net/#easeInQuad
  72748. * @param power Defines the power of the function
  72749. */
  72750. constructor(
  72751. /** Defines the power of the function */
  72752. power?: number);
  72753. /** @hidden */
  72754. easeInCore(gradient: number): number;
  72755. }
  72756. /**
  72757. * Easing function with a power of 2 shape (see link below).
  72758. * @see https://easings.net/#easeInQuad
  72759. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72760. */
  72761. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  72762. /** @hidden */
  72763. easeInCore(gradient: number): number;
  72764. }
  72765. /**
  72766. * Easing function with a power of 4 shape (see link below).
  72767. * @see https://easings.net/#easeInQuart
  72768. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72769. */
  72770. export class QuarticEase extends EasingFunction implements IEasingFunction {
  72771. /** @hidden */
  72772. easeInCore(gradient: number): number;
  72773. }
  72774. /**
  72775. * Easing function with a power of 5 shape (see link below).
  72776. * @see https://easings.net/#easeInQuint
  72777. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72778. */
  72779. export class QuinticEase extends EasingFunction implements IEasingFunction {
  72780. /** @hidden */
  72781. easeInCore(gradient: number): number;
  72782. }
  72783. /**
  72784. * Easing function with a sin shape (see link below).
  72785. * @see https://easings.net/#easeInSine
  72786. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72787. */
  72788. export class SineEase extends EasingFunction implements IEasingFunction {
  72789. /** @hidden */
  72790. easeInCore(gradient: number): number;
  72791. }
  72792. /**
  72793. * Easing function with a bezier shape (see link below).
  72794. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  72795. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72796. */
  72797. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  72798. /** Defines the x component of the start tangent in the bezier curve */
  72799. x1: number;
  72800. /** Defines the y component of the start tangent in the bezier curve */
  72801. y1: number;
  72802. /** Defines the x component of the end tangent in the bezier curve */
  72803. x2: number;
  72804. /** Defines the y component of the end tangent in the bezier curve */
  72805. y2: number;
  72806. /**
  72807. * Instantiates a bezier function
  72808. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  72809. * @param x1 Defines the x component of the start tangent in the bezier curve
  72810. * @param y1 Defines the y component of the start tangent in the bezier curve
  72811. * @param x2 Defines the x component of the end tangent in the bezier curve
  72812. * @param y2 Defines the y component of the end tangent in the bezier curve
  72813. */
  72814. constructor(
  72815. /** Defines the x component of the start tangent in the bezier curve */
  72816. x1?: number,
  72817. /** Defines the y component of the start tangent in the bezier curve */
  72818. y1?: number,
  72819. /** Defines the x component of the end tangent in the bezier curve */
  72820. x2?: number,
  72821. /** Defines the y component of the end tangent in the bezier curve */
  72822. y2?: number);
  72823. /** @hidden */
  72824. easeInCore(gradient: number): number;
  72825. }
  72826. }
  72827. declare module BABYLON {
  72828. /**
  72829. * Class used to hold a RBG color
  72830. */
  72831. export class Color3 {
  72832. /**
  72833. * Defines the red component (between 0 and 1, default is 0)
  72834. */
  72835. r: number;
  72836. /**
  72837. * Defines the green component (between 0 and 1, default is 0)
  72838. */
  72839. g: number;
  72840. /**
  72841. * Defines the blue component (between 0 and 1, default is 0)
  72842. */
  72843. b: number;
  72844. /**
  72845. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  72846. * @param r defines the red component (between 0 and 1, default is 0)
  72847. * @param g defines the green component (between 0 and 1, default is 0)
  72848. * @param b defines the blue component (between 0 and 1, default is 0)
  72849. */
  72850. constructor(
  72851. /**
  72852. * Defines the red component (between 0 and 1, default is 0)
  72853. */
  72854. r?: number,
  72855. /**
  72856. * Defines the green component (between 0 and 1, default is 0)
  72857. */
  72858. g?: number,
  72859. /**
  72860. * Defines the blue component (between 0 and 1, default is 0)
  72861. */
  72862. b?: number);
  72863. /**
  72864. * Creates a string with the Color3 current values
  72865. * @returns the string representation of the Color3 object
  72866. */
  72867. toString(): string;
  72868. /**
  72869. * Returns the string "Color3"
  72870. * @returns "Color3"
  72871. */
  72872. getClassName(): string;
  72873. /**
  72874. * Compute the Color3 hash code
  72875. * @returns an unique number that can be used to hash Color3 objects
  72876. */
  72877. getHashCode(): number;
  72878. /**
  72879. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  72880. * @param array defines the array where to store the r,g,b components
  72881. * @param index defines an optional index in the target array to define where to start storing values
  72882. * @returns the current Color3 object
  72883. */
  72884. toArray(array: FloatArray, index?: number): Color3;
  72885. /**
  72886. * Returns a new Color4 object from the current Color3 and the given alpha
  72887. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  72888. * @returns a new Color4 object
  72889. */
  72890. toColor4(alpha?: number): Color4;
  72891. /**
  72892. * Returns a new array populated with 3 numeric elements : red, green and blue values
  72893. * @returns the new array
  72894. */
  72895. asArray(): number[];
  72896. /**
  72897. * Returns the luminance value
  72898. * @returns a float value
  72899. */
  72900. toLuminance(): number;
  72901. /**
  72902. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  72903. * @param otherColor defines the second operand
  72904. * @returns the new Color3 object
  72905. */
  72906. multiply(otherColor: DeepImmutable<Color3>): Color3;
  72907. /**
  72908. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  72909. * @param otherColor defines the second operand
  72910. * @param result defines the Color3 object where to store the result
  72911. * @returns the current Color3
  72912. */
  72913. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  72914. /**
  72915. * Determines equality between Color3 objects
  72916. * @param otherColor defines the second operand
  72917. * @returns true if the rgb values are equal to the given ones
  72918. */
  72919. equals(otherColor: DeepImmutable<Color3>): boolean;
  72920. /**
  72921. * Determines equality between the current Color3 object and a set of r,b,g values
  72922. * @param r defines the red component to check
  72923. * @param g defines the green component to check
  72924. * @param b defines the blue component to check
  72925. * @returns true if the rgb values are equal to the given ones
  72926. */
  72927. equalsFloats(r: number, g: number, b: number): boolean;
  72928. /**
  72929. * Multiplies in place each rgb value by scale
  72930. * @param scale defines the scaling factor
  72931. * @returns the updated Color3
  72932. */
  72933. scale(scale: number): Color3;
  72934. /**
  72935. * Multiplies the rgb values by scale and stores the result into "result"
  72936. * @param scale defines the scaling factor
  72937. * @param result defines the Color3 object where to store the result
  72938. * @returns the unmodified current Color3
  72939. */
  72940. scaleToRef(scale: number, result: Color3): Color3;
  72941. /**
  72942. * Scale the current Color3 values by a factor and add the result to a given Color3
  72943. * @param scale defines the scale factor
  72944. * @param result defines color to store the result into
  72945. * @returns the unmodified current Color3
  72946. */
  72947. scaleAndAddToRef(scale: number, result: Color3): Color3;
  72948. /**
  72949. * Clamps the rgb values by the min and max values and stores the result into "result"
  72950. * @param min defines minimum clamping value (default is 0)
  72951. * @param max defines maximum clamping value (default is 1)
  72952. * @param result defines color to store the result into
  72953. * @returns the original Color3
  72954. */
  72955. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  72956. /**
  72957. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  72958. * @param otherColor defines the second operand
  72959. * @returns the new Color3
  72960. */
  72961. add(otherColor: DeepImmutable<Color3>): Color3;
  72962. /**
  72963. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  72964. * @param otherColor defines the second operand
  72965. * @param result defines Color3 object to store the result into
  72966. * @returns the unmodified current Color3
  72967. */
  72968. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  72969. /**
  72970. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  72971. * @param otherColor defines the second operand
  72972. * @returns the new Color3
  72973. */
  72974. subtract(otherColor: DeepImmutable<Color3>): Color3;
  72975. /**
  72976. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  72977. * @param otherColor defines the second operand
  72978. * @param result defines Color3 object to store the result into
  72979. * @returns the unmodified current Color3
  72980. */
  72981. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  72982. /**
  72983. * Copy the current object
  72984. * @returns a new Color3 copied the current one
  72985. */
  72986. clone(): Color3;
  72987. /**
  72988. * Copies the rgb values from the source in the current Color3
  72989. * @param source defines the source Color3 object
  72990. * @returns the updated Color3 object
  72991. */
  72992. copyFrom(source: DeepImmutable<Color3>): Color3;
  72993. /**
  72994. * Updates the Color3 rgb values from the given floats
  72995. * @param r defines the red component to read from
  72996. * @param g defines the green component to read from
  72997. * @param b defines the blue component to read from
  72998. * @returns the current Color3 object
  72999. */
  73000. copyFromFloats(r: number, g: number, b: number): Color3;
  73001. /**
  73002. * Updates the Color3 rgb values from the given floats
  73003. * @param r defines the red component to read from
  73004. * @param g defines the green component to read from
  73005. * @param b defines the blue component to read from
  73006. * @returns the current Color3 object
  73007. */
  73008. set(r: number, g: number, b: number): Color3;
  73009. /**
  73010. * Compute the Color3 hexadecimal code as a string
  73011. * @returns a string containing the hexadecimal representation of the Color3 object
  73012. */
  73013. toHexString(): string;
  73014. /**
  73015. * Computes a new Color3 converted from the current one to linear space
  73016. * @returns a new Color3 object
  73017. */
  73018. toLinearSpace(): Color3;
  73019. /**
  73020. * Converts current color in rgb space to HSV values
  73021. * @returns a new color3 representing the HSV values
  73022. */
  73023. toHSV(): Color3;
  73024. /**
  73025. * Converts current color in rgb space to HSV values
  73026. * @param result defines the Color3 where to store the HSV values
  73027. */
  73028. toHSVToRef(result: Color3): void;
  73029. /**
  73030. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  73031. * @param convertedColor defines the Color3 object where to store the linear space version
  73032. * @returns the unmodified Color3
  73033. */
  73034. toLinearSpaceToRef(convertedColor: Color3): Color3;
  73035. /**
  73036. * Computes a new Color3 converted from the current one to gamma space
  73037. * @returns a new Color3 object
  73038. */
  73039. toGammaSpace(): Color3;
  73040. /**
  73041. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  73042. * @param convertedColor defines the Color3 object where to store the gamma space version
  73043. * @returns the unmodified Color3
  73044. */
  73045. toGammaSpaceToRef(convertedColor: Color3): Color3;
  73046. private static _BlackReadOnly;
  73047. /**
  73048. * Convert Hue, saturation and value to a Color3 (RGB)
  73049. * @param hue defines the hue
  73050. * @param saturation defines the saturation
  73051. * @param value defines the value
  73052. * @param result defines the Color3 where to store the RGB values
  73053. */
  73054. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  73055. /**
  73056. * Creates a new Color3 from the string containing valid hexadecimal values
  73057. * @param hex defines a string containing valid hexadecimal values
  73058. * @returns a new Color3 object
  73059. */
  73060. static FromHexString(hex: string): Color3;
  73061. /**
  73062. * Creates a new Color3 from the starting index of the given array
  73063. * @param array defines the source array
  73064. * @param offset defines an offset in the source array
  73065. * @returns a new Color3 object
  73066. */
  73067. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  73068. /**
  73069. * Creates a new Color3 from integer values (< 256)
  73070. * @param r defines the red component to read from (value between 0 and 255)
  73071. * @param g defines the green component to read from (value between 0 and 255)
  73072. * @param b defines the blue component to read from (value between 0 and 255)
  73073. * @returns a new Color3 object
  73074. */
  73075. static FromInts(r: number, g: number, b: number): Color3;
  73076. /**
  73077. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  73078. * @param start defines the start Color3 value
  73079. * @param end defines the end Color3 value
  73080. * @param amount defines the gradient value between start and end
  73081. * @returns a new Color3 object
  73082. */
  73083. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  73084. /**
  73085. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  73086. * @param left defines the start value
  73087. * @param right defines the end value
  73088. * @param amount defines the gradient factor
  73089. * @param result defines the Color3 object where to store the result
  73090. */
  73091. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  73092. /**
  73093. * Returns a Color3 value containing a red color
  73094. * @returns a new Color3 object
  73095. */
  73096. static Red(): Color3;
  73097. /**
  73098. * Returns a Color3 value containing a green color
  73099. * @returns a new Color3 object
  73100. */
  73101. static Green(): Color3;
  73102. /**
  73103. * Returns a Color3 value containing a blue color
  73104. * @returns a new Color3 object
  73105. */
  73106. static Blue(): Color3;
  73107. /**
  73108. * Returns a Color3 value containing a black color
  73109. * @returns a new Color3 object
  73110. */
  73111. static Black(): Color3;
  73112. /**
  73113. * Gets a Color3 value containing a black color that must not be updated
  73114. */
  73115. static readonly BlackReadOnly: DeepImmutable<Color3>;
  73116. /**
  73117. * Returns a Color3 value containing a white color
  73118. * @returns a new Color3 object
  73119. */
  73120. static White(): Color3;
  73121. /**
  73122. * Returns a Color3 value containing a purple color
  73123. * @returns a new Color3 object
  73124. */
  73125. static Purple(): Color3;
  73126. /**
  73127. * Returns a Color3 value containing a magenta color
  73128. * @returns a new Color3 object
  73129. */
  73130. static Magenta(): Color3;
  73131. /**
  73132. * Returns a Color3 value containing a yellow color
  73133. * @returns a new Color3 object
  73134. */
  73135. static Yellow(): Color3;
  73136. /**
  73137. * Returns a Color3 value containing a gray color
  73138. * @returns a new Color3 object
  73139. */
  73140. static Gray(): Color3;
  73141. /**
  73142. * Returns a Color3 value containing a teal color
  73143. * @returns a new Color3 object
  73144. */
  73145. static Teal(): Color3;
  73146. /**
  73147. * Returns a Color3 value containing a random color
  73148. * @returns a new Color3 object
  73149. */
  73150. static Random(): Color3;
  73151. }
  73152. /**
  73153. * Class used to hold a RBGA color
  73154. */
  73155. export class Color4 {
  73156. /**
  73157. * Defines the red component (between 0 and 1, default is 0)
  73158. */
  73159. r: number;
  73160. /**
  73161. * Defines the green component (between 0 and 1, default is 0)
  73162. */
  73163. g: number;
  73164. /**
  73165. * Defines the blue component (between 0 and 1, default is 0)
  73166. */
  73167. b: number;
  73168. /**
  73169. * Defines the alpha component (between 0 and 1, default is 1)
  73170. */
  73171. a: number;
  73172. /**
  73173. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  73174. * @param r defines the red component (between 0 and 1, default is 0)
  73175. * @param g defines the green component (between 0 and 1, default is 0)
  73176. * @param b defines the blue component (between 0 and 1, default is 0)
  73177. * @param a defines the alpha component (between 0 and 1, default is 1)
  73178. */
  73179. constructor(
  73180. /**
  73181. * Defines the red component (between 0 and 1, default is 0)
  73182. */
  73183. r?: number,
  73184. /**
  73185. * Defines the green component (between 0 and 1, default is 0)
  73186. */
  73187. g?: number,
  73188. /**
  73189. * Defines the blue component (between 0 and 1, default is 0)
  73190. */
  73191. b?: number,
  73192. /**
  73193. * Defines the alpha component (between 0 and 1, default is 1)
  73194. */
  73195. a?: number);
  73196. /**
  73197. * Adds in place the given Color4 values to the current Color4 object
  73198. * @param right defines the second operand
  73199. * @returns the current updated Color4 object
  73200. */
  73201. addInPlace(right: DeepImmutable<Color4>): Color4;
  73202. /**
  73203. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  73204. * @returns the new array
  73205. */
  73206. asArray(): number[];
  73207. /**
  73208. * Stores from the starting index in the given array the Color4 successive values
  73209. * @param array defines the array where to store the r,g,b components
  73210. * @param index defines an optional index in the target array to define where to start storing values
  73211. * @returns the current Color4 object
  73212. */
  73213. toArray(array: number[], index?: number): Color4;
  73214. /**
  73215. * Determines equality between Color4 objects
  73216. * @param otherColor defines the second operand
  73217. * @returns true if the rgba values are equal to the given ones
  73218. */
  73219. equals(otherColor: DeepImmutable<Color4>): boolean;
  73220. /**
  73221. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  73222. * @param right defines the second operand
  73223. * @returns a new Color4 object
  73224. */
  73225. add(right: DeepImmutable<Color4>): Color4;
  73226. /**
  73227. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  73228. * @param right defines the second operand
  73229. * @returns a new Color4 object
  73230. */
  73231. subtract(right: DeepImmutable<Color4>): Color4;
  73232. /**
  73233. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  73234. * @param right defines the second operand
  73235. * @param result defines the Color4 object where to store the result
  73236. * @returns the current Color4 object
  73237. */
  73238. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  73239. /**
  73240. * Creates a new Color4 with the current Color4 values multiplied by scale
  73241. * @param scale defines the scaling factor to apply
  73242. * @returns a new Color4 object
  73243. */
  73244. scale(scale: number): Color4;
  73245. /**
  73246. * Multiplies the current Color4 values by scale and stores the result in "result"
  73247. * @param scale defines the scaling factor to apply
  73248. * @param result defines the Color4 object where to store the result
  73249. * @returns the current unmodified Color4
  73250. */
  73251. scaleToRef(scale: number, result: Color4): Color4;
  73252. /**
  73253. * Scale the current Color4 values by a factor and add the result to a given Color4
  73254. * @param scale defines the scale factor
  73255. * @param result defines the Color4 object where to store the result
  73256. * @returns the unmodified current Color4
  73257. */
  73258. scaleAndAddToRef(scale: number, result: Color4): Color4;
  73259. /**
  73260. * Clamps the rgb values by the min and max values and stores the result into "result"
  73261. * @param min defines minimum clamping value (default is 0)
  73262. * @param max defines maximum clamping value (default is 1)
  73263. * @param result defines color to store the result into.
  73264. * @returns the cuurent Color4
  73265. */
  73266. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  73267. /**
  73268. * Multipy an Color4 value by another and return a new Color4 object
  73269. * @param color defines the Color4 value to multiply by
  73270. * @returns a new Color4 object
  73271. */
  73272. multiply(color: Color4): Color4;
  73273. /**
  73274. * Multipy a Color4 value by another and push the result in a reference value
  73275. * @param color defines the Color4 value to multiply by
  73276. * @param result defines the Color4 to fill the result in
  73277. * @returns the result Color4
  73278. */
  73279. multiplyToRef(color: Color4, result: Color4): Color4;
  73280. /**
  73281. * Creates a string with the Color4 current values
  73282. * @returns the string representation of the Color4 object
  73283. */
  73284. toString(): string;
  73285. /**
  73286. * Returns the string "Color4"
  73287. * @returns "Color4"
  73288. */
  73289. getClassName(): string;
  73290. /**
  73291. * Compute the Color4 hash code
  73292. * @returns an unique number that can be used to hash Color4 objects
  73293. */
  73294. getHashCode(): number;
  73295. /**
  73296. * Creates a new Color4 copied from the current one
  73297. * @returns a new Color4 object
  73298. */
  73299. clone(): Color4;
  73300. /**
  73301. * Copies the given Color4 values into the current one
  73302. * @param source defines the source Color4 object
  73303. * @returns the current updated Color4 object
  73304. */
  73305. copyFrom(source: Color4): Color4;
  73306. /**
  73307. * Copies the given float values into the current one
  73308. * @param r defines the red component to read from
  73309. * @param g defines the green component to read from
  73310. * @param b defines the blue component to read from
  73311. * @param a defines the alpha component to read from
  73312. * @returns the current updated Color4 object
  73313. */
  73314. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  73315. /**
  73316. * Copies the given float values into the current one
  73317. * @param r defines the red component to read from
  73318. * @param g defines the green component to read from
  73319. * @param b defines the blue component to read from
  73320. * @param a defines the alpha component to read from
  73321. * @returns the current updated Color4 object
  73322. */
  73323. set(r: number, g: number, b: number, a: number): Color4;
  73324. /**
  73325. * Compute the Color4 hexadecimal code as a string
  73326. * @returns a string containing the hexadecimal representation of the Color4 object
  73327. */
  73328. toHexString(): string;
  73329. /**
  73330. * Computes a new Color4 converted from the current one to linear space
  73331. * @returns a new Color4 object
  73332. */
  73333. toLinearSpace(): Color4;
  73334. /**
  73335. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  73336. * @param convertedColor defines the Color4 object where to store the linear space version
  73337. * @returns the unmodified Color4
  73338. */
  73339. toLinearSpaceToRef(convertedColor: Color4): Color4;
  73340. /**
  73341. * Computes a new Color4 converted from the current one to gamma space
  73342. * @returns a new Color4 object
  73343. */
  73344. toGammaSpace(): Color4;
  73345. /**
  73346. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  73347. * @param convertedColor defines the Color4 object where to store the gamma space version
  73348. * @returns the unmodified Color4
  73349. */
  73350. toGammaSpaceToRef(convertedColor: Color4): Color4;
  73351. /**
  73352. * Creates a new Color4 from the string containing valid hexadecimal values
  73353. * @param hex defines a string containing valid hexadecimal values
  73354. * @returns a new Color4 object
  73355. */
  73356. static FromHexString(hex: string): Color4;
  73357. /**
  73358. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  73359. * @param left defines the start value
  73360. * @param right defines the end value
  73361. * @param amount defines the gradient factor
  73362. * @returns a new Color4 object
  73363. */
  73364. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  73365. /**
  73366. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  73367. * @param left defines the start value
  73368. * @param right defines the end value
  73369. * @param amount defines the gradient factor
  73370. * @param result defines the Color4 object where to store data
  73371. */
  73372. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  73373. /**
  73374. * Creates a new Color4 from a Color3 and an alpha value
  73375. * @param color3 defines the source Color3 to read from
  73376. * @param alpha defines the alpha component (1.0 by default)
  73377. * @returns a new Color4 object
  73378. */
  73379. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  73380. /**
  73381. * Creates a new Color4 from the starting index element of the given array
  73382. * @param array defines the source array to read from
  73383. * @param offset defines the offset in the source array
  73384. * @returns a new Color4 object
  73385. */
  73386. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  73387. /**
  73388. * Creates a new Color3 from integer values (< 256)
  73389. * @param r defines the red component to read from (value between 0 and 255)
  73390. * @param g defines the green component to read from (value between 0 and 255)
  73391. * @param b defines the blue component to read from (value between 0 and 255)
  73392. * @param a defines the alpha component to read from (value between 0 and 255)
  73393. * @returns a new Color3 object
  73394. */
  73395. static FromInts(r: number, g: number, b: number, a: number): Color4;
  73396. /**
  73397. * Check the content of a given array and convert it to an array containing RGBA data
  73398. * If the original array was already containing count * 4 values then it is returned directly
  73399. * @param colors defines the array to check
  73400. * @param count defines the number of RGBA data to expect
  73401. * @returns an array containing count * 4 values (RGBA)
  73402. */
  73403. static CheckColors4(colors: number[], count: number): number[];
  73404. }
  73405. /**
  73406. * @hidden
  73407. */
  73408. export class TmpColors {
  73409. static Color3: Color3[];
  73410. static Color4: Color4[];
  73411. }
  73412. }
  73413. declare module BABYLON {
  73414. /**
  73415. * Defines an interface which represents an animation key frame
  73416. */
  73417. export interface IAnimationKey {
  73418. /**
  73419. * Frame of the key frame
  73420. */
  73421. frame: number;
  73422. /**
  73423. * Value at the specifies key frame
  73424. */
  73425. value: any;
  73426. /**
  73427. * The input tangent for the cubic hermite spline
  73428. */
  73429. inTangent?: any;
  73430. /**
  73431. * The output tangent for the cubic hermite spline
  73432. */
  73433. outTangent?: any;
  73434. /**
  73435. * The animation interpolation type
  73436. */
  73437. interpolation?: AnimationKeyInterpolation;
  73438. }
  73439. /**
  73440. * Enum for the animation key frame interpolation type
  73441. */
  73442. export enum AnimationKeyInterpolation {
  73443. /**
  73444. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  73445. */
  73446. STEP = 1
  73447. }
  73448. }
  73449. declare module BABYLON {
  73450. /**
  73451. * Represents the range of an animation
  73452. */
  73453. export class AnimationRange {
  73454. /**The name of the animation range**/
  73455. name: string;
  73456. /**The starting frame of the animation */
  73457. from: number;
  73458. /**The ending frame of the animation*/
  73459. to: number;
  73460. /**
  73461. * Initializes the range of an animation
  73462. * @param name The name of the animation range
  73463. * @param from The starting frame of the animation
  73464. * @param to The ending frame of the animation
  73465. */
  73466. constructor(
  73467. /**The name of the animation range**/
  73468. name: string,
  73469. /**The starting frame of the animation */
  73470. from: number,
  73471. /**The ending frame of the animation*/
  73472. to: number);
  73473. /**
  73474. * Makes a copy of the animation range
  73475. * @returns A copy of the animation range
  73476. */
  73477. clone(): AnimationRange;
  73478. }
  73479. }
  73480. declare module BABYLON {
  73481. /**
  73482. * Composed of a frame, and an action function
  73483. */
  73484. export class AnimationEvent {
  73485. /** The frame for which the event is triggered **/
  73486. frame: number;
  73487. /** The event to perform when triggered **/
  73488. action: (currentFrame: number) => void;
  73489. /** Specifies if the event should be triggered only once**/
  73490. onlyOnce?: boolean | undefined;
  73491. /**
  73492. * Specifies if the animation event is done
  73493. */
  73494. isDone: boolean;
  73495. /**
  73496. * Initializes the animation event
  73497. * @param frame The frame for which the event is triggered
  73498. * @param action The event to perform when triggered
  73499. * @param onlyOnce Specifies if the event should be triggered only once
  73500. */
  73501. constructor(
  73502. /** The frame for which the event is triggered **/
  73503. frame: number,
  73504. /** The event to perform when triggered **/
  73505. action: (currentFrame: number) => void,
  73506. /** Specifies if the event should be triggered only once**/
  73507. onlyOnce?: boolean | undefined);
  73508. /** @hidden */
  73509. _clone(): AnimationEvent;
  73510. }
  73511. }
  73512. declare module BABYLON {
  73513. /**
  73514. * Interface used to define a behavior
  73515. */
  73516. export interface Behavior<T> {
  73517. /** gets or sets behavior's name */
  73518. name: string;
  73519. /**
  73520. * Function called when the behavior needs to be initialized (after attaching it to a target)
  73521. */
  73522. init(): void;
  73523. /**
  73524. * Called when the behavior is attached to a target
  73525. * @param target defines the target where the behavior is attached to
  73526. */
  73527. attach(target: T): void;
  73528. /**
  73529. * Called when the behavior is detached from its target
  73530. */
  73531. detach(): void;
  73532. }
  73533. /**
  73534. * Interface implemented by classes supporting behaviors
  73535. */
  73536. export interface IBehaviorAware<T> {
  73537. /**
  73538. * Attach a behavior
  73539. * @param behavior defines the behavior to attach
  73540. * @returns the current host
  73541. */
  73542. addBehavior(behavior: Behavior<T>): T;
  73543. /**
  73544. * Remove a behavior from the current object
  73545. * @param behavior defines the behavior to detach
  73546. * @returns the current host
  73547. */
  73548. removeBehavior(behavior: Behavior<T>): T;
  73549. /**
  73550. * Gets a behavior using its name to search
  73551. * @param name defines the name to search
  73552. * @returns the behavior or null if not found
  73553. */
  73554. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  73555. }
  73556. }
  73557. declare module BABYLON {
  73558. /**
  73559. * Defines an array and its length.
  73560. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  73561. */
  73562. export interface ISmartArrayLike<T> {
  73563. /**
  73564. * The data of the array.
  73565. */
  73566. data: Array<T>;
  73567. /**
  73568. * The active length of the array.
  73569. */
  73570. length: number;
  73571. }
  73572. /**
  73573. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  73574. */
  73575. export class SmartArray<T> implements ISmartArrayLike<T> {
  73576. /**
  73577. * The full set of data from the array.
  73578. */
  73579. data: Array<T>;
  73580. /**
  73581. * The active length of the array.
  73582. */
  73583. length: number;
  73584. protected _id: number;
  73585. /**
  73586. * Instantiates a Smart Array.
  73587. * @param capacity defines the default capacity of the array.
  73588. */
  73589. constructor(capacity: number);
  73590. /**
  73591. * Pushes a value at the end of the active data.
  73592. * @param value defines the object to push in the array.
  73593. */
  73594. push(value: T): void;
  73595. /**
  73596. * Iterates over the active data and apply the lambda to them.
  73597. * @param func defines the action to apply on each value.
  73598. */
  73599. forEach(func: (content: T) => void): void;
  73600. /**
  73601. * Sorts the full sets of data.
  73602. * @param compareFn defines the comparison function to apply.
  73603. */
  73604. sort(compareFn: (a: T, b: T) => number): void;
  73605. /**
  73606. * Resets the active data to an empty array.
  73607. */
  73608. reset(): void;
  73609. /**
  73610. * Releases all the data from the array as well as the array.
  73611. */
  73612. dispose(): void;
  73613. /**
  73614. * Concats the active data with a given array.
  73615. * @param array defines the data to concatenate with.
  73616. */
  73617. concat(array: any): void;
  73618. /**
  73619. * Returns the position of a value in the active data.
  73620. * @param value defines the value to find the index for
  73621. * @returns the index if found in the active data otherwise -1
  73622. */
  73623. indexOf(value: T): number;
  73624. /**
  73625. * Returns whether an element is part of the active data.
  73626. * @param value defines the value to look for
  73627. * @returns true if found in the active data otherwise false
  73628. */
  73629. contains(value: T): boolean;
  73630. private static _GlobalId;
  73631. }
  73632. /**
  73633. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  73634. * The data in this array can only be present once
  73635. */
  73636. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  73637. private _duplicateId;
  73638. /**
  73639. * Pushes a value at the end of the active data.
  73640. * THIS DOES NOT PREVENT DUPPLICATE DATA
  73641. * @param value defines the object to push in the array.
  73642. */
  73643. push(value: T): void;
  73644. /**
  73645. * Pushes a value at the end of the active data.
  73646. * If the data is already present, it won t be added again
  73647. * @param value defines the object to push in the array.
  73648. * @returns true if added false if it was already present
  73649. */
  73650. pushNoDuplicate(value: T): boolean;
  73651. /**
  73652. * Resets the active data to an empty array.
  73653. */
  73654. reset(): void;
  73655. /**
  73656. * Concats the active data with a given array.
  73657. * This ensures no dupplicate will be present in the result.
  73658. * @param array defines the data to concatenate with.
  73659. */
  73660. concatWithNoDuplicate(array: any): void;
  73661. }
  73662. }
  73663. declare module BABYLON {
  73664. /**
  73665. * @ignore
  73666. * This is a list of all the different input types that are available in the application.
  73667. * Fo instance: ArcRotateCameraGamepadInput...
  73668. */
  73669. export var CameraInputTypes: {};
  73670. /**
  73671. * This is the contract to implement in order to create a new input class.
  73672. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  73673. */
  73674. export interface ICameraInput<TCamera extends Camera> {
  73675. /**
  73676. * Defines the camera the input is attached to.
  73677. */
  73678. camera: Nullable<TCamera>;
  73679. /**
  73680. * Gets the class name of the current intput.
  73681. * @returns the class name
  73682. */
  73683. getClassName(): string;
  73684. /**
  73685. * Get the friendly name associated with the input class.
  73686. * @returns the input friendly name
  73687. */
  73688. getSimpleName(): string;
  73689. /**
  73690. * Attach the input controls to a specific dom element to get the input from.
  73691. * @param element Defines the element the controls should be listened from
  73692. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  73693. */
  73694. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  73695. /**
  73696. * Detach the current controls from the specified dom element.
  73697. * @param element Defines the element to stop listening the inputs from
  73698. */
  73699. detachControl(element: Nullable<HTMLElement>): void;
  73700. /**
  73701. * Update the current camera state depending on the inputs that have been used this frame.
  73702. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  73703. */
  73704. checkInputs?: () => void;
  73705. }
  73706. /**
  73707. * Represents a map of input types to input instance or input index to input instance.
  73708. */
  73709. export interface CameraInputsMap<TCamera extends Camera> {
  73710. /**
  73711. * Accessor to the input by input type.
  73712. */
  73713. [name: string]: ICameraInput<TCamera>;
  73714. /**
  73715. * Accessor to the input by input index.
  73716. */
  73717. [idx: number]: ICameraInput<TCamera>;
  73718. }
  73719. /**
  73720. * This represents the input manager used within a camera.
  73721. * It helps dealing with all the different kind of input attached to a camera.
  73722. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  73723. */
  73724. export class CameraInputsManager<TCamera extends Camera> {
  73725. /**
  73726. * Defines the list of inputs attahed to the camera.
  73727. */
  73728. attached: CameraInputsMap<TCamera>;
  73729. /**
  73730. * Defines the dom element the camera is collecting inputs from.
  73731. * This is null if the controls have not been attached.
  73732. */
  73733. attachedElement: Nullable<HTMLElement>;
  73734. /**
  73735. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  73736. */
  73737. noPreventDefault: boolean;
  73738. /**
  73739. * Defined the camera the input manager belongs to.
  73740. */
  73741. camera: TCamera;
  73742. /**
  73743. * Update the current camera state depending on the inputs that have been used this frame.
  73744. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  73745. */
  73746. checkInputs: () => void;
  73747. /**
  73748. * Instantiate a new Camera Input Manager.
  73749. * @param camera Defines the camera the input manager blongs to
  73750. */
  73751. constructor(camera: TCamera);
  73752. /**
  73753. * Add an input method to a camera
  73754. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  73755. * @param input camera input method
  73756. */
  73757. add(input: ICameraInput<TCamera>): void;
  73758. /**
  73759. * Remove a specific input method from a camera
  73760. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  73761. * @param inputToRemove camera input method
  73762. */
  73763. remove(inputToRemove: ICameraInput<TCamera>): void;
  73764. /**
  73765. * Remove a specific input type from a camera
  73766. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  73767. * @param inputType the type of the input to remove
  73768. */
  73769. removeByType(inputType: string): void;
  73770. private _addCheckInputs;
  73771. /**
  73772. * Attach the input controls to the currently attached dom element to listen the events from.
  73773. * @param input Defines the input to attach
  73774. */
  73775. attachInput(input: ICameraInput<TCamera>): void;
  73776. /**
  73777. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  73778. * @param element Defines the dom element to collect the events from
  73779. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  73780. */
  73781. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  73782. /**
  73783. * Detach the current manager inputs controls from a specific dom element.
  73784. * @param element Defines the dom element to collect the events from
  73785. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  73786. */
  73787. detachElement(element: HTMLElement, disconnect?: boolean): void;
  73788. /**
  73789. * Rebuild the dynamic inputCheck function from the current list of
  73790. * defined inputs in the manager.
  73791. */
  73792. rebuildInputCheck(): void;
  73793. /**
  73794. * Remove all attached input methods from a camera
  73795. */
  73796. clear(): void;
  73797. /**
  73798. * Serialize the current input manager attached to a camera.
  73799. * This ensures than once parsed,
  73800. * the input associated to the camera will be identical to the current ones
  73801. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  73802. */
  73803. serialize(serializedCamera: any): void;
  73804. /**
  73805. * Parses an input manager serialized JSON to restore the previous list of inputs
  73806. * and states associated to a camera.
  73807. * @param parsedCamera Defines the JSON to parse
  73808. */
  73809. parse(parsedCamera: any): void;
  73810. }
  73811. }
  73812. declare module BABYLON {
  73813. /**
  73814. * Class used to store data that will be store in GPU memory
  73815. */
  73816. export class Buffer {
  73817. private _engine;
  73818. private _buffer;
  73819. /** @hidden */
  73820. _data: Nullable<DataArray>;
  73821. private _updatable;
  73822. private _instanced;
  73823. private _divisor;
  73824. /**
  73825. * Gets the byte stride.
  73826. */
  73827. readonly byteStride: number;
  73828. /**
  73829. * Constructor
  73830. * @param engine the engine
  73831. * @param data the data to use for this buffer
  73832. * @param updatable whether the data is updatable
  73833. * @param stride the stride (optional)
  73834. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  73835. * @param instanced whether the buffer is instanced (optional)
  73836. * @param useBytes set to true if the stride in in bytes (optional)
  73837. * @param divisor sets an optional divisor for instances (1 by default)
  73838. */
  73839. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  73840. /**
  73841. * Create a new VertexBuffer based on the current buffer
  73842. * @param kind defines the vertex buffer kind (position, normal, etc.)
  73843. * @param offset defines offset in the buffer (0 by default)
  73844. * @param size defines the size in floats of attributes (position is 3 for instance)
  73845. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  73846. * @param instanced defines if the vertex buffer contains indexed data
  73847. * @param useBytes defines if the offset and stride are in bytes *
  73848. * @param divisor sets an optional divisor for instances (1 by default)
  73849. * @returns the new vertex buffer
  73850. */
  73851. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  73852. /**
  73853. * Gets a boolean indicating if the Buffer is updatable?
  73854. * @returns true if the buffer is updatable
  73855. */
  73856. isUpdatable(): boolean;
  73857. /**
  73858. * Gets current buffer's data
  73859. * @returns a DataArray or null
  73860. */
  73861. getData(): Nullable<DataArray>;
  73862. /**
  73863. * Gets underlying native buffer
  73864. * @returns underlying native buffer
  73865. */
  73866. getBuffer(): Nullable<DataBuffer>;
  73867. /**
  73868. * Gets the stride in float32 units (i.e. byte stride / 4).
  73869. * May not be an integer if the byte stride is not divisible by 4.
  73870. * DEPRECATED. Use byteStride instead.
  73871. * @returns the stride in float32 units
  73872. */
  73873. getStrideSize(): number;
  73874. /**
  73875. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  73876. * @param data defines the data to store
  73877. */
  73878. create(data?: Nullable<DataArray>): void;
  73879. /** @hidden */
  73880. _rebuild(): void;
  73881. /**
  73882. * Update current buffer data
  73883. * @param data defines the data to store
  73884. */
  73885. update(data: DataArray): void;
  73886. /**
  73887. * Updates the data directly.
  73888. * @param data the new data
  73889. * @param offset the new offset
  73890. * @param vertexCount the vertex count (optional)
  73891. * @param useBytes set to true if the offset is in bytes
  73892. */
  73893. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  73894. /**
  73895. * Release all resources
  73896. */
  73897. dispose(): void;
  73898. }
  73899. /**
  73900. * Specialized buffer used to store vertex data
  73901. */
  73902. export class VertexBuffer {
  73903. /** @hidden */
  73904. _buffer: Buffer;
  73905. private _kind;
  73906. private _size;
  73907. private _ownsBuffer;
  73908. private _instanced;
  73909. private _instanceDivisor;
  73910. /**
  73911. * The byte type.
  73912. */
  73913. static readonly BYTE: number;
  73914. /**
  73915. * The unsigned byte type.
  73916. */
  73917. static readonly UNSIGNED_BYTE: number;
  73918. /**
  73919. * The short type.
  73920. */
  73921. static readonly SHORT: number;
  73922. /**
  73923. * The unsigned short type.
  73924. */
  73925. static readonly UNSIGNED_SHORT: number;
  73926. /**
  73927. * The integer type.
  73928. */
  73929. static readonly INT: number;
  73930. /**
  73931. * The unsigned integer type.
  73932. */
  73933. static readonly UNSIGNED_INT: number;
  73934. /**
  73935. * The float type.
  73936. */
  73937. static readonly FLOAT: number;
  73938. /**
  73939. * Gets or sets the instance divisor when in instanced mode
  73940. */
  73941. instanceDivisor: number;
  73942. /**
  73943. * Gets the byte stride.
  73944. */
  73945. readonly byteStride: number;
  73946. /**
  73947. * Gets the byte offset.
  73948. */
  73949. readonly byteOffset: number;
  73950. /**
  73951. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  73952. */
  73953. readonly normalized: boolean;
  73954. /**
  73955. * Gets the data type of each component in the array.
  73956. */
  73957. readonly type: number;
  73958. /**
  73959. * Constructor
  73960. * @param engine the engine
  73961. * @param data the data to use for this vertex buffer
  73962. * @param kind the vertex buffer kind
  73963. * @param updatable whether the data is updatable
  73964. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  73965. * @param stride the stride (optional)
  73966. * @param instanced whether the buffer is instanced (optional)
  73967. * @param offset the offset of the data (optional)
  73968. * @param size the number of components (optional)
  73969. * @param type the type of the component (optional)
  73970. * @param normalized whether the data contains normalized data (optional)
  73971. * @param useBytes set to true if stride and offset are in bytes (optional)
  73972. * @param divisor defines the instance divisor to use (1 by default)
  73973. */
  73974. 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);
  73975. /** @hidden */
  73976. _rebuild(): void;
  73977. /**
  73978. * Returns the kind of the VertexBuffer (string)
  73979. * @returns a string
  73980. */
  73981. getKind(): string;
  73982. /**
  73983. * Gets a boolean indicating if the VertexBuffer is updatable?
  73984. * @returns true if the buffer is updatable
  73985. */
  73986. isUpdatable(): boolean;
  73987. /**
  73988. * Gets current buffer's data
  73989. * @returns a DataArray or null
  73990. */
  73991. getData(): Nullable<DataArray>;
  73992. /**
  73993. * Gets underlying native buffer
  73994. * @returns underlying native buffer
  73995. */
  73996. getBuffer(): Nullable<DataBuffer>;
  73997. /**
  73998. * Gets the stride in float32 units (i.e. byte stride / 4).
  73999. * May not be an integer if the byte stride is not divisible by 4.
  74000. * DEPRECATED. Use byteStride instead.
  74001. * @returns the stride in float32 units
  74002. */
  74003. getStrideSize(): number;
  74004. /**
  74005. * Returns the offset as a multiple of the type byte length.
  74006. * DEPRECATED. Use byteOffset instead.
  74007. * @returns the offset in bytes
  74008. */
  74009. getOffset(): number;
  74010. /**
  74011. * Returns the number of components per vertex attribute (integer)
  74012. * @returns the size in float
  74013. */
  74014. getSize(): number;
  74015. /**
  74016. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  74017. * @returns true if this buffer is instanced
  74018. */
  74019. getIsInstanced(): boolean;
  74020. /**
  74021. * Returns the instancing divisor, zero for non-instanced (integer).
  74022. * @returns a number
  74023. */
  74024. getInstanceDivisor(): number;
  74025. /**
  74026. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  74027. * @param data defines the data to store
  74028. */
  74029. create(data?: DataArray): void;
  74030. /**
  74031. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  74032. * This function will create a new buffer if the current one is not updatable
  74033. * @param data defines the data to store
  74034. */
  74035. update(data: DataArray): void;
  74036. /**
  74037. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  74038. * Returns the directly updated WebGLBuffer.
  74039. * @param data the new data
  74040. * @param offset the new offset
  74041. * @param useBytes set to true if the offset is in bytes
  74042. */
  74043. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  74044. /**
  74045. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  74046. */
  74047. dispose(): void;
  74048. /**
  74049. * Enumerates each value of this vertex buffer as numbers.
  74050. * @param count the number of values to enumerate
  74051. * @param callback the callback function called for each value
  74052. */
  74053. forEach(count: number, callback: (value: number, index: number) => void): void;
  74054. /**
  74055. * Positions
  74056. */
  74057. static readonly PositionKind: string;
  74058. /**
  74059. * Normals
  74060. */
  74061. static readonly NormalKind: string;
  74062. /**
  74063. * Tangents
  74064. */
  74065. static readonly TangentKind: string;
  74066. /**
  74067. * Texture coordinates
  74068. */
  74069. static readonly UVKind: string;
  74070. /**
  74071. * Texture coordinates 2
  74072. */
  74073. static readonly UV2Kind: string;
  74074. /**
  74075. * Texture coordinates 3
  74076. */
  74077. static readonly UV3Kind: string;
  74078. /**
  74079. * Texture coordinates 4
  74080. */
  74081. static readonly UV4Kind: string;
  74082. /**
  74083. * Texture coordinates 5
  74084. */
  74085. static readonly UV5Kind: string;
  74086. /**
  74087. * Texture coordinates 6
  74088. */
  74089. static readonly UV6Kind: string;
  74090. /**
  74091. * Colors
  74092. */
  74093. static readonly ColorKind: string;
  74094. /**
  74095. * Matrix indices (for bones)
  74096. */
  74097. static readonly MatricesIndicesKind: string;
  74098. /**
  74099. * Matrix weights (for bones)
  74100. */
  74101. static readonly MatricesWeightsKind: string;
  74102. /**
  74103. * Additional matrix indices (for bones)
  74104. */
  74105. static readonly MatricesIndicesExtraKind: string;
  74106. /**
  74107. * Additional matrix weights (for bones)
  74108. */
  74109. static readonly MatricesWeightsExtraKind: string;
  74110. /**
  74111. * Deduces the stride given a kind.
  74112. * @param kind The kind string to deduce
  74113. * @returns The deduced stride
  74114. */
  74115. static DeduceStride(kind: string): number;
  74116. /**
  74117. * Gets the byte length of the given type.
  74118. * @param type the type
  74119. * @returns the number of bytes
  74120. */
  74121. static GetTypeByteLength(type: number): number;
  74122. /**
  74123. * Enumerates each value of the given parameters as numbers.
  74124. * @param data the data to enumerate
  74125. * @param byteOffset the byte offset of the data
  74126. * @param byteStride the byte stride of the data
  74127. * @param componentCount the number of components per element
  74128. * @param componentType the type of the component
  74129. * @param count the number of values to enumerate
  74130. * @param normalized whether the data is normalized
  74131. * @param callback the callback function called for each value
  74132. */
  74133. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  74134. private static _GetFloatValue;
  74135. }
  74136. }
  74137. declare module BABYLON {
  74138. /**
  74139. * @hidden
  74140. */
  74141. export class IntersectionInfo {
  74142. bu: Nullable<number>;
  74143. bv: Nullable<number>;
  74144. distance: number;
  74145. faceId: number;
  74146. subMeshId: number;
  74147. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  74148. }
  74149. }
  74150. declare module BABYLON {
  74151. /**
  74152. * Represens a plane by the equation ax + by + cz + d = 0
  74153. */
  74154. export class Plane {
  74155. private static _TmpMatrix;
  74156. /**
  74157. * Normal of the plane (a,b,c)
  74158. */
  74159. normal: Vector3;
  74160. /**
  74161. * d component of the plane
  74162. */
  74163. d: number;
  74164. /**
  74165. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  74166. * @param a a component of the plane
  74167. * @param b b component of the plane
  74168. * @param c c component of the plane
  74169. * @param d d component of the plane
  74170. */
  74171. constructor(a: number, b: number, c: number, d: number);
  74172. /**
  74173. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  74174. */
  74175. asArray(): number[];
  74176. /**
  74177. * @returns a new plane copied from the current Plane.
  74178. */
  74179. clone(): Plane;
  74180. /**
  74181. * @returns the string "Plane".
  74182. */
  74183. getClassName(): string;
  74184. /**
  74185. * @returns the Plane hash code.
  74186. */
  74187. getHashCode(): number;
  74188. /**
  74189. * Normalize the current Plane in place.
  74190. * @returns the updated Plane.
  74191. */
  74192. normalize(): Plane;
  74193. /**
  74194. * Applies a transformation the plane and returns the result
  74195. * @param transformation the transformation matrix to be applied to the plane
  74196. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  74197. */
  74198. transform(transformation: DeepImmutable<Matrix>): Plane;
  74199. /**
  74200. * Calcualtte the dot product between the point and the plane normal
  74201. * @param point point to calculate the dot product with
  74202. * @returns the dot product (float) of the point coordinates and the plane normal.
  74203. */
  74204. dotCoordinate(point: DeepImmutable<Vector3>): number;
  74205. /**
  74206. * Updates the current Plane from the plane defined by the three given points.
  74207. * @param point1 one of the points used to contruct the plane
  74208. * @param point2 one of the points used to contruct the plane
  74209. * @param point3 one of the points used to contruct the plane
  74210. * @returns the updated Plane.
  74211. */
  74212. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  74213. /**
  74214. * Checks if the plane is facing a given direction
  74215. * @param direction the direction to check if the plane is facing
  74216. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  74217. * @returns True is the vector "direction" is the same side than the plane normal.
  74218. */
  74219. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  74220. /**
  74221. * Calculates the distance to a point
  74222. * @param point point to calculate distance to
  74223. * @returns the signed distance (float) from the given point to the Plane.
  74224. */
  74225. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  74226. /**
  74227. * Creates a plane from an array
  74228. * @param array the array to create a plane from
  74229. * @returns a new Plane from the given array.
  74230. */
  74231. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  74232. /**
  74233. * Creates a plane from three points
  74234. * @param point1 point used to create the plane
  74235. * @param point2 point used to create the plane
  74236. * @param point3 point used to create the plane
  74237. * @returns a new Plane defined by the three given points.
  74238. */
  74239. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  74240. /**
  74241. * Creates a plane from an origin point and a normal
  74242. * @param origin origin of the plane to be constructed
  74243. * @param normal normal of the plane to be constructed
  74244. * @returns a new Plane the normal vector to this plane at the given origin point.
  74245. * Note : the vector "normal" is updated because normalized.
  74246. */
  74247. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): Plane;
  74248. /**
  74249. * Calculates the distance from a plane and a point
  74250. * @param origin origin of the plane to be constructed
  74251. * @param normal normal of the plane to be constructed
  74252. * @param point point to calculate distance to
  74253. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  74254. */
  74255. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  74256. }
  74257. }
  74258. declare module BABYLON {
  74259. /**
  74260. * Class used to store bounding sphere information
  74261. */
  74262. export class BoundingSphere {
  74263. /**
  74264. * Gets the center of the bounding sphere in local space
  74265. */
  74266. readonly center: Vector3;
  74267. /**
  74268. * Radius of the bounding sphere in local space
  74269. */
  74270. radius: number;
  74271. /**
  74272. * Gets the center of the bounding sphere in world space
  74273. */
  74274. readonly centerWorld: Vector3;
  74275. /**
  74276. * Radius of the bounding sphere in world space
  74277. */
  74278. radiusWorld: number;
  74279. /**
  74280. * Gets the minimum vector in local space
  74281. */
  74282. readonly minimum: Vector3;
  74283. /**
  74284. * Gets the maximum vector in local space
  74285. */
  74286. readonly maximum: Vector3;
  74287. private _worldMatrix;
  74288. private static readonly TmpVector3;
  74289. /**
  74290. * Creates a new bounding sphere
  74291. * @param min defines the minimum vector (in local space)
  74292. * @param max defines the maximum vector (in local space)
  74293. * @param worldMatrix defines the new world matrix
  74294. */
  74295. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  74296. /**
  74297. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  74298. * @param min defines the new minimum vector (in local space)
  74299. * @param max defines the new maximum vector (in local space)
  74300. * @param worldMatrix defines the new world matrix
  74301. */
  74302. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  74303. /**
  74304. * Scale the current bounding sphere by applying a scale factor
  74305. * @param factor defines the scale factor to apply
  74306. * @returns the current bounding box
  74307. */
  74308. scale(factor: number): BoundingSphere;
  74309. /**
  74310. * Gets the world matrix of the bounding box
  74311. * @returns a matrix
  74312. */
  74313. getWorldMatrix(): DeepImmutable<Matrix>;
  74314. /** @hidden */
  74315. _update(worldMatrix: DeepImmutable<Matrix>): void;
  74316. /**
  74317. * Tests if the bounding sphere is intersecting the frustum planes
  74318. * @param frustumPlanes defines the frustum planes to test
  74319. * @returns true if there is an intersection
  74320. */
  74321. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74322. /**
  74323. * Tests if the bounding sphere center is in between the frustum planes.
  74324. * Used for optimistic fast inclusion.
  74325. * @param frustumPlanes defines the frustum planes to test
  74326. * @returns true if the sphere center is in between the frustum planes
  74327. */
  74328. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74329. /**
  74330. * Tests if a point is inside the bounding sphere
  74331. * @param point defines the point to test
  74332. * @returns true if the point is inside the bounding sphere
  74333. */
  74334. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  74335. /**
  74336. * Checks if two sphere intersct
  74337. * @param sphere0 sphere 0
  74338. * @param sphere1 sphere 1
  74339. * @returns true if the speres intersect
  74340. */
  74341. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  74342. }
  74343. }
  74344. declare module BABYLON {
  74345. /**
  74346. * Class used to store bounding box information
  74347. */
  74348. export class BoundingBox implements ICullable {
  74349. /**
  74350. * Gets the 8 vectors representing the bounding box in local space
  74351. */
  74352. readonly vectors: Vector3[];
  74353. /**
  74354. * Gets the center of the bounding box in local space
  74355. */
  74356. readonly center: Vector3;
  74357. /**
  74358. * Gets the center of the bounding box in world space
  74359. */
  74360. readonly centerWorld: Vector3;
  74361. /**
  74362. * Gets the extend size in local space
  74363. */
  74364. readonly extendSize: Vector3;
  74365. /**
  74366. * Gets the extend size in world space
  74367. */
  74368. readonly extendSizeWorld: Vector3;
  74369. /**
  74370. * Gets the OBB (object bounding box) directions
  74371. */
  74372. readonly directions: Vector3[];
  74373. /**
  74374. * Gets the 8 vectors representing the bounding box in world space
  74375. */
  74376. readonly vectorsWorld: Vector3[];
  74377. /**
  74378. * Gets the minimum vector in world space
  74379. */
  74380. readonly minimumWorld: Vector3;
  74381. /**
  74382. * Gets the maximum vector in world space
  74383. */
  74384. readonly maximumWorld: Vector3;
  74385. /**
  74386. * Gets the minimum vector in local space
  74387. */
  74388. readonly minimum: Vector3;
  74389. /**
  74390. * Gets the maximum vector in local space
  74391. */
  74392. readonly maximum: Vector3;
  74393. private _worldMatrix;
  74394. private static readonly TmpVector3;
  74395. /**
  74396. * @hidden
  74397. */
  74398. _tag: number;
  74399. /**
  74400. * Creates a new bounding box
  74401. * @param min defines the minimum vector (in local space)
  74402. * @param max defines the maximum vector (in local space)
  74403. * @param worldMatrix defines the new world matrix
  74404. */
  74405. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  74406. /**
  74407. * Recreates the entire bounding box from scratch as if we call the constructor in place
  74408. * @param min defines the new minimum vector (in local space)
  74409. * @param max defines the new maximum vector (in local space)
  74410. * @param worldMatrix defines the new world matrix
  74411. */
  74412. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  74413. /**
  74414. * Scale the current bounding box by applying a scale factor
  74415. * @param factor defines the scale factor to apply
  74416. * @returns the current bounding box
  74417. */
  74418. scale(factor: number): BoundingBox;
  74419. /**
  74420. * Gets the world matrix of the bounding box
  74421. * @returns a matrix
  74422. */
  74423. getWorldMatrix(): DeepImmutable<Matrix>;
  74424. /** @hidden */
  74425. _update(world: DeepImmutable<Matrix>): void;
  74426. /**
  74427. * Tests if the bounding box is intersecting the frustum planes
  74428. * @param frustumPlanes defines the frustum planes to test
  74429. * @returns true if there is an intersection
  74430. */
  74431. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74432. /**
  74433. * Tests if the bounding box is entirely inside the frustum planes
  74434. * @param frustumPlanes defines the frustum planes to test
  74435. * @returns true if there is an inclusion
  74436. */
  74437. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74438. /**
  74439. * Tests if a point is inside the bounding box
  74440. * @param point defines the point to test
  74441. * @returns true if the point is inside the bounding box
  74442. */
  74443. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  74444. /**
  74445. * Tests if the bounding box intersects with a bounding sphere
  74446. * @param sphere defines the sphere to test
  74447. * @returns true if there is an intersection
  74448. */
  74449. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  74450. /**
  74451. * Tests if the bounding box intersects with a box defined by a min and max vectors
  74452. * @param min defines the min vector to use
  74453. * @param max defines the max vector to use
  74454. * @returns true if there is an intersection
  74455. */
  74456. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  74457. /**
  74458. * Tests if two bounding boxes are intersections
  74459. * @param box0 defines the first box to test
  74460. * @param box1 defines the second box to test
  74461. * @returns true if there is an intersection
  74462. */
  74463. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  74464. /**
  74465. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  74466. * @param minPoint defines the minimum vector of the bounding box
  74467. * @param maxPoint defines the maximum vector of the bounding box
  74468. * @param sphereCenter defines the sphere center
  74469. * @param sphereRadius defines the sphere radius
  74470. * @returns true if there is an intersection
  74471. */
  74472. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  74473. /**
  74474. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  74475. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  74476. * @param frustumPlanes defines the frustum planes to test
  74477. * @return true if there is an inclusion
  74478. */
  74479. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74480. /**
  74481. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  74482. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  74483. * @param frustumPlanes defines the frustum planes to test
  74484. * @return true if there is an intersection
  74485. */
  74486. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74487. }
  74488. }
  74489. declare module BABYLON {
  74490. /** @hidden */
  74491. export class Collider {
  74492. /** Define if a collision was found */
  74493. collisionFound: boolean;
  74494. /**
  74495. * Define last intersection point in local space
  74496. */
  74497. intersectionPoint: Vector3;
  74498. /**
  74499. * Define last collided mesh
  74500. */
  74501. collidedMesh: Nullable<AbstractMesh>;
  74502. private _collisionPoint;
  74503. private _planeIntersectionPoint;
  74504. private _tempVector;
  74505. private _tempVector2;
  74506. private _tempVector3;
  74507. private _tempVector4;
  74508. private _edge;
  74509. private _baseToVertex;
  74510. private _destinationPoint;
  74511. private _slidePlaneNormal;
  74512. private _displacementVector;
  74513. /** @hidden */
  74514. _radius: Vector3;
  74515. /** @hidden */
  74516. _retry: number;
  74517. private _velocity;
  74518. private _basePoint;
  74519. private _epsilon;
  74520. /** @hidden */
  74521. _velocityWorldLength: number;
  74522. /** @hidden */
  74523. _basePointWorld: Vector3;
  74524. private _velocityWorld;
  74525. private _normalizedVelocity;
  74526. /** @hidden */
  74527. _initialVelocity: Vector3;
  74528. /** @hidden */
  74529. _initialPosition: Vector3;
  74530. private _nearestDistance;
  74531. private _collisionMask;
  74532. collisionMask: number;
  74533. /**
  74534. * Gets the plane normal used to compute the sliding response (in local space)
  74535. */
  74536. readonly slidePlaneNormal: Vector3;
  74537. /** @hidden */
  74538. _initialize(source: Vector3, dir: Vector3, e: number): void;
  74539. /** @hidden */
  74540. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  74541. /** @hidden */
  74542. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  74543. /** @hidden */
  74544. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  74545. /** @hidden */
  74546. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  74547. /** @hidden */
  74548. _getResponse(pos: Vector3, vel: Vector3): void;
  74549. }
  74550. }
  74551. declare module BABYLON {
  74552. /**
  74553. * Interface for cullable objects
  74554. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  74555. */
  74556. export interface ICullable {
  74557. /**
  74558. * Checks if the object or part of the object is in the frustum
  74559. * @param frustumPlanes Camera near/planes
  74560. * @returns true if the object is in frustum otherwise false
  74561. */
  74562. isInFrustum(frustumPlanes: Plane[]): boolean;
  74563. /**
  74564. * Checks if a cullable object (mesh...) is in the camera frustum
  74565. * Unlike isInFrustum this cheks the full bounding box
  74566. * @param frustumPlanes Camera near/planes
  74567. * @returns true if the object is in frustum otherwise false
  74568. */
  74569. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  74570. }
  74571. /**
  74572. * Info for a bounding data of a mesh
  74573. */
  74574. export class BoundingInfo implements ICullable {
  74575. /**
  74576. * Bounding box for the mesh
  74577. */
  74578. readonly boundingBox: BoundingBox;
  74579. /**
  74580. * Bounding sphere for the mesh
  74581. */
  74582. readonly boundingSphere: BoundingSphere;
  74583. private _isLocked;
  74584. private static readonly TmpVector3;
  74585. /**
  74586. * Constructs bounding info
  74587. * @param minimum min vector of the bounding box/sphere
  74588. * @param maximum max vector of the bounding box/sphere
  74589. * @param worldMatrix defines the new world matrix
  74590. */
  74591. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  74592. /**
  74593. * Recreates the entire bounding info from scratch as if we call the constructor in place
  74594. * @param min defines the new minimum vector (in local space)
  74595. * @param max defines the new maximum vector (in local space)
  74596. * @param worldMatrix defines the new world matrix
  74597. */
  74598. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  74599. /**
  74600. * min vector of the bounding box/sphere
  74601. */
  74602. readonly minimum: Vector3;
  74603. /**
  74604. * max vector of the bounding box/sphere
  74605. */
  74606. readonly maximum: Vector3;
  74607. /**
  74608. * If the info is locked and won't be updated to avoid perf overhead
  74609. */
  74610. isLocked: boolean;
  74611. /**
  74612. * Updates the bounding sphere and box
  74613. * @param world world matrix to be used to update
  74614. */
  74615. update(world: DeepImmutable<Matrix>): void;
  74616. /**
  74617. * Recreate the bounding info to be centered around a specific point given a specific extend.
  74618. * @param center New center of the bounding info
  74619. * @param extend New extend of the bounding info
  74620. * @returns the current bounding info
  74621. */
  74622. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  74623. /**
  74624. * Scale the current bounding info by applying a scale factor
  74625. * @param factor defines the scale factor to apply
  74626. * @returns the current bounding info
  74627. */
  74628. scale(factor: number): BoundingInfo;
  74629. /**
  74630. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  74631. * @param frustumPlanes defines the frustum to test
  74632. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  74633. * @returns true if the bounding info is in the frustum planes
  74634. */
  74635. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  74636. /**
  74637. * Gets the world distance between the min and max points of the bounding box
  74638. */
  74639. readonly diagonalLength: number;
  74640. /**
  74641. * Checks if a cullable object (mesh...) is in the camera frustum
  74642. * Unlike isInFrustum this cheks the full bounding box
  74643. * @param frustumPlanes Camera near/planes
  74644. * @returns true if the object is in frustum otherwise false
  74645. */
  74646. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74647. /** @hidden */
  74648. _checkCollision(collider: Collider): boolean;
  74649. /**
  74650. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  74651. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  74652. * @param point the point to check intersection with
  74653. * @returns if the point intersects
  74654. */
  74655. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  74656. /**
  74657. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  74658. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  74659. * @param boundingInfo the bounding info to check intersection with
  74660. * @param precise if the intersection should be done using OBB
  74661. * @returns if the bounding info intersects
  74662. */
  74663. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  74664. }
  74665. }
  74666. declare module BABYLON {
  74667. /**
  74668. * Extracts minimum and maximum values from a list of indexed positions
  74669. * @param positions defines the positions to use
  74670. * @param indices defines the indices to the positions
  74671. * @param indexStart defines the start index
  74672. * @param indexCount defines the end index
  74673. * @param bias defines bias value to add to the result
  74674. * @return minimum and maximum values
  74675. */
  74676. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  74677. minimum: Vector3;
  74678. maximum: Vector3;
  74679. };
  74680. /**
  74681. * Extracts minimum and maximum values from a list of positions
  74682. * @param positions defines the positions to use
  74683. * @param start defines the start index in the positions array
  74684. * @param count defines the number of positions to handle
  74685. * @param bias defines bias value to add to the result
  74686. * @param stride defines the stride size to use (distance between two positions in the positions array)
  74687. * @return minimum and maximum values
  74688. */
  74689. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  74690. minimum: Vector3;
  74691. maximum: Vector3;
  74692. };
  74693. }
  74694. declare module BABYLON {
  74695. /** @hidden */
  74696. export class WebGLDataBuffer extends DataBuffer {
  74697. private _buffer;
  74698. constructor(resource: WebGLBuffer);
  74699. readonly underlyingResource: any;
  74700. }
  74701. }
  74702. declare module BABYLON {
  74703. /** @hidden */
  74704. export class WebGLPipelineContext implements IPipelineContext {
  74705. engine: ThinEngine;
  74706. program: Nullable<WebGLProgram>;
  74707. context?: WebGLRenderingContext;
  74708. vertexShader?: WebGLShader;
  74709. fragmentShader?: WebGLShader;
  74710. isParallelCompiled: boolean;
  74711. onCompiled?: () => void;
  74712. transformFeedback?: WebGLTransformFeedback | null;
  74713. readonly isAsync: boolean;
  74714. readonly isReady: boolean;
  74715. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  74716. }
  74717. }
  74718. declare module BABYLON {
  74719. interface ThinEngine {
  74720. /**
  74721. * Create an uniform buffer
  74722. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  74723. * @param elements defines the content of the uniform buffer
  74724. * @returns the webGL uniform buffer
  74725. */
  74726. createUniformBuffer(elements: FloatArray): DataBuffer;
  74727. /**
  74728. * Create a dynamic uniform buffer
  74729. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  74730. * @param elements defines the content of the uniform buffer
  74731. * @returns the webGL uniform buffer
  74732. */
  74733. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  74734. /**
  74735. * Update an existing uniform buffer
  74736. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  74737. * @param uniformBuffer defines the target uniform buffer
  74738. * @param elements defines the content to update
  74739. * @param offset defines the offset in the uniform buffer where update should start
  74740. * @param count defines the size of the data to update
  74741. */
  74742. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  74743. /**
  74744. * Bind an uniform buffer to the current webGL context
  74745. * @param buffer defines the buffer to bind
  74746. */
  74747. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  74748. /**
  74749. * Bind a buffer to the current webGL context at a given location
  74750. * @param buffer defines the buffer to bind
  74751. * @param location defines the index where to bind the buffer
  74752. */
  74753. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  74754. /**
  74755. * Bind a specific block at a given index in a specific shader program
  74756. * @param pipelineContext defines the pipeline context to use
  74757. * @param blockName defines the block name
  74758. * @param index defines the index where to bind the block
  74759. */
  74760. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  74761. }
  74762. }
  74763. declare module BABYLON {
  74764. /**
  74765. * Uniform buffer objects.
  74766. *
  74767. * Handles blocks of uniform on the GPU.
  74768. *
  74769. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  74770. *
  74771. * For more information, please refer to :
  74772. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  74773. */
  74774. export class UniformBuffer {
  74775. private _engine;
  74776. private _buffer;
  74777. private _data;
  74778. private _bufferData;
  74779. private _dynamic?;
  74780. private _uniformLocations;
  74781. private _uniformSizes;
  74782. private _uniformLocationPointer;
  74783. private _needSync;
  74784. private _noUBO;
  74785. private _currentEffect;
  74786. /** @hidden */
  74787. _alreadyBound: boolean;
  74788. private static _MAX_UNIFORM_SIZE;
  74789. private static _tempBuffer;
  74790. /**
  74791. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  74792. * This is dynamic to allow compat with webgl 1 and 2.
  74793. * You will need to pass the name of the uniform as well as the value.
  74794. */
  74795. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  74796. /**
  74797. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  74798. * This is dynamic to allow compat with webgl 1 and 2.
  74799. * You will need to pass the name of the uniform as well as the value.
  74800. */
  74801. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  74802. /**
  74803. * Lambda to Update a single float in a uniform buffer.
  74804. * This is dynamic to allow compat with webgl 1 and 2.
  74805. * You will need to pass the name of the uniform as well as the value.
  74806. */
  74807. updateFloat: (name: string, x: number) => void;
  74808. /**
  74809. * Lambda to Update a vec2 of float in a uniform buffer.
  74810. * This is dynamic to allow compat with webgl 1 and 2.
  74811. * You will need to pass the name of the uniform as well as the value.
  74812. */
  74813. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  74814. /**
  74815. * Lambda to Update a vec3 of float in a uniform buffer.
  74816. * This is dynamic to allow compat with webgl 1 and 2.
  74817. * You will need to pass the name of the uniform as well as the value.
  74818. */
  74819. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  74820. /**
  74821. * Lambda to Update a vec4 of float in a uniform buffer.
  74822. * This is dynamic to allow compat with webgl 1 and 2.
  74823. * You will need to pass the name of the uniform as well as the value.
  74824. */
  74825. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  74826. /**
  74827. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  74828. * This is dynamic to allow compat with webgl 1 and 2.
  74829. * You will need to pass the name of the uniform as well as the value.
  74830. */
  74831. updateMatrix: (name: string, mat: Matrix) => void;
  74832. /**
  74833. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  74834. * This is dynamic to allow compat with webgl 1 and 2.
  74835. * You will need to pass the name of the uniform as well as the value.
  74836. */
  74837. updateVector3: (name: string, vector: Vector3) => void;
  74838. /**
  74839. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  74840. * This is dynamic to allow compat with webgl 1 and 2.
  74841. * You will need to pass the name of the uniform as well as the value.
  74842. */
  74843. updateVector4: (name: string, vector: Vector4) => void;
  74844. /**
  74845. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  74846. * This is dynamic to allow compat with webgl 1 and 2.
  74847. * You will need to pass the name of the uniform as well as the value.
  74848. */
  74849. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  74850. /**
  74851. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  74852. * This is dynamic to allow compat with webgl 1 and 2.
  74853. * You will need to pass the name of the uniform as well as the value.
  74854. */
  74855. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  74856. /**
  74857. * Instantiates a new Uniform buffer objects.
  74858. *
  74859. * Handles blocks of uniform on the GPU.
  74860. *
  74861. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  74862. *
  74863. * For more information, please refer to :
  74864. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  74865. * @param engine Define the engine the buffer is associated with
  74866. * @param data Define the data contained in the buffer
  74867. * @param dynamic Define if the buffer is updatable
  74868. */
  74869. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  74870. /**
  74871. * Indicates if the buffer is using the WebGL2 UBO implementation,
  74872. * or just falling back on setUniformXXX calls.
  74873. */
  74874. readonly useUbo: boolean;
  74875. /**
  74876. * Indicates if the WebGL underlying uniform buffer is in sync
  74877. * with the javascript cache data.
  74878. */
  74879. readonly isSync: boolean;
  74880. /**
  74881. * Indicates if the WebGL underlying uniform buffer is dynamic.
  74882. * Also, a dynamic UniformBuffer will disable cache verification and always
  74883. * update the underlying WebGL uniform buffer to the GPU.
  74884. * @returns if Dynamic, otherwise false
  74885. */
  74886. isDynamic(): boolean;
  74887. /**
  74888. * The data cache on JS side.
  74889. * @returns the underlying data as a float array
  74890. */
  74891. getData(): Float32Array;
  74892. /**
  74893. * The underlying WebGL Uniform buffer.
  74894. * @returns the webgl buffer
  74895. */
  74896. getBuffer(): Nullable<DataBuffer>;
  74897. /**
  74898. * std140 layout specifies how to align data within an UBO structure.
  74899. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  74900. * for specs.
  74901. */
  74902. private _fillAlignment;
  74903. /**
  74904. * Adds an uniform in the buffer.
  74905. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  74906. * for the layout to be correct !
  74907. * @param name Name of the uniform, as used in the uniform block in the shader.
  74908. * @param size Data size, or data directly.
  74909. */
  74910. addUniform(name: string, size: number | number[]): void;
  74911. /**
  74912. * Adds a Matrix 4x4 to the uniform buffer.
  74913. * @param name Name of the uniform, as used in the uniform block in the shader.
  74914. * @param mat A 4x4 matrix.
  74915. */
  74916. addMatrix(name: string, mat: Matrix): void;
  74917. /**
  74918. * Adds a vec2 to the uniform buffer.
  74919. * @param name Name of the uniform, as used in the uniform block in the shader.
  74920. * @param x Define the x component value of the vec2
  74921. * @param y Define the y component value of the vec2
  74922. */
  74923. addFloat2(name: string, x: number, y: number): void;
  74924. /**
  74925. * Adds a vec3 to the uniform buffer.
  74926. * @param name Name of the uniform, as used in the uniform block in the shader.
  74927. * @param x Define the x component value of the vec3
  74928. * @param y Define the y component value of the vec3
  74929. * @param z Define the z component value of the vec3
  74930. */
  74931. addFloat3(name: string, x: number, y: number, z: number): void;
  74932. /**
  74933. * Adds a vec3 to the uniform buffer.
  74934. * @param name Name of the uniform, as used in the uniform block in the shader.
  74935. * @param color Define the vec3 from a Color
  74936. */
  74937. addColor3(name: string, color: Color3): void;
  74938. /**
  74939. * Adds a vec4 to the uniform buffer.
  74940. * @param name Name of the uniform, as used in the uniform block in the shader.
  74941. * @param color Define the rgb components from a Color
  74942. * @param alpha Define the a component of the vec4
  74943. */
  74944. addColor4(name: string, color: Color3, alpha: number): void;
  74945. /**
  74946. * Adds a vec3 to the uniform buffer.
  74947. * @param name Name of the uniform, as used in the uniform block in the shader.
  74948. * @param vector Define the vec3 components from a Vector
  74949. */
  74950. addVector3(name: string, vector: Vector3): void;
  74951. /**
  74952. * Adds a Matrix 3x3 to the uniform buffer.
  74953. * @param name Name of the uniform, as used in the uniform block in the shader.
  74954. */
  74955. addMatrix3x3(name: string): void;
  74956. /**
  74957. * Adds a Matrix 2x2 to the uniform buffer.
  74958. * @param name Name of the uniform, as used in the uniform block in the shader.
  74959. */
  74960. addMatrix2x2(name: string): void;
  74961. /**
  74962. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  74963. */
  74964. create(): void;
  74965. /** @hidden */
  74966. _rebuild(): void;
  74967. /**
  74968. * Updates the WebGL Uniform Buffer on the GPU.
  74969. * If the `dynamic` flag is set to true, no cache comparison is done.
  74970. * Otherwise, the buffer will be updated only if the cache differs.
  74971. */
  74972. update(): void;
  74973. /**
  74974. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  74975. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  74976. * @param data Define the flattened data
  74977. * @param size Define the size of the data.
  74978. */
  74979. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  74980. private _valueCache;
  74981. private _cacheMatrix;
  74982. private _updateMatrix3x3ForUniform;
  74983. private _updateMatrix3x3ForEffect;
  74984. private _updateMatrix2x2ForEffect;
  74985. private _updateMatrix2x2ForUniform;
  74986. private _updateFloatForEffect;
  74987. private _updateFloatForUniform;
  74988. private _updateFloat2ForEffect;
  74989. private _updateFloat2ForUniform;
  74990. private _updateFloat3ForEffect;
  74991. private _updateFloat3ForUniform;
  74992. private _updateFloat4ForEffect;
  74993. private _updateFloat4ForUniform;
  74994. private _updateMatrixForEffect;
  74995. private _updateMatrixForUniform;
  74996. private _updateVector3ForEffect;
  74997. private _updateVector3ForUniform;
  74998. private _updateVector4ForEffect;
  74999. private _updateVector4ForUniform;
  75000. private _updateColor3ForEffect;
  75001. private _updateColor3ForUniform;
  75002. private _updateColor4ForEffect;
  75003. private _updateColor4ForUniform;
  75004. /**
  75005. * Sets a sampler uniform on the effect.
  75006. * @param name Define the name of the sampler.
  75007. * @param texture Define the texture to set in the sampler
  75008. */
  75009. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  75010. /**
  75011. * Directly updates the value of the uniform in the cache AND on the GPU.
  75012. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  75013. * @param data Define the flattened data
  75014. */
  75015. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  75016. /**
  75017. * Binds this uniform buffer to an effect.
  75018. * @param effect Define the effect to bind the buffer to
  75019. * @param name Name of the uniform block in the shader.
  75020. */
  75021. bindToEffect(effect: Effect, name: string): void;
  75022. /**
  75023. * Disposes the uniform buffer.
  75024. */
  75025. dispose(): void;
  75026. }
  75027. }
  75028. declare module BABYLON {
  75029. /**
  75030. * Enum that determines the text-wrapping mode to use.
  75031. */
  75032. export enum InspectableType {
  75033. /**
  75034. * Checkbox for booleans
  75035. */
  75036. Checkbox = 0,
  75037. /**
  75038. * Sliders for numbers
  75039. */
  75040. Slider = 1,
  75041. /**
  75042. * Vector3
  75043. */
  75044. Vector3 = 2,
  75045. /**
  75046. * Quaternions
  75047. */
  75048. Quaternion = 3,
  75049. /**
  75050. * Color3
  75051. */
  75052. Color3 = 4,
  75053. /**
  75054. * String
  75055. */
  75056. String = 5
  75057. }
  75058. /**
  75059. * Interface used to define custom inspectable properties.
  75060. * This interface is used by the inspector to display custom property grids
  75061. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  75062. */
  75063. export interface IInspectable {
  75064. /**
  75065. * Gets the label to display
  75066. */
  75067. label: string;
  75068. /**
  75069. * Gets the name of the property to edit
  75070. */
  75071. propertyName: string;
  75072. /**
  75073. * Gets the type of the editor to use
  75074. */
  75075. type: InspectableType;
  75076. /**
  75077. * Gets the minimum value of the property when using in "slider" mode
  75078. */
  75079. min?: number;
  75080. /**
  75081. * Gets the maximum value of the property when using in "slider" mode
  75082. */
  75083. max?: number;
  75084. /**
  75085. * Gets the setp to use when using in "slider" mode
  75086. */
  75087. step?: number;
  75088. }
  75089. }
  75090. declare module BABYLON {
  75091. /**
  75092. * Class used to provide helper for timing
  75093. */
  75094. export class TimingTools {
  75095. /**
  75096. * Polyfill for setImmediate
  75097. * @param action defines the action to execute after the current execution block
  75098. */
  75099. static SetImmediate(action: () => void): void;
  75100. }
  75101. }
  75102. declare module BABYLON {
  75103. /**
  75104. * Class used to enable instatition of objects by class name
  75105. */
  75106. export class InstantiationTools {
  75107. /**
  75108. * Use this object to register external classes like custom textures or material
  75109. * to allow the laoders to instantiate them
  75110. */
  75111. static RegisteredExternalClasses: {
  75112. [key: string]: Object;
  75113. };
  75114. /**
  75115. * Tries to instantiate a new object from a given class name
  75116. * @param className defines the class name to instantiate
  75117. * @returns the new object or null if the system was not able to do the instantiation
  75118. */
  75119. static Instantiate(className: string): any;
  75120. }
  75121. }
  75122. declare module BABYLON {
  75123. /**
  75124. * Define options used to create a depth texture
  75125. */
  75126. export class DepthTextureCreationOptions {
  75127. /** Specifies whether or not a stencil should be allocated in the texture */
  75128. generateStencil?: boolean;
  75129. /** Specifies whether or not bilinear filtering is enable on the texture */
  75130. bilinearFiltering?: boolean;
  75131. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  75132. comparisonFunction?: number;
  75133. /** Specifies if the created texture is a cube texture */
  75134. isCube?: boolean;
  75135. }
  75136. }
  75137. declare module BABYLON {
  75138. interface ThinEngine {
  75139. /**
  75140. * Creates a depth stencil cube texture.
  75141. * This is only available in WebGL 2.
  75142. * @param size The size of face edge in the cube texture.
  75143. * @param options The options defining the cube texture.
  75144. * @returns The cube texture
  75145. */
  75146. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  75147. /**
  75148. * Creates a cube texture
  75149. * @param rootUrl defines the url where the files to load is located
  75150. * @param scene defines the current scene
  75151. * @param files defines the list of files to load (1 per face)
  75152. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75153. * @param onLoad defines an optional callback raised when the texture is loaded
  75154. * @param onError defines an optional callback raised if there is an issue to load the texture
  75155. * @param format defines the format of the data
  75156. * @param forcedExtension defines the extension to use to pick the right loader
  75157. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  75158. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  75159. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  75160. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  75161. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (defualt: empty array)
  75162. * @returns the cube texture as an InternalTexture
  75163. */
  75164. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean | undefined, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number, fallback: Nullable<InternalTexture>, excludeLoaders: Array<IInternalTextureLoader>): InternalTexture;
  75165. /**
  75166. * Creates a cube texture
  75167. * @param rootUrl defines the url where the files to load is located
  75168. * @param scene defines the current scene
  75169. * @param files defines the list of files to load (1 per face)
  75170. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75171. * @param onLoad defines an optional callback raised when the texture is loaded
  75172. * @param onError defines an optional callback raised if there is an issue to load the texture
  75173. * @param format defines the format of the data
  75174. * @param forcedExtension defines the extension to use to pick the right loader
  75175. * @returns the cube texture as an InternalTexture
  75176. */
  75177. 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;
  75178. /**
  75179. * Creates a cube texture
  75180. * @param rootUrl defines the url where the files to load is located
  75181. * @param scene defines the current scene
  75182. * @param files defines the list of files to load (1 per face)
  75183. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75184. * @param onLoad defines an optional callback raised when the texture is loaded
  75185. * @param onError defines an optional callback raised if there is an issue to load the texture
  75186. * @param format defines the format of the data
  75187. * @param forcedExtension defines the extension to use to pick the right loader
  75188. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  75189. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  75190. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  75191. * @returns the cube texture as an InternalTexture
  75192. */
  75193. 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;
  75194. /** @hidden */
  75195. _partialLoadFile(url: string, index: number, loadedFiles: (string | ArrayBuffer)[], onfinish: (files: (string | ArrayBuffer)[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  75196. /** @hidden */
  75197. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: (string | ArrayBuffer)[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  75198. /** @hidden */
  75199. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  75200. /** @hidden */
  75201. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  75202. /**
  75203. * @hidden
  75204. */
  75205. _setCubeMapTextureParams(loadMipmap: boolean): void;
  75206. }
  75207. }
  75208. declare module BABYLON {
  75209. /**
  75210. * Class for creating a cube texture
  75211. */
  75212. export class CubeTexture extends BaseTexture {
  75213. private _delayedOnLoad;
  75214. /**
  75215. * The url of the texture
  75216. */
  75217. url: string;
  75218. /**
  75219. * Gets or sets the center of the bounding box associated with the cube texture.
  75220. * It must define where the camera used to render the texture was set
  75221. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  75222. */
  75223. boundingBoxPosition: Vector3;
  75224. private _boundingBoxSize;
  75225. /**
  75226. * Gets or sets the size of the bounding box associated with the cube texture
  75227. * When defined, the cubemap will switch to local mode
  75228. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  75229. * @example https://www.babylonjs-playground.com/#RNASML
  75230. */
  75231. /**
  75232. * Returns the bounding box size
  75233. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  75234. */
  75235. boundingBoxSize: Vector3;
  75236. protected _rotationY: number;
  75237. /**
  75238. * Sets texture matrix rotation angle around Y axis in radians.
  75239. */
  75240. /**
  75241. * Gets texture matrix rotation angle around Y axis radians.
  75242. */
  75243. rotationY: number;
  75244. /**
  75245. * Are mip maps generated for this texture or not.
  75246. */
  75247. readonly noMipmap: boolean;
  75248. private _noMipmap;
  75249. private _files;
  75250. protected _forcedExtension: Nullable<string>;
  75251. private _extensions;
  75252. private _textureMatrix;
  75253. private _format;
  75254. private _createPolynomials;
  75255. /** @hidden */
  75256. _prefiltered: boolean;
  75257. /**
  75258. * Creates a cube texture from an array of image urls
  75259. * @param files defines an array of image urls
  75260. * @param scene defines the hosting scene
  75261. * @param noMipmap specifies if mip maps are not used
  75262. * @returns a cube texture
  75263. */
  75264. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  75265. /**
  75266. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  75267. * @param url defines the url of the prefiltered texture
  75268. * @param scene defines the scene the texture is attached to
  75269. * @param forcedExtension defines the extension of the file if different from the url
  75270. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  75271. * @return the prefiltered texture
  75272. */
  75273. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  75274. /**
  75275. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  75276. * as prefiltered data.
  75277. * @param rootUrl defines the url of the texture or the root name of the six images
  75278. * @param scene defines the scene the texture is attached to
  75279. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  75280. * @param noMipmap defines if mipmaps should be created or not
  75281. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  75282. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  75283. * @param onError defines a callback triggered in case of error during load
  75284. * @param format defines the internal format to use for the texture once loaded
  75285. * @param prefiltered defines whether or not the texture is created from prefiltered data
  75286. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  75287. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  75288. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  75289. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  75290. * @return the cube texture
  75291. */
  75292. constructor(rootUrl: string, scene: Scene, extensions?: Nullable<string[]>, noMipmap?: boolean, files?: Nullable<string[]>, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, prefiltered?: boolean, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number);
  75293. /**
  75294. * Gets a boolean indicating if the cube texture contains prefiltered mips (used to simulate roughness with PBR)
  75295. */
  75296. readonly isPrefiltered: boolean;
  75297. /**
  75298. * Get the current class name of the texture useful for serialization or dynamic coding.
  75299. * @returns "CubeTexture"
  75300. */
  75301. getClassName(): string;
  75302. /**
  75303. * Update the url (and optional buffer) of this texture if url was null during construction.
  75304. * @param url the url of the texture
  75305. * @param forcedExtension defines the extension to use
  75306. * @param onLoad callback called when the texture is loaded (defaults to null)
  75307. */
  75308. updateURL(url: string, forcedExtension?: string, onLoad?: () => void): void;
  75309. /**
  75310. * Delays loading of the cube texture
  75311. * @param forcedExtension defines the extension to use
  75312. */
  75313. delayLoad(forcedExtension?: string): void;
  75314. /**
  75315. * Returns the reflection texture matrix
  75316. * @returns the reflection texture matrix
  75317. */
  75318. getReflectionTextureMatrix(): Matrix;
  75319. /**
  75320. * Sets the reflection texture matrix
  75321. * @param value Reflection texture matrix
  75322. */
  75323. setReflectionTextureMatrix(value: Matrix): void;
  75324. /**
  75325. * Parses text to create a cube texture
  75326. * @param parsedTexture define the serialized text to read from
  75327. * @param scene defines the hosting scene
  75328. * @param rootUrl defines the root url of the cube texture
  75329. * @returns a cube texture
  75330. */
  75331. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  75332. /**
  75333. * Makes a clone, or deep copy, of the cube texture
  75334. * @returns a new cube texture
  75335. */
  75336. clone(): CubeTexture;
  75337. }
  75338. }
  75339. declare module BABYLON {
  75340. /**
  75341. * Manages the defines for the Material
  75342. */
  75343. export class MaterialDefines {
  75344. /** @hidden */
  75345. protected _keys: string[];
  75346. private _isDirty;
  75347. /** @hidden */
  75348. _renderId: number;
  75349. /** @hidden */
  75350. _areLightsDirty: boolean;
  75351. /** @hidden */
  75352. _areLightsDisposed: boolean;
  75353. /** @hidden */
  75354. _areAttributesDirty: boolean;
  75355. /** @hidden */
  75356. _areTexturesDirty: boolean;
  75357. /** @hidden */
  75358. _areFresnelDirty: boolean;
  75359. /** @hidden */
  75360. _areMiscDirty: boolean;
  75361. /** @hidden */
  75362. _areImageProcessingDirty: boolean;
  75363. /** @hidden */
  75364. _normals: boolean;
  75365. /** @hidden */
  75366. _uvs: boolean;
  75367. /** @hidden */
  75368. _needNormals: boolean;
  75369. /** @hidden */
  75370. _needUVs: boolean;
  75371. [id: string]: any;
  75372. /**
  75373. * Specifies if the material needs to be re-calculated
  75374. */
  75375. readonly isDirty: boolean;
  75376. /**
  75377. * Marks the material to indicate that it has been re-calculated
  75378. */
  75379. markAsProcessed(): void;
  75380. /**
  75381. * Marks the material to indicate that it needs to be re-calculated
  75382. */
  75383. markAsUnprocessed(): void;
  75384. /**
  75385. * Marks the material to indicate all of its defines need to be re-calculated
  75386. */
  75387. markAllAsDirty(): void;
  75388. /**
  75389. * Marks the material to indicate that image processing needs to be re-calculated
  75390. */
  75391. markAsImageProcessingDirty(): void;
  75392. /**
  75393. * Marks the material to indicate the lights need to be re-calculated
  75394. * @param disposed Defines whether the light is dirty due to dispose or not
  75395. */
  75396. markAsLightDirty(disposed?: boolean): void;
  75397. /**
  75398. * Marks the attribute state as changed
  75399. */
  75400. markAsAttributesDirty(): void;
  75401. /**
  75402. * Marks the texture state as changed
  75403. */
  75404. markAsTexturesDirty(): void;
  75405. /**
  75406. * Marks the fresnel state as changed
  75407. */
  75408. markAsFresnelDirty(): void;
  75409. /**
  75410. * Marks the misc state as changed
  75411. */
  75412. markAsMiscDirty(): void;
  75413. /**
  75414. * Rebuilds the material defines
  75415. */
  75416. rebuild(): void;
  75417. /**
  75418. * Specifies if two material defines are equal
  75419. * @param other - A material define instance to compare to
  75420. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  75421. */
  75422. isEqual(other: MaterialDefines): boolean;
  75423. /**
  75424. * Clones this instance's defines to another instance
  75425. * @param other - material defines to clone values to
  75426. */
  75427. cloneTo(other: MaterialDefines): void;
  75428. /**
  75429. * Resets the material define values
  75430. */
  75431. reset(): void;
  75432. /**
  75433. * Converts the material define values to a string
  75434. * @returns - String of material define information
  75435. */
  75436. toString(): string;
  75437. }
  75438. }
  75439. declare module BABYLON {
  75440. /**
  75441. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  75442. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  75443. * 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;
  75444. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  75445. */
  75446. export class ColorCurves {
  75447. private _dirty;
  75448. private _tempColor;
  75449. private _globalCurve;
  75450. private _highlightsCurve;
  75451. private _midtonesCurve;
  75452. private _shadowsCurve;
  75453. private _positiveCurve;
  75454. private _negativeCurve;
  75455. private _globalHue;
  75456. private _globalDensity;
  75457. private _globalSaturation;
  75458. private _globalExposure;
  75459. /**
  75460. * Gets the global Hue value.
  75461. * 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).
  75462. */
  75463. /**
  75464. * Sets the global Hue value.
  75465. * 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).
  75466. */
  75467. globalHue: number;
  75468. /**
  75469. * Gets the global Density value.
  75470. * 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.
  75471. * Values less than zero provide a filter of opposite hue.
  75472. */
  75473. /**
  75474. * Sets the global Density value.
  75475. * 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.
  75476. * Values less than zero provide a filter of opposite hue.
  75477. */
  75478. globalDensity: number;
  75479. /**
  75480. * Gets the global Saturation value.
  75481. * 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.
  75482. */
  75483. /**
  75484. * Sets the global Saturation value.
  75485. * 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.
  75486. */
  75487. globalSaturation: number;
  75488. /**
  75489. * Gets the global Exposure value.
  75490. * 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.
  75491. */
  75492. /**
  75493. * Sets the global Exposure value.
  75494. * 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.
  75495. */
  75496. globalExposure: number;
  75497. private _highlightsHue;
  75498. private _highlightsDensity;
  75499. private _highlightsSaturation;
  75500. private _highlightsExposure;
  75501. /**
  75502. * Gets the highlights Hue value.
  75503. * 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).
  75504. */
  75505. /**
  75506. * Sets the highlights Hue value.
  75507. * 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).
  75508. */
  75509. highlightsHue: number;
  75510. /**
  75511. * Gets the highlights Density value.
  75512. * 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.
  75513. * Values less than zero provide a filter of opposite hue.
  75514. */
  75515. /**
  75516. * Sets the highlights Density value.
  75517. * 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.
  75518. * Values less than zero provide a filter of opposite hue.
  75519. */
  75520. highlightsDensity: number;
  75521. /**
  75522. * Gets the highlights Saturation value.
  75523. * 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.
  75524. */
  75525. /**
  75526. * Sets the highlights Saturation value.
  75527. * 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.
  75528. */
  75529. highlightsSaturation: number;
  75530. /**
  75531. * Gets the highlights Exposure value.
  75532. * 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.
  75533. */
  75534. /**
  75535. * Sets the highlights Exposure value.
  75536. * 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.
  75537. */
  75538. highlightsExposure: number;
  75539. private _midtonesHue;
  75540. private _midtonesDensity;
  75541. private _midtonesSaturation;
  75542. private _midtonesExposure;
  75543. /**
  75544. * Gets the midtones Hue value.
  75545. * 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).
  75546. */
  75547. /**
  75548. * Sets the midtones Hue value.
  75549. * 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).
  75550. */
  75551. midtonesHue: number;
  75552. /**
  75553. * Gets the midtones Density value.
  75554. * 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.
  75555. * Values less than zero provide a filter of opposite hue.
  75556. */
  75557. /**
  75558. * Sets the midtones Density value.
  75559. * 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.
  75560. * Values less than zero provide a filter of opposite hue.
  75561. */
  75562. midtonesDensity: number;
  75563. /**
  75564. * Gets the midtones Saturation value.
  75565. * 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.
  75566. */
  75567. /**
  75568. * Sets the midtones Saturation value.
  75569. * 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.
  75570. */
  75571. midtonesSaturation: number;
  75572. /**
  75573. * Gets the midtones Exposure value.
  75574. * 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.
  75575. */
  75576. /**
  75577. * Sets the midtones Exposure value.
  75578. * 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.
  75579. */
  75580. midtonesExposure: number;
  75581. private _shadowsHue;
  75582. private _shadowsDensity;
  75583. private _shadowsSaturation;
  75584. private _shadowsExposure;
  75585. /**
  75586. * Gets the shadows Hue value.
  75587. * 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).
  75588. */
  75589. /**
  75590. * Sets the shadows Hue value.
  75591. * 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).
  75592. */
  75593. shadowsHue: number;
  75594. /**
  75595. * Gets the shadows Density value.
  75596. * 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.
  75597. * Values less than zero provide a filter of opposite hue.
  75598. */
  75599. /**
  75600. * Sets the shadows Density value.
  75601. * 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.
  75602. * Values less than zero provide a filter of opposite hue.
  75603. */
  75604. shadowsDensity: number;
  75605. /**
  75606. * Gets the shadows Saturation value.
  75607. * 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.
  75608. */
  75609. /**
  75610. * Sets the shadows Saturation value.
  75611. * 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.
  75612. */
  75613. shadowsSaturation: number;
  75614. /**
  75615. * Gets the shadows Exposure value.
  75616. * 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.
  75617. */
  75618. /**
  75619. * Sets the shadows Exposure value.
  75620. * 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.
  75621. */
  75622. shadowsExposure: number;
  75623. /**
  75624. * Returns the class name
  75625. * @returns The class name
  75626. */
  75627. getClassName(): string;
  75628. /**
  75629. * Binds the color curves to the shader.
  75630. * @param colorCurves The color curve to bind
  75631. * @param effect The effect to bind to
  75632. * @param positiveUniform The positive uniform shader parameter
  75633. * @param neutralUniform The neutral uniform shader parameter
  75634. * @param negativeUniform The negative uniform shader parameter
  75635. */
  75636. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  75637. /**
  75638. * Prepare the list of uniforms associated with the ColorCurves effects.
  75639. * @param uniformsList The list of uniforms used in the effect
  75640. */
  75641. static PrepareUniforms(uniformsList: string[]): void;
  75642. /**
  75643. * Returns color grading data based on a hue, density, saturation and exposure value.
  75644. * @param filterHue The hue of the color filter.
  75645. * @param filterDensity The density of the color filter.
  75646. * @param saturation The saturation.
  75647. * @param exposure The exposure.
  75648. * @param result The result data container.
  75649. */
  75650. private getColorGradingDataToRef;
  75651. /**
  75652. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  75653. * @param value The input slider value in range [-100,100].
  75654. * @returns Adjusted value.
  75655. */
  75656. private static applyColorGradingSliderNonlinear;
  75657. /**
  75658. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  75659. * @param hue The hue (H) input.
  75660. * @param saturation The saturation (S) input.
  75661. * @param brightness The brightness (B) input.
  75662. * @result An RGBA color represented as Vector4.
  75663. */
  75664. private static fromHSBToRef;
  75665. /**
  75666. * Returns a value clamped between min and max
  75667. * @param value The value to clamp
  75668. * @param min The minimum of value
  75669. * @param max The maximum of value
  75670. * @returns The clamped value.
  75671. */
  75672. private static clamp;
  75673. /**
  75674. * Clones the current color curve instance.
  75675. * @return The cloned curves
  75676. */
  75677. clone(): ColorCurves;
  75678. /**
  75679. * Serializes the current color curve instance to a json representation.
  75680. * @return a JSON representation
  75681. */
  75682. serialize(): any;
  75683. /**
  75684. * Parses the color curve from a json representation.
  75685. * @param source the JSON source to parse
  75686. * @return The parsed curves
  75687. */
  75688. static Parse(source: any): ColorCurves;
  75689. }
  75690. }
  75691. declare module BABYLON {
  75692. /**
  75693. * Interface to follow in your material defines to integrate easily the
  75694. * Image proccessing functions.
  75695. * @hidden
  75696. */
  75697. export interface IImageProcessingConfigurationDefines {
  75698. IMAGEPROCESSING: boolean;
  75699. VIGNETTE: boolean;
  75700. VIGNETTEBLENDMODEMULTIPLY: boolean;
  75701. VIGNETTEBLENDMODEOPAQUE: boolean;
  75702. TONEMAPPING: boolean;
  75703. TONEMAPPING_ACES: boolean;
  75704. CONTRAST: boolean;
  75705. EXPOSURE: boolean;
  75706. COLORCURVES: boolean;
  75707. COLORGRADING: boolean;
  75708. COLORGRADING3D: boolean;
  75709. SAMPLER3DGREENDEPTH: boolean;
  75710. SAMPLER3DBGRMAP: boolean;
  75711. IMAGEPROCESSINGPOSTPROCESS: boolean;
  75712. }
  75713. /**
  75714. * @hidden
  75715. */
  75716. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  75717. IMAGEPROCESSING: boolean;
  75718. VIGNETTE: boolean;
  75719. VIGNETTEBLENDMODEMULTIPLY: boolean;
  75720. VIGNETTEBLENDMODEOPAQUE: boolean;
  75721. TONEMAPPING: boolean;
  75722. TONEMAPPING_ACES: boolean;
  75723. CONTRAST: boolean;
  75724. COLORCURVES: boolean;
  75725. COLORGRADING: boolean;
  75726. COLORGRADING3D: boolean;
  75727. SAMPLER3DGREENDEPTH: boolean;
  75728. SAMPLER3DBGRMAP: boolean;
  75729. IMAGEPROCESSINGPOSTPROCESS: boolean;
  75730. EXPOSURE: boolean;
  75731. constructor();
  75732. }
  75733. /**
  75734. * This groups together the common properties used for image processing either in direct forward pass
  75735. * or through post processing effect depending on the use of the image processing pipeline in your scene
  75736. * or not.
  75737. */
  75738. export class ImageProcessingConfiguration {
  75739. /**
  75740. * Default tone mapping applied in BabylonJS.
  75741. */
  75742. static readonly TONEMAPPING_STANDARD: number;
  75743. /**
  75744. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  75745. * to other engines rendering to increase portability.
  75746. */
  75747. static readonly TONEMAPPING_ACES: number;
  75748. /**
  75749. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  75750. */
  75751. colorCurves: Nullable<ColorCurves>;
  75752. private _colorCurvesEnabled;
  75753. /**
  75754. * Gets wether the color curves effect is enabled.
  75755. */
  75756. /**
  75757. * Sets wether the color curves effect is enabled.
  75758. */
  75759. colorCurvesEnabled: boolean;
  75760. private _colorGradingTexture;
  75761. /**
  75762. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  75763. */
  75764. /**
  75765. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  75766. */
  75767. colorGradingTexture: Nullable<BaseTexture>;
  75768. private _colorGradingEnabled;
  75769. /**
  75770. * Gets wether the color grading effect is enabled.
  75771. */
  75772. /**
  75773. * Sets wether the color grading effect is enabled.
  75774. */
  75775. colorGradingEnabled: boolean;
  75776. private _colorGradingWithGreenDepth;
  75777. /**
  75778. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  75779. */
  75780. /**
  75781. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  75782. */
  75783. colorGradingWithGreenDepth: boolean;
  75784. private _colorGradingBGR;
  75785. /**
  75786. * Gets wether the color grading texture contains BGR values.
  75787. */
  75788. /**
  75789. * Sets wether the color grading texture contains BGR values.
  75790. */
  75791. colorGradingBGR: boolean;
  75792. /** @hidden */
  75793. _exposure: number;
  75794. /**
  75795. * Gets the Exposure used in the effect.
  75796. */
  75797. /**
  75798. * Sets the Exposure used in the effect.
  75799. */
  75800. exposure: number;
  75801. private _toneMappingEnabled;
  75802. /**
  75803. * Gets wether the tone mapping effect is enabled.
  75804. */
  75805. /**
  75806. * Sets wether the tone mapping effect is enabled.
  75807. */
  75808. toneMappingEnabled: boolean;
  75809. private _toneMappingType;
  75810. /**
  75811. * Gets the type of tone mapping effect.
  75812. */
  75813. /**
  75814. * Sets the type of tone mapping effect used in BabylonJS.
  75815. */
  75816. toneMappingType: number;
  75817. protected _contrast: number;
  75818. /**
  75819. * Gets the contrast used in the effect.
  75820. */
  75821. /**
  75822. * Sets the contrast used in the effect.
  75823. */
  75824. contrast: number;
  75825. /**
  75826. * Vignette stretch size.
  75827. */
  75828. vignetteStretch: number;
  75829. /**
  75830. * Vignette centre X Offset.
  75831. */
  75832. vignetteCentreX: number;
  75833. /**
  75834. * Vignette centre Y Offset.
  75835. */
  75836. vignetteCentreY: number;
  75837. /**
  75838. * Vignette weight or intensity of the vignette effect.
  75839. */
  75840. vignetteWeight: number;
  75841. /**
  75842. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  75843. * if vignetteEnabled is set to true.
  75844. */
  75845. vignetteColor: Color4;
  75846. /**
  75847. * Camera field of view used by the Vignette effect.
  75848. */
  75849. vignetteCameraFov: number;
  75850. private _vignetteBlendMode;
  75851. /**
  75852. * Gets the vignette blend mode allowing different kind of effect.
  75853. */
  75854. /**
  75855. * Sets the vignette blend mode allowing different kind of effect.
  75856. */
  75857. vignetteBlendMode: number;
  75858. private _vignetteEnabled;
  75859. /**
  75860. * Gets wether the vignette effect is enabled.
  75861. */
  75862. /**
  75863. * Sets wether the vignette effect is enabled.
  75864. */
  75865. vignetteEnabled: boolean;
  75866. private _applyByPostProcess;
  75867. /**
  75868. * Gets wether the image processing is applied through a post process or not.
  75869. */
  75870. /**
  75871. * Sets wether the image processing is applied through a post process or not.
  75872. */
  75873. applyByPostProcess: boolean;
  75874. private _isEnabled;
  75875. /**
  75876. * Gets wether the image processing is enabled or not.
  75877. */
  75878. /**
  75879. * Sets wether the image processing is enabled or not.
  75880. */
  75881. isEnabled: boolean;
  75882. /**
  75883. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  75884. */
  75885. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  75886. /**
  75887. * Method called each time the image processing information changes requires to recompile the effect.
  75888. */
  75889. protected _updateParameters(): void;
  75890. /**
  75891. * Gets the current class name.
  75892. * @return "ImageProcessingConfiguration"
  75893. */
  75894. getClassName(): string;
  75895. /**
  75896. * Prepare the list of uniforms associated with the Image Processing effects.
  75897. * @param uniforms The list of uniforms used in the effect
  75898. * @param defines the list of defines currently in use
  75899. */
  75900. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  75901. /**
  75902. * Prepare the list of samplers associated with the Image Processing effects.
  75903. * @param samplersList The list of uniforms used in the effect
  75904. * @param defines the list of defines currently in use
  75905. */
  75906. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  75907. /**
  75908. * Prepare the list of defines associated to the shader.
  75909. * @param defines the list of defines to complete
  75910. * @param forPostProcess Define if we are currently in post process mode or not
  75911. */
  75912. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  75913. /**
  75914. * Returns true if all the image processing information are ready.
  75915. * @returns True if ready, otherwise, false
  75916. */
  75917. isReady(): boolean;
  75918. /**
  75919. * Binds the image processing to the shader.
  75920. * @param effect The effect to bind to
  75921. * @param overrideAspectRatio Override the aspect ratio of the effect
  75922. */
  75923. bind(effect: Effect, overrideAspectRatio?: number): void;
  75924. /**
  75925. * Clones the current image processing instance.
  75926. * @return The cloned image processing
  75927. */
  75928. clone(): ImageProcessingConfiguration;
  75929. /**
  75930. * Serializes the current image processing instance to a json representation.
  75931. * @return a JSON representation
  75932. */
  75933. serialize(): any;
  75934. /**
  75935. * Parses the image processing from a json representation.
  75936. * @param source the JSON source to parse
  75937. * @return The parsed image processing
  75938. */
  75939. static Parse(source: any): ImageProcessingConfiguration;
  75940. private static _VIGNETTEMODE_MULTIPLY;
  75941. private static _VIGNETTEMODE_OPAQUE;
  75942. /**
  75943. * Used to apply the vignette as a mix with the pixel color.
  75944. */
  75945. static readonly VIGNETTEMODE_MULTIPLY: number;
  75946. /**
  75947. * Used to apply the vignette as a replacement of the pixel color.
  75948. */
  75949. static readonly VIGNETTEMODE_OPAQUE: number;
  75950. }
  75951. }
  75952. declare module BABYLON {
  75953. /** @hidden */
  75954. export var postprocessVertexShader: {
  75955. name: string;
  75956. shader: string;
  75957. };
  75958. }
  75959. declare module BABYLON {
  75960. interface ThinEngine {
  75961. /**
  75962. * Creates a new render target texture
  75963. * @param size defines the size of the texture
  75964. * @param options defines the options used to create the texture
  75965. * @returns a new render target texture stored in an InternalTexture
  75966. */
  75967. createRenderTargetTexture(size: number | {
  75968. width: number;
  75969. height: number;
  75970. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  75971. /**
  75972. * Creates a depth stencil texture.
  75973. * This is only available in WebGL 2 or with the depth texture extension available.
  75974. * @param size The size of face edge in the texture.
  75975. * @param options The options defining the texture.
  75976. * @returns The texture
  75977. */
  75978. createDepthStencilTexture(size: number | {
  75979. width: number;
  75980. height: number;
  75981. }, options: DepthTextureCreationOptions): InternalTexture;
  75982. /** @hidden */
  75983. _createDepthStencilTexture(size: number | {
  75984. width: number;
  75985. height: number;
  75986. }, options: DepthTextureCreationOptions): InternalTexture;
  75987. }
  75988. }
  75989. declare module BABYLON {
  75990. /** Defines supported spaces */
  75991. export enum Space {
  75992. /** Local (object) space */
  75993. LOCAL = 0,
  75994. /** World space */
  75995. WORLD = 1,
  75996. /** Bone space */
  75997. BONE = 2
  75998. }
  75999. /** Defines the 3 main axes */
  76000. export class Axis {
  76001. /** X axis */
  76002. static X: Vector3;
  76003. /** Y axis */
  76004. static Y: Vector3;
  76005. /** Z axis */
  76006. static Z: Vector3;
  76007. }
  76008. }
  76009. declare module BABYLON {
  76010. /**
  76011. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  76012. * This is the base of the follow, arc rotate cameras and Free camera
  76013. * @see http://doc.babylonjs.com/features/cameras
  76014. */
  76015. export class TargetCamera extends Camera {
  76016. private static _RigCamTransformMatrix;
  76017. private static _TargetTransformMatrix;
  76018. private static _TargetFocalPoint;
  76019. /**
  76020. * Define the current direction the camera is moving to
  76021. */
  76022. cameraDirection: Vector3;
  76023. /**
  76024. * Define the current rotation the camera is rotating to
  76025. */
  76026. cameraRotation: Vector2;
  76027. /**
  76028. * When set, the up vector of the camera will be updated by the rotation of the camera
  76029. */
  76030. updateUpVectorFromRotation: boolean;
  76031. private _tmpQuaternion;
  76032. /**
  76033. * Define the current rotation of the camera
  76034. */
  76035. rotation: Vector3;
  76036. /**
  76037. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  76038. */
  76039. rotationQuaternion: Quaternion;
  76040. /**
  76041. * Define the current speed of the camera
  76042. */
  76043. speed: number;
  76044. /**
  76045. * Add cconstraint to the camera to prevent it to move freely in all directions and
  76046. * around all axis.
  76047. */
  76048. noRotationConstraint: boolean;
  76049. /**
  76050. * Define the current target of the camera as an object or a position.
  76051. */
  76052. lockedTarget: any;
  76053. /** @hidden */
  76054. _currentTarget: Vector3;
  76055. /** @hidden */
  76056. _initialFocalDistance: number;
  76057. /** @hidden */
  76058. _viewMatrix: Matrix;
  76059. /** @hidden */
  76060. _camMatrix: Matrix;
  76061. /** @hidden */
  76062. _cameraTransformMatrix: Matrix;
  76063. /** @hidden */
  76064. _cameraRotationMatrix: Matrix;
  76065. /** @hidden */
  76066. _referencePoint: Vector3;
  76067. /** @hidden */
  76068. _transformedReferencePoint: Vector3;
  76069. protected _globalCurrentTarget: Vector3;
  76070. protected _globalCurrentUpVector: Vector3;
  76071. /** @hidden */
  76072. _reset: () => void;
  76073. private _defaultUp;
  76074. /**
  76075. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  76076. * This is the base of the follow, arc rotate cameras and Free camera
  76077. * @see http://doc.babylonjs.com/features/cameras
  76078. * @param name Defines the name of the camera in the scene
  76079. * @param position Defines the start position of the camera in the scene
  76080. * @param scene Defines the scene the camera belongs to
  76081. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  76082. */
  76083. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  76084. /**
  76085. * Gets the position in front of the camera at a given distance.
  76086. * @param distance The distance from the camera we want the position to be
  76087. * @returns the position
  76088. */
  76089. getFrontPosition(distance: number): Vector3;
  76090. /** @hidden */
  76091. _getLockedTargetPosition(): Nullable<Vector3>;
  76092. private _storedPosition;
  76093. private _storedRotation;
  76094. private _storedRotationQuaternion;
  76095. /**
  76096. * Store current camera state of the camera (fov, position, rotation, etc..)
  76097. * @returns the camera
  76098. */
  76099. storeState(): Camera;
  76100. /**
  76101. * Restored camera state. You must call storeState() first
  76102. * @returns whether it was successful or not
  76103. * @hidden
  76104. */
  76105. _restoreStateValues(): boolean;
  76106. /** @hidden */
  76107. _initCache(): void;
  76108. /** @hidden */
  76109. _updateCache(ignoreParentClass?: boolean): void;
  76110. /** @hidden */
  76111. _isSynchronizedViewMatrix(): boolean;
  76112. /** @hidden */
  76113. _computeLocalCameraSpeed(): number;
  76114. /**
  76115. * Defines the target the camera should look at.
  76116. * @param target Defines the new target as a Vector or a mesh
  76117. */
  76118. setTarget(target: Vector3): void;
  76119. /**
  76120. * Return the current target position of the camera. This value is expressed in local space.
  76121. * @returns the target position
  76122. */
  76123. getTarget(): Vector3;
  76124. /** @hidden */
  76125. _decideIfNeedsToMove(): boolean;
  76126. /** @hidden */
  76127. _updatePosition(): void;
  76128. /** @hidden */
  76129. _checkInputs(): void;
  76130. protected _updateCameraRotationMatrix(): void;
  76131. /**
  76132. * 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)
  76133. * @returns the current camera
  76134. */
  76135. private _rotateUpVectorWithCameraRotationMatrix;
  76136. private _cachedRotationZ;
  76137. private _cachedQuaternionRotationZ;
  76138. /** @hidden */
  76139. _getViewMatrix(): Matrix;
  76140. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  76141. /**
  76142. * @hidden
  76143. */
  76144. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  76145. /**
  76146. * @hidden
  76147. */
  76148. _updateRigCameras(): void;
  76149. private _getRigCamPositionAndTarget;
  76150. /**
  76151. * Gets the current object class name.
  76152. * @return the class name
  76153. */
  76154. getClassName(): string;
  76155. }
  76156. }
  76157. declare module BABYLON {
  76158. /**
  76159. * Gather the list of keyboard event types as constants.
  76160. */
  76161. export class KeyboardEventTypes {
  76162. /**
  76163. * The keydown event is fired when a key becomes active (pressed).
  76164. */
  76165. static readonly KEYDOWN: number;
  76166. /**
  76167. * The keyup event is fired when a key has been released.
  76168. */
  76169. static readonly KEYUP: number;
  76170. }
  76171. /**
  76172. * This class is used to store keyboard related info for the onKeyboardObservable event.
  76173. */
  76174. export class KeyboardInfo {
  76175. /**
  76176. * Defines the type of event (KeyboardEventTypes)
  76177. */
  76178. type: number;
  76179. /**
  76180. * Defines the related dom event
  76181. */
  76182. event: KeyboardEvent;
  76183. /**
  76184. * Instantiates a new keyboard info.
  76185. * This class is used to store keyboard related info for the onKeyboardObservable event.
  76186. * @param type Defines the type of event (KeyboardEventTypes)
  76187. * @param event Defines the related dom event
  76188. */
  76189. constructor(
  76190. /**
  76191. * Defines the type of event (KeyboardEventTypes)
  76192. */
  76193. type: number,
  76194. /**
  76195. * Defines the related dom event
  76196. */
  76197. event: KeyboardEvent);
  76198. }
  76199. /**
  76200. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  76201. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  76202. */
  76203. export class KeyboardInfoPre extends KeyboardInfo {
  76204. /**
  76205. * Defines the type of event (KeyboardEventTypes)
  76206. */
  76207. type: number;
  76208. /**
  76209. * Defines the related dom event
  76210. */
  76211. event: KeyboardEvent;
  76212. /**
  76213. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  76214. */
  76215. skipOnPointerObservable: boolean;
  76216. /**
  76217. * Instantiates a new keyboard pre info.
  76218. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  76219. * @param type Defines the type of event (KeyboardEventTypes)
  76220. * @param event Defines the related dom event
  76221. */
  76222. constructor(
  76223. /**
  76224. * Defines the type of event (KeyboardEventTypes)
  76225. */
  76226. type: number,
  76227. /**
  76228. * Defines the related dom event
  76229. */
  76230. event: KeyboardEvent);
  76231. }
  76232. }
  76233. declare module BABYLON {
  76234. /**
  76235. * Manage the keyboard inputs to control the movement of a free camera.
  76236. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  76237. */
  76238. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  76239. /**
  76240. * Defines the camera the input is attached to.
  76241. */
  76242. camera: FreeCamera;
  76243. /**
  76244. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  76245. */
  76246. keysUp: number[];
  76247. /**
  76248. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  76249. */
  76250. keysDown: number[];
  76251. /**
  76252. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  76253. */
  76254. keysLeft: number[];
  76255. /**
  76256. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  76257. */
  76258. keysRight: number[];
  76259. private _keys;
  76260. private _onCanvasBlurObserver;
  76261. private _onKeyboardObserver;
  76262. private _engine;
  76263. private _scene;
  76264. /**
  76265. * Attach the input controls to a specific dom element to get the input from.
  76266. * @param element Defines the element the controls should be listened from
  76267. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  76268. */
  76269. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  76270. /**
  76271. * Detach the current controls from the specified dom element.
  76272. * @param element Defines the element to stop listening the inputs from
  76273. */
  76274. detachControl(element: Nullable<HTMLElement>): void;
  76275. /**
  76276. * Update the current camera state depending on the inputs that have been used this frame.
  76277. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  76278. */
  76279. checkInputs(): void;
  76280. /**
  76281. * Gets the class name of the current intput.
  76282. * @returns the class name
  76283. */
  76284. getClassName(): string;
  76285. /** @hidden */
  76286. _onLostFocus(): void;
  76287. /**
  76288. * Get the friendly name associated with the input class.
  76289. * @returns the input friendly name
  76290. */
  76291. getSimpleName(): string;
  76292. }
  76293. }
  76294. declare module BABYLON {
  76295. /**
  76296. * Interface describing all the common properties and methods a shadow light needs to implement.
  76297. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  76298. * as well as binding the different shadow properties to the effects.
  76299. */
  76300. export interface IShadowLight extends Light {
  76301. /**
  76302. * The light id in the scene (used in scene.findLighById for instance)
  76303. */
  76304. id: string;
  76305. /**
  76306. * The position the shdow will be casted from.
  76307. */
  76308. position: Vector3;
  76309. /**
  76310. * In 2d mode (needCube being false), the direction used to cast the shadow.
  76311. */
  76312. direction: Vector3;
  76313. /**
  76314. * The transformed position. Position of the light in world space taking parenting in account.
  76315. */
  76316. transformedPosition: Vector3;
  76317. /**
  76318. * The transformed direction. Direction of the light in world space taking parenting in account.
  76319. */
  76320. transformedDirection: Vector3;
  76321. /**
  76322. * The friendly name of the light in the scene.
  76323. */
  76324. name: string;
  76325. /**
  76326. * Defines the shadow projection clipping minimum z value.
  76327. */
  76328. shadowMinZ: number;
  76329. /**
  76330. * Defines the shadow projection clipping maximum z value.
  76331. */
  76332. shadowMaxZ: number;
  76333. /**
  76334. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  76335. * @returns true if the information has been computed, false if it does not need to (no parenting)
  76336. */
  76337. computeTransformedInformation(): boolean;
  76338. /**
  76339. * Gets the scene the light belongs to.
  76340. * @returns The scene
  76341. */
  76342. getScene(): Scene;
  76343. /**
  76344. * Callback defining a custom Projection Matrix Builder.
  76345. * This can be used to override the default projection matrix computation.
  76346. */
  76347. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  76348. /**
  76349. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  76350. * @param matrix The materix to updated with the projection information
  76351. * @param viewMatrix The transform matrix of the light
  76352. * @param renderList The list of mesh to render in the map
  76353. * @returns The current light
  76354. */
  76355. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  76356. /**
  76357. * Gets the current depth scale used in ESM.
  76358. * @returns The scale
  76359. */
  76360. getDepthScale(): number;
  76361. /**
  76362. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  76363. * @returns true if a cube texture needs to be use
  76364. */
  76365. needCube(): boolean;
  76366. /**
  76367. * Detects if the projection matrix requires to be recomputed this frame.
  76368. * @returns true if it requires to be recomputed otherwise, false.
  76369. */
  76370. needProjectionMatrixCompute(): boolean;
  76371. /**
  76372. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  76373. */
  76374. forceProjectionMatrixCompute(): void;
  76375. /**
  76376. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  76377. * @param faceIndex The index of the face we are computed the direction to generate shadow
  76378. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  76379. */
  76380. getShadowDirection(faceIndex?: number): Vector3;
  76381. /**
  76382. * Gets the minZ used for shadow according to both the scene and the light.
  76383. * @param activeCamera The camera we are returning the min for
  76384. * @returns the depth min z
  76385. */
  76386. getDepthMinZ(activeCamera: Camera): number;
  76387. /**
  76388. * Gets the maxZ used for shadow according to both the scene and the light.
  76389. * @param activeCamera The camera we are returning the max for
  76390. * @returns the depth max z
  76391. */
  76392. getDepthMaxZ(activeCamera: Camera): number;
  76393. }
  76394. /**
  76395. * Base implementation IShadowLight
  76396. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  76397. */
  76398. export abstract class ShadowLight extends Light implements IShadowLight {
  76399. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  76400. protected _position: Vector3;
  76401. protected _setPosition(value: Vector3): void;
  76402. /**
  76403. * Sets the position the shadow will be casted from. Also use as the light position for both
  76404. * point and spot lights.
  76405. */
  76406. /**
  76407. * Sets the position the shadow will be casted from. Also use as the light position for both
  76408. * point and spot lights.
  76409. */
  76410. position: Vector3;
  76411. protected _direction: Vector3;
  76412. protected _setDirection(value: Vector3): void;
  76413. /**
  76414. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  76415. * Also use as the light direction on spot and directional lights.
  76416. */
  76417. /**
  76418. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  76419. * Also use as the light direction on spot and directional lights.
  76420. */
  76421. direction: Vector3;
  76422. private _shadowMinZ;
  76423. /**
  76424. * Gets the shadow projection clipping minimum z value.
  76425. */
  76426. /**
  76427. * Sets the shadow projection clipping minimum z value.
  76428. */
  76429. shadowMinZ: number;
  76430. private _shadowMaxZ;
  76431. /**
  76432. * Sets the shadow projection clipping maximum z value.
  76433. */
  76434. /**
  76435. * Gets the shadow projection clipping maximum z value.
  76436. */
  76437. shadowMaxZ: number;
  76438. /**
  76439. * Callback defining a custom Projection Matrix Builder.
  76440. * This can be used to override the default projection matrix computation.
  76441. */
  76442. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  76443. /**
  76444. * The transformed position. Position of the light in world space taking parenting in account.
  76445. */
  76446. transformedPosition: Vector3;
  76447. /**
  76448. * The transformed direction. Direction of the light in world space taking parenting in account.
  76449. */
  76450. transformedDirection: Vector3;
  76451. private _needProjectionMatrixCompute;
  76452. /**
  76453. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  76454. * @returns true if the information has been computed, false if it does not need to (no parenting)
  76455. */
  76456. computeTransformedInformation(): boolean;
  76457. /**
  76458. * Return the depth scale used for the shadow map.
  76459. * @returns the depth scale.
  76460. */
  76461. getDepthScale(): number;
  76462. /**
  76463. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  76464. * @param faceIndex The index of the face we are computed the direction to generate shadow
  76465. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  76466. */
  76467. getShadowDirection(faceIndex?: number): Vector3;
  76468. /**
  76469. * Returns the ShadowLight absolute position in the World.
  76470. * @returns the position vector in world space
  76471. */
  76472. getAbsolutePosition(): Vector3;
  76473. /**
  76474. * Sets the ShadowLight direction toward the passed target.
  76475. * @param target The point to target in local space
  76476. * @returns the updated ShadowLight direction
  76477. */
  76478. setDirectionToTarget(target: Vector3): Vector3;
  76479. /**
  76480. * Returns the light rotation in euler definition.
  76481. * @returns the x y z rotation in local space.
  76482. */
  76483. getRotation(): Vector3;
  76484. /**
  76485. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  76486. * @returns true if a cube texture needs to be use
  76487. */
  76488. needCube(): boolean;
  76489. /**
  76490. * Detects if the projection matrix requires to be recomputed this frame.
  76491. * @returns true if it requires to be recomputed otherwise, false.
  76492. */
  76493. needProjectionMatrixCompute(): boolean;
  76494. /**
  76495. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  76496. */
  76497. forceProjectionMatrixCompute(): void;
  76498. /** @hidden */
  76499. _initCache(): void;
  76500. /** @hidden */
  76501. _isSynchronized(): boolean;
  76502. /**
  76503. * Computes the world matrix of the node
  76504. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  76505. * @returns the world matrix
  76506. */
  76507. computeWorldMatrix(force?: boolean): Matrix;
  76508. /**
  76509. * Gets the minZ used for shadow according to both the scene and the light.
  76510. * @param activeCamera The camera we are returning the min for
  76511. * @returns the depth min z
  76512. */
  76513. getDepthMinZ(activeCamera: Camera): number;
  76514. /**
  76515. * Gets the maxZ used for shadow according to both the scene and the light.
  76516. * @param activeCamera The camera we are returning the max for
  76517. * @returns the depth max z
  76518. */
  76519. getDepthMaxZ(activeCamera: Camera): number;
  76520. /**
  76521. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  76522. * @param matrix The materix to updated with the projection information
  76523. * @param viewMatrix The transform matrix of the light
  76524. * @param renderList The list of mesh to render in the map
  76525. * @returns The current light
  76526. */
  76527. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  76528. }
  76529. }
  76530. declare module BABYLON {
  76531. /**
  76532. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  76533. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  76534. */
  76535. export class EffectFallbacks implements IEffectFallbacks {
  76536. private _defines;
  76537. private _currentRank;
  76538. private _maxRank;
  76539. private _mesh;
  76540. /**
  76541. * Removes the fallback from the bound mesh.
  76542. */
  76543. unBindMesh(): void;
  76544. /**
  76545. * Adds a fallback on the specified property.
  76546. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  76547. * @param define The name of the define in the shader
  76548. */
  76549. addFallback(rank: number, define: string): void;
  76550. /**
  76551. * Sets the mesh to use CPU skinning when needing to fallback.
  76552. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  76553. * @param mesh The mesh to use the fallbacks.
  76554. */
  76555. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  76556. /**
  76557. * Checks to see if more fallbacks are still availible.
  76558. */
  76559. readonly hasMoreFallbacks: boolean;
  76560. /**
  76561. * Removes the defines that should be removed when falling back.
  76562. * @param currentDefines defines the current define statements for the shader.
  76563. * @param effect defines the current effect we try to compile
  76564. * @returns The resulting defines with defines of the current rank removed.
  76565. */
  76566. reduce(currentDefines: string, effect: Effect): string;
  76567. }
  76568. }
  76569. declare module BABYLON {
  76570. /**
  76571. * "Static Class" containing the most commonly used helper while dealing with material for
  76572. * rendering purpose.
  76573. *
  76574. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  76575. *
  76576. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  76577. */
  76578. export class MaterialHelper {
  76579. /**
  76580. * Bind the current view position to an effect.
  76581. * @param effect The effect to be bound
  76582. * @param scene The scene the eyes position is used from
  76583. */
  76584. static BindEyePosition(effect: Effect, scene: Scene): void;
  76585. /**
  76586. * Helps preparing the defines values about the UVs in used in the effect.
  76587. * UVs are shared as much as we can accross channels in the shaders.
  76588. * @param texture The texture we are preparing the UVs for
  76589. * @param defines The defines to update
  76590. * @param key The channel key "diffuse", "specular"... used in the shader
  76591. */
  76592. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  76593. /**
  76594. * Binds a texture matrix value to its corrsponding uniform
  76595. * @param texture The texture to bind the matrix for
  76596. * @param uniformBuffer The uniform buffer receivin the data
  76597. * @param key The channel key "diffuse", "specular"... used in the shader
  76598. */
  76599. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  76600. /**
  76601. * Gets the current status of the fog (should it be enabled?)
  76602. * @param mesh defines the mesh to evaluate for fog support
  76603. * @param scene defines the hosting scene
  76604. * @returns true if fog must be enabled
  76605. */
  76606. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  76607. /**
  76608. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  76609. * @param mesh defines the current mesh
  76610. * @param scene defines the current scene
  76611. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  76612. * @param pointsCloud defines if point cloud rendering has to be turned on
  76613. * @param fogEnabled defines if fog has to be turned on
  76614. * @param alphaTest defines if alpha testing has to be turned on
  76615. * @param defines defines the current list of defines
  76616. */
  76617. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  76618. /**
  76619. * Helper used to prepare the list of defines associated with frame values for shader compilation
  76620. * @param scene defines the current scene
  76621. * @param engine defines the current engine
  76622. * @param defines specifies the list of active defines
  76623. * @param useInstances defines if instances have to be turned on
  76624. * @param useClipPlane defines if clip plane have to be turned on
  76625. */
  76626. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>): void;
  76627. /**
  76628. * Prepares the defines for bones
  76629. * @param mesh The mesh containing the geometry data we will draw
  76630. * @param defines The defines to update
  76631. */
  76632. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  76633. /**
  76634. * Prepares the defines for morph targets
  76635. * @param mesh The mesh containing the geometry data we will draw
  76636. * @param defines The defines to update
  76637. */
  76638. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  76639. /**
  76640. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  76641. * @param mesh The mesh containing the geometry data we will draw
  76642. * @param defines The defines to update
  76643. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  76644. * @param useBones Precise whether bones should be used or not (override mesh info)
  76645. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  76646. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  76647. * @returns false if defines are considered not dirty and have not been checked
  76648. */
  76649. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  76650. /**
  76651. * Prepares the defines related to multiview
  76652. * @param scene The scene we are intending to draw
  76653. * @param defines The defines to update
  76654. */
  76655. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  76656. /**
  76657. * Prepares the defines related to the light information passed in parameter
  76658. * @param scene The scene we are intending to draw
  76659. * @param mesh The mesh the effect is compiling for
  76660. * @param light The light the effect is compiling for
  76661. * @param lightIndex The index of the light
  76662. * @param defines The defines to update
  76663. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  76664. * @param state Defines the current state regarding what is needed (normals, etc...)
  76665. */
  76666. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  76667. needNormals: boolean;
  76668. needRebuild: boolean;
  76669. shadowEnabled: boolean;
  76670. specularEnabled: boolean;
  76671. lightmapMode: boolean;
  76672. }): void;
  76673. /**
  76674. * Prepares the defines related to the light information passed in parameter
  76675. * @param scene The scene we are intending to draw
  76676. * @param mesh The mesh the effect is compiling for
  76677. * @param defines The defines to update
  76678. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  76679. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  76680. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  76681. * @returns true if normals will be required for the rest of the effect
  76682. */
  76683. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  76684. /**
  76685. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  76686. * @param lightIndex defines the light index
  76687. * @param uniformsList The uniform list
  76688. * @param samplersList The sampler list
  76689. * @param projectedLightTexture defines if projected texture must be used
  76690. * @param uniformBuffersList defines an optional list of uniform buffers
  76691. */
  76692. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  76693. /**
  76694. * Prepares the uniforms and samplers list to be used in the effect
  76695. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  76696. * @param samplersList The sampler list
  76697. * @param defines The defines helping in the list generation
  76698. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  76699. */
  76700. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  76701. /**
  76702. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  76703. * @param defines The defines to update while falling back
  76704. * @param fallbacks The authorized effect fallbacks
  76705. * @param maxSimultaneousLights The maximum number of lights allowed
  76706. * @param rank the current rank of the Effect
  76707. * @returns The newly affected rank
  76708. */
  76709. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  76710. private static _TmpMorphInfluencers;
  76711. /**
  76712. * Prepares the list of attributes required for morph targets according to the effect defines.
  76713. * @param attribs The current list of supported attribs
  76714. * @param mesh The mesh to prepare the morph targets attributes for
  76715. * @param influencers The number of influencers
  76716. */
  76717. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  76718. /**
  76719. * Prepares the list of attributes required for morph targets according to the effect defines.
  76720. * @param attribs The current list of supported attribs
  76721. * @param mesh The mesh to prepare the morph targets attributes for
  76722. * @param defines The current Defines of the effect
  76723. */
  76724. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  76725. /**
  76726. * Prepares the list of attributes required for bones according to the effect defines.
  76727. * @param attribs The current list of supported attribs
  76728. * @param mesh The mesh to prepare the bones attributes for
  76729. * @param defines The current Defines of the effect
  76730. * @param fallbacks The current efffect fallback strategy
  76731. */
  76732. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  76733. /**
  76734. * Check and prepare the list of attributes required for instances according to the effect defines.
  76735. * @param attribs The current list of supported attribs
  76736. * @param defines The current MaterialDefines of the effect
  76737. */
  76738. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  76739. /**
  76740. * Add the list of attributes required for instances to the attribs array.
  76741. * @param attribs The current list of supported attribs
  76742. */
  76743. static PushAttributesForInstances(attribs: string[]): void;
  76744. /**
  76745. * Binds the light information to the effect.
  76746. * @param light The light containing the generator
  76747. * @param effect The effect we are binding the data to
  76748. * @param lightIndex The light index in the effect used to render
  76749. */
  76750. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  76751. /**
  76752. * Binds the lights information from the scene to the effect for the given mesh.
  76753. * @param light Light to bind
  76754. * @param lightIndex Light index
  76755. * @param scene The scene where the light belongs to
  76756. * @param effect The effect we are binding the data to
  76757. * @param useSpecular Defines if specular is supported
  76758. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  76759. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  76760. */
  76761. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  76762. /**
  76763. * Binds the lights information from the scene to the effect for the given mesh.
  76764. * @param scene The scene the lights belongs to
  76765. * @param mesh The mesh we are binding the information to render
  76766. * @param effect The effect we are binding the data to
  76767. * @param defines The generated defines for the effect
  76768. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  76769. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  76770. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  76771. */
  76772. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  76773. private static _tempFogColor;
  76774. /**
  76775. * Binds the fog information from the scene to the effect for the given mesh.
  76776. * @param scene The scene the lights belongs to
  76777. * @param mesh The mesh we are binding the information to render
  76778. * @param effect The effect we are binding the data to
  76779. * @param linearSpace Defines if the fog effect is applied in linear space
  76780. */
  76781. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  76782. /**
  76783. * Binds the bones information from the mesh to the effect.
  76784. * @param mesh The mesh we are binding the information to render
  76785. * @param effect The effect we are binding the data to
  76786. */
  76787. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  76788. /**
  76789. * Binds the morph targets information from the mesh to the effect.
  76790. * @param abstractMesh The mesh we are binding the information to render
  76791. * @param effect The effect we are binding the data to
  76792. */
  76793. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  76794. /**
  76795. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  76796. * @param defines The generated defines used in the effect
  76797. * @param effect The effect we are binding the data to
  76798. * @param scene The scene we are willing to render with logarithmic scale for
  76799. */
  76800. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  76801. /**
  76802. * Binds the clip plane information from the scene to the effect.
  76803. * @param scene The scene the clip plane information are extracted from
  76804. * @param effect The effect we are binding the data to
  76805. */
  76806. static BindClipPlane(effect: Effect, scene: Scene): void;
  76807. }
  76808. }
  76809. declare module BABYLON {
  76810. /** @hidden */
  76811. export var packingFunctions: {
  76812. name: string;
  76813. shader: string;
  76814. };
  76815. }
  76816. declare module BABYLON {
  76817. /** @hidden */
  76818. export var shadowMapPixelShader: {
  76819. name: string;
  76820. shader: string;
  76821. };
  76822. }
  76823. declare module BABYLON {
  76824. /** @hidden */
  76825. export var bonesDeclaration: {
  76826. name: string;
  76827. shader: string;
  76828. };
  76829. }
  76830. declare module BABYLON {
  76831. /** @hidden */
  76832. export var morphTargetsVertexGlobalDeclaration: {
  76833. name: string;
  76834. shader: string;
  76835. };
  76836. }
  76837. declare module BABYLON {
  76838. /** @hidden */
  76839. export var morphTargetsVertexDeclaration: {
  76840. name: string;
  76841. shader: string;
  76842. };
  76843. }
  76844. declare module BABYLON {
  76845. /** @hidden */
  76846. export var instancesDeclaration: {
  76847. name: string;
  76848. shader: string;
  76849. };
  76850. }
  76851. declare module BABYLON {
  76852. /** @hidden */
  76853. export var helperFunctions: {
  76854. name: string;
  76855. shader: string;
  76856. };
  76857. }
  76858. declare module BABYLON {
  76859. /** @hidden */
  76860. export var morphTargetsVertex: {
  76861. name: string;
  76862. shader: string;
  76863. };
  76864. }
  76865. declare module BABYLON {
  76866. /** @hidden */
  76867. export var instancesVertex: {
  76868. name: string;
  76869. shader: string;
  76870. };
  76871. }
  76872. declare module BABYLON {
  76873. /** @hidden */
  76874. export var bonesVertex: {
  76875. name: string;
  76876. shader: string;
  76877. };
  76878. }
  76879. declare module BABYLON {
  76880. /** @hidden */
  76881. export var shadowMapVertexShader: {
  76882. name: string;
  76883. shader: string;
  76884. };
  76885. }
  76886. declare module BABYLON {
  76887. /** @hidden */
  76888. export var depthBoxBlurPixelShader: {
  76889. name: string;
  76890. shader: string;
  76891. };
  76892. }
  76893. declare module BABYLON {
  76894. /**
  76895. * Defines the options associated with the creation of a custom shader for a shadow generator.
  76896. */
  76897. export interface ICustomShaderOptions {
  76898. /**
  76899. * Gets or sets the custom shader name to use
  76900. */
  76901. shaderName: string;
  76902. /**
  76903. * The list of attribute names used in the shader
  76904. */
  76905. attributes?: string[];
  76906. /**
  76907. * The list of unifrom names used in the shader
  76908. */
  76909. uniforms?: string[];
  76910. /**
  76911. * The list of sampler names used in the shader
  76912. */
  76913. samplers?: string[];
  76914. /**
  76915. * The list of defines used in the shader
  76916. */
  76917. defines?: string[];
  76918. }
  76919. /**
  76920. * Interface to implement to create a shadow generator compatible with BJS.
  76921. */
  76922. export interface IShadowGenerator {
  76923. /**
  76924. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  76925. * @returns The render target texture if present otherwise, null
  76926. */
  76927. getShadowMap(): Nullable<RenderTargetTexture>;
  76928. /**
  76929. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  76930. * @returns The render target texture if the shadow map is present otherwise, null
  76931. */
  76932. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  76933. /**
  76934. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  76935. * @param subMesh The submesh we want to render in the shadow map
  76936. * @param useInstances Defines wether will draw in the map using instances
  76937. * @returns true if ready otherwise, false
  76938. */
  76939. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  76940. /**
  76941. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  76942. * @param defines Defines of the material we want to update
  76943. * @param lightIndex Index of the light in the enabled light list of the material
  76944. */
  76945. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  76946. /**
  76947. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  76948. * defined in the generator but impacting the effect).
  76949. * It implies the unifroms available on the materials are the standard BJS ones.
  76950. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  76951. * @param effect The effect we are binfing the information for
  76952. */
  76953. bindShadowLight(lightIndex: string, effect: Effect): void;
  76954. /**
  76955. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  76956. * (eq to shadow prjection matrix * light transform matrix)
  76957. * @returns The transform matrix used to create the shadow map
  76958. */
  76959. getTransformMatrix(): Matrix;
  76960. /**
  76961. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  76962. * Cube and 2D textures for instance.
  76963. */
  76964. recreateShadowMap(): void;
  76965. /**
  76966. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  76967. * @param onCompiled Callback triggered at the and of the effects compilation
  76968. * @param options Sets of optional options forcing the compilation with different modes
  76969. */
  76970. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  76971. useInstances: boolean;
  76972. }>): void;
  76973. /**
  76974. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  76975. * @param options Sets of optional options forcing the compilation with different modes
  76976. * @returns A promise that resolves when the compilation completes
  76977. */
  76978. forceCompilationAsync(options?: Partial<{
  76979. useInstances: boolean;
  76980. }>): Promise<void>;
  76981. /**
  76982. * Serializes the shadow generator setup to a json object.
  76983. * @returns The serialized JSON object
  76984. */
  76985. serialize(): any;
  76986. /**
  76987. * Disposes the Shadow map and related Textures and effects.
  76988. */
  76989. dispose(): void;
  76990. }
  76991. /**
  76992. * Default implementation IShadowGenerator.
  76993. * This is the main object responsible of generating shadows in the framework.
  76994. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  76995. */
  76996. export class ShadowGenerator implements IShadowGenerator {
  76997. /**
  76998. * Shadow generator mode None: no filtering applied.
  76999. */
  77000. static readonly FILTER_NONE: number;
  77001. /**
  77002. * Shadow generator mode ESM: Exponential Shadow Mapping.
  77003. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77004. */
  77005. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  77006. /**
  77007. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  77008. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  77009. */
  77010. static readonly FILTER_POISSONSAMPLING: number;
  77011. /**
  77012. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  77013. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77014. */
  77015. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  77016. /**
  77017. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  77018. * edge artifacts on steep falloff.
  77019. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77020. */
  77021. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  77022. /**
  77023. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  77024. * edge artifacts on steep falloff.
  77025. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77026. */
  77027. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  77028. /**
  77029. * Shadow generator mode PCF: Percentage Closer Filtering
  77030. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  77031. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  77032. */
  77033. static readonly FILTER_PCF: number;
  77034. /**
  77035. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  77036. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  77037. * Contact Hardening
  77038. */
  77039. static readonly FILTER_PCSS: number;
  77040. /**
  77041. * Reserved for PCF and PCSS
  77042. * Highest Quality.
  77043. *
  77044. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  77045. *
  77046. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  77047. */
  77048. static readonly QUALITY_HIGH: number;
  77049. /**
  77050. * Reserved for PCF and PCSS
  77051. * Good tradeoff for quality/perf cross devices
  77052. *
  77053. * Execute PCF on a 3*3 kernel.
  77054. *
  77055. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  77056. */
  77057. static readonly QUALITY_MEDIUM: number;
  77058. /**
  77059. * Reserved for PCF and PCSS
  77060. * The lowest quality but the fastest.
  77061. *
  77062. * Execute PCF on a 1*1 kernel.
  77063. *
  77064. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  77065. */
  77066. static readonly QUALITY_LOW: number;
  77067. /** Gets or sets the custom shader name to use */
  77068. customShaderOptions: ICustomShaderOptions;
  77069. /**
  77070. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  77071. */
  77072. onBeforeShadowMapRenderObservable: Observable<Effect>;
  77073. /**
  77074. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  77075. */
  77076. onAfterShadowMapRenderObservable: Observable<Effect>;
  77077. /**
  77078. * Observable triggered before a mesh is rendered in the shadow map.
  77079. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  77080. */
  77081. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  77082. /**
  77083. * Observable triggered after a mesh is rendered in the shadow map.
  77084. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  77085. */
  77086. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  77087. private _bias;
  77088. /**
  77089. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  77090. */
  77091. /**
  77092. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  77093. */
  77094. bias: number;
  77095. private _normalBias;
  77096. /**
  77097. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  77098. */
  77099. /**
  77100. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  77101. */
  77102. normalBias: number;
  77103. private _blurBoxOffset;
  77104. /**
  77105. * Gets the blur box offset: offset applied during the blur pass.
  77106. * Only useful if useKernelBlur = false
  77107. */
  77108. /**
  77109. * Sets the blur box offset: offset applied during the blur pass.
  77110. * Only useful if useKernelBlur = false
  77111. */
  77112. blurBoxOffset: number;
  77113. private _blurScale;
  77114. /**
  77115. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  77116. * 2 means half of the size.
  77117. */
  77118. /**
  77119. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  77120. * 2 means half of the size.
  77121. */
  77122. blurScale: number;
  77123. private _blurKernel;
  77124. /**
  77125. * Gets the blur kernel: kernel size of the blur pass.
  77126. * Only useful if useKernelBlur = true
  77127. */
  77128. /**
  77129. * Sets the blur kernel: kernel size of the blur pass.
  77130. * Only useful if useKernelBlur = true
  77131. */
  77132. blurKernel: number;
  77133. private _useKernelBlur;
  77134. /**
  77135. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  77136. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  77137. */
  77138. /**
  77139. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  77140. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  77141. */
  77142. useKernelBlur: boolean;
  77143. private _depthScale;
  77144. /**
  77145. * Gets the depth scale used in ESM mode.
  77146. */
  77147. /**
  77148. * Sets the depth scale used in ESM mode.
  77149. * This can override the scale stored on the light.
  77150. */
  77151. depthScale: number;
  77152. private _filter;
  77153. /**
  77154. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  77155. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  77156. */
  77157. /**
  77158. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  77159. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  77160. */
  77161. filter: number;
  77162. /**
  77163. * Gets if the current filter is set to Poisson Sampling.
  77164. */
  77165. /**
  77166. * Sets the current filter to Poisson Sampling.
  77167. */
  77168. usePoissonSampling: boolean;
  77169. /**
  77170. * Gets if the current filter is set to ESM.
  77171. */
  77172. /**
  77173. * Sets the current filter is to ESM.
  77174. */
  77175. useExponentialShadowMap: boolean;
  77176. /**
  77177. * Gets if the current filter is set to filtered ESM.
  77178. */
  77179. /**
  77180. * Gets if the current filter is set to filtered ESM.
  77181. */
  77182. useBlurExponentialShadowMap: boolean;
  77183. /**
  77184. * Gets if the current filter is set to "close ESM" (using the inverse of the
  77185. * exponential to prevent steep falloff artifacts).
  77186. */
  77187. /**
  77188. * Sets the current filter to "close ESM" (using the inverse of the
  77189. * exponential to prevent steep falloff artifacts).
  77190. */
  77191. useCloseExponentialShadowMap: boolean;
  77192. /**
  77193. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  77194. * exponential to prevent steep falloff artifacts).
  77195. */
  77196. /**
  77197. * Sets the current filter to filtered "close ESM" (using the inverse of the
  77198. * exponential to prevent steep falloff artifacts).
  77199. */
  77200. useBlurCloseExponentialShadowMap: boolean;
  77201. /**
  77202. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  77203. */
  77204. /**
  77205. * Sets the current filter to "PCF" (percentage closer filtering).
  77206. */
  77207. usePercentageCloserFiltering: boolean;
  77208. private _filteringQuality;
  77209. /**
  77210. * Gets the PCF or PCSS Quality.
  77211. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  77212. */
  77213. /**
  77214. * Sets the PCF or PCSS Quality.
  77215. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  77216. */
  77217. filteringQuality: number;
  77218. /**
  77219. * Gets if the current filter is set to "PCSS" (contact hardening).
  77220. */
  77221. /**
  77222. * Sets the current filter to "PCSS" (contact hardening).
  77223. */
  77224. useContactHardeningShadow: boolean;
  77225. private _contactHardeningLightSizeUVRatio;
  77226. /**
  77227. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  77228. * Using a ratio helps keeping shape stability independently of the map size.
  77229. *
  77230. * It does not account for the light projection as it was having too much
  77231. * instability during the light setup or during light position changes.
  77232. *
  77233. * Only valid if useContactHardeningShadow is true.
  77234. */
  77235. /**
  77236. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  77237. * Using a ratio helps keeping shape stability independently of the map size.
  77238. *
  77239. * It does not account for the light projection as it was having too much
  77240. * instability during the light setup or during light position changes.
  77241. *
  77242. * Only valid if useContactHardeningShadow is true.
  77243. */
  77244. contactHardeningLightSizeUVRatio: number;
  77245. private _darkness;
  77246. /** Gets or sets the actual darkness of a shadow */
  77247. darkness: number;
  77248. /**
  77249. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  77250. * 0 means strongest and 1 would means no shadow.
  77251. * @returns the darkness.
  77252. */
  77253. getDarkness(): number;
  77254. /**
  77255. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  77256. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  77257. * @returns the shadow generator allowing fluent coding.
  77258. */
  77259. setDarkness(darkness: number): ShadowGenerator;
  77260. private _transparencyShadow;
  77261. /** Gets or sets the ability to have transparent shadow */
  77262. transparencyShadow: boolean;
  77263. /**
  77264. * Sets the ability to have transparent shadow (boolean).
  77265. * @param transparent True if transparent else False
  77266. * @returns the shadow generator allowing fluent coding
  77267. */
  77268. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  77269. private _shadowMap;
  77270. private _shadowMap2;
  77271. /**
  77272. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  77273. * @returns The render target texture if present otherwise, null
  77274. */
  77275. getShadowMap(): Nullable<RenderTargetTexture>;
  77276. /**
  77277. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  77278. * @returns The render target texture if the shadow map is present otherwise, null
  77279. */
  77280. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  77281. /**
  77282. * Gets the class name of that object
  77283. * @returns "ShadowGenerator"
  77284. */
  77285. getClassName(): string;
  77286. /**
  77287. * Helper function to add a mesh and its descendants to the list of shadow casters.
  77288. * @param mesh Mesh to add
  77289. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  77290. * @returns the Shadow Generator itself
  77291. */
  77292. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  77293. /**
  77294. * Helper function to remove a mesh and its descendants from the list of shadow casters
  77295. * @param mesh Mesh to remove
  77296. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  77297. * @returns the Shadow Generator itself
  77298. */
  77299. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  77300. /**
  77301. * Controls the extent to which the shadows fade out at the edge of the frustum
  77302. * Used only by directionals and spots
  77303. */
  77304. frustumEdgeFalloff: number;
  77305. private _light;
  77306. /**
  77307. * Returns the associated light object.
  77308. * @returns the light generating the shadow
  77309. */
  77310. getLight(): IShadowLight;
  77311. /**
  77312. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  77313. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  77314. * It might on the other hand introduce peter panning.
  77315. */
  77316. forceBackFacesOnly: boolean;
  77317. private _scene;
  77318. private _lightDirection;
  77319. private _effect;
  77320. private _viewMatrix;
  77321. private _projectionMatrix;
  77322. private _transformMatrix;
  77323. private _cachedPosition;
  77324. private _cachedDirection;
  77325. private _cachedDefines;
  77326. private _currentRenderID;
  77327. private _boxBlurPostprocess;
  77328. private _kernelBlurXPostprocess;
  77329. private _kernelBlurYPostprocess;
  77330. private _blurPostProcesses;
  77331. private _mapSize;
  77332. private _currentFaceIndex;
  77333. private _currentFaceIndexCache;
  77334. private _textureType;
  77335. private _defaultTextureMatrix;
  77336. private _storedUniqueId;
  77337. /** @hidden */
  77338. static _SceneComponentInitialization: (scene: Scene) => void;
  77339. /**
  77340. * Creates a ShadowGenerator object.
  77341. * A ShadowGenerator is the required tool to use the shadows.
  77342. * Each light casting shadows needs to use its own ShadowGenerator.
  77343. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  77344. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  77345. * @param light The light object generating the shadows.
  77346. * @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.
  77347. */
  77348. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  77349. private _initializeGenerator;
  77350. private _initializeShadowMap;
  77351. private _initializeBlurRTTAndPostProcesses;
  77352. private _renderForShadowMap;
  77353. private _renderSubMeshForShadowMap;
  77354. private _applyFilterValues;
  77355. /**
  77356. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  77357. * @param onCompiled Callback triggered at the and of the effects compilation
  77358. * @param options Sets of optional options forcing the compilation with different modes
  77359. */
  77360. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  77361. useInstances: boolean;
  77362. }>): void;
  77363. /**
  77364. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  77365. * @param options Sets of optional options forcing the compilation with different modes
  77366. * @returns A promise that resolves when the compilation completes
  77367. */
  77368. forceCompilationAsync(options?: Partial<{
  77369. useInstances: boolean;
  77370. }>): Promise<void>;
  77371. /**
  77372. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  77373. * @param subMesh The submesh we want to render in the shadow map
  77374. * @param useInstances Defines wether will draw in the map using instances
  77375. * @returns true if ready otherwise, false
  77376. */
  77377. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  77378. /**
  77379. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  77380. * @param defines Defines of the material we want to update
  77381. * @param lightIndex Index of the light in the enabled light list of the material
  77382. */
  77383. prepareDefines(defines: any, lightIndex: number): void;
  77384. /**
  77385. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  77386. * defined in the generator but impacting the effect).
  77387. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  77388. * @param effect The effect we are binfing the information for
  77389. */
  77390. bindShadowLight(lightIndex: string, effect: Effect): void;
  77391. /**
  77392. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  77393. * (eq to shadow prjection matrix * light transform matrix)
  77394. * @returns The transform matrix used to create the shadow map
  77395. */
  77396. getTransformMatrix(): Matrix;
  77397. /**
  77398. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  77399. * Cube and 2D textures for instance.
  77400. */
  77401. recreateShadowMap(): void;
  77402. private _disposeBlurPostProcesses;
  77403. private _disposeRTTandPostProcesses;
  77404. /**
  77405. * Disposes the ShadowGenerator.
  77406. * Returns nothing.
  77407. */
  77408. dispose(): void;
  77409. /**
  77410. * Serializes the shadow generator setup to a json object.
  77411. * @returns The serialized JSON object
  77412. */
  77413. serialize(): any;
  77414. /**
  77415. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  77416. * @param parsedShadowGenerator The JSON object to parse
  77417. * @param scene The scene to create the shadow map for
  77418. * @returns The parsed shadow generator
  77419. */
  77420. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  77421. }
  77422. }
  77423. declare module BABYLON {
  77424. /**
  77425. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  77426. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  77427. * 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.
  77428. */
  77429. export abstract class Light extends Node {
  77430. /**
  77431. * Falloff Default: light is falling off following the material specification:
  77432. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  77433. */
  77434. static readonly FALLOFF_DEFAULT: number;
  77435. /**
  77436. * Falloff Physical: light is falling off following the inverse squared distance law.
  77437. */
  77438. static readonly FALLOFF_PHYSICAL: number;
  77439. /**
  77440. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  77441. * to enhance interoperability with other engines.
  77442. */
  77443. static readonly FALLOFF_GLTF: number;
  77444. /**
  77445. * Falloff Standard: light is falling off like in the standard material
  77446. * to enhance interoperability with other materials.
  77447. */
  77448. static readonly FALLOFF_STANDARD: number;
  77449. /**
  77450. * If every light affecting the material is in this lightmapMode,
  77451. * material.lightmapTexture adds or multiplies
  77452. * (depends on material.useLightmapAsShadowmap)
  77453. * after every other light calculations.
  77454. */
  77455. static readonly LIGHTMAP_DEFAULT: number;
  77456. /**
  77457. * material.lightmapTexture as only diffuse lighting from this light
  77458. * adds only specular lighting from this light
  77459. * adds dynamic shadows
  77460. */
  77461. static readonly LIGHTMAP_SPECULAR: number;
  77462. /**
  77463. * material.lightmapTexture as only lighting
  77464. * no light calculation from this light
  77465. * only adds dynamic shadows from this light
  77466. */
  77467. static readonly LIGHTMAP_SHADOWSONLY: number;
  77468. /**
  77469. * Each light type uses the default quantity according to its type:
  77470. * point/spot lights use luminous intensity
  77471. * directional lights use illuminance
  77472. */
  77473. static readonly INTENSITYMODE_AUTOMATIC: number;
  77474. /**
  77475. * lumen (lm)
  77476. */
  77477. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  77478. /**
  77479. * candela (lm/sr)
  77480. */
  77481. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  77482. /**
  77483. * lux (lm/m^2)
  77484. */
  77485. static readonly INTENSITYMODE_ILLUMINANCE: number;
  77486. /**
  77487. * nit (cd/m^2)
  77488. */
  77489. static readonly INTENSITYMODE_LUMINANCE: number;
  77490. /**
  77491. * Light type const id of the point light.
  77492. */
  77493. static readonly LIGHTTYPEID_POINTLIGHT: number;
  77494. /**
  77495. * Light type const id of the directional light.
  77496. */
  77497. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  77498. /**
  77499. * Light type const id of the spot light.
  77500. */
  77501. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  77502. /**
  77503. * Light type const id of the hemispheric light.
  77504. */
  77505. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  77506. /**
  77507. * Diffuse gives the basic color to an object.
  77508. */
  77509. diffuse: Color3;
  77510. /**
  77511. * Specular produces a highlight color on an object.
  77512. * Note: This is note affecting PBR materials.
  77513. */
  77514. specular: Color3;
  77515. /**
  77516. * Defines the falloff type for this light. This lets overrriding how punctual light are
  77517. * falling off base on range or angle.
  77518. * This can be set to any values in Light.FALLOFF_x.
  77519. *
  77520. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  77521. * other types of materials.
  77522. */
  77523. falloffType: number;
  77524. /**
  77525. * Strength of the light.
  77526. * Note: By default it is define in the framework own unit.
  77527. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  77528. */
  77529. intensity: number;
  77530. private _range;
  77531. protected _inverseSquaredRange: number;
  77532. /**
  77533. * Defines how far from the source the light is impacting in scene units.
  77534. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  77535. */
  77536. /**
  77537. * Defines how far from the source the light is impacting in scene units.
  77538. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  77539. */
  77540. range: number;
  77541. /**
  77542. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  77543. * of light.
  77544. */
  77545. private _photometricScale;
  77546. private _intensityMode;
  77547. /**
  77548. * Gets the photometric scale used to interpret the intensity.
  77549. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  77550. */
  77551. /**
  77552. * Sets the photometric scale used to interpret the intensity.
  77553. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  77554. */
  77555. intensityMode: number;
  77556. private _radius;
  77557. /**
  77558. * Gets the light radius used by PBR Materials to simulate soft area lights.
  77559. */
  77560. /**
  77561. * sets the light radius used by PBR Materials to simulate soft area lights.
  77562. */
  77563. radius: number;
  77564. private _renderPriority;
  77565. /**
  77566. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  77567. * exceeding the number allowed of the materials.
  77568. */
  77569. renderPriority: number;
  77570. private _shadowEnabled;
  77571. /**
  77572. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  77573. * the current shadow generator.
  77574. */
  77575. /**
  77576. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  77577. * the current shadow generator.
  77578. */
  77579. shadowEnabled: boolean;
  77580. private _includedOnlyMeshes;
  77581. /**
  77582. * Gets the only meshes impacted by this light.
  77583. */
  77584. /**
  77585. * Sets the only meshes impacted by this light.
  77586. */
  77587. includedOnlyMeshes: AbstractMesh[];
  77588. private _excludedMeshes;
  77589. /**
  77590. * Gets the meshes not impacted by this light.
  77591. */
  77592. /**
  77593. * Sets the meshes not impacted by this light.
  77594. */
  77595. excludedMeshes: AbstractMesh[];
  77596. private _excludeWithLayerMask;
  77597. /**
  77598. * Gets the layer id use to find what meshes are not impacted by the light.
  77599. * Inactive if 0
  77600. */
  77601. /**
  77602. * Sets the layer id use to find what meshes are not impacted by the light.
  77603. * Inactive if 0
  77604. */
  77605. excludeWithLayerMask: number;
  77606. private _includeOnlyWithLayerMask;
  77607. /**
  77608. * Gets the layer id use to find what meshes are impacted by the light.
  77609. * Inactive if 0
  77610. */
  77611. /**
  77612. * Sets the layer id use to find what meshes are impacted by the light.
  77613. * Inactive if 0
  77614. */
  77615. includeOnlyWithLayerMask: number;
  77616. private _lightmapMode;
  77617. /**
  77618. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  77619. */
  77620. /**
  77621. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  77622. */
  77623. lightmapMode: number;
  77624. /**
  77625. * Shadow generator associted to the light.
  77626. * @hidden Internal use only.
  77627. */
  77628. _shadowGenerator: Nullable<IShadowGenerator>;
  77629. /**
  77630. * @hidden Internal use only.
  77631. */
  77632. _excludedMeshesIds: string[];
  77633. /**
  77634. * @hidden Internal use only.
  77635. */
  77636. _includedOnlyMeshesIds: string[];
  77637. /**
  77638. * The current light unifom buffer.
  77639. * @hidden Internal use only.
  77640. */
  77641. _uniformBuffer: UniformBuffer;
  77642. /** @hidden */
  77643. _renderId: number;
  77644. /**
  77645. * Creates a Light object in the scene.
  77646. * Documentation : https://doc.babylonjs.com/babylon101/lights
  77647. * @param name The firendly name of the light
  77648. * @param scene The scene the light belongs too
  77649. */
  77650. constructor(name: string, scene: Scene);
  77651. protected abstract _buildUniformLayout(): void;
  77652. /**
  77653. * Sets the passed Effect "effect" with the Light information.
  77654. * @param effect The effect to update
  77655. * @param lightIndex The index of the light in the effect to update
  77656. * @returns The light
  77657. */
  77658. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  77659. /**
  77660. * Sets the passed Effect "effect" with the Light information.
  77661. * @param effect The effect to update
  77662. * @param lightDataUniformName The uniform used to store light data (position or direction)
  77663. * @returns The light
  77664. */
  77665. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  77666. /**
  77667. * Returns the string "Light".
  77668. * @returns the class name
  77669. */
  77670. getClassName(): string;
  77671. /** @hidden */
  77672. readonly _isLight: boolean;
  77673. /**
  77674. * Converts the light information to a readable string for debug purpose.
  77675. * @param fullDetails Supports for multiple levels of logging within scene loading
  77676. * @returns the human readable light info
  77677. */
  77678. toString(fullDetails?: boolean): string;
  77679. /** @hidden */
  77680. protected _syncParentEnabledState(): void;
  77681. /**
  77682. * Set the enabled state of this node.
  77683. * @param value - the new enabled state
  77684. */
  77685. setEnabled(value: boolean): void;
  77686. /**
  77687. * Returns the Light associated shadow generator if any.
  77688. * @return the associated shadow generator.
  77689. */
  77690. getShadowGenerator(): Nullable<IShadowGenerator>;
  77691. /**
  77692. * Returns a Vector3, the absolute light position in the World.
  77693. * @returns the world space position of the light
  77694. */
  77695. getAbsolutePosition(): Vector3;
  77696. /**
  77697. * Specifies if the light will affect the passed mesh.
  77698. * @param mesh The mesh to test against the light
  77699. * @return true the mesh is affected otherwise, false.
  77700. */
  77701. canAffectMesh(mesh: AbstractMesh): boolean;
  77702. /**
  77703. * Sort function to order lights for rendering.
  77704. * @param a First Light object to compare to second.
  77705. * @param b Second Light object to compare first.
  77706. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  77707. */
  77708. static CompareLightsPriority(a: Light, b: Light): number;
  77709. /**
  77710. * Releases resources associated with this node.
  77711. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  77712. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  77713. */
  77714. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  77715. /**
  77716. * Returns the light type ID (integer).
  77717. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  77718. */
  77719. getTypeID(): number;
  77720. /**
  77721. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  77722. * @returns the scaled intensity in intensity mode unit
  77723. */
  77724. getScaledIntensity(): number;
  77725. /**
  77726. * Returns a new Light object, named "name", from the current one.
  77727. * @param name The name of the cloned light
  77728. * @returns the new created light
  77729. */
  77730. clone(name: string): Nullable<Light>;
  77731. /**
  77732. * Serializes the current light into a Serialization object.
  77733. * @returns the serialized object.
  77734. */
  77735. serialize(): any;
  77736. /**
  77737. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  77738. * This new light is named "name" and added to the passed scene.
  77739. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  77740. * @param name The friendly name of the light
  77741. * @param scene The scene the new light will belong to
  77742. * @returns the constructor function
  77743. */
  77744. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  77745. /**
  77746. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  77747. * @param parsedLight The JSON representation of the light
  77748. * @param scene The scene to create the parsed light in
  77749. * @returns the created light after parsing
  77750. */
  77751. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  77752. private _hookArrayForExcluded;
  77753. private _hookArrayForIncludedOnly;
  77754. private _resyncMeshes;
  77755. /**
  77756. * Forces the meshes to update their light related information in their rendering used effects
  77757. * @hidden Internal Use Only
  77758. */
  77759. _markMeshesAsLightDirty(): void;
  77760. /**
  77761. * Recomputes the cached photometric scale if needed.
  77762. */
  77763. private _computePhotometricScale;
  77764. /**
  77765. * Returns the Photometric Scale according to the light type and intensity mode.
  77766. */
  77767. private _getPhotometricScale;
  77768. /**
  77769. * Reorder the light in the scene according to their defined priority.
  77770. * @hidden Internal Use Only
  77771. */
  77772. _reorderLightsInScene(): void;
  77773. /**
  77774. * Prepares the list of defines specific to the light type.
  77775. * @param defines the list of defines
  77776. * @param lightIndex defines the index of the light for the effect
  77777. */
  77778. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  77779. }
  77780. }
  77781. declare module BABYLON {
  77782. /**
  77783. * Interface used to define Action
  77784. */
  77785. export interface IAction {
  77786. /**
  77787. * Trigger for the action
  77788. */
  77789. trigger: number;
  77790. /** Options of the trigger */
  77791. triggerOptions: any;
  77792. /**
  77793. * Gets the trigger parameters
  77794. * @returns the trigger parameters
  77795. */
  77796. getTriggerParameter(): any;
  77797. /**
  77798. * Internal only - executes current action event
  77799. * @hidden
  77800. */
  77801. _executeCurrent(evt?: ActionEvent): void;
  77802. /**
  77803. * Serialize placeholder for child classes
  77804. * @param parent of child
  77805. * @returns the serialized object
  77806. */
  77807. serialize(parent: any): any;
  77808. /**
  77809. * Internal only
  77810. * @hidden
  77811. */
  77812. _prepare(): void;
  77813. /**
  77814. * Internal only - manager for action
  77815. * @hidden
  77816. */
  77817. _actionManager: AbstractActionManager;
  77818. /**
  77819. * Adds action to chain of actions, may be a DoNothingAction
  77820. * @param action defines the next action to execute
  77821. * @returns The action passed in
  77822. * @see https://www.babylonjs-playground.com/#1T30HR#0
  77823. */
  77824. then(action: IAction): IAction;
  77825. }
  77826. /**
  77827. * The action to be carried out following a trigger
  77828. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  77829. */
  77830. export class Action implements IAction {
  77831. /** the trigger, with or without parameters, for the action */
  77832. triggerOptions: any;
  77833. /**
  77834. * Trigger for the action
  77835. */
  77836. trigger: number;
  77837. /**
  77838. * Internal only - manager for action
  77839. * @hidden
  77840. */
  77841. _actionManager: ActionManager;
  77842. private _nextActiveAction;
  77843. private _child;
  77844. private _condition?;
  77845. private _triggerParameter;
  77846. /**
  77847. * An event triggered prior to action being executed.
  77848. */
  77849. onBeforeExecuteObservable: Observable<Action>;
  77850. /**
  77851. * Creates a new Action
  77852. * @param triggerOptions the trigger, with or without parameters, for the action
  77853. * @param condition an optional determinant of action
  77854. */
  77855. constructor(
  77856. /** the trigger, with or without parameters, for the action */
  77857. triggerOptions: any, condition?: Condition);
  77858. /**
  77859. * Internal only
  77860. * @hidden
  77861. */
  77862. _prepare(): void;
  77863. /**
  77864. * Gets the trigger parameters
  77865. * @returns the trigger parameters
  77866. */
  77867. getTriggerParameter(): any;
  77868. /**
  77869. * Internal only - executes current action event
  77870. * @hidden
  77871. */
  77872. _executeCurrent(evt?: ActionEvent): void;
  77873. /**
  77874. * Execute placeholder for child classes
  77875. * @param evt optional action event
  77876. */
  77877. execute(evt?: ActionEvent): void;
  77878. /**
  77879. * Skips to next active action
  77880. */
  77881. skipToNextActiveAction(): void;
  77882. /**
  77883. * Adds action to chain of actions, may be a DoNothingAction
  77884. * @param action defines the next action to execute
  77885. * @returns The action passed in
  77886. * @see https://www.babylonjs-playground.com/#1T30HR#0
  77887. */
  77888. then(action: Action): Action;
  77889. /**
  77890. * Internal only
  77891. * @hidden
  77892. */
  77893. _getProperty(propertyPath: string): string;
  77894. /**
  77895. * Internal only
  77896. * @hidden
  77897. */
  77898. _getEffectiveTarget(target: any, propertyPath: string): any;
  77899. /**
  77900. * Serialize placeholder for child classes
  77901. * @param parent of child
  77902. * @returns the serialized object
  77903. */
  77904. serialize(parent: any): any;
  77905. /**
  77906. * Internal only called by serialize
  77907. * @hidden
  77908. */
  77909. protected _serialize(serializedAction: any, parent?: any): any;
  77910. /**
  77911. * Internal only
  77912. * @hidden
  77913. */
  77914. static _SerializeValueAsString: (value: any) => string;
  77915. /**
  77916. * Internal only
  77917. * @hidden
  77918. */
  77919. static _GetTargetProperty: (target: Node | Scene) => {
  77920. name: string;
  77921. targetType: string;
  77922. value: string;
  77923. };
  77924. }
  77925. }
  77926. declare module BABYLON {
  77927. /**
  77928. * A Condition applied to an Action
  77929. */
  77930. export class Condition {
  77931. /**
  77932. * Internal only - manager for action
  77933. * @hidden
  77934. */
  77935. _actionManager: ActionManager;
  77936. /**
  77937. * Internal only
  77938. * @hidden
  77939. */
  77940. _evaluationId: number;
  77941. /**
  77942. * Internal only
  77943. * @hidden
  77944. */
  77945. _currentResult: boolean;
  77946. /**
  77947. * Creates a new Condition
  77948. * @param actionManager the manager of the action the condition is applied to
  77949. */
  77950. constructor(actionManager: ActionManager);
  77951. /**
  77952. * Check if the current condition is valid
  77953. * @returns a boolean
  77954. */
  77955. isValid(): boolean;
  77956. /**
  77957. * Internal only
  77958. * @hidden
  77959. */
  77960. _getProperty(propertyPath: string): string;
  77961. /**
  77962. * Internal only
  77963. * @hidden
  77964. */
  77965. _getEffectiveTarget(target: any, propertyPath: string): any;
  77966. /**
  77967. * Serialize placeholder for child classes
  77968. * @returns the serialized object
  77969. */
  77970. serialize(): any;
  77971. /**
  77972. * Internal only
  77973. * @hidden
  77974. */
  77975. protected _serialize(serializedCondition: any): any;
  77976. }
  77977. /**
  77978. * Defines specific conditional operators as extensions of Condition
  77979. */
  77980. export class ValueCondition extends Condition {
  77981. /** path to specify the property of the target the conditional operator uses */
  77982. propertyPath: string;
  77983. /** the value compared by the conditional operator against the current value of the property */
  77984. value: any;
  77985. /** the conditional operator, default ValueCondition.IsEqual */
  77986. operator: number;
  77987. /**
  77988. * Internal only
  77989. * @hidden
  77990. */
  77991. private static _IsEqual;
  77992. /**
  77993. * Internal only
  77994. * @hidden
  77995. */
  77996. private static _IsDifferent;
  77997. /**
  77998. * Internal only
  77999. * @hidden
  78000. */
  78001. private static _IsGreater;
  78002. /**
  78003. * Internal only
  78004. * @hidden
  78005. */
  78006. private static _IsLesser;
  78007. /**
  78008. * returns the number for IsEqual
  78009. */
  78010. static readonly IsEqual: number;
  78011. /**
  78012. * Returns the number for IsDifferent
  78013. */
  78014. static readonly IsDifferent: number;
  78015. /**
  78016. * Returns the number for IsGreater
  78017. */
  78018. static readonly IsGreater: number;
  78019. /**
  78020. * Returns the number for IsLesser
  78021. */
  78022. static readonly IsLesser: number;
  78023. /**
  78024. * Internal only The action manager for the condition
  78025. * @hidden
  78026. */
  78027. _actionManager: ActionManager;
  78028. /**
  78029. * Internal only
  78030. * @hidden
  78031. */
  78032. private _target;
  78033. /**
  78034. * Internal only
  78035. * @hidden
  78036. */
  78037. private _effectiveTarget;
  78038. /**
  78039. * Internal only
  78040. * @hidden
  78041. */
  78042. private _property;
  78043. /**
  78044. * Creates a new ValueCondition
  78045. * @param actionManager manager for the action the condition applies to
  78046. * @param target for the action
  78047. * @param propertyPath path to specify the property of the target the conditional operator uses
  78048. * @param value the value compared by the conditional operator against the current value of the property
  78049. * @param operator the conditional operator, default ValueCondition.IsEqual
  78050. */
  78051. constructor(actionManager: ActionManager, target: any,
  78052. /** path to specify the property of the target the conditional operator uses */
  78053. propertyPath: string,
  78054. /** the value compared by the conditional operator against the current value of the property */
  78055. value: any,
  78056. /** the conditional operator, default ValueCondition.IsEqual */
  78057. operator?: number);
  78058. /**
  78059. * Compares the given value with the property value for the specified conditional operator
  78060. * @returns the result of the comparison
  78061. */
  78062. isValid(): boolean;
  78063. /**
  78064. * Serialize the ValueCondition into a JSON compatible object
  78065. * @returns serialization object
  78066. */
  78067. serialize(): any;
  78068. /**
  78069. * Gets the name of the conditional operator for the ValueCondition
  78070. * @param operator the conditional operator
  78071. * @returns the name
  78072. */
  78073. static GetOperatorName(operator: number): string;
  78074. }
  78075. /**
  78076. * Defines a predicate condition as an extension of Condition
  78077. */
  78078. export class PredicateCondition extends Condition {
  78079. /** defines the predicate function used to validate the condition */
  78080. predicate: () => boolean;
  78081. /**
  78082. * Internal only - manager for action
  78083. * @hidden
  78084. */
  78085. _actionManager: ActionManager;
  78086. /**
  78087. * Creates a new PredicateCondition
  78088. * @param actionManager manager for the action the condition applies to
  78089. * @param predicate defines the predicate function used to validate the condition
  78090. */
  78091. constructor(actionManager: ActionManager,
  78092. /** defines the predicate function used to validate the condition */
  78093. predicate: () => boolean);
  78094. /**
  78095. * @returns the validity of the predicate condition
  78096. */
  78097. isValid(): boolean;
  78098. }
  78099. /**
  78100. * Defines a state condition as an extension of Condition
  78101. */
  78102. export class StateCondition extends Condition {
  78103. /** Value to compare with target state */
  78104. value: string;
  78105. /**
  78106. * Internal only - manager for action
  78107. * @hidden
  78108. */
  78109. _actionManager: ActionManager;
  78110. /**
  78111. * Internal only
  78112. * @hidden
  78113. */
  78114. private _target;
  78115. /**
  78116. * Creates a new StateCondition
  78117. * @param actionManager manager for the action the condition applies to
  78118. * @param target of the condition
  78119. * @param value to compare with target state
  78120. */
  78121. constructor(actionManager: ActionManager, target: any,
  78122. /** Value to compare with target state */
  78123. value: string);
  78124. /**
  78125. * Gets a boolean indicating if the current condition is met
  78126. * @returns the validity of the state
  78127. */
  78128. isValid(): boolean;
  78129. /**
  78130. * Serialize the StateCondition into a JSON compatible object
  78131. * @returns serialization object
  78132. */
  78133. serialize(): any;
  78134. }
  78135. }
  78136. declare module BABYLON {
  78137. /**
  78138. * This defines an action responsible to toggle a boolean once triggered.
  78139. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78140. */
  78141. export class SwitchBooleanAction extends Action {
  78142. /**
  78143. * The path to the boolean property in the target object
  78144. */
  78145. propertyPath: string;
  78146. private _target;
  78147. private _effectiveTarget;
  78148. private _property;
  78149. /**
  78150. * Instantiate the action
  78151. * @param triggerOptions defines the trigger options
  78152. * @param target defines the object containing the boolean
  78153. * @param propertyPath defines the path to the boolean property in the target object
  78154. * @param condition defines the trigger related conditions
  78155. */
  78156. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  78157. /** @hidden */
  78158. _prepare(): void;
  78159. /**
  78160. * Execute the action toggle the boolean value.
  78161. */
  78162. execute(): void;
  78163. /**
  78164. * Serializes the actions and its related information.
  78165. * @param parent defines the object to serialize in
  78166. * @returns the serialized object
  78167. */
  78168. serialize(parent: any): any;
  78169. }
  78170. /**
  78171. * This defines an action responsible to set a the state field of the target
  78172. * to a desired value once triggered.
  78173. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78174. */
  78175. export class SetStateAction extends Action {
  78176. /**
  78177. * The value to store in the state field.
  78178. */
  78179. value: string;
  78180. private _target;
  78181. /**
  78182. * Instantiate the action
  78183. * @param triggerOptions defines the trigger options
  78184. * @param target defines the object containing the state property
  78185. * @param value defines the value to store in the state field
  78186. * @param condition defines the trigger related conditions
  78187. */
  78188. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  78189. /**
  78190. * Execute the action and store the value on the target state property.
  78191. */
  78192. execute(): void;
  78193. /**
  78194. * Serializes the actions and its related information.
  78195. * @param parent defines the object to serialize in
  78196. * @returns the serialized object
  78197. */
  78198. serialize(parent: any): any;
  78199. }
  78200. /**
  78201. * This defines an action responsible to set a property of the target
  78202. * to a desired value once triggered.
  78203. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78204. */
  78205. export class SetValueAction extends Action {
  78206. /**
  78207. * The path of the property to set in the target.
  78208. */
  78209. propertyPath: string;
  78210. /**
  78211. * The value to set in the property
  78212. */
  78213. value: any;
  78214. private _target;
  78215. private _effectiveTarget;
  78216. private _property;
  78217. /**
  78218. * Instantiate the action
  78219. * @param triggerOptions defines the trigger options
  78220. * @param target defines the object containing the property
  78221. * @param propertyPath defines the path of the property to set in the target
  78222. * @param value defines the value to set in the property
  78223. * @param condition defines the trigger related conditions
  78224. */
  78225. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  78226. /** @hidden */
  78227. _prepare(): void;
  78228. /**
  78229. * Execute the action and set the targetted property to the desired value.
  78230. */
  78231. execute(): void;
  78232. /**
  78233. * Serializes the actions and its related information.
  78234. * @param parent defines the object to serialize in
  78235. * @returns the serialized object
  78236. */
  78237. serialize(parent: any): any;
  78238. }
  78239. /**
  78240. * This defines an action responsible to increment the target value
  78241. * to a desired value once triggered.
  78242. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78243. */
  78244. export class IncrementValueAction extends Action {
  78245. /**
  78246. * The path of the property to increment in the target.
  78247. */
  78248. propertyPath: string;
  78249. /**
  78250. * The value we should increment the property by.
  78251. */
  78252. value: any;
  78253. private _target;
  78254. private _effectiveTarget;
  78255. private _property;
  78256. /**
  78257. * Instantiate the action
  78258. * @param triggerOptions defines the trigger options
  78259. * @param target defines the object containing the property
  78260. * @param propertyPath defines the path of the property to increment in the target
  78261. * @param value defines the value value we should increment the property by
  78262. * @param condition defines the trigger related conditions
  78263. */
  78264. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  78265. /** @hidden */
  78266. _prepare(): void;
  78267. /**
  78268. * Execute the action and increment the target of the value amount.
  78269. */
  78270. execute(): void;
  78271. /**
  78272. * Serializes the actions and its related information.
  78273. * @param parent defines the object to serialize in
  78274. * @returns the serialized object
  78275. */
  78276. serialize(parent: any): any;
  78277. }
  78278. /**
  78279. * This defines an action responsible to start an animation once triggered.
  78280. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78281. */
  78282. export class PlayAnimationAction extends Action {
  78283. /**
  78284. * Where the animation should start (animation frame)
  78285. */
  78286. from: number;
  78287. /**
  78288. * Where the animation should stop (animation frame)
  78289. */
  78290. to: number;
  78291. /**
  78292. * Define if the animation should loop or stop after the first play.
  78293. */
  78294. loop?: boolean;
  78295. private _target;
  78296. /**
  78297. * Instantiate the action
  78298. * @param triggerOptions defines the trigger options
  78299. * @param target defines the target animation or animation name
  78300. * @param from defines from where the animation should start (animation frame)
  78301. * @param end defines where the animation should stop (animation frame)
  78302. * @param loop defines if the animation should loop or stop after the first play
  78303. * @param condition defines the trigger related conditions
  78304. */
  78305. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  78306. /** @hidden */
  78307. _prepare(): void;
  78308. /**
  78309. * Execute the action and play the animation.
  78310. */
  78311. execute(): void;
  78312. /**
  78313. * Serializes the actions and its related information.
  78314. * @param parent defines the object to serialize in
  78315. * @returns the serialized object
  78316. */
  78317. serialize(parent: any): any;
  78318. }
  78319. /**
  78320. * This defines an action responsible to stop an animation once triggered.
  78321. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78322. */
  78323. export class StopAnimationAction extends Action {
  78324. private _target;
  78325. /**
  78326. * Instantiate the action
  78327. * @param triggerOptions defines the trigger options
  78328. * @param target defines the target animation or animation name
  78329. * @param condition defines the trigger related conditions
  78330. */
  78331. constructor(triggerOptions: any, target: any, condition?: Condition);
  78332. /** @hidden */
  78333. _prepare(): void;
  78334. /**
  78335. * Execute the action and stop the animation.
  78336. */
  78337. execute(): void;
  78338. /**
  78339. * Serializes the actions and its related information.
  78340. * @param parent defines the object to serialize in
  78341. * @returns the serialized object
  78342. */
  78343. serialize(parent: any): any;
  78344. }
  78345. /**
  78346. * This defines an action responsible that does nothing once triggered.
  78347. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78348. */
  78349. export class DoNothingAction extends Action {
  78350. /**
  78351. * Instantiate the action
  78352. * @param triggerOptions defines the trigger options
  78353. * @param condition defines the trigger related conditions
  78354. */
  78355. constructor(triggerOptions?: any, condition?: Condition);
  78356. /**
  78357. * Execute the action and do nothing.
  78358. */
  78359. execute(): void;
  78360. /**
  78361. * Serializes the actions and its related information.
  78362. * @param parent defines the object to serialize in
  78363. * @returns the serialized object
  78364. */
  78365. serialize(parent: any): any;
  78366. }
  78367. /**
  78368. * This defines an action responsible to trigger several actions once triggered.
  78369. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78370. */
  78371. export class CombineAction extends Action {
  78372. /**
  78373. * The list of aggregated animations to run.
  78374. */
  78375. children: Action[];
  78376. /**
  78377. * Instantiate the action
  78378. * @param triggerOptions defines the trigger options
  78379. * @param children defines the list of aggregated animations to run
  78380. * @param condition defines the trigger related conditions
  78381. */
  78382. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  78383. /** @hidden */
  78384. _prepare(): void;
  78385. /**
  78386. * Execute the action and executes all the aggregated actions.
  78387. */
  78388. execute(evt: ActionEvent): void;
  78389. /**
  78390. * Serializes the actions and its related information.
  78391. * @param parent defines the object to serialize in
  78392. * @returns the serialized object
  78393. */
  78394. serialize(parent: any): any;
  78395. }
  78396. /**
  78397. * This defines an action responsible to run code (external event) once triggered.
  78398. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78399. */
  78400. export class ExecuteCodeAction extends Action {
  78401. /**
  78402. * The callback function to run.
  78403. */
  78404. func: (evt: ActionEvent) => void;
  78405. /**
  78406. * Instantiate the action
  78407. * @param triggerOptions defines the trigger options
  78408. * @param func defines the callback function to run
  78409. * @param condition defines the trigger related conditions
  78410. */
  78411. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  78412. /**
  78413. * Execute the action and run the attached code.
  78414. */
  78415. execute(evt: ActionEvent): void;
  78416. }
  78417. /**
  78418. * This defines an action responsible to set the parent property of the target once triggered.
  78419. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78420. */
  78421. export class SetParentAction extends Action {
  78422. private _parent;
  78423. private _target;
  78424. /**
  78425. * Instantiate the action
  78426. * @param triggerOptions defines the trigger options
  78427. * @param target defines the target containing the parent property
  78428. * @param parent defines from where the animation should start (animation frame)
  78429. * @param condition defines the trigger related conditions
  78430. */
  78431. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  78432. /** @hidden */
  78433. _prepare(): void;
  78434. /**
  78435. * Execute the action and set the parent property.
  78436. */
  78437. execute(): void;
  78438. /**
  78439. * Serializes the actions and its related information.
  78440. * @param parent defines the object to serialize in
  78441. * @returns the serialized object
  78442. */
  78443. serialize(parent: any): any;
  78444. }
  78445. }
  78446. declare module BABYLON {
  78447. /**
  78448. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  78449. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  78450. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78451. */
  78452. export class ActionManager extends AbstractActionManager {
  78453. /**
  78454. * Nothing
  78455. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78456. */
  78457. static readonly NothingTrigger: number;
  78458. /**
  78459. * On pick
  78460. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78461. */
  78462. static readonly OnPickTrigger: number;
  78463. /**
  78464. * On left pick
  78465. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78466. */
  78467. static readonly OnLeftPickTrigger: number;
  78468. /**
  78469. * On right pick
  78470. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78471. */
  78472. static readonly OnRightPickTrigger: number;
  78473. /**
  78474. * On center pick
  78475. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78476. */
  78477. static readonly OnCenterPickTrigger: number;
  78478. /**
  78479. * On pick down
  78480. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78481. */
  78482. static readonly OnPickDownTrigger: number;
  78483. /**
  78484. * On double pick
  78485. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78486. */
  78487. static readonly OnDoublePickTrigger: number;
  78488. /**
  78489. * On pick up
  78490. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78491. */
  78492. static readonly OnPickUpTrigger: number;
  78493. /**
  78494. * On pick out.
  78495. * This trigger will only be raised if you also declared a OnPickDown
  78496. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78497. */
  78498. static readonly OnPickOutTrigger: number;
  78499. /**
  78500. * On long press
  78501. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78502. */
  78503. static readonly OnLongPressTrigger: number;
  78504. /**
  78505. * On pointer over
  78506. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78507. */
  78508. static readonly OnPointerOverTrigger: number;
  78509. /**
  78510. * On pointer out
  78511. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78512. */
  78513. static readonly OnPointerOutTrigger: number;
  78514. /**
  78515. * On every frame
  78516. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78517. */
  78518. static readonly OnEveryFrameTrigger: number;
  78519. /**
  78520. * On intersection enter
  78521. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78522. */
  78523. static readonly OnIntersectionEnterTrigger: number;
  78524. /**
  78525. * On intersection exit
  78526. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78527. */
  78528. static readonly OnIntersectionExitTrigger: number;
  78529. /**
  78530. * On key down
  78531. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78532. */
  78533. static readonly OnKeyDownTrigger: number;
  78534. /**
  78535. * On key up
  78536. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78537. */
  78538. static readonly OnKeyUpTrigger: number;
  78539. private _scene;
  78540. /**
  78541. * Creates a new action manager
  78542. * @param scene defines the hosting scene
  78543. */
  78544. constructor(scene: Scene);
  78545. /**
  78546. * Releases all associated resources
  78547. */
  78548. dispose(): void;
  78549. /**
  78550. * Gets hosting scene
  78551. * @returns the hosting scene
  78552. */
  78553. getScene(): Scene;
  78554. /**
  78555. * Does this action manager handles actions of any of the given triggers
  78556. * @param triggers defines the triggers to be tested
  78557. * @return a boolean indicating whether one (or more) of the triggers is handled
  78558. */
  78559. hasSpecificTriggers(triggers: number[]): boolean;
  78560. /**
  78561. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  78562. * speed.
  78563. * @param triggerA defines the trigger to be tested
  78564. * @param triggerB defines the trigger to be tested
  78565. * @return a boolean indicating whether one (or more) of the triggers is handled
  78566. */
  78567. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  78568. /**
  78569. * Does this action manager handles actions of a given trigger
  78570. * @param trigger defines the trigger to be tested
  78571. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  78572. * @return whether the trigger is handled
  78573. */
  78574. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  78575. /**
  78576. * Does this action manager has pointer triggers
  78577. */
  78578. readonly hasPointerTriggers: boolean;
  78579. /**
  78580. * Does this action manager has pick triggers
  78581. */
  78582. readonly hasPickTriggers: boolean;
  78583. /**
  78584. * Registers an action to this action manager
  78585. * @param action defines the action to be registered
  78586. * @return the action amended (prepared) after registration
  78587. */
  78588. registerAction(action: IAction): Nullable<IAction>;
  78589. /**
  78590. * Unregisters an action to this action manager
  78591. * @param action defines the action to be unregistered
  78592. * @return a boolean indicating whether the action has been unregistered
  78593. */
  78594. unregisterAction(action: IAction): Boolean;
  78595. /**
  78596. * Process a specific trigger
  78597. * @param trigger defines the trigger to process
  78598. * @param evt defines the event details to be processed
  78599. */
  78600. processTrigger(trigger: number, evt?: IActionEvent): void;
  78601. /** @hidden */
  78602. _getEffectiveTarget(target: any, propertyPath: string): any;
  78603. /** @hidden */
  78604. _getProperty(propertyPath: string): string;
  78605. /**
  78606. * Serialize this manager to a JSON object
  78607. * @param name defines the property name to store this manager
  78608. * @returns a JSON representation of this manager
  78609. */
  78610. serialize(name: string): any;
  78611. /**
  78612. * Creates a new ActionManager from a JSON data
  78613. * @param parsedActions defines the JSON data to read from
  78614. * @param object defines the hosting mesh
  78615. * @param scene defines the hosting scene
  78616. */
  78617. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  78618. /**
  78619. * Get a trigger name by index
  78620. * @param trigger defines the trigger index
  78621. * @returns a trigger name
  78622. */
  78623. static GetTriggerName(trigger: number): string;
  78624. }
  78625. }
  78626. declare module BABYLON {
  78627. /**
  78628. * Class representing a ray with position and direction
  78629. */
  78630. export class Ray {
  78631. /** origin point */
  78632. origin: Vector3;
  78633. /** direction */
  78634. direction: Vector3;
  78635. /** length of the ray */
  78636. length: number;
  78637. private static readonly TmpVector3;
  78638. private _tmpRay;
  78639. /**
  78640. * Creates a new ray
  78641. * @param origin origin point
  78642. * @param direction direction
  78643. * @param length length of the ray
  78644. */
  78645. constructor(
  78646. /** origin point */
  78647. origin: Vector3,
  78648. /** direction */
  78649. direction: Vector3,
  78650. /** length of the ray */
  78651. length?: number);
  78652. /**
  78653. * Checks if the ray intersects a box
  78654. * @param minimum bound of the box
  78655. * @param maximum bound of the box
  78656. * @param intersectionTreshold extra extend to be added to the box in all direction
  78657. * @returns if the box was hit
  78658. */
  78659. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  78660. /**
  78661. * Checks if the ray intersects a box
  78662. * @param box the bounding box to check
  78663. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  78664. * @returns if the box was hit
  78665. */
  78666. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  78667. /**
  78668. * If the ray hits a sphere
  78669. * @param sphere the bounding sphere to check
  78670. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  78671. * @returns true if it hits the sphere
  78672. */
  78673. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  78674. /**
  78675. * If the ray hits a triange
  78676. * @param vertex0 triangle vertex
  78677. * @param vertex1 triangle vertex
  78678. * @param vertex2 triangle vertex
  78679. * @returns intersection information if hit
  78680. */
  78681. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  78682. /**
  78683. * Checks if ray intersects a plane
  78684. * @param plane the plane to check
  78685. * @returns the distance away it was hit
  78686. */
  78687. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  78688. /**
  78689. * Calculate the intercept of a ray on a given axis
  78690. * @param axis to check 'x' | 'y' | 'z'
  78691. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  78692. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  78693. */
  78694. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  78695. /**
  78696. * Checks if ray intersects a mesh
  78697. * @param mesh the mesh to check
  78698. * @param fastCheck if only the bounding box should checked
  78699. * @returns picking info of the intersecton
  78700. */
  78701. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  78702. /**
  78703. * Checks if ray intersects a mesh
  78704. * @param meshes the meshes to check
  78705. * @param fastCheck if only the bounding box should checked
  78706. * @param results array to store result in
  78707. * @returns Array of picking infos
  78708. */
  78709. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  78710. private _comparePickingInfo;
  78711. private static smallnum;
  78712. private static rayl;
  78713. /**
  78714. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  78715. * @param sega the first point of the segment to test the intersection against
  78716. * @param segb the second point of the segment to test the intersection against
  78717. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  78718. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  78719. */
  78720. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  78721. /**
  78722. * Update the ray from viewport position
  78723. * @param x position
  78724. * @param y y position
  78725. * @param viewportWidth viewport width
  78726. * @param viewportHeight viewport height
  78727. * @param world world matrix
  78728. * @param view view matrix
  78729. * @param projection projection matrix
  78730. * @returns this ray updated
  78731. */
  78732. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  78733. /**
  78734. * Creates a ray with origin and direction of 0,0,0
  78735. * @returns the new ray
  78736. */
  78737. static Zero(): Ray;
  78738. /**
  78739. * Creates a new ray from screen space and viewport
  78740. * @param x position
  78741. * @param y y position
  78742. * @param viewportWidth viewport width
  78743. * @param viewportHeight viewport height
  78744. * @param world world matrix
  78745. * @param view view matrix
  78746. * @param projection projection matrix
  78747. * @returns new ray
  78748. */
  78749. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  78750. /**
  78751. * 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
  78752. * transformed to the given world matrix.
  78753. * @param origin The origin point
  78754. * @param end The end point
  78755. * @param world a matrix to transform the ray to. Default is the identity matrix.
  78756. * @returns the new ray
  78757. */
  78758. static CreateNewFromTo(origin: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, world?: DeepImmutable<Matrix>): Ray;
  78759. /**
  78760. * Transforms a ray by a matrix
  78761. * @param ray ray to transform
  78762. * @param matrix matrix to apply
  78763. * @returns the resulting new ray
  78764. */
  78765. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  78766. /**
  78767. * Transforms a ray by a matrix
  78768. * @param ray ray to transform
  78769. * @param matrix matrix to apply
  78770. * @param result ray to store result in
  78771. */
  78772. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  78773. /**
  78774. * Unproject a ray from screen space to object space
  78775. * @param sourceX defines the screen space x coordinate to use
  78776. * @param sourceY defines the screen space y coordinate to use
  78777. * @param viewportWidth defines the current width of the viewport
  78778. * @param viewportHeight defines the current height of the viewport
  78779. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  78780. * @param view defines the view matrix to use
  78781. * @param projection defines the projection matrix to use
  78782. */
  78783. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  78784. }
  78785. /**
  78786. * Type used to define predicate used to select faces when a mesh intersection is detected
  78787. */
  78788. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  78789. interface Scene {
  78790. /** @hidden */
  78791. _tempPickingRay: Nullable<Ray>;
  78792. /** @hidden */
  78793. _cachedRayForTransform: Ray;
  78794. /** @hidden */
  78795. _pickWithRayInverseMatrix: Matrix;
  78796. /** @hidden */
  78797. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  78798. /** @hidden */
  78799. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  78800. }
  78801. }
  78802. declare module BABYLON {
  78803. /**
  78804. * Groups all the scene component constants in one place to ease maintenance.
  78805. * @hidden
  78806. */
  78807. export class SceneComponentConstants {
  78808. static readonly NAME_EFFECTLAYER: string;
  78809. static readonly NAME_LAYER: string;
  78810. static readonly NAME_LENSFLARESYSTEM: string;
  78811. static readonly NAME_BOUNDINGBOXRENDERER: string;
  78812. static readonly NAME_PARTICLESYSTEM: string;
  78813. static readonly NAME_GAMEPAD: string;
  78814. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  78815. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  78816. static readonly NAME_DEPTHRENDERER: string;
  78817. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  78818. static readonly NAME_SPRITE: string;
  78819. static readonly NAME_OUTLINERENDERER: string;
  78820. static readonly NAME_PROCEDURALTEXTURE: string;
  78821. static readonly NAME_SHADOWGENERATOR: string;
  78822. static readonly NAME_OCTREE: string;
  78823. static readonly NAME_PHYSICSENGINE: string;
  78824. static readonly NAME_AUDIO: string;
  78825. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  78826. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  78827. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  78828. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  78829. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  78830. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  78831. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  78832. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  78833. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  78834. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  78835. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  78836. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  78837. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  78838. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  78839. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  78840. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  78841. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  78842. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  78843. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  78844. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  78845. static readonly STEP_AFTERRENDER_AUDIO: number;
  78846. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  78847. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  78848. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  78849. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  78850. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  78851. static readonly STEP_POINTERMOVE_SPRITE: number;
  78852. static readonly STEP_POINTERDOWN_SPRITE: number;
  78853. static readonly STEP_POINTERUP_SPRITE: number;
  78854. }
  78855. /**
  78856. * This represents a scene component.
  78857. *
  78858. * This is used to decouple the dependency the scene is having on the different workloads like
  78859. * layers, post processes...
  78860. */
  78861. export interface ISceneComponent {
  78862. /**
  78863. * The name of the component. Each component must have a unique name.
  78864. */
  78865. name: string;
  78866. /**
  78867. * The scene the component belongs to.
  78868. */
  78869. scene: Scene;
  78870. /**
  78871. * Register the component to one instance of a scene.
  78872. */
  78873. register(): void;
  78874. /**
  78875. * Rebuilds the elements related to this component in case of
  78876. * context lost for instance.
  78877. */
  78878. rebuild(): void;
  78879. /**
  78880. * Disposes the component and the associated ressources.
  78881. */
  78882. dispose(): void;
  78883. }
  78884. /**
  78885. * This represents a SERIALIZABLE scene component.
  78886. *
  78887. * This extends Scene Component to add Serialization methods on top.
  78888. */
  78889. export interface ISceneSerializableComponent extends ISceneComponent {
  78890. /**
  78891. * Adds all the elements from the container to the scene
  78892. * @param container the container holding the elements
  78893. */
  78894. addFromContainer(container: AbstractScene): void;
  78895. /**
  78896. * Removes all the elements in the container from the scene
  78897. * @param container contains the elements to remove
  78898. * @param dispose if the removed element should be disposed (default: false)
  78899. */
  78900. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  78901. /**
  78902. * Serializes the component data to the specified json object
  78903. * @param serializationObject The object to serialize to
  78904. */
  78905. serialize(serializationObject: any): void;
  78906. }
  78907. /**
  78908. * Strong typing of a Mesh related stage step action
  78909. */
  78910. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  78911. /**
  78912. * Strong typing of a Evaluate Sub Mesh related stage step action
  78913. */
  78914. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  78915. /**
  78916. * Strong typing of a Active Mesh related stage step action
  78917. */
  78918. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  78919. /**
  78920. * Strong typing of a Camera related stage step action
  78921. */
  78922. export type CameraStageAction = (camera: Camera) => void;
  78923. /**
  78924. * Strong typing of a Camera Frame buffer related stage step action
  78925. */
  78926. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  78927. /**
  78928. * Strong typing of a Render Target related stage step action
  78929. */
  78930. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  78931. /**
  78932. * Strong typing of a RenderingGroup related stage step action
  78933. */
  78934. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  78935. /**
  78936. * Strong typing of a Mesh Render related stage step action
  78937. */
  78938. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  78939. /**
  78940. * Strong typing of a simple stage step action
  78941. */
  78942. export type SimpleStageAction = () => void;
  78943. /**
  78944. * Strong typing of a render target action.
  78945. */
  78946. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  78947. /**
  78948. * Strong typing of a pointer move action.
  78949. */
  78950. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, canvas: HTMLCanvasElement) => Nullable<PickingInfo>;
  78951. /**
  78952. * Strong typing of a pointer up/down action.
  78953. */
  78954. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  78955. /**
  78956. * Representation of a stage in the scene (Basically a list of ordered steps)
  78957. * @hidden
  78958. */
  78959. export class Stage<T extends Function> extends Array<{
  78960. index: number;
  78961. component: ISceneComponent;
  78962. action: T;
  78963. }> {
  78964. /**
  78965. * Hide ctor from the rest of the world.
  78966. * @param items The items to add.
  78967. */
  78968. private constructor();
  78969. /**
  78970. * Creates a new Stage.
  78971. * @returns A new instance of a Stage
  78972. */
  78973. static Create<T extends Function>(): Stage<T>;
  78974. /**
  78975. * Registers a step in an ordered way in the targeted stage.
  78976. * @param index Defines the position to register the step in
  78977. * @param component Defines the component attached to the step
  78978. * @param action Defines the action to launch during the step
  78979. */
  78980. registerStep(index: number, component: ISceneComponent, action: T): void;
  78981. /**
  78982. * Clears all the steps from the stage.
  78983. */
  78984. clear(): void;
  78985. }
  78986. }
  78987. declare module BABYLON {
  78988. interface Scene {
  78989. /** @hidden */
  78990. _pointerOverSprite: Nullable<Sprite>;
  78991. /** @hidden */
  78992. _pickedDownSprite: Nullable<Sprite>;
  78993. /** @hidden */
  78994. _tempSpritePickingRay: Nullable<Ray>;
  78995. /**
  78996. * All of the sprite managers added to this scene
  78997. * @see http://doc.babylonjs.com/babylon101/sprites
  78998. */
  78999. spriteManagers: Array<ISpriteManager>;
  79000. /**
  79001. * An event triggered when sprites rendering is about to start
  79002. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  79003. */
  79004. onBeforeSpritesRenderingObservable: Observable<Scene>;
  79005. /**
  79006. * An event triggered when sprites rendering is done
  79007. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  79008. */
  79009. onAfterSpritesRenderingObservable: Observable<Scene>;
  79010. /** @hidden */
  79011. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79012. /** Launch a ray to try to pick a sprite in the scene
  79013. * @param x position on screen
  79014. * @param y position on screen
  79015. * @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
  79016. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  79017. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  79018. * @returns a PickingInfo
  79019. */
  79020. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79021. /** Use the given ray to pick a sprite in the scene
  79022. * @param ray The ray (in world space) to use to pick meshes
  79023. * @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
  79024. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  79025. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  79026. * @returns a PickingInfo
  79027. */
  79028. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79029. /** @hidden */
  79030. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79031. /** Launch a ray to try to pick sprites in the scene
  79032. * @param x position on screen
  79033. * @param y position on screen
  79034. * @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
  79035. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  79036. * @returns a PickingInfo array
  79037. */
  79038. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79039. /** Use the given ray to pick sprites in the scene
  79040. * @param ray The ray (in world space) to use to pick meshes
  79041. * @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
  79042. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  79043. * @returns a PickingInfo array
  79044. */
  79045. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79046. /**
  79047. * Force the sprite under the pointer
  79048. * @param sprite defines the sprite to use
  79049. */
  79050. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  79051. /**
  79052. * Gets the sprite under the pointer
  79053. * @returns a Sprite or null if no sprite is under the pointer
  79054. */
  79055. getPointerOverSprite(): Nullable<Sprite>;
  79056. }
  79057. /**
  79058. * Defines the sprite scene component responsible to manage sprites
  79059. * in a given scene.
  79060. */
  79061. export class SpriteSceneComponent implements ISceneComponent {
  79062. /**
  79063. * The component name helpfull to identify the component in the list of scene components.
  79064. */
  79065. readonly name: string;
  79066. /**
  79067. * The scene the component belongs to.
  79068. */
  79069. scene: Scene;
  79070. /** @hidden */
  79071. private _spritePredicate;
  79072. /**
  79073. * Creates a new instance of the component for the given scene
  79074. * @param scene Defines the scene to register the component in
  79075. */
  79076. constructor(scene: Scene);
  79077. /**
  79078. * Registers the component in a given scene
  79079. */
  79080. register(): void;
  79081. /**
  79082. * Rebuilds the elements related to this component in case of
  79083. * context lost for instance.
  79084. */
  79085. rebuild(): void;
  79086. /**
  79087. * Disposes the component and the associated ressources.
  79088. */
  79089. dispose(): void;
  79090. private _pickSpriteButKeepRay;
  79091. private _pointerMove;
  79092. private _pointerDown;
  79093. private _pointerUp;
  79094. }
  79095. }
  79096. declare module BABYLON {
  79097. /** @hidden */
  79098. export var fogFragmentDeclaration: {
  79099. name: string;
  79100. shader: string;
  79101. };
  79102. }
  79103. declare module BABYLON {
  79104. /** @hidden */
  79105. export var fogFragment: {
  79106. name: string;
  79107. shader: string;
  79108. };
  79109. }
  79110. declare module BABYLON {
  79111. /** @hidden */
  79112. export var spritesPixelShader: {
  79113. name: string;
  79114. shader: string;
  79115. };
  79116. }
  79117. declare module BABYLON {
  79118. /** @hidden */
  79119. export var fogVertexDeclaration: {
  79120. name: string;
  79121. shader: string;
  79122. };
  79123. }
  79124. declare module BABYLON {
  79125. /** @hidden */
  79126. export var spritesVertexShader: {
  79127. name: string;
  79128. shader: string;
  79129. };
  79130. }
  79131. declare module BABYLON {
  79132. /**
  79133. * Defines the minimum interface to fullfil in order to be a sprite manager.
  79134. */
  79135. export interface ISpriteManager extends IDisposable {
  79136. /**
  79137. * Restricts the camera to viewing objects with the same layerMask.
  79138. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  79139. */
  79140. layerMask: number;
  79141. /**
  79142. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  79143. */
  79144. isPickable: boolean;
  79145. /**
  79146. * Specifies the rendering group id for this mesh (0 by default)
  79147. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  79148. */
  79149. renderingGroupId: number;
  79150. /**
  79151. * Defines the list of sprites managed by the manager.
  79152. */
  79153. sprites: Array<Sprite>;
  79154. /**
  79155. * Tests the intersection of a sprite with a specific ray.
  79156. * @param ray The ray we are sending to test the collision
  79157. * @param camera The camera space we are sending rays in
  79158. * @param predicate A predicate allowing excluding sprites from the list of object to test
  79159. * @param fastCheck Is the hit test done in a OOBB or AOBB fashion the faster, the less precise
  79160. * @returns picking info or null.
  79161. */
  79162. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  79163. /**
  79164. * Intersects the sprites with a ray
  79165. * @param ray defines the ray to intersect with
  79166. * @param camera defines the current active camera
  79167. * @param predicate defines a predicate used to select candidate sprites
  79168. * @returns null if no hit or a PickingInfo array
  79169. */
  79170. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  79171. /**
  79172. * Renders the list of sprites on screen.
  79173. */
  79174. render(): void;
  79175. }
  79176. /**
  79177. * Class used to manage multiple sprites on the same spritesheet
  79178. * @see http://doc.babylonjs.com/babylon101/sprites
  79179. */
  79180. export class SpriteManager implements ISpriteManager {
  79181. /** defines the manager's name */
  79182. name: string;
  79183. /** Gets the list of sprites */
  79184. sprites: Sprite[];
  79185. /** Gets or sets the rendering group id (0 by default) */
  79186. renderingGroupId: number;
  79187. /** Gets or sets camera layer mask */
  79188. layerMask: number;
  79189. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  79190. fogEnabled: boolean;
  79191. /** Gets or sets a boolean indicating if the sprites are pickable */
  79192. isPickable: boolean;
  79193. /** Defines the default width of a cell in the spritesheet */
  79194. cellWidth: number;
  79195. /** Defines the default height of a cell in the spritesheet */
  79196. cellHeight: number;
  79197. /** Associative array from JSON sprite data file */
  79198. private _cellData;
  79199. /** Array of sprite names from JSON sprite data file */
  79200. private _spriteMap;
  79201. /** True when packed cell data from JSON file is ready*/
  79202. private _packedAndReady;
  79203. /**
  79204. * An event triggered when the manager is disposed.
  79205. */
  79206. onDisposeObservable: Observable<SpriteManager>;
  79207. private _onDisposeObserver;
  79208. /**
  79209. * Callback called when the manager is disposed
  79210. */
  79211. onDispose: () => void;
  79212. private _capacity;
  79213. private _fromPacked;
  79214. private _spriteTexture;
  79215. private _epsilon;
  79216. private _scene;
  79217. private _vertexData;
  79218. private _buffer;
  79219. private _vertexBuffers;
  79220. private _indexBuffer;
  79221. private _effectBase;
  79222. private _effectFog;
  79223. /**
  79224. * Gets or sets the spritesheet texture
  79225. */
  79226. texture: Texture;
  79227. /**
  79228. * Creates a new sprite manager
  79229. * @param name defines the manager's name
  79230. * @param imgUrl defines the sprite sheet url
  79231. * @param capacity defines the maximum allowed number of sprites
  79232. * @param cellSize defines the size of a sprite cell
  79233. * @param scene defines the hosting scene
  79234. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  79235. * @param samplingMode defines the smapling mode to use with spritesheet
  79236. * @param fromPacked set to false; do not alter
  79237. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  79238. */
  79239. constructor(
  79240. /** defines the manager's name */
  79241. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: string | null);
  79242. private _makePacked;
  79243. private _appendSpriteVertex;
  79244. /**
  79245. * Intersects the sprites with a ray
  79246. * @param ray defines the ray to intersect with
  79247. * @param camera defines the current active camera
  79248. * @param predicate defines a predicate used to select candidate sprites
  79249. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  79250. * @returns null if no hit or a PickingInfo
  79251. */
  79252. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  79253. /**
  79254. * Intersects the sprites with a ray
  79255. * @param ray defines the ray to intersect with
  79256. * @param camera defines the current active camera
  79257. * @param predicate defines a predicate used to select candidate sprites
  79258. * @returns null if no hit or a PickingInfo array
  79259. */
  79260. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  79261. /**
  79262. * Render all child sprites
  79263. */
  79264. render(): void;
  79265. /**
  79266. * Release associated resources
  79267. */
  79268. dispose(): void;
  79269. }
  79270. }
  79271. declare module BABYLON {
  79272. /**
  79273. * Class used to represent a sprite
  79274. * @see http://doc.babylonjs.com/babylon101/sprites
  79275. */
  79276. export class Sprite {
  79277. /** defines the name */
  79278. name: string;
  79279. /** Gets or sets the current world position */
  79280. position: Vector3;
  79281. /** Gets or sets the main color */
  79282. color: Color4;
  79283. /** Gets or sets the width */
  79284. width: number;
  79285. /** Gets or sets the height */
  79286. height: number;
  79287. /** Gets or sets rotation angle */
  79288. angle: number;
  79289. /** Gets or sets the cell index in the sprite sheet */
  79290. cellIndex: number;
  79291. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  79292. cellRef: string;
  79293. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  79294. invertU: number;
  79295. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  79296. invertV: number;
  79297. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  79298. disposeWhenFinishedAnimating: boolean;
  79299. /** Gets the list of attached animations */
  79300. animations: Animation[];
  79301. /** Gets or sets a boolean indicating if the sprite can be picked */
  79302. isPickable: boolean;
  79303. /**
  79304. * Gets or sets the associated action manager
  79305. */
  79306. actionManager: Nullable<ActionManager>;
  79307. private _animationStarted;
  79308. private _loopAnimation;
  79309. private _fromIndex;
  79310. private _toIndex;
  79311. private _delay;
  79312. private _direction;
  79313. private _manager;
  79314. private _time;
  79315. private _onAnimationEnd;
  79316. /**
  79317. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  79318. */
  79319. isVisible: boolean;
  79320. /**
  79321. * Gets or sets the sprite size
  79322. */
  79323. size: number;
  79324. /**
  79325. * Creates a new Sprite
  79326. * @param name defines the name
  79327. * @param manager defines the manager
  79328. */
  79329. constructor(
  79330. /** defines the name */
  79331. name: string, manager: ISpriteManager);
  79332. /**
  79333. * Starts an animation
  79334. * @param from defines the initial key
  79335. * @param to defines the end key
  79336. * @param loop defines if the animation must loop
  79337. * @param delay defines the start delay (in ms)
  79338. * @param onAnimationEnd defines a callback to call when animation ends
  79339. */
  79340. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: () => void): void;
  79341. /** Stops current animation (if any) */
  79342. stopAnimation(): void;
  79343. /** @hidden */
  79344. _animate(deltaTime: number): void;
  79345. /** Release associated resources */
  79346. dispose(): void;
  79347. }
  79348. }
  79349. declare module BABYLON {
  79350. /**
  79351. * Information about the result of picking within a scene
  79352. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  79353. */
  79354. export class PickingInfo {
  79355. /** @hidden */
  79356. _pickingUnavailable: boolean;
  79357. /**
  79358. * If the pick collided with an object
  79359. */
  79360. hit: boolean;
  79361. /**
  79362. * Distance away where the pick collided
  79363. */
  79364. distance: number;
  79365. /**
  79366. * The location of pick collision
  79367. */
  79368. pickedPoint: Nullable<Vector3>;
  79369. /**
  79370. * The mesh corresponding the the pick collision
  79371. */
  79372. pickedMesh: Nullable<AbstractMesh>;
  79373. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  79374. bu: number;
  79375. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  79376. bv: number;
  79377. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  79378. faceId: number;
  79379. /** Id of the the submesh that was picked */
  79380. subMeshId: number;
  79381. /** If a sprite was picked, this will be the sprite the pick collided with */
  79382. pickedSprite: Nullable<Sprite>;
  79383. /**
  79384. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  79385. */
  79386. originMesh: Nullable<AbstractMesh>;
  79387. /**
  79388. * The ray that was used to perform the picking.
  79389. */
  79390. ray: Nullable<Ray>;
  79391. /**
  79392. * Gets the normal correspodning to the face the pick collided with
  79393. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  79394. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  79395. * @returns The normal correspodning to the face the pick collided with
  79396. */
  79397. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  79398. /**
  79399. * Gets the texture coordinates of where the pick occured
  79400. * @returns the vector containing the coordnates of the texture
  79401. */
  79402. getTextureCoordinates(): Nullable<Vector2>;
  79403. }
  79404. }
  79405. declare module BABYLON {
  79406. /**
  79407. * Gather the list of pointer event types as constants.
  79408. */
  79409. export class PointerEventTypes {
  79410. /**
  79411. * 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.
  79412. */
  79413. static readonly POINTERDOWN: number;
  79414. /**
  79415. * The pointerup event is fired when a pointer is no longer active.
  79416. */
  79417. static readonly POINTERUP: number;
  79418. /**
  79419. * The pointermove event is fired when a pointer changes coordinates.
  79420. */
  79421. static readonly POINTERMOVE: number;
  79422. /**
  79423. * The pointerwheel event is fired when a mouse wheel has been rotated.
  79424. */
  79425. static readonly POINTERWHEEL: number;
  79426. /**
  79427. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  79428. */
  79429. static readonly POINTERPICK: number;
  79430. /**
  79431. * The pointertap event is fired when a the object has been touched and released without drag.
  79432. */
  79433. static readonly POINTERTAP: number;
  79434. /**
  79435. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  79436. */
  79437. static readonly POINTERDOUBLETAP: number;
  79438. }
  79439. /**
  79440. * Base class of pointer info types.
  79441. */
  79442. export class PointerInfoBase {
  79443. /**
  79444. * Defines the type of event (PointerEventTypes)
  79445. */
  79446. type: number;
  79447. /**
  79448. * Defines the related dom event
  79449. */
  79450. event: PointerEvent | MouseWheelEvent;
  79451. /**
  79452. * Instantiates the base class of pointers info.
  79453. * @param type Defines the type of event (PointerEventTypes)
  79454. * @param event Defines the related dom event
  79455. */
  79456. constructor(
  79457. /**
  79458. * Defines the type of event (PointerEventTypes)
  79459. */
  79460. type: number,
  79461. /**
  79462. * Defines the related dom event
  79463. */
  79464. event: PointerEvent | MouseWheelEvent);
  79465. }
  79466. /**
  79467. * This class is used to store pointer related info for the onPrePointerObservable event.
  79468. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  79469. */
  79470. export class PointerInfoPre extends PointerInfoBase {
  79471. /**
  79472. * Ray from a pointer if availible (eg. 6dof controller)
  79473. */
  79474. ray: Nullable<Ray>;
  79475. /**
  79476. * Defines the local position of the pointer on the canvas.
  79477. */
  79478. localPosition: Vector2;
  79479. /**
  79480. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  79481. */
  79482. skipOnPointerObservable: boolean;
  79483. /**
  79484. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  79485. * @param type Defines the type of event (PointerEventTypes)
  79486. * @param event Defines the related dom event
  79487. * @param localX Defines the local x coordinates of the pointer when the event occured
  79488. * @param localY Defines the local y coordinates of the pointer when the event occured
  79489. */
  79490. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  79491. }
  79492. /**
  79493. * This type contains all the data related to a pointer event in Babylon.js.
  79494. * 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.
  79495. */
  79496. export class PointerInfo extends PointerInfoBase {
  79497. /**
  79498. * Defines the picking info associated to the info (if any)\
  79499. */
  79500. pickInfo: Nullable<PickingInfo>;
  79501. /**
  79502. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  79503. * @param type Defines the type of event (PointerEventTypes)
  79504. * @param event Defines the related dom event
  79505. * @param pickInfo Defines the picking info associated to the info (if any)\
  79506. */
  79507. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  79508. /**
  79509. * Defines the picking info associated to the info (if any)\
  79510. */
  79511. pickInfo: Nullable<PickingInfo>);
  79512. }
  79513. /**
  79514. * Data relating to a touch event on the screen.
  79515. */
  79516. export interface PointerTouch {
  79517. /**
  79518. * X coordinate of touch.
  79519. */
  79520. x: number;
  79521. /**
  79522. * Y coordinate of touch.
  79523. */
  79524. y: number;
  79525. /**
  79526. * Id of touch. Unique for each finger.
  79527. */
  79528. pointerId: number;
  79529. /**
  79530. * Event type passed from DOM.
  79531. */
  79532. type: any;
  79533. }
  79534. }
  79535. declare module BABYLON {
  79536. /**
  79537. * Manage the mouse inputs to control the movement of a free camera.
  79538. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  79539. */
  79540. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  79541. /**
  79542. * Define if touch is enabled in the mouse input
  79543. */
  79544. touchEnabled: boolean;
  79545. /**
  79546. * Defines the camera the input is attached to.
  79547. */
  79548. camera: FreeCamera;
  79549. /**
  79550. * Defines the buttons associated with the input to handle camera move.
  79551. */
  79552. buttons: number[];
  79553. /**
  79554. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  79555. */
  79556. angularSensibility: number;
  79557. private _pointerInput;
  79558. private _onMouseMove;
  79559. private _observer;
  79560. private previousPosition;
  79561. /**
  79562. * Observable for when a pointer move event occurs containing the move offset
  79563. */
  79564. onPointerMovedObservable: Observable<{
  79565. offsetX: number;
  79566. offsetY: number;
  79567. }>;
  79568. /**
  79569. * @hidden
  79570. * If the camera should be rotated automatically based on pointer movement
  79571. */
  79572. _allowCameraRotation: boolean;
  79573. /**
  79574. * Manage the mouse inputs to control the movement of a free camera.
  79575. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  79576. * @param touchEnabled Defines if touch is enabled or not
  79577. */
  79578. constructor(
  79579. /**
  79580. * Define if touch is enabled in the mouse input
  79581. */
  79582. touchEnabled?: boolean);
  79583. /**
  79584. * Attach the input controls to a specific dom element to get the input from.
  79585. * @param element Defines the element the controls should be listened from
  79586. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  79587. */
  79588. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  79589. /**
  79590. * Called on JS contextmenu event.
  79591. * Override this method to provide functionality.
  79592. */
  79593. protected onContextMenu(evt: PointerEvent): void;
  79594. /**
  79595. * Detach the current controls from the specified dom element.
  79596. * @param element Defines the element to stop listening the inputs from
  79597. */
  79598. detachControl(element: Nullable<HTMLElement>): void;
  79599. /**
  79600. * Gets the class name of the current intput.
  79601. * @returns the class name
  79602. */
  79603. getClassName(): string;
  79604. /**
  79605. * Get the friendly name associated with the input class.
  79606. * @returns the input friendly name
  79607. */
  79608. getSimpleName(): string;
  79609. }
  79610. }
  79611. declare module BABYLON {
  79612. /**
  79613. * Manage the touch inputs to control the movement of a free camera.
  79614. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  79615. */
  79616. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  79617. /**
  79618. * Defines the camera the input is attached to.
  79619. */
  79620. camera: FreeCamera;
  79621. /**
  79622. * Defines the touch sensibility for rotation.
  79623. * The higher the faster.
  79624. */
  79625. touchAngularSensibility: number;
  79626. /**
  79627. * Defines the touch sensibility for move.
  79628. * The higher the faster.
  79629. */
  79630. touchMoveSensibility: number;
  79631. private _offsetX;
  79632. private _offsetY;
  79633. private _pointerPressed;
  79634. private _pointerInput;
  79635. private _observer;
  79636. private _onLostFocus;
  79637. /**
  79638. * Attach the input controls to a specific dom element to get the input from.
  79639. * @param element Defines the element the controls should be listened from
  79640. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  79641. */
  79642. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  79643. /**
  79644. * Detach the current controls from the specified dom element.
  79645. * @param element Defines the element to stop listening the inputs from
  79646. */
  79647. detachControl(element: Nullable<HTMLElement>): void;
  79648. /**
  79649. * Update the current camera state depending on the inputs that have been used this frame.
  79650. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  79651. */
  79652. checkInputs(): void;
  79653. /**
  79654. * Gets the class name of the current intput.
  79655. * @returns the class name
  79656. */
  79657. getClassName(): string;
  79658. /**
  79659. * Get the friendly name associated with the input class.
  79660. * @returns the input friendly name
  79661. */
  79662. getSimpleName(): string;
  79663. }
  79664. }
  79665. declare module BABYLON {
  79666. /**
  79667. * Default Inputs manager for the FreeCamera.
  79668. * It groups all the default supported inputs for ease of use.
  79669. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  79670. */
  79671. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  79672. /**
  79673. * @hidden
  79674. */
  79675. _mouseInput: Nullable<FreeCameraMouseInput>;
  79676. /**
  79677. * Instantiates a new FreeCameraInputsManager.
  79678. * @param camera Defines the camera the inputs belong to
  79679. */
  79680. constructor(camera: FreeCamera);
  79681. /**
  79682. * Add keyboard input support to the input manager.
  79683. * @returns the current input manager
  79684. */
  79685. addKeyboard(): FreeCameraInputsManager;
  79686. /**
  79687. * Add mouse input support to the input manager.
  79688. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  79689. * @returns the current input manager
  79690. */
  79691. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  79692. /**
  79693. * Removes the mouse input support from the manager
  79694. * @returns the current input manager
  79695. */
  79696. removeMouse(): FreeCameraInputsManager;
  79697. /**
  79698. * Add touch input support to the input manager.
  79699. * @returns the current input manager
  79700. */
  79701. addTouch(): FreeCameraInputsManager;
  79702. /**
  79703. * Remove all attached input methods from a camera
  79704. */
  79705. clear(): void;
  79706. }
  79707. }
  79708. declare module BABYLON {
  79709. /**
  79710. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  79711. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  79712. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  79713. */
  79714. export class FreeCamera extends TargetCamera {
  79715. /**
  79716. * Define the collision ellipsoid of the camera.
  79717. * This is helpful to simulate a camera body like the player body around the camera
  79718. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  79719. */
  79720. ellipsoid: Vector3;
  79721. /**
  79722. * Define an offset for the position of the ellipsoid around the camera.
  79723. * This can be helpful to determine the center of the body near the gravity center of the body
  79724. * instead of its head.
  79725. */
  79726. ellipsoidOffset: Vector3;
  79727. /**
  79728. * Enable or disable collisions of the camera with the rest of the scene objects.
  79729. */
  79730. checkCollisions: boolean;
  79731. /**
  79732. * Enable or disable gravity on the camera.
  79733. */
  79734. applyGravity: boolean;
  79735. /**
  79736. * Define the input manager associated to the camera.
  79737. */
  79738. inputs: FreeCameraInputsManager;
  79739. /**
  79740. * Gets the input sensibility for a mouse input. (default is 2000.0)
  79741. * Higher values reduce sensitivity.
  79742. */
  79743. /**
  79744. * Sets the input sensibility for a mouse input. (default is 2000.0)
  79745. * Higher values reduce sensitivity.
  79746. */
  79747. angularSensibility: number;
  79748. /**
  79749. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  79750. */
  79751. keysUp: number[];
  79752. /**
  79753. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  79754. */
  79755. keysDown: number[];
  79756. /**
  79757. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  79758. */
  79759. keysLeft: number[];
  79760. /**
  79761. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  79762. */
  79763. keysRight: number[];
  79764. /**
  79765. * Event raised when the camera collide with a mesh in the scene.
  79766. */
  79767. onCollide: (collidedMesh: AbstractMesh) => void;
  79768. private _collider;
  79769. private _needMoveForGravity;
  79770. private _oldPosition;
  79771. private _diffPosition;
  79772. private _newPosition;
  79773. /** @hidden */
  79774. _localDirection: Vector3;
  79775. /** @hidden */
  79776. _transformedDirection: Vector3;
  79777. /**
  79778. * Instantiates a Free Camera.
  79779. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  79780. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  79781. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  79782. * @param name Define the name of the camera in the scene
  79783. * @param position Define the start position of the camera in the scene
  79784. * @param scene Define the scene the camera belongs to
  79785. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  79786. */
  79787. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  79788. /**
  79789. * Attached controls to the current camera.
  79790. * @param element Defines the element the controls should be listened from
  79791. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  79792. */
  79793. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  79794. /**
  79795. * Detach the current controls from the camera.
  79796. * The camera will stop reacting to inputs.
  79797. * @param element Defines the element to stop listening the inputs from
  79798. */
  79799. detachControl(element: HTMLElement): void;
  79800. private _collisionMask;
  79801. /**
  79802. * Define a collision mask to limit the list of object the camera can collide with
  79803. */
  79804. collisionMask: number;
  79805. /** @hidden */
  79806. _collideWithWorld(displacement: Vector3): void;
  79807. private _onCollisionPositionChange;
  79808. /** @hidden */
  79809. _checkInputs(): void;
  79810. /** @hidden */
  79811. _decideIfNeedsToMove(): boolean;
  79812. /** @hidden */
  79813. _updatePosition(): void;
  79814. /**
  79815. * Destroy the camera and release the current resources hold by it.
  79816. */
  79817. dispose(): void;
  79818. /**
  79819. * Gets the current object class name.
  79820. * @return the class name
  79821. */
  79822. getClassName(): string;
  79823. }
  79824. }
  79825. declare module BABYLON {
  79826. /**
  79827. * Represents a gamepad control stick position
  79828. */
  79829. export class StickValues {
  79830. /**
  79831. * The x component of the control stick
  79832. */
  79833. x: number;
  79834. /**
  79835. * The y component of the control stick
  79836. */
  79837. y: number;
  79838. /**
  79839. * Initializes the gamepad x and y control stick values
  79840. * @param x The x component of the gamepad control stick value
  79841. * @param y The y component of the gamepad control stick value
  79842. */
  79843. constructor(
  79844. /**
  79845. * The x component of the control stick
  79846. */
  79847. x: number,
  79848. /**
  79849. * The y component of the control stick
  79850. */
  79851. y: number);
  79852. }
  79853. /**
  79854. * An interface which manages callbacks for gamepad button changes
  79855. */
  79856. export interface GamepadButtonChanges {
  79857. /**
  79858. * Called when a gamepad has been changed
  79859. */
  79860. changed: boolean;
  79861. /**
  79862. * Called when a gamepad press event has been triggered
  79863. */
  79864. pressChanged: boolean;
  79865. /**
  79866. * Called when a touch event has been triggered
  79867. */
  79868. touchChanged: boolean;
  79869. /**
  79870. * Called when a value has changed
  79871. */
  79872. valueChanged: boolean;
  79873. }
  79874. /**
  79875. * Represents a gamepad
  79876. */
  79877. export class Gamepad {
  79878. /**
  79879. * The id of the gamepad
  79880. */
  79881. id: string;
  79882. /**
  79883. * The index of the gamepad
  79884. */
  79885. index: number;
  79886. /**
  79887. * The browser gamepad
  79888. */
  79889. browserGamepad: any;
  79890. /**
  79891. * Specifies what type of gamepad this represents
  79892. */
  79893. type: number;
  79894. private _leftStick;
  79895. private _rightStick;
  79896. /** @hidden */
  79897. _isConnected: boolean;
  79898. private _leftStickAxisX;
  79899. private _leftStickAxisY;
  79900. private _rightStickAxisX;
  79901. private _rightStickAxisY;
  79902. /**
  79903. * Triggered when the left control stick has been changed
  79904. */
  79905. private _onleftstickchanged;
  79906. /**
  79907. * Triggered when the right control stick has been changed
  79908. */
  79909. private _onrightstickchanged;
  79910. /**
  79911. * Represents a gamepad controller
  79912. */
  79913. static GAMEPAD: number;
  79914. /**
  79915. * Represents a generic controller
  79916. */
  79917. static GENERIC: number;
  79918. /**
  79919. * Represents an XBox controller
  79920. */
  79921. static XBOX: number;
  79922. /**
  79923. * Represents a pose-enabled controller
  79924. */
  79925. static POSE_ENABLED: number;
  79926. /**
  79927. * Represents an Dual Shock controller
  79928. */
  79929. static DUALSHOCK: number;
  79930. /**
  79931. * Specifies whether the left control stick should be Y-inverted
  79932. */
  79933. protected _invertLeftStickY: boolean;
  79934. /**
  79935. * Specifies if the gamepad has been connected
  79936. */
  79937. readonly isConnected: boolean;
  79938. /**
  79939. * Initializes the gamepad
  79940. * @param id The id of the gamepad
  79941. * @param index The index of the gamepad
  79942. * @param browserGamepad The browser gamepad
  79943. * @param leftStickX The x component of the left joystick
  79944. * @param leftStickY The y component of the left joystick
  79945. * @param rightStickX The x component of the right joystick
  79946. * @param rightStickY The y component of the right joystick
  79947. */
  79948. constructor(
  79949. /**
  79950. * The id of the gamepad
  79951. */
  79952. id: string,
  79953. /**
  79954. * The index of the gamepad
  79955. */
  79956. index: number,
  79957. /**
  79958. * The browser gamepad
  79959. */
  79960. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  79961. /**
  79962. * Callback triggered when the left joystick has changed
  79963. * @param callback
  79964. */
  79965. onleftstickchanged(callback: (values: StickValues) => void): void;
  79966. /**
  79967. * Callback triggered when the right joystick has changed
  79968. * @param callback
  79969. */
  79970. onrightstickchanged(callback: (values: StickValues) => void): void;
  79971. /**
  79972. * Gets the left joystick
  79973. */
  79974. /**
  79975. * Sets the left joystick values
  79976. */
  79977. leftStick: StickValues;
  79978. /**
  79979. * Gets the right joystick
  79980. */
  79981. /**
  79982. * Sets the right joystick value
  79983. */
  79984. rightStick: StickValues;
  79985. /**
  79986. * Updates the gamepad joystick positions
  79987. */
  79988. update(): void;
  79989. /**
  79990. * Disposes the gamepad
  79991. */
  79992. dispose(): void;
  79993. }
  79994. /**
  79995. * Represents a generic gamepad
  79996. */
  79997. export class GenericPad extends Gamepad {
  79998. private _buttons;
  79999. private _onbuttondown;
  80000. private _onbuttonup;
  80001. /**
  80002. * Observable triggered when a button has been pressed
  80003. */
  80004. onButtonDownObservable: Observable<number>;
  80005. /**
  80006. * Observable triggered when a button has been released
  80007. */
  80008. onButtonUpObservable: Observable<number>;
  80009. /**
  80010. * Callback triggered when a button has been pressed
  80011. * @param callback Called when a button has been pressed
  80012. */
  80013. onbuttondown(callback: (buttonPressed: number) => void): void;
  80014. /**
  80015. * Callback triggered when a button has been released
  80016. * @param callback Called when a button has been released
  80017. */
  80018. onbuttonup(callback: (buttonReleased: number) => void): void;
  80019. /**
  80020. * Initializes the generic gamepad
  80021. * @param id The id of the generic gamepad
  80022. * @param index The index of the generic gamepad
  80023. * @param browserGamepad The browser gamepad
  80024. */
  80025. constructor(id: string, index: number, browserGamepad: any);
  80026. private _setButtonValue;
  80027. /**
  80028. * Updates the generic gamepad
  80029. */
  80030. update(): void;
  80031. /**
  80032. * Disposes the generic gamepad
  80033. */
  80034. dispose(): void;
  80035. }
  80036. }
  80037. declare module BABYLON {
  80038. interface Engine {
  80039. /**
  80040. * Creates a raw texture
  80041. * @param data defines the data to store in the texture
  80042. * @param width defines the width of the texture
  80043. * @param height defines the height of the texture
  80044. * @param format defines the format of the data
  80045. * @param generateMipMaps defines if the engine should generate the mip levels
  80046. * @param invertY defines if data must be stored with Y axis inverted
  80047. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  80048. * @param compression defines the compression used (null by default)
  80049. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80050. * @returns the raw texture inside an InternalTexture
  80051. */
  80052. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  80053. /**
  80054. * Update a raw texture
  80055. * @param texture defines the texture to update
  80056. * @param data defines the data to store in the texture
  80057. * @param format defines the format of the data
  80058. * @param invertY defines if data must be stored with Y axis inverted
  80059. */
  80060. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  80061. /**
  80062. * Update a raw texture
  80063. * @param texture defines the texture to update
  80064. * @param data defines the data to store in the texture
  80065. * @param format defines the format of the data
  80066. * @param invertY defines if data must be stored with Y axis inverted
  80067. * @param compression defines the compression used (null by default)
  80068. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80069. */
  80070. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  80071. /**
  80072. * Creates a new raw cube texture
  80073. * @param data defines the array of data to use to create each face
  80074. * @param size defines the size of the textures
  80075. * @param format defines the format of the data
  80076. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80077. * @param generateMipMaps defines if the engine should generate the mip levels
  80078. * @param invertY defines if data must be stored with Y axis inverted
  80079. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80080. * @param compression defines the compression used (null by default)
  80081. * @returns the cube texture as an InternalTexture
  80082. */
  80083. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  80084. /**
  80085. * Update a raw cube texture
  80086. * @param texture defines the texture to udpdate
  80087. * @param data defines the data to store
  80088. * @param format defines the data format
  80089. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80090. * @param invertY defines if data must be stored with Y axis inverted
  80091. */
  80092. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  80093. /**
  80094. * Update a raw cube texture
  80095. * @param texture defines the texture to udpdate
  80096. * @param data defines the data to store
  80097. * @param format defines the data format
  80098. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80099. * @param invertY defines if data must be stored with Y axis inverted
  80100. * @param compression defines the compression used (null by default)
  80101. */
  80102. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  80103. /**
  80104. * Update a raw cube texture
  80105. * @param texture defines the texture to udpdate
  80106. * @param data defines the data to store
  80107. * @param format defines the data format
  80108. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80109. * @param invertY defines if data must be stored with Y axis inverted
  80110. * @param compression defines the compression used (null by default)
  80111. * @param level defines which level of the texture to update
  80112. */
  80113. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  80114. /**
  80115. * Creates a new raw cube texture from a specified url
  80116. * @param url defines the url where the data is located
  80117. * @param scene defines the current scene
  80118. * @param size defines the size of the textures
  80119. * @param format defines the format of the data
  80120. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80121. * @param noMipmap defines if the engine should avoid generating the mip levels
  80122. * @param callback defines a callback used to extract texture data from loaded data
  80123. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  80124. * @param onLoad defines a callback called when texture is loaded
  80125. * @param onError defines a callback called if there is an error
  80126. * @returns the cube texture as an InternalTexture
  80127. */
  80128. createRawCubeTextureFromUrl(url: string, scene: Scene, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>): InternalTexture;
  80129. /**
  80130. * Creates a new raw cube texture from a specified url
  80131. * @param url defines the url where the data is located
  80132. * @param scene defines the current scene
  80133. * @param size defines the size of the textures
  80134. * @param format defines the format of the data
  80135. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80136. * @param noMipmap defines if the engine should avoid generating the mip levels
  80137. * @param callback defines a callback used to extract texture data from loaded data
  80138. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  80139. * @param onLoad defines a callback called when texture is loaded
  80140. * @param onError defines a callback called if there is an error
  80141. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80142. * @param invertY defines if data must be stored with Y axis inverted
  80143. * @returns the cube texture as an InternalTexture
  80144. */
  80145. createRawCubeTextureFromUrl(url: string, scene: Scene, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>, samplingMode: number, invertY: boolean): InternalTexture;
  80146. /**
  80147. * Creates a new raw 3D texture
  80148. * @param data defines the data used to create the texture
  80149. * @param width defines the width of the texture
  80150. * @param height defines the height of the texture
  80151. * @param depth defines the depth of the texture
  80152. * @param format defines the format of the texture
  80153. * @param generateMipMaps defines if the engine must generate mip levels
  80154. * @param invertY defines if data must be stored with Y axis inverted
  80155. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80156. * @param compression defines the compressed used (can be null)
  80157. * @param textureType defines the compressed used (can be null)
  80158. * @returns a new raw 3D texture (stored in an InternalTexture)
  80159. */
  80160. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  80161. /**
  80162. * Update a raw 3D texture
  80163. * @param texture defines the texture to update
  80164. * @param data defines the data to store
  80165. * @param format defines the data format
  80166. * @param invertY defines if data must be stored with Y axis inverted
  80167. */
  80168. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  80169. /**
  80170. * Update a raw 3D texture
  80171. * @param texture defines the texture to update
  80172. * @param data defines the data to store
  80173. * @param format defines the data format
  80174. * @param invertY defines if data must be stored with Y axis inverted
  80175. * @param compression defines the used compression (can be null)
  80176. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  80177. */
  80178. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  80179. }
  80180. }
  80181. declare module BABYLON {
  80182. /**
  80183. * Raw texture can help creating a texture directly from an array of data.
  80184. * This can be super useful if you either get the data from an uncompressed source or
  80185. * if you wish to create your texture pixel by pixel.
  80186. */
  80187. export class RawTexture extends Texture {
  80188. /**
  80189. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  80190. */
  80191. format: number;
  80192. private _engine;
  80193. /**
  80194. * Instantiates a new RawTexture.
  80195. * Raw texture can help creating a texture directly from an array of data.
  80196. * This can be super useful if you either get the data from an uncompressed source or
  80197. * if you wish to create your texture pixel by pixel.
  80198. * @param data define the array of data to use to create the texture
  80199. * @param width define the width of the texture
  80200. * @param height define the height of the texture
  80201. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  80202. * @param scene define the scene the texture belongs to
  80203. * @param generateMipMaps define whether mip maps should be generated or not
  80204. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80205. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80206. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  80207. */
  80208. constructor(data: ArrayBufferView, width: number, height: number,
  80209. /**
  80210. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  80211. */
  80212. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  80213. /**
  80214. * Updates the texture underlying data.
  80215. * @param data Define the new data of the texture
  80216. */
  80217. update(data: ArrayBufferView): void;
  80218. /**
  80219. * Creates a luminance texture from some data.
  80220. * @param data Define the texture data
  80221. * @param width Define the width of the texture
  80222. * @param height Define the height of the texture
  80223. * @param scene Define the scene the texture belongs to
  80224. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80225. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80226. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80227. * @returns the luminance texture
  80228. */
  80229. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  80230. /**
  80231. * Creates a luminance alpha texture from some data.
  80232. * @param data Define the texture data
  80233. * @param width Define the width of the texture
  80234. * @param height Define the height of the texture
  80235. * @param scene Define the scene the texture belongs to
  80236. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80237. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80238. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80239. * @returns the luminance alpha texture
  80240. */
  80241. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  80242. /**
  80243. * Creates an alpha texture from some data.
  80244. * @param data Define the texture data
  80245. * @param width Define the width of the texture
  80246. * @param height Define the height of the texture
  80247. * @param scene Define the scene the texture belongs to
  80248. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80249. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80250. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80251. * @returns the alpha texture
  80252. */
  80253. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  80254. /**
  80255. * Creates a RGB texture from some data.
  80256. * @param data Define the texture data
  80257. * @param width Define the width of the texture
  80258. * @param height Define the height of the texture
  80259. * @param scene Define the scene the texture belongs to
  80260. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80261. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80262. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80263. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  80264. * @returns the RGB alpha texture
  80265. */
  80266. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  80267. /**
  80268. * Creates a RGBA texture from some data.
  80269. * @param data Define the texture data
  80270. * @param width Define the width of the texture
  80271. * @param height Define the height of the texture
  80272. * @param scene Define the scene the texture belongs to
  80273. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80274. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80275. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80276. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  80277. * @returns the RGBA texture
  80278. */
  80279. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  80280. /**
  80281. * Creates a R texture from some data.
  80282. * @param data Define the texture data
  80283. * @param width Define the width of the texture
  80284. * @param height Define the height of the texture
  80285. * @param scene Define the scene the texture belongs to
  80286. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80287. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80288. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80289. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  80290. * @returns the R texture
  80291. */
  80292. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  80293. }
  80294. }
  80295. declare module BABYLON {
  80296. /**
  80297. * Interface for the size containing width and height
  80298. */
  80299. export interface ISize {
  80300. /**
  80301. * Width
  80302. */
  80303. width: number;
  80304. /**
  80305. * Heighht
  80306. */
  80307. height: number;
  80308. }
  80309. /**
  80310. * Size containing widht and height
  80311. */
  80312. export class Size implements ISize {
  80313. /**
  80314. * Width
  80315. */
  80316. width: number;
  80317. /**
  80318. * Height
  80319. */
  80320. height: number;
  80321. /**
  80322. * Creates a Size object from the given width and height (floats).
  80323. * @param width width of the new size
  80324. * @param height height of the new size
  80325. */
  80326. constructor(width: number, height: number);
  80327. /**
  80328. * Returns a string with the Size width and height
  80329. * @returns a string with the Size width and height
  80330. */
  80331. toString(): string;
  80332. /**
  80333. * "Size"
  80334. * @returns the string "Size"
  80335. */
  80336. getClassName(): string;
  80337. /**
  80338. * Returns the Size hash code.
  80339. * @returns a hash code for a unique width and height
  80340. */
  80341. getHashCode(): number;
  80342. /**
  80343. * Updates the current size from the given one.
  80344. * @param src the given size
  80345. */
  80346. copyFrom(src: Size): void;
  80347. /**
  80348. * Updates in place the current Size from the given floats.
  80349. * @param width width of the new size
  80350. * @param height height of the new size
  80351. * @returns the updated Size.
  80352. */
  80353. copyFromFloats(width: number, height: number): Size;
  80354. /**
  80355. * Updates in place the current Size from the given floats.
  80356. * @param width width to set
  80357. * @param height height to set
  80358. * @returns the updated Size.
  80359. */
  80360. set(width: number, height: number): Size;
  80361. /**
  80362. * Multiplies the width and height by numbers
  80363. * @param w factor to multiple the width by
  80364. * @param h factor to multiple the height by
  80365. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  80366. */
  80367. multiplyByFloats(w: number, h: number): Size;
  80368. /**
  80369. * Clones the size
  80370. * @returns a new Size copied from the given one.
  80371. */
  80372. clone(): Size;
  80373. /**
  80374. * True if the current Size and the given one width and height are strictly equal.
  80375. * @param other the other size to compare against
  80376. * @returns True if the current Size and the given one width and height are strictly equal.
  80377. */
  80378. equals(other: Size): boolean;
  80379. /**
  80380. * The surface of the Size : width * height (float).
  80381. */
  80382. readonly surface: number;
  80383. /**
  80384. * Create a new size of zero
  80385. * @returns a new Size set to (0.0, 0.0)
  80386. */
  80387. static Zero(): Size;
  80388. /**
  80389. * Sums the width and height of two sizes
  80390. * @param otherSize size to add to this size
  80391. * @returns a new Size set as the addition result of the current Size and the given one.
  80392. */
  80393. add(otherSize: Size): Size;
  80394. /**
  80395. * Subtracts the width and height of two
  80396. * @param otherSize size to subtract to this size
  80397. * @returns a new Size set as the subtraction result of the given one from the current Size.
  80398. */
  80399. subtract(otherSize: Size): Size;
  80400. /**
  80401. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  80402. * @param start starting size to lerp between
  80403. * @param end end size to lerp between
  80404. * @param amount amount to lerp between the start and end values
  80405. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  80406. */
  80407. static Lerp(start: Size, end: Size, amount: number): Size;
  80408. }
  80409. }
  80410. declare module BABYLON {
  80411. /**
  80412. * Defines a runtime animation
  80413. */
  80414. export class RuntimeAnimation {
  80415. private _events;
  80416. /**
  80417. * The current frame of the runtime animation
  80418. */
  80419. private _currentFrame;
  80420. /**
  80421. * The animation used by the runtime animation
  80422. */
  80423. private _animation;
  80424. /**
  80425. * The target of the runtime animation
  80426. */
  80427. private _target;
  80428. /**
  80429. * The initiating animatable
  80430. */
  80431. private _host;
  80432. /**
  80433. * The original value of the runtime animation
  80434. */
  80435. private _originalValue;
  80436. /**
  80437. * The original blend value of the runtime animation
  80438. */
  80439. private _originalBlendValue;
  80440. /**
  80441. * The offsets cache of the runtime animation
  80442. */
  80443. private _offsetsCache;
  80444. /**
  80445. * The high limits cache of the runtime animation
  80446. */
  80447. private _highLimitsCache;
  80448. /**
  80449. * Specifies if the runtime animation has been stopped
  80450. */
  80451. private _stopped;
  80452. /**
  80453. * The blending factor of the runtime animation
  80454. */
  80455. private _blendingFactor;
  80456. /**
  80457. * The BabylonJS scene
  80458. */
  80459. private _scene;
  80460. /**
  80461. * The current value of the runtime animation
  80462. */
  80463. private _currentValue;
  80464. /** @hidden */
  80465. _animationState: _IAnimationState;
  80466. /**
  80467. * The active target of the runtime animation
  80468. */
  80469. private _activeTargets;
  80470. private _currentActiveTarget;
  80471. private _directTarget;
  80472. /**
  80473. * The target path of the runtime animation
  80474. */
  80475. private _targetPath;
  80476. /**
  80477. * The weight of the runtime animation
  80478. */
  80479. private _weight;
  80480. /**
  80481. * The ratio offset of the runtime animation
  80482. */
  80483. private _ratioOffset;
  80484. /**
  80485. * The previous delay of the runtime animation
  80486. */
  80487. private _previousDelay;
  80488. /**
  80489. * The previous ratio of the runtime animation
  80490. */
  80491. private _previousRatio;
  80492. private _enableBlending;
  80493. private _keys;
  80494. private _minFrame;
  80495. private _maxFrame;
  80496. private _minValue;
  80497. private _maxValue;
  80498. private _targetIsArray;
  80499. /**
  80500. * Gets the current frame of the runtime animation
  80501. */
  80502. readonly currentFrame: number;
  80503. /**
  80504. * Gets the weight of the runtime animation
  80505. */
  80506. readonly weight: number;
  80507. /**
  80508. * Gets the current value of the runtime animation
  80509. */
  80510. readonly currentValue: any;
  80511. /**
  80512. * Gets the target path of the runtime animation
  80513. */
  80514. readonly targetPath: string;
  80515. /**
  80516. * Gets the actual target of the runtime animation
  80517. */
  80518. readonly target: any;
  80519. /** @hidden */
  80520. _onLoop: () => void;
  80521. /**
  80522. * Create a new RuntimeAnimation object
  80523. * @param target defines the target of the animation
  80524. * @param animation defines the source animation object
  80525. * @param scene defines the hosting scene
  80526. * @param host defines the initiating Animatable
  80527. */
  80528. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  80529. private _preparePath;
  80530. /**
  80531. * Gets the animation from the runtime animation
  80532. */
  80533. readonly animation: Animation;
  80534. /**
  80535. * Resets the runtime animation to the beginning
  80536. * @param restoreOriginal defines whether to restore the target property to the original value
  80537. */
  80538. reset(restoreOriginal?: boolean): void;
  80539. /**
  80540. * Specifies if the runtime animation is stopped
  80541. * @returns Boolean specifying if the runtime animation is stopped
  80542. */
  80543. isStopped(): boolean;
  80544. /**
  80545. * Disposes of the runtime animation
  80546. */
  80547. dispose(): void;
  80548. /**
  80549. * Apply the interpolated value to the target
  80550. * @param currentValue defines the value computed by the animation
  80551. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  80552. */
  80553. setValue(currentValue: any, weight: number): void;
  80554. private _getOriginalValues;
  80555. private _setValue;
  80556. /**
  80557. * Gets the loop pmode of the runtime animation
  80558. * @returns Loop Mode
  80559. */
  80560. private _getCorrectLoopMode;
  80561. /**
  80562. * Move the current animation to a given frame
  80563. * @param frame defines the frame to move to
  80564. */
  80565. goToFrame(frame: number): void;
  80566. /**
  80567. * @hidden Internal use only
  80568. */
  80569. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  80570. /**
  80571. * Execute the current animation
  80572. * @param delay defines the delay to add to the current frame
  80573. * @param from defines the lower bound of the animation range
  80574. * @param to defines the upper bound of the animation range
  80575. * @param loop defines if the current animation must loop
  80576. * @param speedRatio defines the current speed ratio
  80577. * @param weight defines the weight of the animation (default is -1 so no weight)
  80578. * @param onLoop optional callback called when animation loops
  80579. * @returns a boolean indicating if the animation is running
  80580. */
  80581. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  80582. }
  80583. }
  80584. declare module BABYLON {
  80585. /**
  80586. * Class used to store an actual running animation
  80587. */
  80588. export class Animatable {
  80589. /** defines the target object */
  80590. target: any;
  80591. /** defines the starting frame number (default is 0) */
  80592. fromFrame: number;
  80593. /** defines the ending frame number (default is 100) */
  80594. toFrame: number;
  80595. /** defines if the animation must loop (default is false) */
  80596. loopAnimation: boolean;
  80597. /** defines a callback to call when animation ends if it is not looping */
  80598. onAnimationEnd?: (() => void) | null | undefined;
  80599. /** defines a callback to call when animation loops */
  80600. onAnimationLoop?: (() => void) | null | undefined;
  80601. private _localDelayOffset;
  80602. private _pausedDelay;
  80603. private _runtimeAnimations;
  80604. private _paused;
  80605. private _scene;
  80606. private _speedRatio;
  80607. private _weight;
  80608. private _syncRoot;
  80609. /**
  80610. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  80611. * This will only apply for non looping animation (default is true)
  80612. */
  80613. disposeOnEnd: boolean;
  80614. /**
  80615. * Gets a boolean indicating if the animation has started
  80616. */
  80617. animationStarted: boolean;
  80618. /**
  80619. * Observer raised when the animation ends
  80620. */
  80621. onAnimationEndObservable: Observable<Animatable>;
  80622. /**
  80623. * Observer raised when the animation loops
  80624. */
  80625. onAnimationLoopObservable: Observable<Animatable>;
  80626. /**
  80627. * Gets the root Animatable used to synchronize and normalize animations
  80628. */
  80629. readonly syncRoot: Nullable<Animatable>;
  80630. /**
  80631. * Gets the current frame of the first RuntimeAnimation
  80632. * Used to synchronize Animatables
  80633. */
  80634. readonly masterFrame: number;
  80635. /**
  80636. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  80637. */
  80638. weight: number;
  80639. /**
  80640. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  80641. */
  80642. speedRatio: number;
  80643. /**
  80644. * Creates a new Animatable
  80645. * @param scene defines the hosting scene
  80646. * @param target defines the target object
  80647. * @param fromFrame defines the starting frame number (default is 0)
  80648. * @param toFrame defines the ending frame number (default is 100)
  80649. * @param loopAnimation defines if the animation must loop (default is false)
  80650. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  80651. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  80652. * @param animations defines a group of animation to add to the new Animatable
  80653. * @param onAnimationLoop defines a callback to call when animation loops
  80654. */
  80655. constructor(scene: Scene,
  80656. /** defines the target object */
  80657. target: any,
  80658. /** defines the starting frame number (default is 0) */
  80659. fromFrame?: number,
  80660. /** defines the ending frame number (default is 100) */
  80661. toFrame?: number,
  80662. /** defines if the animation must loop (default is false) */
  80663. loopAnimation?: boolean, speedRatio?: number,
  80664. /** defines a callback to call when animation ends if it is not looping */
  80665. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  80666. /** defines a callback to call when animation loops */
  80667. onAnimationLoop?: (() => void) | null | undefined);
  80668. /**
  80669. * Synchronize and normalize current Animatable with a source Animatable
  80670. * This is useful when using animation weights and when animations are not of the same length
  80671. * @param root defines the root Animatable to synchronize with
  80672. * @returns the current Animatable
  80673. */
  80674. syncWith(root: Animatable): Animatable;
  80675. /**
  80676. * Gets the list of runtime animations
  80677. * @returns an array of RuntimeAnimation
  80678. */
  80679. getAnimations(): RuntimeAnimation[];
  80680. /**
  80681. * Adds more animations to the current animatable
  80682. * @param target defines the target of the animations
  80683. * @param animations defines the new animations to add
  80684. */
  80685. appendAnimations(target: any, animations: Animation[]): void;
  80686. /**
  80687. * Gets the source animation for a specific property
  80688. * @param property defines the propertyu to look for
  80689. * @returns null or the source animation for the given property
  80690. */
  80691. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  80692. /**
  80693. * Gets the runtime animation for a specific property
  80694. * @param property defines the propertyu to look for
  80695. * @returns null or the runtime animation for the given property
  80696. */
  80697. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  80698. /**
  80699. * Resets the animatable to its original state
  80700. */
  80701. reset(): void;
  80702. /**
  80703. * Allows the animatable to blend with current running animations
  80704. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  80705. * @param blendingSpeed defines the blending speed to use
  80706. */
  80707. enableBlending(blendingSpeed: number): void;
  80708. /**
  80709. * Disable animation blending
  80710. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  80711. */
  80712. disableBlending(): void;
  80713. /**
  80714. * Jump directly to a given frame
  80715. * @param frame defines the frame to jump to
  80716. */
  80717. goToFrame(frame: number): void;
  80718. /**
  80719. * Pause the animation
  80720. */
  80721. pause(): void;
  80722. /**
  80723. * Restart the animation
  80724. */
  80725. restart(): void;
  80726. private _raiseOnAnimationEnd;
  80727. /**
  80728. * Stop and delete the current animation
  80729. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  80730. * @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)
  80731. */
  80732. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  80733. /**
  80734. * Wait asynchronously for the animation to end
  80735. * @returns a promise which will be fullfilled when the animation ends
  80736. */
  80737. waitAsync(): Promise<Animatable>;
  80738. /** @hidden */
  80739. _animate(delay: number): boolean;
  80740. }
  80741. interface Scene {
  80742. /** @hidden */
  80743. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  80744. /** @hidden */
  80745. _processLateAnimationBindingsForMatrices(holder: {
  80746. totalWeight: number;
  80747. animations: RuntimeAnimation[];
  80748. originalValue: Matrix;
  80749. }): any;
  80750. /** @hidden */
  80751. _processLateAnimationBindingsForQuaternions(holder: {
  80752. totalWeight: number;
  80753. animations: RuntimeAnimation[];
  80754. originalValue: Quaternion;
  80755. }, refQuaternion: Quaternion): Quaternion;
  80756. /** @hidden */
  80757. _processLateAnimationBindings(): void;
  80758. /**
  80759. * Will start the animation sequence of a given target
  80760. * @param target defines the target
  80761. * @param from defines from which frame should animation start
  80762. * @param to defines until which frame should animation run.
  80763. * @param weight defines the weight to apply to the animation (1.0 by default)
  80764. * @param loop defines if the animation loops
  80765. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  80766. * @param onAnimationEnd defines the function to be executed when the animation ends
  80767. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  80768. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  80769. * @param onAnimationLoop defines the callback to call when an animation loops
  80770. * @returns the animatable object created for this animation
  80771. */
  80772. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  80773. /**
  80774. * Will start the animation sequence of a given target
  80775. * @param target defines the target
  80776. * @param from defines from which frame should animation start
  80777. * @param to defines until which frame should animation run.
  80778. * @param loop defines if the animation loops
  80779. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  80780. * @param onAnimationEnd defines the function to be executed when the animation ends
  80781. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  80782. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  80783. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  80784. * @param onAnimationLoop defines the callback to call when an animation loops
  80785. * @returns the animatable object created for this animation
  80786. */
  80787. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  80788. /**
  80789. * Will start the animation sequence of a given target and its hierarchy
  80790. * @param target defines the target
  80791. * @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.
  80792. * @param from defines from which frame should animation start
  80793. * @param to defines until which frame should animation run.
  80794. * @param loop defines if the animation loops
  80795. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  80796. * @param onAnimationEnd defines the function to be executed when the animation ends
  80797. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  80798. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  80799. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  80800. * @param onAnimationLoop defines the callback to call when an animation loops
  80801. * @returns the list of created animatables
  80802. */
  80803. beginHierarchyAnimation(target: any, directDescendantsOnly: boolean, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable[];
  80804. /**
  80805. * Begin a new animation on a given node
  80806. * @param target defines the target where the animation will take place
  80807. * @param animations defines the list of animations to start
  80808. * @param from defines the initial value
  80809. * @param to defines the final value
  80810. * @param loop defines if you want animation to loop (off by default)
  80811. * @param speedRatio defines the speed ratio to apply to all animations
  80812. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  80813. * @param onAnimationLoop defines the callback to call when an animation loops
  80814. * @returns the list of created animatables
  80815. */
  80816. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable;
  80817. /**
  80818. * Begin a new animation on a given node and its hierarchy
  80819. * @param target defines the root node where the animation will take place
  80820. * @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.
  80821. * @param animations defines the list of animations to start
  80822. * @param from defines the initial value
  80823. * @param to defines the final value
  80824. * @param loop defines if you want animation to loop (off by default)
  80825. * @param speedRatio defines the speed ratio to apply to all animations
  80826. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  80827. * @param onAnimationLoop defines the callback to call when an animation loops
  80828. * @returns the list of animatables created for all nodes
  80829. */
  80830. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable[];
  80831. /**
  80832. * Gets the animatable associated with a specific target
  80833. * @param target defines the target of the animatable
  80834. * @returns the required animatable if found
  80835. */
  80836. getAnimatableByTarget(target: any): Nullable<Animatable>;
  80837. /**
  80838. * Gets all animatables associated with a given target
  80839. * @param target defines the target to look animatables for
  80840. * @returns an array of Animatables
  80841. */
  80842. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  80843. /**
  80844. * Stops and removes all animations that have been applied to the scene
  80845. */
  80846. stopAllAnimations(): void;
  80847. /**
  80848. * Gets the current delta time used by animation engine
  80849. */
  80850. deltaTime: number;
  80851. }
  80852. interface Bone {
  80853. /**
  80854. * Copy an animation range from another bone
  80855. * @param source defines the source bone
  80856. * @param rangeName defines the range name to copy
  80857. * @param frameOffset defines the frame offset
  80858. * @param rescaleAsRequired defines if rescaling must be applied if required
  80859. * @param skelDimensionsRatio defines the scaling ratio
  80860. * @returns true if operation was successful
  80861. */
  80862. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  80863. }
  80864. }
  80865. declare module BABYLON {
  80866. /**
  80867. * Class used to override all child animations of a given target
  80868. */
  80869. export class AnimationPropertiesOverride {
  80870. /**
  80871. * Gets or sets a value indicating if animation blending must be used
  80872. */
  80873. enableBlending: boolean;
  80874. /**
  80875. * Gets or sets the blending speed to use when enableBlending is true
  80876. */
  80877. blendingSpeed: number;
  80878. /**
  80879. * Gets or sets the default loop mode to use
  80880. */
  80881. loopMode: number;
  80882. }
  80883. }
  80884. declare module BABYLON {
  80885. /**
  80886. * Class used to handle skinning animations
  80887. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  80888. */
  80889. export class Skeleton implements IAnimatable {
  80890. /** defines the skeleton name */
  80891. name: string;
  80892. /** defines the skeleton Id */
  80893. id: string;
  80894. /**
  80895. * Defines the list of child bones
  80896. */
  80897. bones: Bone[];
  80898. /**
  80899. * Defines an estimate of the dimension of the skeleton at rest
  80900. */
  80901. dimensionsAtRest: Vector3;
  80902. /**
  80903. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  80904. */
  80905. needInitialSkinMatrix: boolean;
  80906. /**
  80907. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  80908. */
  80909. overrideMesh: Nullable<AbstractMesh>;
  80910. /**
  80911. * Gets the list of animations attached to this skeleton
  80912. */
  80913. animations: Array<Animation>;
  80914. private _scene;
  80915. private _isDirty;
  80916. private _transformMatrices;
  80917. private _transformMatrixTexture;
  80918. private _meshesWithPoseMatrix;
  80919. private _animatables;
  80920. private _identity;
  80921. private _synchronizedWithMesh;
  80922. private _ranges;
  80923. private _lastAbsoluteTransformsUpdateId;
  80924. private _canUseTextureForBones;
  80925. private _uniqueId;
  80926. /** @hidden */
  80927. _numBonesWithLinkedTransformNode: number;
  80928. /** @hidden */
  80929. _hasWaitingData: Nullable<boolean>;
  80930. /**
  80931. * Specifies if the skeleton should be serialized
  80932. */
  80933. doNotSerialize: boolean;
  80934. private _useTextureToStoreBoneMatrices;
  80935. /**
  80936. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  80937. * Please note that this option is not available if the hardware does not support it
  80938. */
  80939. useTextureToStoreBoneMatrices: boolean;
  80940. private _animationPropertiesOverride;
  80941. /**
  80942. * Gets or sets the animation properties override
  80943. */
  80944. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  80945. /**
  80946. * List of inspectable custom properties (used by the Inspector)
  80947. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  80948. */
  80949. inspectableCustomProperties: IInspectable[];
  80950. /**
  80951. * An observable triggered before computing the skeleton's matrices
  80952. */
  80953. onBeforeComputeObservable: Observable<Skeleton>;
  80954. /**
  80955. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  80956. */
  80957. readonly isUsingTextureForMatrices: boolean;
  80958. /**
  80959. * Gets the unique ID of this skeleton
  80960. */
  80961. readonly uniqueId: number;
  80962. /**
  80963. * Creates a new skeleton
  80964. * @param name defines the skeleton name
  80965. * @param id defines the skeleton Id
  80966. * @param scene defines the hosting scene
  80967. */
  80968. constructor(
  80969. /** defines the skeleton name */
  80970. name: string,
  80971. /** defines the skeleton Id */
  80972. id: string, scene: Scene);
  80973. /**
  80974. * Gets the current object class name.
  80975. * @return the class name
  80976. */
  80977. getClassName(): string;
  80978. /**
  80979. * Returns an array containing the root bones
  80980. * @returns an array containing the root bones
  80981. */
  80982. getChildren(): Array<Bone>;
  80983. /**
  80984. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  80985. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  80986. * @returns a Float32Array containing matrices data
  80987. */
  80988. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  80989. /**
  80990. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  80991. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  80992. * @returns a raw texture containing the data
  80993. */
  80994. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  80995. /**
  80996. * Gets the current hosting scene
  80997. * @returns a scene object
  80998. */
  80999. getScene(): Scene;
  81000. /**
  81001. * Gets a string representing the current skeleton data
  81002. * @param fullDetails defines a boolean indicating if we want a verbose version
  81003. * @returns a string representing the current skeleton data
  81004. */
  81005. toString(fullDetails?: boolean): string;
  81006. /**
  81007. * Get bone's index searching by name
  81008. * @param name defines bone's name to search for
  81009. * @return the indice of the bone. Returns -1 if not found
  81010. */
  81011. getBoneIndexByName(name: string): number;
  81012. /**
  81013. * Creater a new animation range
  81014. * @param name defines the name of the range
  81015. * @param from defines the start key
  81016. * @param to defines the end key
  81017. */
  81018. createAnimationRange(name: string, from: number, to: number): void;
  81019. /**
  81020. * Delete a specific animation range
  81021. * @param name defines the name of the range
  81022. * @param deleteFrames defines if frames must be removed as well
  81023. */
  81024. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  81025. /**
  81026. * Gets a specific animation range
  81027. * @param name defines the name of the range to look for
  81028. * @returns the requested animation range or null if not found
  81029. */
  81030. getAnimationRange(name: string): Nullable<AnimationRange>;
  81031. /**
  81032. * Gets the list of all animation ranges defined on this skeleton
  81033. * @returns an array
  81034. */
  81035. getAnimationRanges(): Nullable<AnimationRange>[];
  81036. /**
  81037. * Copy animation range from a source skeleton.
  81038. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  81039. * @param source defines the source skeleton
  81040. * @param name defines the name of the range to copy
  81041. * @param rescaleAsRequired defines if rescaling must be applied if required
  81042. * @returns true if operation was successful
  81043. */
  81044. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  81045. /**
  81046. * Forces the skeleton to go to rest pose
  81047. */
  81048. returnToRest(): void;
  81049. private _getHighestAnimationFrame;
  81050. /**
  81051. * Begin a specific animation range
  81052. * @param name defines the name of the range to start
  81053. * @param loop defines if looping must be turned on (false by default)
  81054. * @param speedRatio defines the speed ratio to apply (1 by default)
  81055. * @param onAnimationEnd defines a callback which will be called when animation will end
  81056. * @returns a new animatable
  81057. */
  81058. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  81059. /** @hidden */
  81060. _markAsDirty(): void;
  81061. /** @hidden */
  81062. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  81063. /** @hidden */
  81064. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  81065. private _computeTransformMatrices;
  81066. /**
  81067. * Build all resources required to render a skeleton
  81068. */
  81069. prepare(): void;
  81070. /**
  81071. * Gets the list of animatables currently running for this skeleton
  81072. * @returns an array of animatables
  81073. */
  81074. getAnimatables(): IAnimatable[];
  81075. /**
  81076. * Clone the current skeleton
  81077. * @param name defines the name of the new skeleton
  81078. * @param id defines the id of the new skeleton
  81079. * @returns the new skeleton
  81080. */
  81081. clone(name: string, id?: string): Skeleton;
  81082. /**
  81083. * Enable animation blending for this skeleton
  81084. * @param blendingSpeed defines the blending speed to apply
  81085. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  81086. */
  81087. enableBlending(blendingSpeed?: number): void;
  81088. /**
  81089. * Releases all resources associated with the current skeleton
  81090. */
  81091. dispose(): void;
  81092. /**
  81093. * Serialize the skeleton in a JSON object
  81094. * @returns a JSON object
  81095. */
  81096. serialize(): any;
  81097. /**
  81098. * Creates a new skeleton from serialized data
  81099. * @param parsedSkeleton defines the serialized data
  81100. * @param scene defines the hosting scene
  81101. * @returns a new skeleton
  81102. */
  81103. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  81104. /**
  81105. * Compute all node absolute transforms
  81106. * @param forceUpdate defines if computation must be done even if cache is up to date
  81107. */
  81108. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  81109. /**
  81110. * Gets the root pose matrix
  81111. * @returns a matrix
  81112. */
  81113. getPoseMatrix(): Nullable<Matrix>;
  81114. /**
  81115. * Sorts bones per internal index
  81116. */
  81117. sortBones(): void;
  81118. private _sortBones;
  81119. }
  81120. }
  81121. declare module BABYLON {
  81122. /**
  81123. * Class used to store bone information
  81124. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  81125. */
  81126. export class Bone extends Node {
  81127. /**
  81128. * defines the bone name
  81129. */
  81130. name: string;
  81131. private static _tmpVecs;
  81132. private static _tmpQuat;
  81133. private static _tmpMats;
  81134. /**
  81135. * Gets the list of child bones
  81136. */
  81137. children: Bone[];
  81138. /** Gets the animations associated with this bone */
  81139. animations: Animation[];
  81140. /**
  81141. * Gets or sets bone length
  81142. */
  81143. length: number;
  81144. /**
  81145. * @hidden Internal only
  81146. * Set this value to map this bone to a different index in the transform matrices
  81147. * Set this value to -1 to exclude the bone from the transform matrices
  81148. */
  81149. _index: Nullable<number>;
  81150. private _skeleton;
  81151. private _localMatrix;
  81152. private _restPose;
  81153. private _baseMatrix;
  81154. private _absoluteTransform;
  81155. private _invertedAbsoluteTransform;
  81156. private _parent;
  81157. private _scalingDeterminant;
  81158. private _worldTransform;
  81159. private _localScaling;
  81160. private _localRotation;
  81161. private _localPosition;
  81162. private _needToDecompose;
  81163. private _needToCompose;
  81164. /** @hidden */
  81165. _linkedTransformNode: Nullable<TransformNode>;
  81166. /** @hidden */
  81167. _waitingTransformNodeId: Nullable<string>;
  81168. /** @hidden */
  81169. /** @hidden */
  81170. _matrix: Matrix;
  81171. /**
  81172. * Create a new bone
  81173. * @param name defines the bone name
  81174. * @param skeleton defines the parent skeleton
  81175. * @param parentBone defines the parent (can be null if the bone is the root)
  81176. * @param localMatrix defines the local matrix
  81177. * @param restPose defines the rest pose matrix
  81178. * @param baseMatrix defines the base matrix
  81179. * @param index defines index of the bone in the hiearchy
  81180. */
  81181. constructor(
  81182. /**
  81183. * defines the bone name
  81184. */
  81185. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  81186. /**
  81187. * Gets the current object class name.
  81188. * @return the class name
  81189. */
  81190. getClassName(): string;
  81191. /**
  81192. * Gets the parent skeleton
  81193. * @returns a skeleton
  81194. */
  81195. getSkeleton(): Skeleton;
  81196. /**
  81197. * Gets parent bone
  81198. * @returns a bone or null if the bone is the root of the bone hierarchy
  81199. */
  81200. getParent(): Nullable<Bone>;
  81201. /**
  81202. * Returns an array containing the root bones
  81203. * @returns an array containing the root bones
  81204. */
  81205. getChildren(): Array<Bone>;
  81206. /**
  81207. * Gets the node index in matrix array generated for rendering
  81208. * @returns the node index
  81209. */
  81210. getIndex(): number;
  81211. /**
  81212. * Sets the parent bone
  81213. * @param parent defines the parent (can be null if the bone is the root)
  81214. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  81215. */
  81216. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  81217. /**
  81218. * Gets the local matrix
  81219. * @returns a matrix
  81220. */
  81221. getLocalMatrix(): Matrix;
  81222. /**
  81223. * Gets the base matrix (initial matrix which remains unchanged)
  81224. * @returns a matrix
  81225. */
  81226. getBaseMatrix(): Matrix;
  81227. /**
  81228. * Gets the rest pose matrix
  81229. * @returns a matrix
  81230. */
  81231. getRestPose(): Matrix;
  81232. /**
  81233. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  81234. */
  81235. getWorldMatrix(): Matrix;
  81236. /**
  81237. * Sets the local matrix to rest pose matrix
  81238. */
  81239. returnToRest(): void;
  81240. /**
  81241. * Gets the inverse of the absolute transform matrix.
  81242. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  81243. * @returns a matrix
  81244. */
  81245. getInvertedAbsoluteTransform(): Matrix;
  81246. /**
  81247. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  81248. * @returns a matrix
  81249. */
  81250. getAbsoluteTransform(): Matrix;
  81251. /**
  81252. * Links with the given transform node.
  81253. * The local matrix of this bone is copied from the transform node every frame.
  81254. * @param transformNode defines the transform node to link to
  81255. */
  81256. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  81257. /**
  81258. * Gets the node used to drive the bone's transformation
  81259. * @returns a transform node or null
  81260. */
  81261. getTransformNode(): Nullable<TransformNode>;
  81262. /** Gets or sets current position (in local space) */
  81263. position: Vector3;
  81264. /** Gets or sets current rotation (in local space) */
  81265. rotation: Vector3;
  81266. /** Gets or sets current rotation quaternion (in local space) */
  81267. rotationQuaternion: Quaternion;
  81268. /** Gets or sets current scaling (in local space) */
  81269. scaling: Vector3;
  81270. /**
  81271. * Gets the animation properties override
  81272. */
  81273. readonly animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  81274. private _decompose;
  81275. private _compose;
  81276. /**
  81277. * Update the base and local matrices
  81278. * @param matrix defines the new base or local matrix
  81279. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  81280. * @param updateLocalMatrix defines if the local matrix should be updated
  81281. */
  81282. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  81283. /** @hidden */
  81284. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  81285. /**
  81286. * Flag the bone as dirty (Forcing it to update everything)
  81287. */
  81288. markAsDirty(): void;
  81289. /** @hidden */
  81290. _markAsDirtyAndCompose(): void;
  81291. private _markAsDirtyAndDecompose;
  81292. /**
  81293. * Translate the bone in local or world space
  81294. * @param vec The amount to translate the bone
  81295. * @param space The space that the translation is in
  81296. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81297. */
  81298. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  81299. /**
  81300. * Set the postion of the bone in local or world space
  81301. * @param position The position to set the bone
  81302. * @param space The space that the position is in
  81303. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81304. */
  81305. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  81306. /**
  81307. * Set the absolute position of the bone (world space)
  81308. * @param position The position to set the bone
  81309. * @param mesh The mesh that this bone is attached to
  81310. */
  81311. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  81312. /**
  81313. * Scale the bone on the x, y and z axes (in local space)
  81314. * @param x The amount to scale the bone on the x axis
  81315. * @param y The amount to scale the bone on the y axis
  81316. * @param z The amount to scale the bone on the z axis
  81317. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  81318. */
  81319. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  81320. /**
  81321. * Set the bone scaling in local space
  81322. * @param scale defines the scaling vector
  81323. */
  81324. setScale(scale: Vector3): void;
  81325. /**
  81326. * Gets the current scaling in local space
  81327. * @returns the current scaling vector
  81328. */
  81329. getScale(): Vector3;
  81330. /**
  81331. * Gets the current scaling in local space and stores it in a target vector
  81332. * @param result defines the target vector
  81333. */
  81334. getScaleToRef(result: Vector3): void;
  81335. /**
  81336. * Set the yaw, pitch, and roll of the bone in local or world space
  81337. * @param yaw The rotation of the bone on the y axis
  81338. * @param pitch The rotation of the bone on the x axis
  81339. * @param roll The rotation of the bone on the z axis
  81340. * @param space The space that the axes of rotation are in
  81341. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81342. */
  81343. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  81344. /**
  81345. * Add a rotation to the bone on an axis in local or world space
  81346. * @param axis The axis to rotate the bone on
  81347. * @param amount The amount to rotate the bone
  81348. * @param space The space that the axis is in
  81349. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81350. */
  81351. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  81352. /**
  81353. * Set the rotation of the bone to a particular axis angle in local or world space
  81354. * @param axis The axis to rotate the bone on
  81355. * @param angle The angle that the bone should be rotated to
  81356. * @param space The space that the axis is in
  81357. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81358. */
  81359. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  81360. /**
  81361. * Set the euler rotation of the bone in local of world space
  81362. * @param rotation The euler rotation that the bone should be set to
  81363. * @param space The space that the rotation is in
  81364. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81365. */
  81366. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  81367. /**
  81368. * Set the quaternion rotation of the bone in local of world space
  81369. * @param quat The quaternion rotation that the bone should be set to
  81370. * @param space The space that the rotation is in
  81371. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81372. */
  81373. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  81374. /**
  81375. * Set the rotation matrix of the bone in local of world space
  81376. * @param rotMat The rotation matrix that the bone should be set to
  81377. * @param space The space that the rotation is in
  81378. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81379. */
  81380. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  81381. private _rotateWithMatrix;
  81382. private _getNegativeRotationToRef;
  81383. /**
  81384. * Get the position of the bone in local or world space
  81385. * @param space The space that the returned position is in
  81386. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81387. * @returns The position of the bone
  81388. */
  81389. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  81390. /**
  81391. * Copy the position of the bone to a vector3 in local or world space
  81392. * @param space The space that the returned position is in
  81393. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81394. * @param result The vector3 to copy the position to
  81395. */
  81396. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  81397. /**
  81398. * Get the absolute position of the bone (world space)
  81399. * @param mesh The mesh that this bone is attached to
  81400. * @returns The absolute position of the bone
  81401. */
  81402. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  81403. /**
  81404. * Copy the absolute position of the bone (world space) to the result param
  81405. * @param mesh The mesh that this bone is attached to
  81406. * @param result The vector3 to copy the absolute position to
  81407. */
  81408. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  81409. /**
  81410. * Compute the absolute transforms of this bone and its children
  81411. */
  81412. computeAbsoluteTransforms(): void;
  81413. /**
  81414. * Get the world direction from an axis that is in the local space of the bone
  81415. * @param localAxis The local direction that is used to compute the world direction
  81416. * @param mesh The mesh that this bone is attached to
  81417. * @returns The world direction
  81418. */
  81419. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  81420. /**
  81421. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  81422. * @param localAxis The local direction that is used to compute the world direction
  81423. * @param mesh The mesh that this bone is attached to
  81424. * @param result The vector3 that the world direction will be copied to
  81425. */
  81426. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  81427. /**
  81428. * Get the euler rotation of the bone in local or world space
  81429. * @param space The space that the rotation should be in
  81430. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81431. * @returns The euler rotation
  81432. */
  81433. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  81434. /**
  81435. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  81436. * @param space The space that the rotation should be in
  81437. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81438. * @param result The vector3 that the rotation should be copied to
  81439. */
  81440. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  81441. /**
  81442. * Get the quaternion rotation of the bone in either local or world space
  81443. * @param space The space that the rotation should be in
  81444. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81445. * @returns The quaternion rotation
  81446. */
  81447. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  81448. /**
  81449. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  81450. * @param space The space that the rotation should be in
  81451. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81452. * @param result The quaternion that the rotation should be copied to
  81453. */
  81454. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  81455. /**
  81456. * Get the rotation matrix of the bone in local or world space
  81457. * @param space The space that the rotation should be in
  81458. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81459. * @returns The rotation matrix
  81460. */
  81461. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  81462. /**
  81463. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  81464. * @param space The space that the rotation should be in
  81465. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81466. * @param result The quaternion that the rotation should be copied to
  81467. */
  81468. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  81469. /**
  81470. * Get the world position of a point that is in the local space of the bone
  81471. * @param position The local position
  81472. * @param mesh The mesh that this bone is attached to
  81473. * @returns The world position
  81474. */
  81475. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  81476. /**
  81477. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  81478. * @param position The local position
  81479. * @param mesh The mesh that this bone is attached to
  81480. * @param result The vector3 that the world position should be copied to
  81481. */
  81482. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  81483. /**
  81484. * Get the local position of a point that is in world space
  81485. * @param position The world position
  81486. * @param mesh The mesh that this bone is attached to
  81487. * @returns The local position
  81488. */
  81489. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  81490. /**
  81491. * Get the local position of a point that is in world space and copy it to the result param
  81492. * @param position The world position
  81493. * @param mesh The mesh that this bone is attached to
  81494. * @param result The vector3 that the local position should be copied to
  81495. */
  81496. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  81497. }
  81498. }
  81499. declare module BABYLON {
  81500. /**
  81501. * 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.
  81502. * @see https://doc.babylonjs.com/how_to/transformnode
  81503. */
  81504. export class TransformNode extends Node {
  81505. /**
  81506. * Object will not rotate to face the camera
  81507. */
  81508. static BILLBOARDMODE_NONE: number;
  81509. /**
  81510. * Object will rotate to face the camera but only on the x axis
  81511. */
  81512. static BILLBOARDMODE_X: number;
  81513. /**
  81514. * Object will rotate to face the camera but only on the y axis
  81515. */
  81516. static BILLBOARDMODE_Y: number;
  81517. /**
  81518. * Object will rotate to face the camera but only on the z axis
  81519. */
  81520. static BILLBOARDMODE_Z: number;
  81521. /**
  81522. * Object will rotate to face the camera
  81523. */
  81524. static BILLBOARDMODE_ALL: number;
  81525. /**
  81526. * Object will rotate to face the camera's position instead of orientation
  81527. */
  81528. static BILLBOARDMODE_USE_POSITION: number;
  81529. private _forward;
  81530. private _forwardInverted;
  81531. private _up;
  81532. private _right;
  81533. private _rightInverted;
  81534. private _position;
  81535. private _rotation;
  81536. private _rotationQuaternion;
  81537. protected _scaling: Vector3;
  81538. protected _isDirty: boolean;
  81539. private _transformToBoneReferal;
  81540. private _isAbsoluteSynced;
  81541. private _billboardMode;
  81542. /**
  81543. * Gets or sets the billboard mode. Default is 0.
  81544. *
  81545. * | Value | Type | Description |
  81546. * | --- | --- | --- |
  81547. * | 0 | BILLBOARDMODE_NONE | |
  81548. * | 1 | BILLBOARDMODE_X | |
  81549. * | 2 | BILLBOARDMODE_Y | |
  81550. * | 4 | BILLBOARDMODE_Z | |
  81551. * | 7 | BILLBOARDMODE_ALL | |
  81552. *
  81553. */
  81554. billboardMode: number;
  81555. private _preserveParentRotationForBillboard;
  81556. /**
  81557. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  81558. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  81559. */
  81560. preserveParentRotationForBillboard: boolean;
  81561. /**
  81562. * 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
  81563. */
  81564. scalingDeterminant: number;
  81565. private _infiniteDistance;
  81566. /**
  81567. * Gets or sets the distance of the object to max, often used by skybox
  81568. */
  81569. infiniteDistance: boolean;
  81570. /**
  81571. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  81572. * By default the system will update normals to compensate
  81573. */
  81574. ignoreNonUniformScaling: boolean;
  81575. /**
  81576. * 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
  81577. */
  81578. reIntegrateRotationIntoRotationQuaternion: boolean;
  81579. /** @hidden */
  81580. _poseMatrix: Nullable<Matrix>;
  81581. /** @hidden */
  81582. _localMatrix: Matrix;
  81583. private _usePivotMatrix;
  81584. private _absolutePosition;
  81585. private _absoluteScaling;
  81586. private _absoluteRotationQuaternion;
  81587. private _pivotMatrix;
  81588. private _pivotMatrixInverse;
  81589. protected _postMultiplyPivotMatrix: boolean;
  81590. protected _isWorldMatrixFrozen: boolean;
  81591. /** @hidden */
  81592. _indexInSceneTransformNodesArray: number;
  81593. /**
  81594. * An event triggered after the world matrix is updated
  81595. */
  81596. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  81597. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  81598. /**
  81599. * Gets a string identifying the name of the class
  81600. * @returns "TransformNode" string
  81601. */
  81602. getClassName(): string;
  81603. /**
  81604. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  81605. */
  81606. position: Vector3;
  81607. /**
  81608. * 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)).
  81609. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  81610. */
  81611. rotation: Vector3;
  81612. /**
  81613. * 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)).
  81614. */
  81615. scaling: Vector3;
  81616. /**
  81617. * 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).
  81618. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  81619. */
  81620. rotationQuaternion: Nullable<Quaternion>;
  81621. /**
  81622. * The forward direction of that transform in world space.
  81623. */
  81624. readonly forward: Vector3;
  81625. /**
  81626. * The up direction of that transform in world space.
  81627. */
  81628. readonly up: Vector3;
  81629. /**
  81630. * The right direction of that transform in world space.
  81631. */
  81632. readonly right: Vector3;
  81633. /**
  81634. * Copies the parameter passed Matrix into the mesh Pose matrix.
  81635. * @param matrix the matrix to copy the pose from
  81636. * @returns this TransformNode.
  81637. */
  81638. updatePoseMatrix(matrix: Matrix): TransformNode;
  81639. /**
  81640. * Returns the mesh Pose matrix.
  81641. * @returns the pose matrix
  81642. */
  81643. getPoseMatrix(): Matrix;
  81644. /** @hidden */
  81645. _isSynchronized(): boolean;
  81646. /** @hidden */
  81647. _initCache(): void;
  81648. /**
  81649. * Flag the transform node as dirty (Forcing it to update everything)
  81650. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  81651. * @returns this transform node
  81652. */
  81653. markAsDirty(property: string): TransformNode;
  81654. /**
  81655. * Returns the current mesh absolute position.
  81656. * Returns a Vector3.
  81657. */
  81658. readonly absolutePosition: Vector3;
  81659. /**
  81660. * Returns the current mesh absolute scaling.
  81661. * Returns a Vector3.
  81662. */
  81663. readonly absoluteScaling: Vector3;
  81664. /**
  81665. * Returns the current mesh absolute rotation.
  81666. * Returns a Quaternion.
  81667. */
  81668. readonly absoluteRotationQuaternion: Quaternion;
  81669. /**
  81670. * Sets a new matrix to apply before all other transformation
  81671. * @param matrix defines the transform matrix
  81672. * @returns the current TransformNode
  81673. */
  81674. setPreTransformMatrix(matrix: Matrix): TransformNode;
  81675. /**
  81676. * Sets a new pivot matrix to the current node
  81677. * @param matrix defines the new pivot matrix to use
  81678. * @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
  81679. * @returns the current TransformNode
  81680. */
  81681. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  81682. /**
  81683. * Returns the mesh pivot matrix.
  81684. * Default : Identity.
  81685. * @returns the matrix
  81686. */
  81687. getPivotMatrix(): Matrix;
  81688. /**
  81689. * Instantiate (when possible) or clone that node with its hierarchy
  81690. * @param newParent defines the new parent to use for the instance (or clone)
  81691. * @param options defines options to configure how copy is done
  81692. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  81693. * @returns an instance (or a clone) of the current node with its hiearchy
  81694. */
  81695. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  81696. doNotInstantiate: boolean;
  81697. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  81698. /**
  81699. * Prevents the World matrix to be computed any longer
  81700. * @param newWorldMatrix defines an optional matrix to use as world matrix
  81701. * @returns the TransformNode.
  81702. */
  81703. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  81704. /**
  81705. * Allows back the World matrix computation.
  81706. * @returns the TransformNode.
  81707. */
  81708. unfreezeWorldMatrix(): this;
  81709. /**
  81710. * True if the World matrix has been frozen.
  81711. */
  81712. readonly isWorldMatrixFrozen: boolean;
  81713. /**
  81714. * Retuns the mesh absolute position in the World.
  81715. * @returns a Vector3.
  81716. */
  81717. getAbsolutePosition(): Vector3;
  81718. /**
  81719. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  81720. * @param absolutePosition the absolute position to set
  81721. * @returns the TransformNode.
  81722. */
  81723. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  81724. /**
  81725. * Sets the mesh position in its local space.
  81726. * @param vector3 the position to set in localspace
  81727. * @returns the TransformNode.
  81728. */
  81729. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  81730. /**
  81731. * Returns the mesh position in the local space from the current World matrix values.
  81732. * @returns a new Vector3.
  81733. */
  81734. getPositionExpressedInLocalSpace(): Vector3;
  81735. /**
  81736. * Translates the mesh along the passed Vector3 in its local space.
  81737. * @param vector3 the distance to translate in localspace
  81738. * @returns the TransformNode.
  81739. */
  81740. locallyTranslate(vector3: Vector3): TransformNode;
  81741. private static _lookAtVectorCache;
  81742. /**
  81743. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  81744. * @param targetPoint the position (must be in same space as current mesh) to look at
  81745. * @param yawCor optional yaw (y-axis) correction in radians
  81746. * @param pitchCor optional pitch (x-axis) correction in radians
  81747. * @param rollCor optional roll (z-axis) correction in radians
  81748. * @param space the choosen space of the target
  81749. * @returns the TransformNode.
  81750. */
  81751. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  81752. /**
  81753. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  81754. * This Vector3 is expressed in the World space.
  81755. * @param localAxis axis to rotate
  81756. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  81757. */
  81758. getDirection(localAxis: Vector3): Vector3;
  81759. /**
  81760. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  81761. * localAxis is expressed in the mesh local space.
  81762. * result is computed in the Wordl space from the mesh World matrix.
  81763. * @param localAxis axis to rotate
  81764. * @param result the resulting transformnode
  81765. * @returns this TransformNode.
  81766. */
  81767. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  81768. /**
  81769. * Sets this transform node rotation to the given local axis.
  81770. * @param localAxis the axis in local space
  81771. * @param yawCor optional yaw (y-axis) correction in radians
  81772. * @param pitchCor optional pitch (x-axis) correction in radians
  81773. * @param rollCor optional roll (z-axis) correction in radians
  81774. * @returns this TransformNode
  81775. */
  81776. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  81777. /**
  81778. * Sets a new pivot point to the current node
  81779. * @param point defines the new pivot point to use
  81780. * @param space defines if the point is in world or local space (local by default)
  81781. * @returns the current TransformNode
  81782. */
  81783. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  81784. /**
  81785. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  81786. * @returns the pivot point
  81787. */
  81788. getPivotPoint(): Vector3;
  81789. /**
  81790. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  81791. * @param result the vector3 to store the result
  81792. * @returns this TransformNode.
  81793. */
  81794. getPivotPointToRef(result: Vector3): TransformNode;
  81795. /**
  81796. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  81797. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  81798. */
  81799. getAbsolutePivotPoint(): Vector3;
  81800. /**
  81801. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  81802. * @param result vector3 to store the result
  81803. * @returns this TransformNode.
  81804. */
  81805. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  81806. /**
  81807. * Defines the passed node as the parent of the current node.
  81808. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  81809. * @see https://doc.babylonjs.com/how_to/parenting
  81810. * @param node the node ot set as the parent
  81811. * @returns this TransformNode.
  81812. */
  81813. setParent(node: Nullable<Node>): TransformNode;
  81814. private _nonUniformScaling;
  81815. /**
  81816. * True if the scaling property of this object is non uniform eg. (1,2,1)
  81817. */
  81818. readonly nonUniformScaling: boolean;
  81819. /** @hidden */
  81820. _updateNonUniformScalingState(value: boolean): boolean;
  81821. /**
  81822. * Attach the current TransformNode to another TransformNode associated with a bone
  81823. * @param bone Bone affecting the TransformNode
  81824. * @param affectedTransformNode TransformNode associated with the bone
  81825. * @returns this object
  81826. */
  81827. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  81828. /**
  81829. * Detach the transform node if its associated with a bone
  81830. * @returns this object
  81831. */
  81832. detachFromBone(): TransformNode;
  81833. private static _rotationAxisCache;
  81834. /**
  81835. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  81836. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  81837. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  81838. * The passed axis is also normalized.
  81839. * @param axis the axis to rotate around
  81840. * @param amount the amount to rotate in radians
  81841. * @param space Space to rotate in (Default: local)
  81842. * @returns the TransformNode.
  81843. */
  81844. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  81845. /**
  81846. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  81847. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  81848. * The passed axis is also normalized. .
  81849. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  81850. * @param point the point to rotate around
  81851. * @param axis the axis to rotate around
  81852. * @param amount the amount to rotate in radians
  81853. * @returns the TransformNode
  81854. */
  81855. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  81856. /**
  81857. * Translates the mesh along the axis vector for the passed distance in the given space.
  81858. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  81859. * @param axis the axis to translate in
  81860. * @param distance the distance to translate
  81861. * @param space Space to rotate in (Default: local)
  81862. * @returns the TransformNode.
  81863. */
  81864. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  81865. /**
  81866. * Adds a rotation step to the mesh current rotation.
  81867. * x, y, z are Euler angles expressed in radians.
  81868. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  81869. * This means this rotation is made in the mesh local space only.
  81870. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  81871. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  81872. * ```javascript
  81873. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  81874. * ```
  81875. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  81876. * 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.
  81877. * @param x Rotation to add
  81878. * @param y Rotation to add
  81879. * @param z Rotation to add
  81880. * @returns the TransformNode.
  81881. */
  81882. addRotation(x: number, y: number, z: number): TransformNode;
  81883. /**
  81884. * @hidden
  81885. */
  81886. protected _getEffectiveParent(): Nullable<Node>;
  81887. /**
  81888. * Computes the world matrix of the node
  81889. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  81890. * @returns the world matrix
  81891. */
  81892. computeWorldMatrix(force?: boolean): Matrix;
  81893. protected _afterComputeWorldMatrix(): void;
  81894. /**
  81895. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  81896. * @param func callback function to add
  81897. *
  81898. * @returns the TransformNode.
  81899. */
  81900. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  81901. /**
  81902. * Removes a registered callback function.
  81903. * @param func callback function to remove
  81904. * @returns the TransformNode.
  81905. */
  81906. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  81907. /**
  81908. * Gets the position of the current mesh in camera space
  81909. * @param camera defines the camera to use
  81910. * @returns a position
  81911. */
  81912. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  81913. /**
  81914. * Returns the distance from the mesh to the active camera
  81915. * @param camera defines the camera to use
  81916. * @returns the distance
  81917. */
  81918. getDistanceToCamera(camera?: Nullable<Camera>): number;
  81919. /**
  81920. * Clone the current transform node
  81921. * @param name Name of the new clone
  81922. * @param newParent New parent for the clone
  81923. * @param doNotCloneChildren Do not clone children hierarchy
  81924. * @returns the new transform node
  81925. */
  81926. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  81927. /**
  81928. * Serializes the objects information.
  81929. * @param currentSerializationObject defines the object to serialize in
  81930. * @returns the serialized object
  81931. */
  81932. serialize(currentSerializationObject?: any): any;
  81933. /**
  81934. * Returns a new TransformNode object parsed from the source provided.
  81935. * @param parsedTransformNode is the source.
  81936. * @param scene the scne the object belongs to
  81937. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  81938. * @returns a new TransformNode object parsed from the source provided.
  81939. */
  81940. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  81941. /**
  81942. * Get all child-transformNodes of this node
  81943. * @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
  81944. * @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
  81945. * @returns an array of TransformNode
  81946. */
  81947. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  81948. /**
  81949. * Releases resources associated with this transform node.
  81950. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  81951. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  81952. */
  81953. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  81954. /**
  81955. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  81956. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  81957. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  81958. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  81959. * @returns the current mesh
  81960. */
  81961. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  81962. private _syncAbsoluteScalingAndRotation;
  81963. }
  81964. }
  81965. declare module BABYLON {
  81966. /**
  81967. * Defines the types of pose enabled controllers that are supported
  81968. */
  81969. export enum PoseEnabledControllerType {
  81970. /**
  81971. * HTC Vive
  81972. */
  81973. VIVE = 0,
  81974. /**
  81975. * Oculus Rift
  81976. */
  81977. OCULUS = 1,
  81978. /**
  81979. * Windows mixed reality
  81980. */
  81981. WINDOWS = 2,
  81982. /**
  81983. * Samsung gear VR
  81984. */
  81985. GEAR_VR = 3,
  81986. /**
  81987. * Google Daydream
  81988. */
  81989. DAYDREAM = 4,
  81990. /**
  81991. * Generic
  81992. */
  81993. GENERIC = 5
  81994. }
  81995. /**
  81996. * Defines the MutableGamepadButton interface for the state of a gamepad button
  81997. */
  81998. export interface MutableGamepadButton {
  81999. /**
  82000. * Value of the button/trigger
  82001. */
  82002. value: number;
  82003. /**
  82004. * If the button/trigger is currently touched
  82005. */
  82006. touched: boolean;
  82007. /**
  82008. * If the button/trigger is currently pressed
  82009. */
  82010. pressed: boolean;
  82011. }
  82012. /**
  82013. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  82014. * @hidden
  82015. */
  82016. export interface ExtendedGamepadButton extends GamepadButton {
  82017. /**
  82018. * If the button/trigger is currently pressed
  82019. */
  82020. readonly pressed: boolean;
  82021. /**
  82022. * If the button/trigger is currently touched
  82023. */
  82024. readonly touched: boolean;
  82025. /**
  82026. * Value of the button/trigger
  82027. */
  82028. readonly value: number;
  82029. }
  82030. /** @hidden */
  82031. export interface _GamePadFactory {
  82032. /**
  82033. * Returns wether or not the current gamepad can be created for this type of controller.
  82034. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  82035. * @returns true if it can be created, otherwise false
  82036. */
  82037. canCreate(gamepadInfo: any): boolean;
  82038. /**
  82039. * Creates a new instance of the Gamepad.
  82040. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  82041. * @returns the new gamepad instance
  82042. */
  82043. create(gamepadInfo: any): Gamepad;
  82044. }
  82045. /**
  82046. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  82047. */
  82048. export class PoseEnabledControllerHelper {
  82049. /** @hidden */
  82050. static _ControllerFactories: _GamePadFactory[];
  82051. /** @hidden */
  82052. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  82053. /**
  82054. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  82055. * @param vrGamepad the gamepad to initialized
  82056. * @returns a vr controller of the type the gamepad identified as
  82057. */
  82058. static InitiateController(vrGamepad: any): Gamepad;
  82059. }
  82060. /**
  82061. * Defines the PoseEnabledController object that contains state of a vr capable controller
  82062. */
  82063. export class PoseEnabledController extends Gamepad implements PoseControlled {
  82064. /**
  82065. * If the controller is used in a webXR session
  82066. */
  82067. isXR: boolean;
  82068. private _deviceRoomPosition;
  82069. private _deviceRoomRotationQuaternion;
  82070. /**
  82071. * The device position in babylon space
  82072. */
  82073. devicePosition: Vector3;
  82074. /**
  82075. * The device rotation in babylon space
  82076. */
  82077. deviceRotationQuaternion: Quaternion;
  82078. /**
  82079. * The scale factor of the device in babylon space
  82080. */
  82081. deviceScaleFactor: number;
  82082. /**
  82083. * (Likely devicePosition should be used instead) The device position in its room space
  82084. */
  82085. position: Vector3;
  82086. /**
  82087. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  82088. */
  82089. rotationQuaternion: Quaternion;
  82090. /**
  82091. * The type of controller (Eg. Windows mixed reality)
  82092. */
  82093. controllerType: PoseEnabledControllerType;
  82094. protected _calculatedPosition: Vector3;
  82095. private _calculatedRotation;
  82096. /**
  82097. * The raw pose from the device
  82098. */
  82099. rawPose: DevicePose;
  82100. private _trackPosition;
  82101. private _maxRotationDistFromHeadset;
  82102. private _draggedRoomRotation;
  82103. /**
  82104. * @hidden
  82105. */
  82106. _disableTrackPosition(fixedPosition: Vector3): void;
  82107. /**
  82108. * Internal, the mesh attached to the controller
  82109. * @hidden
  82110. */
  82111. _mesh: Nullable<AbstractMesh>;
  82112. private _poseControlledCamera;
  82113. private _leftHandSystemQuaternion;
  82114. /**
  82115. * Internal, matrix used to convert room space to babylon space
  82116. * @hidden
  82117. */
  82118. _deviceToWorld: Matrix;
  82119. /**
  82120. * Node to be used when casting a ray from the controller
  82121. * @hidden
  82122. */
  82123. _pointingPoseNode: Nullable<TransformNode>;
  82124. /**
  82125. * Name of the child mesh that can be used to cast a ray from the controller
  82126. */
  82127. static readonly POINTING_POSE: string;
  82128. /**
  82129. * Creates a new PoseEnabledController from a gamepad
  82130. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  82131. */
  82132. constructor(browserGamepad: any);
  82133. private _workingMatrix;
  82134. /**
  82135. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  82136. */
  82137. update(): void;
  82138. /**
  82139. * Updates only the pose device and mesh without doing any button event checking
  82140. */
  82141. protected _updatePoseAndMesh(): void;
  82142. /**
  82143. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  82144. * @param poseData raw pose fromthe device
  82145. */
  82146. updateFromDevice(poseData: DevicePose): void;
  82147. /**
  82148. * @hidden
  82149. */
  82150. _meshAttachedObservable: Observable<AbstractMesh>;
  82151. /**
  82152. * Attaches a mesh to the controller
  82153. * @param mesh the mesh to be attached
  82154. */
  82155. attachToMesh(mesh: AbstractMesh): void;
  82156. /**
  82157. * Attaches the controllers mesh to a camera
  82158. * @param camera the camera the mesh should be attached to
  82159. */
  82160. attachToPoseControlledCamera(camera: TargetCamera): void;
  82161. /**
  82162. * Disposes of the controller
  82163. */
  82164. dispose(): void;
  82165. /**
  82166. * The mesh that is attached to the controller
  82167. */
  82168. readonly mesh: Nullable<AbstractMesh>;
  82169. /**
  82170. * Gets the ray of the controller in the direction the controller is pointing
  82171. * @param length the length the resulting ray should be
  82172. * @returns a ray in the direction the controller is pointing
  82173. */
  82174. getForwardRay(length?: number): Ray;
  82175. }
  82176. }
  82177. declare module BABYLON {
  82178. /**
  82179. * Defines the WebVRController object that represents controllers tracked in 3D space
  82180. */
  82181. export abstract class WebVRController extends PoseEnabledController {
  82182. /**
  82183. * Internal, the default controller model for the controller
  82184. */
  82185. protected _defaultModel: Nullable<AbstractMesh>;
  82186. /**
  82187. * Fired when the trigger state has changed
  82188. */
  82189. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  82190. /**
  82191. * Fired when the main button state has changed
  82192. */
  82193. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  82194. /**
  82195. * Fired when the secondary button state has changed
  82196. */
  82197. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  82198. /**
  82199. * Fired when the pad state has changed
  82200. */
  82201. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  82202. /**
  82203. * Fired when controllers stick values have changed
  82204. */
  82205. onPadValuesChangedObservable: Observable<StickValues>;
  82206. /**
  82207. * Array of button availible on the controller
  82208. */
  82209. protected _buttons: Array<MutableGamepadButton>;
  82210. private _onButtonStateChange;
  82211. /**
  82212. * Fired when a controller button's state has changed
  82213. * @param callback the callback containing the button that was modified
  82214. */
  82215. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  82216. /**
  82217. * X and Y axis corresponding to the controllers joystick
  82218. */
  82219. pad: StickValues;
  82220. /**
  82221. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  82222. */
  82223. hand: string;
  82224. /**
  82225. * The default controller model for the controller
  82226. */
  82227. readonly defaultModel: Nullable<AbstractMesh>;
  82228. /**
  82229. * Creates a new WebVRController from a gamepad
  82230. * @param vrGamepad the gamepad that the WebVRController should be created from
  82231. */
  82232. constructor(vrGamepad: any);
  82233. /**
  82234. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  82235. */
  82236. update(): void;
  82237. /**
  82238. * Function to be called when a button is modified
  82239. */
  82240. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  82241. /**
  82242. * Loads a mesh and attaches it to the controller
  82243. * @param scene the scene the mesh should be added to
  82244. * @param meshLoaded callback for when the mesh has been loaded
  82245. */
  82246. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  82247. private _setButtonValue;
  82248. private _changes;
  82249. private _checkChanges;
  82250. /**
  82251. * Disposes of th webVRCOntroller
  82252. */
  82253. dispose(): void;
  82254. }
  82255. }
  82256. declare module BABYLON {
  82257. /**
  82258. * The HemisphericLight simulates the ambient environment light,
  82259. * so the passed direction is the light reflection direction, not the incoming direction.
  82260. */
  82261. export class HemisphericLight extends Light {
  82262. /**
  82263. * The groundColor is the light in the opposite direction to the one specified during creation.
  82264. * 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.
  82265. */
  82266. groundColor: Color3;
  82267. /**
  82268. * The light reflection direction, not the incoming direction.
  82269. */
  82270. direction: Vector3;
  82271. /**
  82272. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  82273. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  82274. * The HemisphericLight can't cast shadows.
  82275. * Documentation : https://doc.babylonjs.com/babylon101/lights
  82276. * @param name The friendly name of the light
  82277. * @param direction The direction of the light reflection
  82278. * @param scene The scene the light belongs to
  82279. */
  82280. constructor(name: string, direction: Vector3, scene: Scene);
  82281. protected _buildUniformLayout(): void;
  82282. /**
  82283. * Returns the string "HemisphericLight".
  82284. * @return The class name
  82285. */
  82286. getClassName(): string;
  82287. /**
  82288. * Sets the HemisphericLight direction towards the passed target (Vector3).
  82289. * Returns the updated direction.
  82290. * @param target The target the direction should point to
  82291. * @return The computed direction
  82292. */
  82293. setDirectionToTarget(target: Vector3): Vector3;
  82294. /**
  82295. * Returns the shadow generator associated to the light.
  82296. * @returns Always null for hemispheric lights because it does not support shadows.
  82297. */
  82298. getShadowGenerator(): Nullable<IShadowGenerator>;
  82299. /**
  82300. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  82301. * @param effect The effect to update
  82302. * @param lightIndex The index of the light in the effect to update
  82303. * @returns The hemispheric light
  82304. */
  82305. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  82306. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  82307. /**
  82308. * Computes the world matrix of the node
  82309. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  82310. * @param useWasUpdatedFlag defines a reserved property
  82311. * @returns the world matrix
  82312. */
  82313. computeWorldMatrix(): Matrix;
  82314. /**
  82315. * Returns the integer 3.
  82316. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  82317. */
  82318. getTypeID(): number;
  82319. /**
  82320. * Prepares the list of defines specific to the light type.
  82321. * @param defines the list of defines
  82322. * @param lightIndex defines the index of the light for the effect
  82323. */
  82324. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  82325. }
  82326. }
  82327. declare module BABYLON {
  82328. /** @hidden */
  82329. export var vrMultiviewToSingleviewPixelShader: {
  82330. name: string;
  82331. shader: string;
  82332. };
  82333. }
  82334. declare module BABYLON {
  82335. /**
  82336. * Renders to multiple views with a single draw call
  82337. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  82338. */
  82339. export class MultiviewRenderTarget extends RenderTargetTexture {
  82340. /**
  82341. * Creates a multiview render target
  82342. * @param scene scene used with the render target
  82343. * @param size the size of the render target (used for each view)
  82344. */
  82345. constructor(scene: Scene, size?: number | {
  82346. width: number;
  82347. height: number;
  82348. } | {
  82349. ratio: number;
  82350. });
  82351. /**
  82352. * @hidden
  82353. * @param faceIndex the face index, if its a cube texture
  82354. */
  82355. _bindFrameBuffer(faceIndex?: number): void;
  82356. /**
  82357. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  82358. * @returns the view count
  82359. */
  82360. getViewCount(): number;
  82361. }
  82362. }
  82363. declare module BABYLON {
  82364. /**
  82365. * Represents a camera frustum
  82366. */
  82367. export class Frustum {
  82368. /**
  82369. * Gets the planes representing the frustum
  82370. * @param transform matrix to be applied to the returned planes
  82371. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  82372. */
  82373. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  82374. /**
  82375. * Gets the near frustum plane transformed by the transform matrix
  82376. * @param transform transformation matrix to be applied to the resulting frustum plane
  82377. * @param frustumPlane the resuling frustum plane
  82378. */
  82379. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82380. /**
  82381. * Gets the far frustum plane transformed by the transform matrix
  82382. * @param transform transformation matrix to be applied to the resulting frustum plane
  82383. * @param frustumPlane the resuling frustum plane
  82384. */
  82385. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82386. /**
  82387. * Gets the left frustum plane transformed by the transform matrix
  82388. * @param transform transformation matrix to be applied to the resulting frustum plane
  82389. * @param frustumPlane the resuling frustum plane
  82390. */
  82391. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82392. /**
  82393. * Gets the right frustum plane transformed by the transform matrix
  82394. * @param transform transformation matrix to be applied to the resulting frustum plane
  82395. * @param frustumPlane the resuling frustum plane
  82396. */
  82397. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82398. /**
  82399. * Gets the top frustum plane transformed by the transform matrix
  82400. * @param transform transformation matrix to be applied to the resulting frustum plane
  82401. * @param frustumPlane the resuling frustum plane
  82402. */
  82403. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82404. /**
  82405. * Gets the bottom frustum plane transformed by the transform matrix
  82406. * @param transform transformation matrix to be applied to the resulting frustum plane
  82407. * @param frustumPlane the resuling frustum plane
  82408. */
  82409. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82410. /**
  82411. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  82412. * @param transform transformation matrix to be applied to the resulting frustum planes
  82413. * @param frustumPlanes the resuling frustum planes
  82414. */
  82415. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  82416. }
  82417. }
  82418. declare module BABYLON {
  82419. interface Engine {
  82420. /**
  82421. * Creates a new multiview render target
  82422. * @param width defines the width of the texture
  82423. * @param height defines the height of the texture
  82424. * @returns the created multiview texture
  82425. */
  82426. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  82427. /**
  82428. * Binds a multiview framebuffer to be drawn to
  82429. * @param multiviewTexture texture to bind
  82430. */
  82431. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  82432. }
  82433. interface Camera {
  82434. /**
  82435. * @hidden
  82436. * 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)
  82437. */
  82438. _useMultiviewToSingleView: boolean;
  82439. /**
  82440. * @hidden
  82441. * 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)
  82442. */
  82443. _multiviewTexture: Nullable<RenderTargetTexture>;
  82444. /**
  82445. * @hidden
  82446. * ensures the multiview texture of the camera exists and has the specified width/height
  82447. * @param width height to set on the multiview texture
  82448. * @param height width to set on the multiview texture
  82449. */
  82450. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  82451. }
  82452. interface Scene {
  82453. /** @hidden */
  82454. _transformMatrixR: Matrix;
  82455. /** @hidden */
  82456. _multiviewSceneUbo: Nullable<UniformBuffer>;
  82457. /** @hidden */
  82458. _createMultiviewUbo(): void;
  82459. /** @hidden */
  82460. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  82461. /** @hidden */
  82462. _renderMultiviewToSingleView(camera: Camera): void;
  82463. }
  82464. }
  82465. declare module BABYLON {
  82466. /**
  82467. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  82468. * This will not be used for webXR as it supports displaying texture arrays directly
  82469. */
  82470. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  82471. /**
  82472. * Initializes a VRMultiviewToSingleview
  82473. * @param name name of the post process
  82474. * @param camera camera to be applied to
  82475. * @param scaleFactor scaling factor to the size of the output texture
  82476. */
  82477. constructor(name: string, camera: Camera, scaleFactor: number);
  82478. }
  82479. }
  82480. declare module BABYLON {
  82481. /**
  82482. * Interface used to define additional presentation attributes
  82483. */
  82484. export interface IVRPresentationAttributes {
  82485. /**
  82486. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  82487. */
  82488. highRefreshRate: boolean;
  82489. /**
  82490. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  82491. */
  82492. foveationLevel: number;
  82493. }
  82494. interface Engine {
  82495. /** @hidden */
  82496. _vrDisplay: any;
  82497. /** @hidden */
  82498. _vrSupported: boolean;
  82499. /** @hidden */
  82500. _oldSize: Size;
  82501. /** @hidden */
  82502. _oldHardwareScaleFactor: number;
  82503. /** @hidden */
  82504. _vrExclusivePointerMode: boolean;
  82505. /** @hidden */
  82506. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  82507. /** @hidden */
  82508. _onVRDisplayPointerRestricted: () => void;
  82509. /** @hidden */
  82510. _onVRDisplayPointerUnrestricted: () => void;
  82511. /** @hidden */
  82512. _onVrDisplayConnect: Nullable<(display: any) => void>;
  82513. /** @hidden */
  82514. _onVrDisplayDisconnect: Nullable<() => void>;
  82515. /** @hidden */
  82516. _onVrDisplayPresentChange: Nullable<() => void>;
  82517. /**
  82518. * Observable signaled when VR display mode changes
  82519. */
  82520. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  82521. /**
  82522. * Observable signaled when VR request present is complete
  82523. */
  82524. onVRRequestPresentComplete: Observable<boolean>;
  82525. /**
  82526. * Observable signaled when VR request present starts
  82527. */
  82528. onVRRequestPresentStart: Observable<Engine>;
  82529. /**
  82530. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  82531. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  82532. */
  82533. isInVRExclusivePointerMode: boolean;
  82534. /**
  82535. * Gets a boolean indicating if a webVR device was detected
  82536. * @returns true if a webVR device was detected
  82537. */
  82538. isVRDevicePresent(): boolean;
  82539. /**
  82540. * Gets the current webVR device
  82541. * @returns the current webVR device (or null)
  82542. */
  82543. getVRDevice(): any;
  82544. /**
  82545. * Initializes a webVR display and starts listening to display change events
  82546. * The onVRDisplayChangedObservable will be notified upon these changes
  82547. * @returns A promise containing a VRDisplay and if vr is supported
  82548. */
  82549. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  82550. /** @hidden */
  82551. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  82552. /**
  82553. * Gets or sets the presentation attributes used to configure VR rendering
  82554. */
  82555. vrPresentationAttributes?: IVRPresentationAttributes;
  82556. /**
  82557. * Call this function to switch to webVR mode
  82558. * Will do nothing if webVR is not supported or if there is no webVR device
  82559. * @see http://doc.babylonjs.com/how_to/webvr_camera
  82560. */
  82561. enableVR(): void;
  82562. /** @hidden */
  82563. _onVRFullScreenTriggered(): void;
  82564. }
  82565. }
  82566. declare module BABYLON {
  82567. /**
  82568. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  82569. * IMPORTANT!! The data is right-hand data.
  82570. * @export
  82571. * @interface DevicePose
  82572. */
  82573. export interface DevicePose {
  82574. /**
  82575. * The position of the device, values in array are [x,y,z].
  82576. */
  82577. readonly position: Nullable<Float32Array>;
  82578. /**
  82579. * The linearVelocity of the device, values in array are [x,y,z].
  82580. */
  82581. readonly linearVelocity: Nullable<Float32Array>;
  82582. /**
  82583. * The linearAcceleration of the device, values in array are [x,y,z].
  82584. */
  82585. readonly linearAcceleration: Nullable<Float32Array>;
  82586. /**
  82587. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  82588. */
  82589. readonly orientation: Nullable<Float32Array>;
  82590. /**
  82591. * The angularVelocity of the device, values in array are [x,y,z].
  82592. */
  82593. readonly angularVelocity: Nullable<Float32Array>;
  82594. /**
  82595. * The angularAcceleration of the device, values in array are [x,y,z].
  82596. */
  82597. readonly angularAcceleration: Nullable<Float32Array>;
  82598. }
  82599. /**
  82600. * Interface representing a pose controlled object in Babylon.
  82601. * A pose controlled object has both regular pose values as well as pose values
  82602. * from an external device such as a VR head mounted display
  82603. */
  82604. export interface PoseControlled {
  82605. /**
  82606. * The position of the object in babylon space.
  82607. */
  82608. position: Vector3;
  82609. /**
  82610. * The rotation quaternion of the object in babylon space.
  82611. */
  82612. rotationQuaternion: Quaternion;
  82613. /**
  82614. * The position of the device in babylon space.
  82615. */
  82616. devicePosition?: Vector3;
  82617. /**
  82618. * The rotation quaternion of the device in babylon space.
  82619. */
  82620. deviceRotationQuaternion: Quaternion;
  82621. /**
  82622. * The raw pose coming from the device.
  82623. */
  82624. rawPose: Nullable<DevicePose>;
  82625. /**
  82626. * The scale of the device to be used when translating from device space to babylon space.
  82627. */
  82628. deviceScaleFactor: number;
  82629. /**
  82630. * Updates the poseControlled values based on the input device pose.
  82631. * @param poseData the pose data to update the object with
  82632. */
  82633. updateFromDevice(poseData: DevicePose): void;
  82634. }
  82635. /**
  82636. * Set of options to customize the webVRCamera
  82637. */
  82638. export interface WebVROptions {
  82639. /**
  82640. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  82641. */
  82642. trackPosition?: boolean;
  82643. /**
  82644. * Sets the scale of the vrDevice in babylon space. (default: 1)
  82645. */
  82646. positionScale?: number;
  82647. /**
  82648. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  82649. */
  82650. displayName?: string;
  82651. /**
  82652. * Should the native controller meshes be initialized. (default: true)
  82653. */
  82654. controllerMeshes?: boolean;
  82655. /**
  82656. * Creating a default HemiLight only on controllers. (default: true)
  82657. */
  82658. defaultLightingOnControllers?: boolean;
  82659. /**
  82660. * If you don't want to use the default VR button of the helper. (default: false)
  82661. */
  82662. useCustomVRButton?: boolean;
  82663. /**
  82664. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  82665. */
  82666. customVRButton?: HTMLButtonElement;
  82667. /**
  82668. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  82669. */
  82670. rayLength?: number;
  82671. /**
  82672. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  82673. */
  82674. defaultHeight?: number;
  82675. /**
  82676. * If multiview should be used if availible (default: false)
  82677. */
  82678. useMultiview?: boolean;
  82679. }
  82680. /**
  82681. * This represents a WebVR camera.
  82682. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  82683. * @example http://doc.babylonjs.com/how_to/webvr_camera
  82684. */
  82685. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  82686. private webVROptions;
  82687. /**
  82688. * @hidden
  82689. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  82690. */
  82691. _vrDevice: any;
  82692. /**
  82693. * The rawPose of the vrDevice.
  82694. */
  82695. rawPose: Nullable<DevicePose>;
  82696. private _onVREnabled;
  82697. private _specsVersion;
  82698. private _attached;
  82699. private _frameData;
  82700. protected _descendants: Array<Node>;
  82701. private _deviceRoomPosition;
  82702. /** @hidden */
  82703. _deviceRoomRotationQuaternion: Quaternion;
  82704. private _standingMatrix;
  82705. /**
  82706. * Represents device position in babylon space.
  82707. */
  82708. devicePosition: Vector3;
  82709. /**
  82710. * Represents device rotation in babylon space.
  82711. */
  82712. deviceRotationQuaternion: Quaternion;
  82713. /**
  82714. * The scale of the device to be used when translating from device space to babylon space.
  82715. */
  82716. deviceScaleFactor: number;
  82717. private _deviceToWorld;
  82718. private _worldToDevice;
  82719. /**
  82720. * References to the webVR controllers for the vrDevice.
  82721. */
  82722. controllers: Array<WebVRController>;
  82723. /**
  82724. * Emits an event when a controller is attached.
  82725. */
  82726. onControllersAttachedObservable: Observable<WebVRController[]>;
  82727. /**
  82728. * Emits an event when a controller's mesh has been loaded;
  82729. */
  82730. onControllerMeshLoadedObservable: Observable<WebVRController>;
  82731. /**
  82732. * Emits an event when the HMD's pose has been updated.
  82733. */
  82734. onPoseUpdatedFromDeviceObservable: Observable<any>;
  82735. private _poseSet;
  82736. /**
  82737. * If the rig cameras be used as parent instead of this camera.
  82738. */
  82739. rigParenting: boolean;
  82740. private _lightOnControllers;
  82741. private _defaultHeight?;
  82742. /**
  82743. * Instantiates a WebVRFreeCamera.
  82744. * @param name The name of the WebVRFreeCamera
  82745. * @param position The starting anchor position for the camera
  82746. * @param scene The scene the camera belongs to
  82747. * @param webVROptions a set of customizable options for the webVRCamera
  82748. */
  82749. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  82750. /**
  82751. * Gets the device distance from the ground in meters.
  82752. * @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.
  82753. */
  82754. deviceDistanceToRoomGround(): number;
  82755. /**
  82756. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  82757. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  82758. */
  82759. useStandingMatrix(callback?: (bool: boolean) => void): void;
  82760. /**
  82761. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  82762. * @returns A promise with a boolean set to if the standing matrix is supported.
  82763. */
  82764. useStandingMatrixAsync(): Promise<boolean>;
  82765. /**
  82766. * Disposes the camera
  82767. */
  82768. dispose(): void;
  82769. /**
  82770. * Gets a vrController by name.
  82771. * @param name The name of the controller to retreive
  82772. * @returns the controller matching the name specified or null if not found
  82773. */
  82774. getControllerByName(name: string): Nullable<WebVRController>;
  82775. private _leftController;
  82776. /**
  82777. * The controller corresponding to the users left hand.
  82778. */
  82779. readonly leftController: Nullable<WebVRController>;
  82780. private _rightController;
  82781. /**
  82782. * The controller corresponding to the users right hand.
  82783. */
  82784. readonly rightController: Nullable<WebVRController>;
  82785. /**
  82786. * Casts a ray forward from the vrCamera's gaze.
  82787. * @param length Length of the ray (default: 100)
  82788. * @returns the ray corresponding to the gaze
  82789. */
  82790. getForwardRay(length?: number): Ray;
  82791. /**
  82792. * @hidden
  82793. * Updates the camera based on device's frame data
  82794. */
  82795. _checkInputs(): void;
  82796. /**
  82797. * Updates the poseControlled values based on the input device pose.
  82798. * @param poseData Pose coming from the device
  82799. */
  82800. updateFromDevice(poseData: DevicePose): void;
  82801. private _htmlElementAttached;
  82802. private _detachIfAttached;
  82803. /**
  82804. * WebVR's attach control will start broadcasting frames to the device.
  82805. * Note that in certain browsers (chrome for example) this function must be called
  82806. * within a user-interaction callback. Example:
  82807. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  82808. *
  82809. * @param element html element to attach the vrDevice to
  82810. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  82811. */
  82812. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  82813. /**
  82814. * Detaches the camera from the html element and disables VR
  82815. *
  82816. * @param element html element to detach from
  82817. */
  82818. detachControl(element: HTMLElement): void;
  82819. /**
  82820. * @returns the name of this class
  82821. */
  82822. getClassName(): string;
  82823. /**
  82824. * Calls resetPose on the vrDisplay
  82825. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  82826. */
  82827. resetToCurrentRotation(): void;
  82828. /**
  82829. * @hidden
  82830. * Updates the rig cameras (left and right eye)
  82831. */
  82832. _updateRigCameras(): void;
  82833. private _workingVector;
  82834. private _oneVector;
  82835. private _workingMatrix;
  82836. private updateCacheCalled;
  82837. private _correctPositionIfNotTrackPosition;
  82838. /**
  82839. * @hidden
  82840. * Updates the cached values of the camera
  82841. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  82842. */
  82843. _updateCache(ignoreParentClass?: boolean): void;
  82844. /**
  82845. * @hidden
  82846. * Get current device position in babylon world
  82847. */
  82848. _computeDevicePosition(): void;
  82849. /**
  82850. * Updates the current device position and rotation in the babylon world
  82851. */
  82852. update(): void;
  82853. /**
  82854. * @hidden
  82855. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  82856. * @returns an identity matrix
  82857. */
  82858. _getViewMatrix(): Matrix;
  82859. private _tmpMatrix;
  82860. /**
  82861. * This function is called by the two RIG cameras.
  82862. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  82863. * @hidden
  82864. */
  82865. _getWebVRViewMatrix(): Matrix;
  82866. /** @hidden */
  82867. _getWebVRProjectionMatrix(): Matrix;
  82868. private _onGamepadConnectedObserver;
  82869. private _onGamepadDisconnectedObserver;
  82870. private _updateCacheWhenTrackingDisabledObserver;
  82871. /**
  82872. * Initializes the controllers and their meshes
  82873. */
  82874. initControllers(): void;
  82875. }
  82876. }
  82877. declare module BABYLON {
  82878. /**
  82879. * Size options for a post process
  82880. */
  82881. export type PostProcessOptions = {
  82882. width: number;
  82883. height: number;
  82884. };
  82885. /**
  82886. * PostProcess can be used to apply a shader to a texture after it has been rendered
  82887. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  82888. */
  82889. export class PostProcess {
  82890. /** Name of the PostProcess. */
  82891. name: string;
  82892. /**
  82893. * Gets or sets the unique id of the post process
  82894. */
  82895. uniqueId: number;
  82896. /**
  82897. * Width of the texture to apply the post process on
  82898. */
  82899. width: number;
  82900. /**
  82901. * Height of the texture to apply the post process on
  82902. */
  82903. height: number;
  82904. /**
  82905. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  82906. * @hidden
  82907. */
  82908. _outputTexture: Nullable<InternalTexture>;
  82909. /**
  82910. * Sampling mode used by the shader
  82911. * See https://doc.babylonjs.com/classes/3.1/texture
  82912. */
  82913. renderTargetSamplingMode: number;
  82914. /**
  82915. * Clear color to use when screen clearing
  82916. */
  82917. clearColor: Color4;
  82918. /**
  82919. * If the buffer needs to be cleared before applying the post process. (default: true)
  82920. * Should be set to false if shader will overwrite all previous pixels.
  82921. */
  82922. autoClear: boolean;
  82923. /**
  82924. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  82925. */
  82926. alphaMode: number;
  82927. /**
  82928. * Sets the setAlphaBlendConstants of the babylon engine
  82929. */
  82930. alphaConstants: Color4;
  82931. /**
  82932. * Animations to be used for the post processing
  82933. */
  82934. animations: Animation[];
  82935. /**
  82936. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  82937. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  82938. */
  82939. enablePixelPerfectMode: boolean;
  82940. /**
  82941. * Force the postprocess to be applied without taking in account viewport
  82942. */
  82943. forceFullscreenViewport: boolean;
  82944. /**
  82945. * List of inspectable custom properties (used by the Inspector)
  82946. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  82947. */
  82948. inspectableCustomProperties: IInspectable[];
  82949. /**
  82950. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  82951. *
  82952. * | Value | Type | Description |
  82953. * | ----- | ----------------------------------- | ----------- |
  82954. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  82955. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  82956. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  82957. *
  82958. */
  82959. scaleMode: number;
  82960. /**
  82961. * Force textures to be a power of two (default: false)
  82962. */
  82963. alwaysForcePOT: boolean;
  82964. private _samples;
  82965. /**
  82966. * Number of sample textures (default: 1)
  82967. */
  82968. samples: number;
  82969. /**
  82970. * Modify the scale of the post process to be the same as the viewport (default: false)
  82971. */
  82972. adaptScaleToCurrentViewport: boolean;
  82973. private _camera;
  82974. private _scene;
  82975. private _engine;
  82976. private _options;
  82977. private _reusable;
  82978. private _textureType;
  82979. /**
  82980. * Smart array of input and output textures for the post process.
  82981. * @hidden
  82982. */
  82983. _textures: SmartArray<InternalTexture>;
  82984. /**
  82985. * The index in _textures that corresponds to the output texture.
  82986. * @hidden
  82987. */
  82988. _currentRenderTextureInd: number;
  82989. private _effect;
  82990. private _samplers;
  82991. private _fragmentUrl;
  82992. private _vertexUrl;
  82993. private _parameters;
  82994. private _scaleRatio;
  82995. protected _indexParameters: any;
  82996. private _shareOutputWithPostProcess;
  82997. private _texelSize;
  82998. private _forcedOutputTexture;
  82999. /**
  83000. * Returns the fragment url or shader name used in the post process.
  83001. * @returns the fragment url or name in the shader store.
  83002. */
  83003. getEffectName(): string;
  83004. /**
  83005. * An event triggered when the postprocess is activated.
  83006. */
  83007. onActivateObservable: Observable<Camera>;
  83008. private _onActivateObserver;
  83009. /**
  83010. * A function that is added to the onActivateObservable
  83011. */
  83012. onActivate: Nullable<(camera: Camera) => void>;
  83013. /**
  83014. * An event triggered when the postprocess changes its size.
  83015. */
  83016. onSizeChangedObservable: Observable<PostProcess>;
  83017. private _onSizeChangedObserver;
  83018. /**
  83019. * A function that is added to the onSizeChangedObservable
  83020. */
  83021. onSizeChanged: (postProcess: PostProcess) => void;
  83022. /**
  83023. * An event triggered when the postprocess applies its effect.
  83024. */
  83025. onApplyObservable: Observable<Effect>;
  83026. private _onApplyObserver;
  83027. /**
  83028. * A function that is added to the onApplyObservable
  83029. */
  83030. onApply: (effect: Effect) => void;
  83031. /**
  83032. * An event triggered before rendering the postprocess
  83033. */
  83034. onBeforeRenderObservable: Observable<Effect>;
  83035. private _onBeforeRenderObserver;
  83036. /**
  83037. * A function that is added to the onBeforeRenderObservable
  83038. */
  83039. onBeforeRender: (effect: Effect) => void;
  83040. /**
  83041. * An event triggered after rendering the postprocess
  83042. */
  83043. onAfterRenderObservable: Observable<Effect>;
  83044. private _onAfterRenderObserver;
  83045. /**
  83046. * A function that is added to the onAfterRenderObservable
  83047. */
  83048. onAfterRender: (efect: Effect) => void;
  83049. /**
  83050. * 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
  83051. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  83052. */
  83053. inputTexture: InternalTexture;
  83054. /**
  83055. * Gets the camera which post process is applied to.
  83056. * @returns The camera the post process is applied to.
  83057. */
  83058. getCamera(): Camera;
  83059. /**
  83060. * Gets the texel size of the postprocess.
  83061. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  83062. */
  83063. readonly texelSize: Vector2;
  83064. /**
  83065. * Creates a new instance PostProcess
  83066. * @param name The name of the PostProcess.
  83067. * @param fragmentUrl The url of the fragment shader to be used.
  83068. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  83069. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  83070. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  83071. * @param camera The camera to apply the render pass to.
  83072. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  83073. * @param engine The engine which the post process will be applied. (default: current engine)
  83074. * @param reusable If the post process can be reused on the same frame. (default: false)
  83075. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  83076. * @param textureType Type of textures used when performing the post process. (default: 0)
  83077. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  83078. * @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
  83079. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  83080. */
  83081. constructor(
  83082. /** Name of the PostProcess. */
  83083. 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);
  83084. /**
  83085. * Gets a string idenfifying the name of the class
  83086. * @returns "PostProcess" string
  83087. */
  83088. getClassName(): string;
  83089. /**
  83090. * Gets the engine which this post process belongs to.
  83091. * @returns The engine the post process was enabled with.
  83092. */
  83093. getEngine(): Engine;
  83094. /**
  83095. * The effect that is created when initializing the post process.
  83096. * @returns The created effect corresponding the the postprocess.
  83097. */
  83098. getEffect(): Effect;
  83099. /**
  83100. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  83101. * @param postProcess The post process to share the output with.
  83102. * @returns This post process.
  83103. */
  83104. shareOutputWith(postProcess: PostProcess): PostProcess;
  83105. /**
  83106. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  83107. * This should be called if the post process that shares output with this post process is disabled/disposed.
  83108. */
  83109. useOwnOutput(): void;
  83110. /**
  83111. * Updates the effect with the current post process compile time values and recompiles the shader.
  83112. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  83113. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  83114. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  83115. * @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
  83116. * @param onCompiled Called when the shader has been compiled.
  83117. * @param onError Called if there is an error when compiling a shader.
  83118. */
  83119. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  83120. /**
  83121. * The post process is reusable if it can be used multiple times within one frame.
  83122. * @returns If the post process is reusable
  83123. */
  83124. isReusable(): boolean;
  83125. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  83126. markTextureDirty(): void;
  83127. /**
  83128. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  83129. * 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.
  83130. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  83131. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  83132. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  83133. * @returns The target texture that was bound to be written to.
  83134. */
  83135. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  83136. /**
  83137. * If the post process is supported.
  83138. */
  83139. readonly isSupported: boolean;
  83140. /**
  83141. * The aspect ratio of the output texture.
  83142. */
  83143. readonly aspectRatio: number;
  83144. /**
  83145. * Get a value indicating if the post-process is ready to be used
  83146. * @returns true if the post-process is ready (shader is compiled)
  83147. */
  83148. isReady(): boolean;
  83149. /**
  83150. * Binds all textures and uniforms to the shader, this will be run on every pass.
  83151. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  83152. */
  83153. apply(): Nullable<Effect>;
  83154. private _disposeTextures;
  83155. /**
  83156. * Disposes the post process.
  83157. * @param camera The camera to dispose the post process on.
  83158. */
  83159. dispose(camera?: Camera): void;
  83160. }
  83161. }
  83162. declare module BABYLON {
  83163. /** @hidden */
  83164. export var kernelBlurVaryingDeclaration: {
  83165. name: string;
  83166. shader: string;
  83167. };
  83168. }
  83169. declare module BABYLON {
  83170. /** @hidden */
  83171. export var kernelBlurFragment: {
  83172. name: string;
  83173. shader: string;
  83174. };
  83175. }
  83176. declare module BABYLON {
  83177. /** @hidden */
  83178. export var kernelBlurFragment2: {
  83179. name: string;
  83180. shader: string;
  83181. };
  83182. }
  83183. declare module BABYLON {
  83184. /** @hidden */
  83185. export var kernelBlurPixelShader: {
  83186. name: string;
  83187. shader: string;
  83188. };
  83189. }
  83190. declare module BABYLON {
  83191. /** @hidden */
  83192. export var kernelBlurVertex: {
  83193. name: string;
  83194. shader: string;
  83195. };
  83196. }
  83197. declare module BABYLON {
  83198. /** @hidden */
  83199. export var kernelBlurVertexShader: {
  83200. name: string;
  83201. shader: string;
  83202. };
  83203. }
  83204. declare module BABYLON {
  83205. /**
  83206. * The Blur Post Process which blurs an image based on a kernel and direction.
  83207. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  83208. */
  83209. export class BlurPostProcess extends PostProcess {
  83210. /** The direction in which to blur the image. */
  83211. direction: Vector2;
  83212. private blockCompilation;
  83213. protected _kernel: number;
  83214. protected _idealKernel: number;
  83215. protected _packedFloat: boolean;
  83216. private _staticDefines;
  83217. /**
  83218. * Sets the length in pixels of the blur sample region
  83219. */
  83220. /**
  83221. * Gets the length in pixels of the blur sample region
  83222. */
  83223. kernel: number;
  83224. /**
  83225. * Sets wether or not the blur needs to unpack/repack floats
  83226. */
  83227. /**
  83228. * Gets wether or not the blur is unpacking/repacking floats
  83229. */
  83230. packedFloat: boolean;
  83231. /**
  83232. * Creates a new instance BlurPostProcess
  83233. * @param name The name of the effect.
  83234. * @param direction The direction in which to blur the image.
  83235. * @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.
  83236. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  83237. * @param camera The camera to apply the render pass to.
  83238. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  83239. * @param engine The engine which the post process will be applied. (default: current engine)
  83240. * @param reusable If the post process can be reused on the same frame. (default: false)
  83241. * @param textureType Type of textures used when performing the post process. (default: 0)
  83242. * @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)
  83243. */
  83244. constructor(name: string,
  83245. /** The direction in which to blur the image. */
  83246. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  83247. /**
  83248. * Updates the effect with the current post process compile time values and recompiles the shader.
  83249. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  83250. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  83251. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  83252. * @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
  83253. * @param onCompiled Called when the shader has been compiled.
  83254. * @param onError Called if there is an error when compiling a shader.
  83255. */
  83256. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  83257. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  83258. /**
  83259. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  83260. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  83261. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  83262. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  83263. * The gaps between physical kernels are compensated for in the weighting of the samples
  83264. * @param idealKernel Ideal blur kernel.
  83265. * @return Nearest best kernel.
  83266. */
  83267. protected _nearestBestKernel(idealKernel: number): number;
  83268. /**
  83269. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  83270. * @param x The point on the Gaussian distribution to sample.
  83271. * @return the value of the Gaussian function at x.
  83272. */
  83273. protected _gaussianWeight(x: number): number;
  83274. /**
  83275. * Generates a string that can be used as a floating point number in GLSL.
  83276. * @param x Value to print.
  83277. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  83278. * @return GLSL float string.
  83279. */
  83280. protected _glslFloat(x: number, decimalFigures?: number): string;
  83281. }
  83282. }
  83283. declare module BABYLON {
  83284. /**
  83285. * Mirror texture can be used to simulate the view from a mirror in a scene.
  83286. * It will dynamically be rendered every frame to adapt to the camera point of view.
  83287. * You can then easily use it as a reflectionTexture on a flat surface.
  83288. * In case the surface is not a plane, please consider relying on reflection probes.
  83289. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  83290. */
  83291. export class MirrorTexture extends RenderTargetTexture {
  83292. private scene;
  83293. /**
  83294. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  83295. * 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.
  83296. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  83297. */
  83298. mirrorPlane: Plane;
  83299. /**
  83300. * Define the blur ratio used to blur the reflection if needed.
  83301. */
  83302. blurRatio: number;
  83303. /**
  83304. * Define the adaptive blur kernel used to blur the reflection if needed.
  83305. * This will autocompute the closest best match for the `blurKernel`
  83306. */
  83307. adaptiveBlurKernel: number;
  83308. /**
  83309. * Define the blur kernel used to blur the reflection if needed.
  83310. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  83311. */
  83312. blurKernel: number;
  83313. /**
  83314. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  83315. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  83316. */
  83317. blurKernelX: number;
  83318. /**
  83319. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  83320. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  83321. */
  83322. blurKernelY: number;
  83323. private _autoComputeBlurKernel;
  83324. protected _onRatioRescale(): void;
  83325. private _updateGammaSpace;
  83326. private _imageProcessingConfigChangeObserver;
  83327. private _transformMatrix;
  83328. private _mirrorMatrix;
  83329. private _savedViewMatrix;
  83330. private _blurX;
  83331. private _blurY;
  83332. private _adaptiveBlurKernel;
  83333. private _blurKernelX;
  83334. private _blurKernelY;
  83335. private _blurRatio;
  83336. /**
  83337. * Instantiates a Mirror Texture.
  83338. * Mirror texture can be used to simulate the view from a mirror in a scene.
  83339. * It will dynamically be rendered every frame to adapt to the camera point of view.
  83340. * You can then easily use it as a reflectionTexture on a flat surface.
  83341. * In case the surface is not a plane, please consider relying on reflection probes.
  83342. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  83343. * @param name
  83344. * @param size
  83345. * @param scene
  83346. * @param generateMipMaps
  83347. * @param type
  83348. * @param samplingMode
  83349. * @param generateDepthBuffer
  83350. */
  83351. constructor(name: string, size: number | {
  83352. width: number;
  83353. height: number;
  83354. } | {
  83355. ratio: number;
  83356. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  83357. private _preparePostProcesses;
  83358. /**
  83359. * Clone the mirror texture.
  83360. * @returns the cloned texture
  83361. */
  83362. clone(): MirrorTexture;
  83363. /**
  83364. * Serialize the texture to a JSON representation you could use in Parse later on
  83365. * @returns the serialized JSON representation
  83366. */
  83367. serialize(): any;
  83368. /**
  83369. * Dispose the texture and release its associated resources.
  83370. */
  83371. dispose(): void;
  83372. }
  83373. }
  83374. declare module BABYLON {
  83375. /**
  83376. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  83377. * @see http://doc.babylonjs.com/babylon101/materials#texture
  83378. */
  83379. export class Texture extends BaseTexture {
  83380. /**
  83381. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  83382. */
  83383. static SerializeBuffers: boolean;
  83384. /** @hidden */
  83385. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  83386. /** @hidden */
  83387. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  83388. /** @hidden */
  83389. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  83390. /** nearest is mag = nearest and min = nearest and mip = linear */
  83391. static readonly NEAREST_SAMPLINGMODE: number;
  83392. /** nearest is mag = nearest and min = nearest and mip = linear */
  83393. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  83394. /** Bilinear is mag = linear and min = linear and mip = nearest */
  83395. static readonly BILINEAR_SAMPLINGMODE: number;
  83396. /** Bilinear is mag = linear and min = linear and mip = nearest */
  83397. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  83398. /** Trilinear is mag = linear and min = linear and mip = linear */
  83399. static readonly TRILINEAR_SAMPLINGMODE: number;
  83400. /** Trilinear is mag = linear and min = linear and mip = linear */
  83401. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  83402. /** mag = nearest and min = nearest and mip = nearest */
  83403. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  83404. /** mag = nearest and min = linear and mip = nearest */
  83405. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  83406. /** mag = nearest and min = linear and mip = linear */
  83407. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  83408. /** mag = nearest and min = linear and mip = none */
  83409. static readonly NEAREST_LINEAR: number;
  83410. /** mag = nearest and min = nearest and mip = none */
  83411. static readonly NEAREST_NEAREST: number;
  83412. /** mag = linear and min = nearest and mip = nearest */
  83413. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  83414. /** mag = linear and min = nearest and mip = linear */
  83415. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  83416. /** mag = linear and min = linear and mip = none */
  83417. static readonly LINEAR_LINEAR: number;
  83418. /** mag = linear and min = nearest and mip = none */
  83419. static readonly LINEAR_NEAREST: number;
  83420. /** Explicit coordinates mode */
  83421. static readonly EXPLICIT_MODE: number;
  83422. /** Spherical coordinates mode */
  83423. static readonly SPHERICAL_MODE: number;
  83424. /** Planar coordinates mode */
  83425. static readonly PLANAR_MODE: number;
  83426. /** Cubic coordinates mode */
  83427. static readonly CUBIC_MODE: number;
  83428. /** Projection coordinates mode */
  83429. static readonly PROJECTION_MODE: number;
  83430. /** Inverse Cubic coordinates mode */
  83431. static readonly SKYBOX_MODE: number;
  83432. /** Inverse Cubic coordinates mode */
  83433. static readonly INVCUBIC_MODE: number;
  83434. /** Equirectangular coordinates mode */
  83435. static readonly EQUIRECTANGULAR_MODE: number;
  83436. /** Equirectangular Fixed coordinates mode */
  83437. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  83438. /** Equirectangular Fixed Mirrored coordinates mode */
  83439. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  83440. /** Texture is not repeating outside of 0..1 UVs */
  83441. static readonly CLAMP_ADDRESSMODE: number;
  83442. /** Texture is repeating outside of 0..1 UVs */
  83443. static readonly WRAP_ADDRESSMODE: number;
  83444. /** Texture is repeating and mirrored */
  83445. static readonly MIRROR_ADDRESSMODE: number;
  83446. /**
  83447. * 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
  83448. */
  83449. static UseSerializedUrlIfAny: boolean;
  83450. /**
  83451. * Define the url of the texture.
  83452. */
  83453. url: Nullable<string>;
  83454. /**
  83455. * Define an offset on the texture to offset the u coordinates of the UVs
  83456. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  83457. */
  83458. uOffset: number;
  83459. /**
  83460. * Define an offset on the texture to offset the v coordinates of the UVs
  83461. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  83462. */
  83463. vOffset: number;
  83464. /**
  83465. * Define an offset on the texture to scale the u coordinates of the UVs
  83466. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  83467. */
  83468. uScale: number;
  83469. /**
  83470. * Define an offset on the texture to scale the v coordinates of the UVs
  83471. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  83472. */
  83473. vScale: number;
  83474. /**
  83475. * Define an offset on the texture to rotate around the u coordinates of the UVs
  83476. * @see http://doc.babylonjs.com/how_to/more_materials
  83477. */
  83478. uAng: number;
  83479. /**
  83480. * Define an offset on the texture to rotate around the v coordinates of the UVs
  83481. * @see http://doc.babylonjs.com/how_to/more_materials
  83482. */
  83483. vAng: number;
  83484. /**
  83485. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  83486. * @see http://doc.babylonjs.com/how_to/more_materials
  83487. */
  83488. wAng: number;
  83489. /**
  83490. * Defines the center of rotation (U)
  83491. */
  83492. uRotationCenter: number;
  83493. /**
  83494. * Defines the center of rotation (V)
  83495. */
  83496. vRotationCenter: number;
  83497. /**
  83498. * Defines the center of rotation (W)
  83499. */
  83500. wRotationCenter: number;
  83501. /**
  83502. * Are mip maps generated for this texture or not.
  83503. */
  83504. readonly noMipmap: boolean;
  83505. /**
  83506. * List of inspectable custom properties (used by the Inspector)
  83507. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  83508. */
  83509. inspectableCustomProperties: Nullable<IInspectable[]>;
  83510. private _noMipmap;
  83511. /** @hidden */
  83512. _invertY: boolean;
  83513. private _rowGenerationMatrix;
  83514. private _cachedTextureMatrix;
  83515. private _projectionModeMatrix;
  83516. private _t0;
  83517. private _t1;
  83518. private _t2;
  83519. private _cachedUOffset;
  83520. private _cachedVOffset;
  83521. private _cachedUScale;
  83522. private _cachedVScale;
  83523. private _cachedUAng;
  83524. private _cachedVAng;
  83525. private _cachedWAng;
  83526. private _cachedProjectionMatrixId;
  83527. private _cachedCoordinatesMode;
  83528. /** @hidden */
  83529. protected _initialSamplingMode: number;
  83530. /** @hidden */
  83531. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  83532. private _deleteBuffer;
  83533. protected _format: Nullable<number>;
  83534. private _delayedOnLoad;
  83535. private _delayedOnError;
  83536. private _mimeType?;
  83537. /**
  83538. * Observable triggered once the texture has been loaded.
  83539. */
  83540. onLoadObservable: Observable<Texture>;
  83541. protected _isBlocking: boolean;
  83542. /**
  83543. * Is the texture preventing material to render while loading.
  83544. * If false, a default texture will be used instead of the loading one during the preparation step.
  83545. */
  83546. isBlocking: boolean;
  83547. /**
  83548. * Get the current sampling mode associated with the texture.
  83549. */
  83550. readonly samplingMode: number;
  83551. /**
  83552. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  83553. */
  83554. readonly invertY: boolean;
  83555. /**
  83556. * Instantiates a new texture.
  83557. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  83558. * @see http://doc.babylonjs.com/babylon101/materials#texture
  83559. * @param url defines the url of the picture to load as a texture
  83560. * @param scene defines the scene or engine the texture will belong to
  83561. * @param noMipmap defines if the texture will require mip maps or not
  83562. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  83563. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  83564. * @param onLoad defines a callback triggered when the texture has been loaded
  83565. * @param onError defines a callback triggered when an error occurred during the loading session
  83566. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  83567. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  83568. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  83569. * @param mimeType defines an optional mime type information
  83570. */
  83571. 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);
  83572. /**
  83573. * Update the url (and optional buffer) of this texture if url was null during construction.
  83574. * @param url the url of the texture
  83575. * @param buffer the buffer of the texture (defaults to null)
  83576. * @param onLoad callback called when the texture is loaded (defaults to null)
  83577. */
  83578. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  83579. /**
  83580. * Finish the loading sequence of a texture flagged as delayed load.
  83581. * @hidden
  83582. */
  83583. delayLoad(): void;
  83584. private _prepareRowForTextureGeneration;
  83585. /**
  83586. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  83587. * @returns the transform matrix of the texture.
  83588. */
  83589. getTextureMatrix(): Matrix;
  83590. /**
  83591. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  83592. * @returns The reflection texture transform
  83593. */
  83594. getReflectionTextureMatrix(): Matrix;
  83595. /**
  83596. * Clones the texture.
  83597. * @returns the cloned texture
  83598. */
  83599. clone(): Texture;
  83600. /**
  83601. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  83602. * @returns The JSON representation of the texture
  83603. */
  83604. serialize(): any;
  83605. /**
  83606. * Get the current class name of the texture useful for serialization or dynamic coding.
  83607. * @returns "Texture"
  83608. */
  83609. getClassName(): string;
  83610. /**
  83611. * Dispose the texture and release its associated resources.
  83612. */
  83613. dispose(): void;
  83614. /**
  83615. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  83616. * @param parsedTexture Define the JSON representation of the texture
  83617. * @param scene Define the scene the parsed texture should be instantiated in
  83618. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  83619. * @returns The parsed texture if successful
  83620. */
  83621. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  83622. /**
  83623. * Creates a texture from its base 64 representation.
  83624. * @param data Define the base64 payload without the data: prefix
  83625. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  83626. * @param scene Define the scene the texture should belong to
  83627. * @param noMipmap Forces the texture to not create mip map information if true
  83628. * @param invertY define if the texture needs to be inverted on the y axis during loading
  83629. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  83630. * @param onLoad define a callback triggered when the texture has been loaded
  83631. * @param onError define a callback triggered when an error occurred during the loading session
  83632. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  83633. * @returns the created texture
  83634. */
  83635. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  83636. /**
  83637. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  83638. * @param data Define the base64 payload without the data: prefix
  83639. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  83640. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  83641. * @param scene Define the scene the texture should belong to
  83642. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  83643. * @param noMipmap Forces the texture to not create mip map information if true
  83644. * @param invertY define if the texture needs to be inverted on the y axis during loading
  83645. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  83646. * @param onLoad define a callback triggered when the texture has been loaded
  83647. * @param onError define a callback triggered when an error occurred during the loading session
  83648. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  83649. * @returns the created texture
  83650. */
  83651. 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;
  83652. }
  83653. }
  83654. declare module BABYLON {
  83655. /**
  83656. * PostProcessManager is used to manage one or more post processes or post process pipelines
  83657. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  83658. */
  83659. export class PostProcessManager {
  83660. private _scene;
  83661. private _indexBuffer;
  83662. private _vertexBuffers;
  83663. /**
  83664. * Creates a new instance PostProcess
  83665. * @param scene The scene that the post process is associated with.
  83666. */
  83667. constructor(scene: Scene);
  83668. private _prepareBuffers;
  83669. private _buildIndexBuffer;
  83670. /**
  83671. * Rebuilds the vertex buffers of the manager.
  83672. * @hidden
  83673. */
  83674. _rebuild(): void;
  83675. /**
  83676. * Prepares a frame to be run through a post process.
  83677. * @param sourceTexture The input texture to the post procesess. (default: null)
  83678. * @param postProcesses An array of post processes to be run. (default: null)
  83679. * @returns True if the post processes were able to be run.
  83680. * @hidden
  83681. */
  83682. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  83683. /**
  83684. * Manually render a set of post processes to a texture.
  83685. * @param postProcesses An array of post processes to be run.
  83686. * @param targetTexture The target texture to render to.
  83687. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  83688. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  83689. * @param lodLevel defines which lod of the texture to render to
  83690. */
  83691. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  83692. /**
  83693. * Finalize the result of the output of the postprocesses.
  83694. * @param doNotPresent If true the result will not be displayed to the screen.
  83695. * @param targetTexture The target texture to render to.
  83696. * @param faceIndex The index of the face to bind the target texture to.
  83697. * @param postProcesses The array of post processes to render.
  83698. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  83699. * @hidden
  83700. */
  83701. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  83702. /**
  83703. * Disposes of the post process manager.
  83704. */
  83705. dispose(): void;
  83706. }
  83707. }
  83708. declare module BABYLON {
  83709. /** Interface used by value gradients (color, factor, ...) */
  83710. export interface IValueGradient {
  83711. /**
  83712. * Gets or sets the gradient value (between 0 and 1)
  83713. */
  83714. gradient: number;
  83715. }
  83716. /** Class used to store color4 gradient */
  83717. export class ColorGradient implements IValueGradient {
  83718. /**
  83719. * Gets or sets the gradient value (between 0 and 1)
  83720. */
  83721. gradient: number;
  83722. /**
  83723. * Gets or sets first associated color
  83724. */
  83725. color1: Color4;
  83726. /**
  83727. * Gets or sets second associated color
  83728. */
  83729. color2?: Color4;
  83730. /**
  83731. * Will get a color picked randomly between color1 and color2.
  83732. * If color2 is undefined then color1 will be used
  83733. * @param result defines the target Color4 to store the result in
  83734. */
  83735. getColorToRef(result: Color4): void;
  83736. }
  83737. /** Class used to store color 3 gradient */
  83738. export class Color3Gradient implements IValueGradient {
  83739. /**
  83740. * Gets or sets the gradient value (between 0 and 1)
  83741. */
  83742. gradient: number;
  83743. /**
  83744. * Gets or sets the associated color
  83745. */
  83746. color: Color3;
  83747. }
  83748. /** Class used to store factor gradient */
  83749. export class FactorGradient implements IValueGradient {
  83750. /**
  83751. * Gets or sets the gradient value (between 0 and 1)
  83752. */
  83753. gradient: number;
  83754. /**
  83755. * Gets or sets first associated factor
  83756. */
  83757. factor1: number;
  83758. /**
  83759. * Gets or sets second associated factor
  83760. */
  83761. factor2?: number;
  83762. /**
  83763. * Will get a number picked randomly between factor1 and factor2.
  83764. * If factor2 is undefined then factor1 will be used
  83765. * @returns the picked number
  83766. */
  83767. getFactor(): number;
  83768. }
  83769. /**
  83770. * Helper used to simplify some generic gradient tasks
  83771. */
  83772. export class GradientHelper {
  83773. /**
  83774. * Gets the current gradient from an array of IValueGradient
  83775. * @param ratio defines the current ratio to get
  83776. * @param gradients defines the array of IValueGradient
  83777. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  83778. */
  83779. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  83780. }
  83781. }
  83782. declare module BABYLON {
  83783. interface ThinEngine {
  83784. /**
  83785. * Creates a dynamic texture
  83786. * @param width defines the width of the texture
  83787. * @param height defines the height of the texture
  83788. * @param generateMipMaps defines if the engine should generate the mip levels
  83789. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  83790. * @returns the dynamic texture inside an InternalTexture
  83791. */
  83792. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  83793. /**
  83794. * Update the content of a dynamic texture
  83795. * @param texture defines the texture to update
  83796. * @param canvas defines the canvas containing the source
  83797. * @param invertY defines if data must be stored with Y axis inverted
  83798. * @param premulAlpha defines if alpha is stored as premultiplied
  83799. * @param format defines the format of the data
  83800. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  83801. */
  83802. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  83803. }
  83804. }
  83805. declare module BABYLON {
  83806. /**
  83807. * Helper class used to generate a canvas to manipulate images
  83808. */
  83809. export class CanvasGenerator {
  83810. /**
  83811. * Create a new canvas (or offscreen canvas depending on the context)
  83812. * @param width defines the expected width
  83813. * @param height defines the expected height
  83814. * @return a new canvas or offscreen canvas
  83815. */
  83816. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  83817. }
  83818. }
  83819. declare module BABYLON {
  83820. /**
  83821. * A class extending Texture allowing drawing on a texture
  83822. * @see http://doc.babylonjs.com/how_to/dynamictexture
  83823. */
  83824. export class DynamicTexture extends Texture {
  83825. private _generateMipMaps;
  83826. private _canvas;
  83827. private _context;
  83828. private _engine;
  83829. /**
  83830. * Creates a DynamicTexture
  83831. * @param name defines the name of the texture
  83832. * @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
  83833. * @param scene defines the scene where you want the texture
  83834. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  83835. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  83836. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  83837. */
  83838. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  83839. /**
  83840. * Get the current class name of the texture useful for serialization or dynamic coding.
  83841. * @returns "DynamicTexture"
  83842. */
  83843. getClassName(): string;
  83844. /**
  83845. * Gets the current state of canRescale
  83846. */
  83847. readonly canRescale: boolean;
  83848. private _recreate;
  83849. /**
  83850. * Scales the texture
  83851. * @param ratio the scale factor to apply to both width and height
  83852. */
  83853. scale(ratio: number): void;
  83854. /**
  83855. * Resizes the texture
  83856. * @param width the new width
  83857. * @param height the new height
  83858. */
  83859. scaleTo(width: number, height: number): void;
  83860. /**
  83861. * Gets the context of the canvas used by the texture
  83862. * @returns the canvas context of the dynamic texture
  83863. */
  83864. getContext(): CanvasRenderingContext2D;
  83865. /**
  83866. * Clears the texture
  83867. */
  83868. clear(): void;
  83869. /**
  83870. * Updates the texture
  83871. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  83872. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  83873. */
  83874. update(invertY?: boolean, premulAlpha?: boolean): void;
  83875. /**
  83876. * Draws text onto the texture
  83877. * @param text defines the text to be drawn
  83878. * @param x defines the placement of the text from the left
  83879. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  83880. * @param font defines the font to be used with font-style, font-size, font-name
  83881. * @param color defines the color used for the text
  83882. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  83883. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  83884. * @param update defines whether texture is immediately update (default is true)
  83885. */
  83886. drawText(text: string, x: number, y: number, font: string, color: string, clearColor: string, invertY?: boolean, update?: boolean): void;
  83887. /**
  83888. * Clones the texture
  83889. * @returns the clone of the texture.
  83890. */
  83891. clone(): DynamicTexture;
  83892. /**
  83893. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  83894. * @returns a serialized dynamic texture object
  83895. */
  83896. serialize(): any;
  83897. /** @hidden */
  83898. _rebuild(): void;
  83899. }
  83900. }
  83901. declare module BABYLON {
  83902. interface AbstractScene {
  83903. /**
  83904. * The list of procedural textures added to the scene
  83905. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  83906. */
  83907. proceduralTextures: Array<ProceduralTexture>;
  83908. }
  83909. /**
  83910. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  83911. * in a given scene.
  83912. */
  83913. export class ProceduralTextureSceneComponent implements ISceneComponent {
  83914. /**
  83915. * The component name helpfull to identify the component in the list of scene components.
  83916. */
  83917. readonly name: string;
  83918. /**
  83919. * The scene the component belongs to.
  83920. */
  83921. scene: Scene;
  83922. /**
  83923. * Creates a new instance of the component for the given scene
  83924. * @param scene Defines the scene to register the component in
  83925. */
  83926. constructor(scene: Scene);
  83927. /**
  83928. * Registers the component in a given scene
  83929. */
  83930. register(): void;
  83931. /**
  83932. * Rebuilds the elements related to this component in case of
  83933. * context lost for instance.
  83934. */
  83935. rebuild(): void;
  83936. /**
  83937. * Disposes the component and the associated ressources.
  83938. */
  83939. dispose(): void;
  83940. private _beforeClear;
  83941. }
  83942. }
  83943. declare module BABYLON {
  83944. interface ThinEngine {
  83945. /**
  83946. * Creates a new render target cube texture
  83947. * @param size defines the size of the texture
  83948. * @param options defines the options used to create the texture
  83949. * @returns a new render target cube texture stored in an InternalTexture
  83950. */
  83951. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  83952. }
  83953. }
  83954. declare module BABYLON {
  83955. /** @hidden */
  83956. export var proceduralVertexShader: {
  83957. name: string;
  83958. shader: string;
  83959. };
  83960. }
  83961. declare module BABYLON {
  83962. /**
  83963. * 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.
  83964. * This is the base class of any Procedural texture and contains most of the shareable code.
  83965. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  83966. */
  83967. export class ProceduralTexture extends Texture {
  83968. isCube: boolean;
  83969. /**
  83970. * Define if the texture is enabled or not (disabled texture will not render)
  83971. */
  83972. isEnabled: boolean;
  83973. /**
  83974. * Define if the texture must be cleared before rendering (default is true)
  83975. */
  83976. autoClear: boolean;
  83977. /**
  83978. * Callback called when the texture is generated
  83979. */
  83980. onGenerated: () => void;
  83981. /**
  83982. * Event raised when the texture is generated
  83983. */
  83984. onGeneratedObservable: Observable<ProceduralTexture>;
  83985. /** @hidden */
  83986. _generateMipMaps: boolean;
  83987. /** @hidden **/
  83988. _effect: Effect;
  83989. /** @hidden */
  83990. _textures: {
  83991. [key: string]: Texture;
  83992. };
  83993. private _size;
  83994. private _currentRefreshId;
  83995. private _refreshRate;
  83996. private _vertexBuffers;
  83997. private _indexBuffer;
  83998. private _uniforms;
  83999. private _samplers;
  84000. private _fragment;
  84001. private _floats;
  84002. private _ints;
  84003. private _floatsArrays;
  84004. private _colors3;
  84005. private _colors4;
  84006. private _vectors2;
  84007. private _vectors3;
  84008. private _matrices;
  84009. private _fallbackTexture;
  84010. private _fallbackTextureUsed;
  84011. private _engine;
  84012. private _cachedDefines;
  84013. private _contentUpdateId;
  84014. private _contentData;
  84015. /**
  84016. * Instantiates a new procedural texture.
  84017. * 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.
  84018. * This is the base class of any Procedural texture and contains most of the shareable code.
  84019. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  84020. * @param name Define the name of the texture
  84021. * @param size Define the size of the texture to create
  84022. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  84023. * @param scene Define the scene the texture belongs to
  84024. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  84025. * @param generateMipMaps Define if the texture should creates mip maps or not
  84026. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  84027. */
  84028. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  84029. /**
  84030. * The effect that is created when initializing the post process.
  84031. * @returns The created effect corresponding the the postprocess.
  84032. */
  84033. getEffect(): Effect;
  84034. /**
  84035. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  84036. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  84037. */
  84038. getContent(): Nullable<ArrayBufferView>;
  84039. private _createIndexBuffer;
  84040. /** @hidden */
  84041. _rebuild(): void;
  84042. /**
  84043. * Resets the texture in order to recreate its associated resources.
  84044. * This can be called in case of context loss
  84045. */
  84046. reset(): void;
  84047. protected _getDefines(): string;
  84048. /**
  84049. * Is the texture ready to be used ? (rendered at least once)
  84050. * @returns true if ready, otherwise, false.
  84051. */
  84052. isReady(): boolean;
  84053. /**
  84054. * Resets the refresh counter of the texture and start bak from scratch.
  84055. * Could be useful to regenerate the texture if it is setup to render only once.
  84056. */
  84057. resetRefreshCounter(): void;
  84058. /**
  84059. * Set the fragment shader to use in order to render the texture.
  84060. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  84061. */
  84062. setFragment(fragment: any): void;
  84063. /**
  84064. * Define the refresh rate of the texture or the rendering frequency.
  84065. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  84066. */
  84067. refreshRate: number;
  84068. /** @hidden */
  84069. _shouldRender(): boolean;
  84070. /**
  84071. * Get the size the texture is rendering at.
  84072. * @returns the size (texture is always squared)
  84073. */
  84074. getRenderSize(): number;
  84075. /**
  84076. * Resize the texture to new value.
  84077. * @param size Define the new size the texture should have
  84078. * @param generateMipMaps Define whether the new texture should create mip maps
  84079. */
  84080. resize(size: number, generateMipMaps: boolean): void;
  84081. private _checkUniform;
  84082. /**
  84083. * Set a texture in the shader program used to render.
  84084. * @param name Define the name of the uniform samplers as defined in the shader
  84085. * @param texture Define the texture to bind to this sampler
  84086. * @return the texture itself allowing "fluent" like uniform updates
  84087. */
  84088. setTexture(name: string, texture: Texture): ProceduralTexture;
  84089. /**
  84090. * Set a float in the shader.
  84091. * @param name Define the name of the uniform as defined in the shader
  84092. * @param value Define the value to give to the uniform
  84093. * @return the texture itself allowing "fluent" like uniform updates
  84094. */
  84095. setFloat(name: string, value: number): ProceduralTexture;
  84096. /**
  84097. * Set a int in the shader.
  84098. * @param name Define the name of the uniform as defined in the shader
  84099. * @param value Define the value to give to the uniform
  84100. * @return the texture itself allowing "fluent" like uniform updates
  84101. */
  84102. setInt(name: string, value: number): ProceduralTexture;
  84103. /**
  84104. * Set an array of floats in the shader.
  84105. * @param name Define the name of the uniform as defined in the shader
  84106. * @param value Define the value to give to the uniform
  84107. * @return the texture itself allowing "fluent" like uniform updates
  84108. */
  84109. setFloats(name: string, value: number[]): ProceduralTexture;
  84110. /**
  84111. * Set a vec3 in the shader from a Color3.
  84112. * @param name Define the name of the uniform as defined in the shader
  84113. * @param value Define the value to give to the uniform
  84114. * @return the texture itself allowing "fluent" like uniform updates
  84115. */
  84116. setColor3(name: string, value: Color3): ProceduralTexture;
  84117. /**
  84118. * Set a vec4 in the shader from a Color4.
  84119. * @param name Define the name of the uniform as defined in the shader
  84120. * @param value Define the value to give to the uniform
  84121. * @return the texture itself allowing "fluent" like uniform updates
  84122. */
  84123. setColor4(name: string, value: Color4): ProceduralTexture;
  84124. /**
  84125. * Set a vec2 in the shader from a Vector2.
  84126. * @param name Define the name of the uniform as defined in the shader
  84127. * @param value Define the value to give to the uniform
  84128. * @return the texture itself allowing "fluent" like uniform updates
  84129. */
  84130. setVector2(name: string, value: Vector2): ProceduralTexture;
  84131. /**
  84132. * Set a vec3 in the shader from a Vector3.
  84133. * @param name Define the name of the uniform as defined in the shader
  84134. * @param value Define the value to give to the uniform
  84135. * @return the texture itself allowing "fluent" like uniform updates
  84136. */
  84137. setVector3(name: string, value: Vector3): ProceduralTexture;
  84138. /**
  84139. * Set a mat4 in the shader from a MAtrix.
  84140. * @param name Define the name of the uniform as defined in the shader
  84141. * @param value Define the value to give to the uniform
  84142. * @return the texture itself allowing "fluent" like uniform updates
  84143. */
  84144. setMatrix(name: string, value: Matrix): ProceduralTexture;
  84145. /**
  84146. * Render the texture to its associated render target.
  84147. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  84148. */
  84149. render(useCameraPostProcess?: boolean): void;
  84150. /**
  84151. * Clone the texture.
  84152. * @returns the cloned texture
  84153. */
  84154. clone(): ProceduralTexture;
  84155. /**
  84156. * Dispose the texture and release its asoociated resources.
  84157. */
  84158. dispose(): void;
  84159. }
  84160. }
  84161. declare module BABYLON {
  84162. /**
  84163. * This represents the base class for particle system in Babylon.
  84164. * 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.
  84165. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  84166. * @example https://doc.babylonjs.com/babylon101/particles
  84167. */
  84168. export class BaseParticleSystem {
  84169. /**
  84170. * Source color is added to the destination color without alpha affecting the result
  84171. */
  84172. static BLENDMODE_ONEONE: number;
  84173. /**
  84174. * Blend current color and particle color using particle’s alpha
  84175. */
  84176. static BLENDMODE_STANDARD: number;
  84177. /**
  84178. * Add current color and particle color multiplied by particle’s alpha
  84179. */
  84180. static BLENDMODE_ADD: number;
  84181. /**
  84182. * Multiply current color with particle color
  84183. */
  84184. static BLENDMODE_MULTIPLY: number;
  84185. /**
  84186. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  84187. */
  84188. static BLENDMODE_MULTIPLYADD: number;
  84189. /**
  84190. * List of animations used by the particle system.
  84191. */
  84192. animations: Animation[];
  84193. /**
  84194. * The id of the Particle system.
  84195. */
  84196. id: string;
  84197. /**
  84198. * The friendly name of the Particle system.
  84199. */
  84200. name: string;
  84201. /**
  84202. * The rendering group used by the Particle system to chose when to render.
  84203. */
  84204. renderingGroupId: number;
  84205. /**
  84206. * The emitter represents the Mesh or position we are attaching the particle system to.
  84207. */
  84208. emitter: Nullable<AbstractMesh | Vector3>;
  84209. /**
  84210. * The maximum number of particles to emit per frame
  84211. */
  84212. emitRate: number;
  84213. /**
  84214. * If you want to launch only a few particles at once, that can be done, as well.
  84215. */
  84216. manualEmitCount: number;
  84217. /**
  84218. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  84219. */
  84220. updateSpeed: number;
  84221. /**
  84222. * The amount of time the particle system is running (depends of the overall update speed).
  84223. */
  84224. targetStopDuration: number;
  84225. /**
  84226. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  84227. */
  84228. disposeOnStop: boolean;
  84229. /**
  84230. * Minimum power of emitting particles.
  84231. */
  84232. minEmitPower: number;
  84233. /**
  84234. * Maximum power of emitting particles.
  84235. */
  84236. maxEmitPower: number;
  84237. /**
  84238. * Minimum life time of emitting particles.
  84239. */
  84240. minLifeTime: number;
  84241. /**
  84242. * Maximum life time of emitting particles.
  84243. */
  84244. maxLifeTime: number;
  84245. /**
  84246. * Minimum Size of emitting particles.
  84247. */
  84248. minSize: number;
  84249. /**
  84250. * Maximum Size of emitting particles.
  84251. */
  84252. maxSize: number;
  84253. /**
  84254. * Minimum scale of emitting particles on X axis.
  84255. */
  84256. minScaleX: number;
  84257. /**
  84258. * Maximum scale of emitting particles on X axis.
  84259. */
  84260. maxScaleX: number;
  84261. /**
  84262. * Minimum scale of emitting particles on Y axis.
  84263. */
  84264. minScaleY: number;
  84265. /**
  84266. * Maximum scale of emitting particles on Y axis.
  84267. */
  84268. maxScaleY: number;
  84269. /**
  84270. * Gets or sets the minimal initial rotation in radians.
  84271. */
  84272. minInitialRotation: number;
  84273. /**
  84274. * Gets or sets the maximal initial rotation in radians.
  84275. */
  84276. maxInitialRotation: number;
  84277. /**
  84278. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  84279. */
  84280. minAngularSpeed: number;
  84281. /**
  84282. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  84283. */
  84284. maxAngularSpeed: number;
  84285. /**
  84286. * The texture used to render each particle. (this can be a spritesheet)
  84287. */
  84288. particleTexture: Nullable<Texture>;
  84289. /**
  84290. * The layer mask we are rendering the particles through.
  84291. */
  84292. layerMask: number;
  84293. /**
  84294. * This can help using your own shader to render the particle system.
  84295. * The according effect will be created
  84296. */
  84297. customShader: any;
  84298. /**
  84299. * By default particle system starts as soon as they are created. This prevents the
  84300. * automatic start to happen and let you decide when to start emitting particles.
  84301. */
  84302. preventAutoStart: boolean;
  84303. private _noiseTexture;
  84304. /**
  84305. * Gets or sets a texture used to add random noise to particle positions
  84306. */
  84307. noiseTexture: Nullable<ProceduralTexture>;
  84308. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  84309. noiseStrength: Vector3;
  84310. /**
  84311. * Callback triggered when the particle animation is ending.
  84312. */
  84313. onAnimationEnd: Nullable<() => void>;
  84314. /**
  84315. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  84316. */
  84317. blendMode: number;
  84318. /**
  84319. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  84320. * to override the particles.
  84321. */
  84322. forceDepthWrite: boolean;
  84323. /** 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 */
  84324. preWarmCycles: number;
  84325. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  84326. preWarmStepOffset: number;
  84327. /**
  84328. * 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)
  84329. */
  84330. spriteCellChangeSpeed: number;
  84331. /**
  84332. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  84333. */
  84334. startSpriteCellID: number;
  84335. /**
  84336. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  84337. */
  84338. endSpriteCellID: number;
  84339. /**
  84340. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  84341. */
  84342. spriteCellWidth: number;
  84343. /**
  84344. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  84345. */
  84346. spriteCellHeight: number;
  84347. /**
  84348. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  84349. */
  84350. spriteRandomStartCell: boolean;
  84351. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  84352. translationPivot: Vector2;
  84353. /** @hidden */
  84354. protected _isAnimationSheetEnabled: boolean;
  84355. /**
  84356. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  84357. */
  84358. beginAnimationOnStart: boolean;
  84359. /**
  84360. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  84361. */
  84362. beginAnimationFrom: number;
  84363. /**
  84364. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  84365. */
  84366. beginAnimationTo: number;
  84367. /**
  84368. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  84369. */
  84370. beginAnimationLoop: boolean;
  84371. /**
  84372. * Gets or sets a world offset applied to all particles
  84373. */
  84374. worldOffset: Vector3;
  84375. /**
  84376. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  84377. */
  84378. isAnimationSheetEnabled: boolean;
  84379. /**
  84380. * Get hosting scene
  84381. * @returns the scene
  84382. */
  84383. getScene(): Scene;
  84384. /**
  84385. * You can use gravity if you want to give an orientation to your particles.
  84386. */
  84387. gravity: Vector3;
  84388. protected _colorGradients: Nullable<Array<ColorGradient>>;
  84389. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  84390. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  84391. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  84392. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  84393. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  84394. protected _dragGradients: Nullable<Array<FactorGradient>>;
  84395. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  84396. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  84397. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  84398. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  84399. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  84400. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  84401. /**
  84402. * Defines the delay in milliseconds before starting the system (0 by default)
  84403. */
  84404. startDelay: number;
  84405. /**
  84406. * Gets the current list of drag gradients.
  84407. * You must use addDragGradient and removeDragGradient to udpate this list
  84408. * @returns the list of drag gradients
  84409. */
  84410. getDragGradients(): Nullable<Array<FactorGradient>>;
  84411. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  84412. limitVelocityDamping: number;
  84413. /**
  84414. * Gets the current list of limit velocity gradients.
  84415. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  84416. * @returns the list of limit velocity gradients
  84417. */
  84418. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  84419. /**
  84420. * Gets the current list of color gradients.
  84421. * You must use addColorGradient and removeColorGradient to udpate this list
  84422. * @returns the list of color gradients
  84423. */
  84424. getColorGradients(): Nullable<Array<ColorGradient>>;
  84425. /**
  84426. * Gets the current list of size gradients.
  84427. * You must use addSizeGradient and removeSizeGradient to udpate this list
  84428. * @returns the list of size gradients
  84429. */
  84430. getSizeGradients(): Nullable<Array<FactorGradient>>;
  84431. /**
  84432. * Gets the current list of color remap gradients.
  84433. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  84434. * @returns the list of color remap gradients
  84435. */
  84436. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  84437. /**
  84438. * Gets the current list of alpha remap gradients.
  84439. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  84440. * @returns the list of alpha remap gradients
  84441. */
  84442. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  84443. /**
  84444. * Gets the current list of life time gradients.
  84445. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  84446. * @returns the list of life time gradients
  84447. */
  84448. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  84449. /**
  84450. * Gets the current list of angular speed gradients.
  84451. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  84452. * @returns the list of angular speed gradients
  84453. */
  84454. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  84455. /**
  84456. * Gets the current list of velocity gradients.
  84457. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  84458. * @returns the list of velocity gradients
  84459. */
  84460. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  84461. /**
  84462. * Gets the current list of start size gradients.
  84463. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  84464. * @returns the list of start size gradients
  84465. */
  84466. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  84467. /**
  84468. * Gets the current list of emit rate gradients.
  84469. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  84470. * @returns the list of emit rate gradients
  84471. */
  84472. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  84473. /**
  84474. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  84475. * This only works when particleEmitterTyps is a BoxParticleEmitter
  84476. */
  84477. direction1: Vector3;
  84478. /**
  84479. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  84480. * This only works when particleEmitterTyps is a BoxParticleEmitter
  84481. */
  84482. direction2: Vector3;
  84483. /**
  84484. * 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.
  84485. * This only works when particleEmitterTyps is a BoxParticleEmitter
  84486. */
  84487. minEmitBox: Vector3;
  84488. /**
  84489. * 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.
  84490. * This only works when particleEmitterTyps is a BoxParticleEmitter
  84491. */
  84492. maxEmitBox: Vector3;
  84493. /**
  84494. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  84495. */
  84496. color1: Color4;
  84497. /**
  84498. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  84499. */
  84500. color2: Color4;
  84501. /**
  84502. * Color the particle will have at the end of its lifetime
  84503. */
  84504. colorDead: Color4;
  84505. /**
  84506. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  84507. */
  84508. textureMask: Color4;
  84509. /**
  84510. * The particle emitter type defines the emitter used by the particle system.
  84511. * It can be for example box, sphere, or cone...
  84512. */
  84513. particleEmitterType: IParticleEmitterType;
  84514. /** @hidden */
  84515. _isSubEmitter: boolean;
  84516. /**
  84517. * Gets or sets the billboard mode to use when isBillboardBased = true.
  84518. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  84519. */
  84520. billboardMode: number;
  84521. protected _isBillboardBased: boolean;
  84522. /**
  84523. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  84524. */
  84525. isBillboardBased: boolean;
  84526. /**
  84527. * The scene the particle system belongs to.
  84528. */
  84529. protected _scene: Scene;
  84530. /**
  84531. * Local cache of defines for image processing.
  84532. */
  84533. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  84534. /**
  84535. * Default configuration related to image processing available in the standard Material.
  84536. */
  84537. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  84538. /**
  84539. * Gets the image processing configuration used either in this material.
  84540. */
  84541. /**
  84542. * Sets the Default image processing configuration used either in the this material.
  84543. *
  84544. * If sets to null, the scene one is in use.
  84545. */
  84546. imageProcessingConfiguration: ImageProcessingConfiguration;
  84547. /**
  84548. * Attaches a new image processing configuration to the Standard Material.
  84549. * @param configuration
  84550. */
  84551. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  84552. /** @hidden */
  84553. protected _reset(): void;
  84554. /** @hidden */
  84555. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  84556. /**
  84557. * Instantiates a particle system.
  84558. * 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.
  84559. * @param name The name of the particle system
  84560. */
  84561. constructor(name: string);
  84562. /**
  84563. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  84564. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  84565. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  84566. * @returns the emitter
  84567. */
  84568. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  84569. /**
  84570. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  84571. * @param radius The radius of the hemisphere to emit from
  84572. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  84573. * @returns the emitter
  84574. */
  84575. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  84576. /**
  84577. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  84578. * @param radius The radius of the sphere to emit from
  84579. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  84580. * @returns the emitter
  84581. */
  84582. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  84583. /**
  84584. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  84585. * @param radius The radius of the sphere to emit from
  84586. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  84587. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  84588. * @returns the emitter
  84589. */
  84590. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  84591. /**
  84592. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  84593. * @param radius The radius of the emission cylinder
  84594. * @param height The height of the emission cylinder
  84595. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  84596. * @param directionRandomizer How much to randomize the particle direction [0-1]
  84597. * @returns the emitter
  84598. */
  84599. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  84600. /**
  84601. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  84602. * @param radius The radius of the cylinder to emit from
  84603. * @param height The height of the emission cylinder
  84604. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  84605. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  84606. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  84607. * @returns the emitter
  84608. */
  84609. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  84610. /**
  84611. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  84612. * @param radius The radius of the cone to emit from
  84613. * @param angle The base angle of the cone
  84614. * @returns the emitter
  84615. */
  84616. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  84617. /**
  84618. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  84619. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  84620. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  84621. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  84622. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  84623. * @returns the emitter
  84624. */
  84625. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  84626. }
  84627. }
  84628. declare module BABYLON {
  84629. /**
  84630. * Type of sub emitter
  84631. */
  84632. export enum SubEmitterType {
  84633. /**
  84634. * Attached to the particle over it's lifetime
  84635. */
  84636. ATTACHED = 0,
  84637. /**
  84638. * Created when the particle dies
  84639. */
  84640. END = 1
  84641. }
  84642. /**
  84643. * Sub emitter class used to emit particles from an existing particle
  84644. */
  84645. export class SubEmitter {
  84646. /**
  84647. * the particle system to be used by the sub emitter
  84648. */
  84649. particleSystem: ParticleSystem;
  84650. /**
  84651. * Type of the submitter (Default: END)
  84652. */
  84653. type: SubEmitterType;
  84654. /**
  84655. * 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)
  84656. * Note: This only is supported when using an emitter of type Mesh
  84657. */
  84658. inheritDirection: boolean;
  84659. /**
  84660. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  84661. */
  84662. inheritedVelocityAmount: number;
  84663. /**
  84664. * Creates a sub emitter
  84665. * @param particleSystem the particle system to be used by the sub emitter
  84666. */
  84667. constructor(
  84668. /**
  84669. * the particle system to be used by the sub emitter
  84670. */
  84671. particleSystem: ParticleSystem);
  84672. /**
  84673. * Clones the sub emitter
  84674. * @returns the cloned sub emitter
  84675. */
  84676. clone(): SubEmitter;
  84677. /**
  84678. * Serialize current object to a JSON object
  84679. * @returns the serialized object
  84680. */
  84681. serialize(): any;
  84682. /** @hidden */
  84683. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  84684. /**
  84685. * Creates a new SubEmitter from a serialized JSON version
  84686. * @param serializationObject defines the JSON object to read from
  84687. * @param scene defines the hosting scene
  84688. * @param rootUrl defines the rootUrl for data loading
  84689. * @returns a new SubEmitter
  84690. */
  84691. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  84692. /** Release associated resources */
  84693. dispose(): void;
  84694. }
  84695. }
  84696. declare module BABYLON {
  84697. /** @hidden */
  84698. export var clipPlaneFragmentDeclaration: {
  84699. name: string;
  84700. shader: string;
  84701. };
  84702. }
  84703. declare module BABYLON {
  84704. /** @hidden */
  84705. export var imageProcessingDeclaration: {
  84706. name: string;
  84707. shader: string;
  84708. };
  84709. }
  84710. declare module BABYLON {
  84711. /** @hidden */
  84712. export var imageProcessingFunctions: {
  84713. name: string;
  84714. shader: string;
  84715. };
  84716. }
  84717. declare module BABYLON {
  84718. /** @hidden */
  84719. export var clipPlaneFragment: {
  84720. name: string;
  84721. shader: string;
  84722. };
  84723. }
  84724. declare module BABYLON {
  84725. /** @hidden */
  84726. export var particlesPixelShader: {
  84727. name: string;
  84728. shader: string;
  84729. };
  84730. }
  84731. declare module BABYLON {
  84732. /** @hidden */
  84733. export var clipPlaneVertexDeclaration: {
  84734. name: string;
  84735. shader: string;
  84736. };
  84737. }
  84738. declare module BABYLON {
  84739. /** @hidden */
  84740. export var clipPlaneVertex: {
  84741. name: string;
  84742. shader: string;
  84743. };
  84744. }
  84745. declare module BABYLON {
  84746. /** @hidden */
  84747. export var particlesVertexShader: {
  84748. name: string;
  84749. shader: string;
  84750. };
  84751. }
  84752. declare module BABYLON {
  84753. /**
  84754. * This represents a particle system in Babylon.
  84755. * 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.
  84756. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  84757. * @example https://doc.babylonjs.com/babylon101/particles
  84758. */
  84759. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  84760. /**
  84761. * Billboard mode will only apply to Y axis
  84762. */
  84763. static readonly BILLBOARDMODE_Y: number;
  84764. /**
  84765. * Billboard mode will apply to all axes
  84766. */
  84767. static readonly BILLBOARDMODE_ALL: number;
  84768. /**
  84769. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  84770. */
  84771. static readonly BILLBOARDMODE_STRETCHED: number;
  84772. /**
  84773. * This function can be defined to provide custom update for active particles.
  84774. * This function will be called instead of regular update (age, position, color, etc.).
  84775. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  84776. */
  84777. updateFunction: (particles: Particle[]) => void;
  84778. private _emitterWorldMatrix;
  84779. /**
  84780. * This function can be defined to specify initial direction for every new particle.
  84781. * It by default use the emitterType defined function
  84782. */
  84783. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void;
  84784. /**
  84785. * This function can be defined to specify initial position for every new particle.
  84786. * It by default use the emitterType defined function
  84787. */
  84788. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void;
  84789. /**
  84790. * @hidden
  84791. */
  84792. _inheritedVelocityOffset: Vector3;
  84793. /**
  84794. * An event triggered when the system is disposed
  84795. */
  84796. onDisposeObservable: Observable<ParticleSystem>;
  84797. private _onDisposeObserver;
  84798. /**
  84799. * Sets a callback that will be triggered when the system is disposed
  84800. */
  84801. onDispose: () => void;
  84802. private _particles;
  84803. private _epsilon;
  84804. private _capacity;
  84805. private _stockParticles;
  84806. private _newPartsExcess;
  84807. private _vertexData;
  84808. private _vertexBuffer;
  84809. private _vertexBuffers;
  84810. private _spriteBuffer;
  84811. private _indexBuffer;
  84812. private _effect;
  84813. private _customEffect;
  84814. private _cachedDefines;
  84815. private _scaledColorStep;
  84816. private _colorDiff;
  84817. private _scaledDirection;
  84818. private _scaledGravity;
  84819. private _currentRenderId;
  84820. private _alive;
  84821. private _useInstancing;
  84822. private _started;
  84823. private _stopped;
  84824. private _actualFrame;
  84825. private _scaledUpdateSpeed;
  84826. private _vertexBufferSize;
  84827. /** @hidden */
  84828. _currentEmitRateGradient: Nullable<FactorGradient>;
  84829. /** @hidden */
  84830. _currentEmitRate1: number;
  84831. /** @hidden */
  84832. _currentEmitRate2: number;
  84833. /** @hidden */
  84834. _currentStartSizeGradient: Nullable<FactorGradient>;
  84835. /** @hidden */
  84836. _currentStartSize1: number;
  84837. /** @hidden */
  84838. _currentStartSize2: number;
  84839. private readonly _rawTextureWidth;
  84840. private _rampGradientsTexture;
  84841. private _useRampGradients;
  84842. /** Gets or sets a boolean indicating that ramp gradients must be used
  84843. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  84844. */
  84845. useRampGradients: boolean;
  84846. /**
  84847. * 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.
  84848. * 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: [])
  84849. */
  84850. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  84851. private _subEmitters;
  84852. /**
  84853. * @hidden
  84854. * If the particle systems emitter should be disposed when the particle system is disposed
  84855. */
  84856. _disposeEmitterOnDispose: boolean;
  84857. /**
  84858. * The current active Sub-systems, this property is used by the root particle system only.
  84859. */
  84860. activeSubSystems: Array<ParticleSystem>;
  84861. private _rootParticleSystem;
  84862. /**
  84863. * Gets the current list of active particles
  84864. */
  84865. readonly particles: Particle[];
  84866. /**
  84867. * Returns the string "ParticleSystem"
  84868. * @returns a string containing the class name
  84869. */
  84870. getClassName(): string;
  84871. /**
  84872. * Instantiates a particle system.
  84873. * 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.
  84874. * @param name The name of the particle system
  84875. * @param capacity The max number of particles alive at the same time
  84876. * @param scene The scene the particle system belongs to
  84877. * @param customEffect a custom effect used to change the way particles are rendered by default
  84878. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  84879. * @param epsilon Offset used to render the particles
  84880. */
  84881. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  84882. private _addFactorGradient;
  84883. private _removeFactorGradient;
  84884. /**
  84885. * Adds a new life time gradient
  84886. * @param gradient defines the gradient to use (between 0 and 1)
  84887. * @param factor defines the life time factor to affect to the specified gradient
  84888. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  84889. * @returns the current particle system
  84890. */
  84891. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  84892. /**
  84893. * Remove a specific life time gradient
  84894. * @param gradient defines the gradient to remove
  84895. * @returns the current particle system
  84896. */
  84897. removeLifeTimeGradient(gradient: number): IParticleSystem;
  84898. /**
  84899. * Adds a new size gradient
  84900. * @param gradient defines the gradient to use (between 0 and 1)
  84901. * @param factor defines the size factor to affect to the specified gradient
  84902. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  84903. * @returns the current particle system
  84904. */
  84905. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  84906. /**
  84907. * Remove a specific size gradient
  84908. * @param gradient defines the gradient to remove
  84909. * @returns the current particle system
  84910. */
  84911. removeSizeGradient(gradient: number): IParticleSystem;
  84912. /**
  84913. * Adds a new color remap gradient
  84914. * @param gradient defines the gradient to use (between 0 and 1)
  84915. * @param min defines the color remap minimal range
  84916. * @param max defines the color remap maximal range
  84917. * @returns the current particle system
  84918. */
  84919. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  84920. /**
  84921. * Remove a specific color remap gradient
  84922. * @param gradient defines the gradient to remove
  84923. * @returns the current particle system
  84924. */
  84925. removeColorRemapGradient(gradient: number): IParticleSystem;
  84926. /**
  84927. * Adds a new alpha remap gradient
  84928. * @param gradient defines the gradient to use (between 0 and 1)
  84929. * @param min defines the alpha remap minimal range
  84930. * @param max defines the alpha remap maximal range
  84931. * @returns the current particle system
  84932. */
  84933. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  84934. /**
  84935. * Remove a specific alpha remap gradient
  84936. * @param gradient defines the gradient to remove
  84937. * @returns the current particle system
  84938. */
  84939. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  84940. /**
  84941. * Adds a new angular speed gradient
  84942. * @param gradient defines the gradient to use (between 0 and 1)
  84943. * @param factor defines the angular speed to affect to the specified gradient
  84944. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  84945. * @returns the current particle system
  84946. */
  84947. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  84948. /**
  84949. * Remove a specific angular speed gradient
  84950. * @param gradient defines the gradient to remove
  84951. * @returns the current particle system
  84952. */
  84953. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  84954. /**
  84955. * Adds a new velocity gradient
  84956. * @param gradient defines the gradient to use (between 0 and 1)
  84957. * @param factor defines the velocity to affect to the specified gradient
  84958. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  84959. * @returns the current particle system
  84960. */
  84961. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  84962. /**
  84963. * Remove a specific velocity gradient
  84964. * @param gradient defines the gradient to remove
  84965. * @returns the current particle system
  84966. */
  84967. removeVelocityGradient(gradient: number): IParticleSystem;
  84968. /**
  84969. * Adds a new limit velocity gradient
  84970. * @param gradient defines the gradient to use (between 0 and 1)
  84971. * @param factor defines the limit velocity value to affect to the specified gradient
  84972. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  84973. * @returns the current particle system
  84974. */
  84975. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  84976. /**
  84977. * Remove a specific limit velocity gradient
  84978. * @param gradient defines the gradient to remove
  84979. * @returns the current particle system
  84980. */
  84981. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  84982. /**
  84983. * Adds a new drag gradient
  84984. * @param gradient defines the gradient to use (between 0 and 1)
  84985. * @param factor defines the drag value to affect to the specified gradient
  84986. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  84987. * @returns the current particle system
  84988. */
  84989. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  84990. /**
  84991. * Remove a specific drag gradient
  84992. * @param gradient defines the gradient to remove
  84993. * @returns the current particle system
  84994. */
  84995. removeDragGradient(gradient: number): IParticleSystem;
  84996. /**
  84997. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  84998. * @param gradient defines the gradient to use (between 0 and 1)
  84999. * @param factor defines the emit rate value to affect to the specified gradient
  85000. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85001. * @returns the current particle system
  85002. */
  85003. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85004. /**
  85005. * Remove a specific emit rate gradient
  85006. * @param gradient defines the gradient to remove
  85007. * @returns the current particle system
  85008. */
  85009. removeEmitRateGradient(gradient: number): IParticleSystem;
  85010. /**
  85011. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  85012. * @param gradient defines the gradient to use (between 0 and 1)
  85013. * @param factor defines the start size value to affect to the specified gradient
  85014. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85015. * @returns the current particle system
  85016. */
  85017. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85018. /**
  85019. * Remove a specific start size gradient
  85020. * @param gradient defines the gradient to remove
  85021. * @returns the current particle system
  85022. */
  85023. removeStartSizeGradient(gradient: number): IParticleSystem;
  85024. private _createRampGradientTexture;
  85025. /**
  85026. * Gets the current list of ramp gradients.
  85027. * You must use addRampGradient and removeRampGradient to udpate this list
  85028. * @returns the list of ramp gradients
  85029. */
  85030. getRampGradients(): Nullable<Array<Color3Gradient>>;
  85031. /**
  85032. * Adds a new ramp gradient used to remap particle colors
  85033. * @param gradient defines the gradient to use (between 0 and 1)
  85034. * @param color defines the color to affect to the specified gradient
  85035. * @returns the current particle system
  85036. */
  85037. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  85038. /**
  85039. * Remove a specific ramp gradient
  85040. * @param gradient defines the gradient to remove
  85041. * @returns the current particle system
  85042. */
  85043. removeRampGradient(gradient: number): ParticleSystem;
  85044. /**
  85045. * Adds a new color gradient
  85046. * @param gradient defines the gradient to use (between 0 and 1)
  85047. * @param color1 defines the color to affect to the specified gradient
  85048. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  85049. * @returns this particle system
  85050. */
  85051. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  85052. /**
  85053. * Remove a specific color gradient
  85054. * @param gradient defines the gradient to remove
  85055. * @returns this particle system
  85056. */
  85057. removeColorGradient(gradient: number): IParticleSystem;
  85058. private _fetchR;
  85059. protected _reset(): void;
  85060. private _resetEffect;
  85061. private _createVertexBuffers;
  85062. private _createIndexBuffer;
  85063. /**
  85064. * Gets the maximum number of particles active at the same time.
  85065. * @returns The max number of active particles.
  85066. */
  85067. getCapacity(): number;
  85068. /**
  85069. * Gets whether there are still active particles in the system.
  85070. * @returns True if it is alive, otherwise false.
  85071. */
  85072. isAlive(): boolean;
  85073. /**
  85074. * Gets if the system has been started. (Note: this will still be true after stop is called)
  85075. * @returns True if it has been started, otherwise false.
  85076. */
  85077. isStarted(): boolean;
  85078. private _prepareSubEmitterInternalArray;
  85079. /**
  85080. * Starts the particle system and begins to emit
  85081. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  85082. */
  85083. start(delay?: number): void;
  85084. /**
  85085. * Stops the particle system.
  85086. * @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.
  85087. */
  85088. stop(stopSubEmitters?: boolean): void;
  85089. /**
  85090. * Remove all active particles
  85091. */
  85092. reset(): void;
  85093. /**
  85094. * @hidden (for internal use only)
  85095. */
  85096. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  85097. /**
  85098. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  85099. * Its lifetime will start back at 0.
  85100. */
  85101. recycleParticle: (particle: Particle) => void;
  85102. private _stopSubEmitters;
  85103. private _createParticle;
  85104. private _removeFromRoot;
  85105. private _emitFromParticle;
  85106. private _update;
  85107. /** @hidden */
  85108. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  85109. /** @hidden */
  85110. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  85111. /** @hidden */
  85112. private _getEffect;
  85113. /**
  85114. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  85115. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  85116. */
  85117. animate(preWarmOnly?: boolean): void;
  85118. private _appendParticleVertices;
  85119. /**
  85120. * Rebuilds the particle system.
  85121. */
  85122. rebuild(): void;
  85123. /**
  85124. * Is this system ready to be used/rendered
  85125. * @return true if the system is ready
  85126. */
  85127. isReady(): boolean;
  85128. private _render;
  85129. /**
  85130. * Renders the particle system in its current state.
  85131. * @returns the current number of particles
  85132. */
  85133. render(): number;
  85134. /**
  85135. * Disposes the particle system and free the associated resources
  85136. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  85137. */
  85138. dispose(disposeTexture?: boolean): void;
  85139. /**
  85140. * Clones the particle system.
  85141. * @param name The name of the cloned object
  85142. * @param newEmitter The new emitter to use
  85143. * @returns the cloned particle system
  85144. */
  85145. clone(name: string, newEmitter: any): ParticleSystem;
  85146. /**
  85147. * Serializes the particle system to a JSON object.
  85148. * @returns the JSON object
  85149. */
  85150. serialize(): any;
  85151. /** @hidden */
  85152. static _Serialize(serializationObject: any, particleSystem: IParticleSystem): void;
  85153. /** @hidden */
  85154. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  85155. /**
  85156. * Parses a JSON object to create a particle system.
  85157. * @param parsedParticleSystem The JSON object to parse
  85158. * @param scene The scene to create the particle system in
  85159. * @param rootUrl The root url to use to load external dependencies like texture
  85160. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  85161. * @returns the Parsed particle system
  85162. */
  85163. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  85164. }
  85165. }
  85166. declare module BABYLON {
  85167. /**
  85168. * A particle represents one of the element emitted by a particle system.
  85169. * This is mainly define by its coordinates, direction, velocity and age.
  85170. */
  85171. export class Particle {
  85172. /**
  85173. * The particle system the particle belongs to.
  85174. */
  85175. particleSystem: ParticleSystem;
  85176. private static _Count;
  85177. /**
  85178. * Unique ID of the particle
  85179. */
  85180. id: number;
  85181. /**
  85182. * The world position of the particle in the scene.
  85183. */
  85184. position: Vector3;
  85185. /**
  85186. * The world direction of the particle in the scene.
  85187. */
  85188. direction: Vector3;
  85189. /**
  85190. * The color of the particle.
  85191. */
  85192. color: Color4;
  85193. /**
  85194. * The color change of the particle per step.
  85195. */
  85196. colorStep: Color4;
  85197. /**
  85198. * Defines how long will the life of the particle be.
  85199. */
  85200. lifeTime: number;
  85201. /**
  85202. * The current age of the particle.
  85203. */
  85204. age: number;
  85205. /**
  85206. * The current size of the particle.
  85207. */
  85208. size: number;
  85209. /**
  85210. * The current scale of the particle.
  85211. */
  85212. scale: Vector2;
  85213. /**
  85214. * The current angle of the particle.
  85215. */
  85216. angle: number;
  85217. /**
  85218. * Defines how fast is the angle changing.
  85219. */
  85220. angularSpeed: number;
  85221. /**
  85222. * Defines the cell index used by the particle to be rendered from a sprite.
  85223. */
  85224. cellIndex: number;
  85225. /**
  85226. * The information required to support color remapping
  85227. */
  85228. remapData: Vector4;
  85229. /** @hidden */
  85230. _randomCellOffset?: number;
  85231. /** @hidden */
  85232. _initialDirection: Nullable<Vector3>;
  85233. /** @hidden */
  85234. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  85235. /** @hidden */
  85236. _initialStartSpriteCellID: number;
  85237. /** @hidden */
  85238. _initialEndSpriteCellID: number;
  85239. /** @hidden */
  85240. _currentColorGradient: Nullable<ColorGradient>;
  85241. /** @hidden */
  85242. _currentColor1: Color4;
  85243. /** @hidden */
  85244. _currentColor2: Color4;
  85245. /** @hidden */
  85246. _currentSizeGradient: Nullable<FactorGradient>;
  85247. /** @hidden */
  85248. _currentSize1: number;
  85249. /** @hidden */
  85250. _currentSize2: number;
  85251. /** @hidden */
  85252. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  85253. /** @hidden */
  85254. _currentAngularSpeed1: number;
  85255. /** @hidden */
  85256. _currentAngularSpeed2: number;
  85257. /** @hidden */
  85258. _currentVelocityGradient: Nullable<FactorGradient>;
  85259. /** @hidden */
  85260. _currentVelocity1: number;
  85261. /** @hidden */
  85262. _currentVelocity2: number;
  85263. /** @hidden */
  85264. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  85265. /** @hidden */
  85266. _currentLimitVelocity1: number;
  85267. /** @hidden */
  85268. _currentLimitVelocity2: number;
  85269. /** @hidden */
  85270. _currentDragGradient: Nullable<FactorGradient>;
  85271. /** @hidden */
  85272. _currentDrag1: number;
  85273. /** @hidden */
  85274. _currentDrag2: number;
  85275. /** @hidden */
  85276. _randomNoiseCoordinates1: Vector3;
  85277. /** @hidden */
  85278. _randomNoiseCoordinates2: Vector3;
  85279. /**
  85280. * Creates a new instance Particle
  85281. * @param particleSystem the particle system the particle belongs to
  85282. */
  85283. constructor(
  85284. /**
  85285. * The particle system the particle belongs to.
  85286. */
  85287. particleSystem: ParticleSystem);
  85288. private updateCellInfoFromSystem;
  85289. /**
  85290. * Defines how the sprite cell index is updated for the particle
  85291. */
  85292. updateCellIndex(): void;
  85293. /** @hidden */
  85294. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  85295. /** @hidden */
  85296. _inheritParticleInfoToSubEmitters(): void;
  85297. /** @hidden */
  85298. _reset(): void;
  85299. /**
  85300. * Copy the properties of particle to another one.
  85301. * @param other the particle to copy the information to.
  85302. */
  85303. copyTo(other: Particle): void;
  85304. }
  85305. }
  85306. declare module BABYLON {
  85307. /**
  85308. * Particle emitter represents a volume emitting particles.
  85309. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  85310. */
  85311. export interface IParticleEmitterType {
  85312. /**
  85313. * Called by the particle System when the direction is computed for the created particle.
  85314. * @param worldMatrix is the world matrix of the particle system
  85315. * @param directionToUpdate is the direction vector to update with the result
  85316. * @param particle is the particle we are computed the direction for
  85317. */
  85318. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85319. /**
  85320. * Called by the particle System when the position is computed for the created particle.
  85321. * @param worldMatrix is the world matrix of the particle system
  85322. * @param positionToUpdate is the position vector to update with the result
  85323. * @param particle is the particle we are computed the position for
  85324. */
  85325. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85326. /**
  85327. * Clones the current emitter and returns a copy of it
  85328. * @returns the new emitter
  85329. */
  85330. clone(): IParticleEmitterType;
  85331. /**
  85332. * Called by the GPUParticleSystem to setup the update shader
  85333. * @param effect defines the update shader
  85334. */
  85335. applyToShader(effect: Effect): void;
  85336. /**
  85337. * Returns a string to use to update the GPU particles update shader
  85338. * @returns the effect defines string
  85339. */
  85340. getEffectDefines(): string;
  85341. /**
  85342. * Returns a string representing the class name
  85343. * @returns a string containing the class name
  85344. */
  85345. getClassName(): string;
  85346. /**
  85347. * Serializes the particle system to a JSON object.
  85348. * @returns the JSON object
  85349. */
  85350. serialize(): any;
  85351. /**
  85352. * Parse properties from a JSON object
  85353. * @param serializationObject defines the JSON object
  85354. */
  85355. parse(serializationObject: any): void;
  85356. }
  85357. }
  85358. declare module BABYLON {
  85359. /**
  85360. * Particle emitter emitting particles from the inside of a box.
  85361. * It emits the particles randomly between 2 given directions.
  85362. */
  85363. export class BoxParticleEmitter implements IParticleEmitterType {
  85364. /**
  85365. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  85366. */
  85367. direction1: Vector3;
  85368. /**
  85369. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  85370. */
  85371. direction2: Vector3;
  85372. /**
  85373. * 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.
  85374. */
  85375. minEmitBox: Vector3;
  85376. /**
  85377. * 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.
  85378. */
  85379. maxEmitBox: Vector3;
  85380. /**
  85381. * Creates a new instance BoxParticleEmitter
  85382. */
  85383. constructor();
  85384. /**
  85385. * Called by the particle System when the direction is computed for the created particle.
  85386. * @param worldMatrix is the world matrix of the particle system
  85387. * @param directionToUpdate is the direction vector to update with the result
  85388. * @param particle is the particle we are computed the direction for
  85389. */
  85390. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85391. /**
  85392. * Called by the particle System when the position is computed for the created particle.
  85393. * @param worldMatrix is the world matrix of the particle system
  85394. * @param positionToUpdate is the position vector to update with the result
  85395. * @param particle is the particle we are computed the position for
  85396. */
  85397. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85398. /**
  85399. * Clones the current emitter and returns a copy of it
  85400. * @returns the new emitter
  85401. */
  85402. clone(): BoxParticleEmitter;
  85403. /**
  85404. * Called by the GPUParticleSystem to setup the update shader
  85405. * @param effect defines the update shader
  85406. */
  85407. applyToShader(effect: Effect): void;
  85408. /**
  85409. * Returns a string to use to update the GPU particles update shader
  85410. * @returns a string containng the defines string
  85411. */
  85412. getEffectDefines(): string;
  85413. /**
  85414. * Returns the string "BoxParticleEmitter"
  85415. * @returns a string containing the class name
  85416. */
  85417. getClassName(): string;
  85418. /**
  85419. * Serializes the particle system to a JSON object.
  85420. * @returns the JSON object
  85421. */
  85422. serialize(): any;
  85423. /**
  85424. * Parse properties from a JSON object
  85425. * @param serializationObject defines the JSON object
  85426. */
  85427. parse(serializationObject: any): void;
  85428. }
  85429. }
  85430. declare module BABYLON {
  85431. /**
  85432. * Particle emitter emitting particles from the inside of a cone.
  85433. * It emits the particles alongside the cone volume from the base to the particle.
  85434. * The emission direction might be randomized.
  85435. */
  85436. export class ConeParticleEmitter implements IParticleEmitterType {
  85437. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  85438. directionRandomizer: number;
  85439. private _radius;
  85440. private _angle;
  85441. private _height;
  85442. /**
  85443. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  85444. */
  85445. radiusRange: number;
  85446. /**
  85447. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  85448. */
  85449. heightRange: number;
  85450. /**
  85451. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  85452. */
  85453. emitFromSpawnPointOnly: boolean;
  85454. /**
  85455. * Gets or sets the radius of the emission cone
  85456. */
  85457. radius: number;
  85458. /**
  85459. * Gets or sets the angle of the emission cone
  85460. */
  85461. angle: number;
  85462. private _buildHeight;
  85463. /**
  85464. * Creates a new instance ConeParticleEmitter
  85465. * @param radius the radius of the emission cone (1 by default)
  85466. * @param angle the cone base angle (PI by default)
  85467. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  85468. */
  85469. constructor(radius?: number, angle?: number,
  85470. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  85471. directionRandomizer?: number);
  85472. /**
  85473. * Called by the particle System when the direction is computed for the created particle.
  85474. * @param worldMatrix is the world matrix of the particle system
  85475. * @param directionToUpdate is the direction vector to update with the result
  85476. * @param particle is the particle we are computed the direction for
  85477. */
  85478. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85479. /**
  85480. * Called by the particle System when the position is computed for the created particle.
  85481. * @param worldMatrix is the world matrix of the particle system
  85482. * @param positionToUpdate is the position vector to update with the result
  85483. * @param particle is the particle we are computed the position for
  85484. */
  85485. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85486. /**
  85487. * Clones the current emitter and returns a copy of it
  85488. * @returns the new emitter
  85489. */
  85490. clone(): ConeParticleEmitter;
  85491. /**
  85492. * Called by the GPUParticleSystem to setup the update shader
  85493. * @param effect defines the update shader
  85494. */
  85495. applyToShader(effect: Effect): void;
  85496. /**
  85497. * Returns a string to use to update the GPU particles update shader
  85498. * @returns a string containng the defines string
  85499. */
  85500. getEffectDefines(): string;
  85501. /**
  85502. * Returns the string "ConeParticleEmitter"
  85503. * @returns a string containing the class name
  85504. */
  85505. getClassName(): string;
  85506. /**
  85507. * Serializes the particle system to a JSON object.
  85508. * @returns the JSON object
  85509. */
  85510. serialize(): any;
  85511. /**
  85512. * Parse properties from a JSON object
  85513. * @param serializationObject defines the JSON object
  85514. */
  85515. parse(serializationObject: any): void;
  85516. }
  85517. }
  85518. declare module BABYLON {
  85519. /**
  85520. * Particle emitter emitting particles from the inside of a cylinder.
  85521. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  85522. */
  85523. export class CylinderParticleEmitter implements IParticleEmitterType {
  85524. /**
  85525. * The radius of the emission cylinder.
  85526. */
  85527. radius: number;
  85528. /**
  85529. * The height of the emission cylinder.
  85530. */
  85531. height: number;
  85532. /**
  85533. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  85534. */
  85535. radiusRange: number;
  85536. /**
  85537. * How much to randomize the particle direction [0-1].
  85538. */
  85539. directionRandomizer: number;
  85540. /**
  85541. * Creates a new instance CylinderParticleEmitter
  85542. * @param radius the radius of the emission cylinder (1 by default)
  85543. * @param height the height of the emission cylinder (1 by default)
  85544. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  85545. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  85546. */
  85547. constructor(
  85548. /**
  85549. * The radius of the emission cylinder.
  85550. */
  85551. radius?: number,
  85552. /**
  85553. * The height of the emission cylinder.
  85554. */
  85555. height?: number,
  85556. /**
  85557. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  85558. */
  85559. radiusRange?: number,
  85560. /**
  85561. * How much to randomize the particle direction [0-1].
  85562. */
  85563. directionRandomizer?: number);
  85564. /**
  85565. * Called by the particle System when the direction is computed for the created particle.
  85566. * @param worldMatrix is the world matrix of the particle system
  85567. * @param directionToUpdate is the direction vector to update with the result
  85568. * @param particle is the particle we are computed the direction for
  85569. */
  85570. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85571. /**
  85572. * Called by the particle System when the position is computed for the created particle.
  85573. * @param worldMatrix is the world matrix of the particle system
  85574. * @param positionToUpdate is the position vector to update with the result
  85575. * @param particle is the particle we are computed the position for
  85576. */
  85577. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85578. /**
  85579. * Clones the current emitter and returns a copy of it
  85580. * @returns the new emitter
  85581. */
  85582. clone(): CylinderParticleEmitter;
  85583. /**
  85584. * Called by the GPUParticleSystem to setup the update shader
  85585. * @param effect defines the update shader
  85586. */
  85587. applyToShader(effect: Effect): void;
  85588. /**
  85589. * Returns a string to use to update the GPU particles update shader
  85590. * @returns a string containng the defines string
  85591. */
  85592. getEffectDefines(): string;
  85593. /**
  85594. * Returns the string "CylinderParticleEmitter"
  85595. * @returns a string containing the class name
  85596. */
  85597. getClassName(): string;
  85598. /**
  85599. * Serializes the particle system to a JSON object.
  85600. * @returns the JSON object
  85601. */
  85602. serialize(): any;
  85603. /**
  85604. * Parse properties from a JSON object
  85605. * @param serializationObject defines the JSON object
  85606. */
  85607. parse(serializationObject: any): void;
  85608. }
  85609. /**
  85610. * Particle emitter emitting particles from the inside of a cylinder.
  85611. * It emits the particles randomly between two vectors.
  85612. */
  85613. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  85614. /**
  85615. * The min limit of the emission direction.
  85616. */
  85617. direction1: Vector3;
  85618. /**
  85619. * The max limit of the emission direction.
  85620. */
  85621. direction2: Vector3;
  85622. /**
  85623. * Creates a new instance CylinderDirectedParticleEmitter
  85624. * @param radius the radius of the emission cylinder (1 by default)
  85625. * @param height the height of the emission cylinder (1 by default)
  85626. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  85627. * @param direction1 the min limit of the emission direction (up vector by default)
  85628. * @param direction2 the max limit of the emission direction (up vector by default)
  85629. */
  85630. constructor(radius?: number, height?: number, radiusRange?: number,
  85631. /**
  85632. * The min limit of the emission direction.
  85633. */
  85634. direction1?: Vector3,
  85635. /**
  85636. * The max limit of the emission direction.
  85637. */
  85638. direction2?: Vector3);
  85639. /**
  85640. * Called by the particle System when the direction is computed for the created particle.
  85641. * @param worldMatrix is the world matrix of the particle system
  85642. * @param directionToUpdate is the direction vector to update with the result
  85643. * @param particle is the particle we are computed the direction for
  85644. */
  85645. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85646. /**
  85647. * Clones the current emitter and returns a copy of it
  85648. * @returns the new emitter
  85649. */
  85650. clone(): CylinderDirectedParticleEmitter;
  85651. /**
  85652. * Called by the GPUParticleSystem to setup the update shader
  85653. * @param effect defines the update shader
  85654. */
  85655. applyToShader(effect: Effect): void;
  85656. /**
  85657. * Returns a string to use to update the GPU particles update shader
  85658. * @returns a string containng the defines string
  85659. */
  85660. getEffectDefines(): string;
  85661. /**
  85662. * Returns the string "CylinderDirectedParticleEmitter"
  85663. * @returns a string containing the class name
  85664. */
  85665. getClassName(): string;
  85666. /**
  85667. * Serializes the particle system to a JSON object.
  85668. * @returns the JSON object
  85669. */
  85670. serialize(): any;
  85671. /**
  85672. * Parse properties from a JSON object
  85673. * @param serializationObject defines the JSON object
  85674. */
  85675. parse(serializationObject: any): void;
  85676. }
  85677. }
  85678. declare module BABYLON {
  85679. /**
  85680. * Particle emitter emitting particles from the inside of a hemisphere.
  85681. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  85682. */
  85683. export class HemisphericParticleEmitter implements IParticleEmitterType {
  85684. /**
  85685. * The radius of the emission hemisphere.
  85686. */
  85687. radius: number;
  85688. /**
  85689. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  85690. */
  85691. radiusRange: number;
  85692. /**
  85693. * How much to randomize the particle direction [0-1].
  85694. */
  85695. directionRandomizer: number;
  85696. /**
  85697. * Creates a new instance HemisphericParticleEmitter
  85698. * @param radius the radius of the emission hemisphere (1 by default)
  85699. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  85700. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  85701. */
  85702. constructor(
  85703. /**
  85704. * The radius of the emission hemisphere.
  85705. */
  85706. radius?: number,
  85707. /**
  85708. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  85709. */
  85710. radiusRange?: number,
  85711. /**
  85712. * How much to randomize the particle direction [0-1].
  85713. */
  85714. directionRandomizer?: number);
  85715. /**
  85716. * Called by the particle System when the direction is computed for the created particle.
  85717. * @param worldMatrix is the world matrix of the particle system
  85718. * @param directionToUpdate is the direction vector to update with the result
  85719. * @param particle is the particle we are computed the direction for
  85720. */
  85721. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85722. /**
  85723. * Called by the particle System when the position is computed for the created particle.
  85724. * @param worldMatrix is the world matrix of the particle system
  85725. * @param positionToUpdate is the position vector to update with the result
  85726. * @param particle is the particle we are computed the position for
  85727. */
  85728. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85729. /**
  85730. * Clones the current emitter and returns a copy of it
  85731. * @returns the new emitter
  85732. */
  85733. clone(): HemisphericParticleEmitter;
  85734. /**
  85735. * Called by the GPUParticleSystem to setup the update shader
  85736. * @param effect defines the update shader
  85737. */
  85738. applyToShader(effect: Effect): void;
  85739. /**
  85740. * Returns a string to use to update the GPU particles update shader
  85741. * @returns a string containng the defines string
  85742. */
  85743. getEffectDefines(): string;
  85744. /**
  85745. * Returns the string "HemisphericParticleEmitter"
  85746. * @returns a string containing the class name
  85747. */
  85748. getClassName(): string;
  85749. /**
  85750. * Serializes the particle system to a JSON object.
  85751. * @returns the JSON object
  85752. */
  85753. serialize(): any;
  85754. /**
  85755. * Parse properties from a JSON object
  85756. * @param serializationObject defines the JSON object
  85757. */
  85758. parse(serializationObject: any): void;
  85759. }
  85760. }
  85761. declare module BABYLON {
  85762. /**
  85763. * Particle emitter emitting particles from a point.
  85764. * It emits the particles randomly between 2 given directions.
  85765. */
  85766. export class PointParticleEmitter implements IParticleEmitterType {
  85767. /**
  85768. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  85769. */
  85770. direction1: Vector3;
  85771. /**
  85772. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  85773. */
  85774. direction2: Vector3;
  85775. /**
  85776. * Creates a new instance PointParticleEmitter
  85777. */
  85778. constructor();
  85779. /**
  85780. * Called by the particle System when the direction is computed for the created particle.
  85781. * @param worldMatrix is the world matrix of the particle system
  85782. * @param directionToUpdate is the direction vector to update with the result
  85783. * @param particle is the particle we are computed the direction for
  85784. */
  85785. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85786. /**
  85787. * Called by the particle System when the position is computed for the created particle.
  85788. * @param worldMatrix is the world matrix of the particle system
  85789. * @param positionToUpdate is the position vector to update with the result
  85790. * @param particle is the particle we are computed the position for
  85791. */
  85792. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85793. /**
  85794. * Clones the current emitter and returns a copy of it
  85795. * @returns the new emitter
  85796. */
  85797. clone(): PointParticleEmitter;
  85798. /**
  85799. * Called by the GPUParticleSystem to setup the update shader
  85800. * @param effect defines the update shader
  85801. */
  85802. applyToShader(effect: Effect): void;
  85803. /**
  85804. * Returns a string to use to update the GPU particles update shader
  85805. * @returns a string containng the defines string
  85806. */
  85807. getEffectDefines(): string;
  85808. /**
  85809. * Returns the string "PointParticleEmitter"
  85810. * @returns a string containing the class name
  85811. */
  85812. getClassName(): string;
  85813. /**
  85814. * Serializes the particle system to a JSON object.
  85815. * @returns the JSON object
  85816. */
  85817. serialize(): any;
  85818. /**
  85819. * Parse properties from a JSON object
  85820. * @param serializationObject defines the JSON object
  85821. */
  85822. parse(serializationObject: any): void;
  85823. }
  85824. }
  85825. declare module BABYLON {
  85826. /**
  85827. * Particle emitter emitting particles from the inside of a sphere.
  85828. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  85829. */
  85830. export class SphereParticleEmitter implements IParticleEmitterType {
  85831. /**
  85832. * The radius of the emission sphere.
  85833. */
  85834. radius: number;
  85835. /**
  85836. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  85837. */
  85838. radiusRange: number;
  85839. /**
  85840. * How much to randomize the particle direction [0-1].
  85841. */
  85842. directionRandomizer: number;
  85843. /**
  85844. * Creates a new instance SphereParticleEmitter
  85845. * @param radius the radius of the emission sphere (1 by default)
  85846. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  85847. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  85848. */
  85849. constructor(
  85850. /**
  85851. * The radius of the emission sphere.
  85852. */
  85853. radius?: number,
  85854. /**
  85855. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  85856. */
  85857. radiusRange?: number,
  85858. /**
  85859. * How much to randomize the particle direction [0-1].
  85860. */
  85861. directionRandomizer?: number);
  85862. /**
  85863. * Called by the particle System when the direction is computed for the created particle.
  85864. * @param worldMatrix is the world matrix of the particle system
  85865. * @param directionToUpdate is the direction vector to update with the result
  85866. * @param particle is the particle we are computed the direction for
  85867. */
  85868. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85869. /**
  85870. * Called by the particle System when the position is computed for the created particle.
  85871. * @param worldMatrix is the world matrix of the particle system
  85872. * @param positionToUpdate is the position vector to update with the result
  85873. * @param particle is the particle we are computed the position for
  85874. */
  85875. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85876. /**
  85877. * Clones the current emitter and returns a copy of it
  85878. * @returns the new emitter
  85879. */
  85880. clone(): SphereParticleEmitter;
  85881. /**
  85882. * Called by the GPUParticleSystem to setup the update shader
  85883. * @param effect defines the update shader
  85884. */
  85885. applyToShader(effect: Effect): void;
  85886. /**
  85887. * Returns a string to use to update the GPU particles update shader
  85888. * @returns a string containng the defines string
  85889. */
  85890. getEffectDefines(): string;
  85891. /**
  85892. * Returns the string "SphereParticleEmitter"
  85893. * @returns a string containing the class name
  85894. */
  85895. getClassName(): string;
  85896. /**
  85897. * Serializes the particle system to a JSON object.
  85898. * @returns the JSON object
  85899. */
  85900. serialize(): any;
  85901. /**
  85902. * Parse properties from a JSON object
  85903. * @param serializationObject defines the JSON object
  85904. */
  85905. parse(serializationObject: any): void;
  85906. }
  85907. /**
  85908. * Particle emitter emitting particles from the inside of a sphere.
  85909. * It emits the particles randomly between two vectors.
  85910. */
  85911. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  85912. /**
  85913. * The min limit of the emission direction.
  85914. */
  85915. direction1: Vector3;
  85916. /**
  85917. * The max limit of the emission direction.
  85918. */
  85919. direction2: Vector3;
  85920. /**
  85921. * Creates a new instance SphereDirectedParticleEmitter
  85922. * @param radius the radius of the emission sphere (1 by default)
  85923. * @param direction1 the min limit of the emission direction (up vector by default)
  85924. * @param direction2 the max limit of the emission direction (up vector by default)
  85925. */
  85926. constructor(radius?: number,
  85927. /**
  85928. * The min limit of the emission direction.
  85929. */
  85930. direction1?: Vector3,
  85931. /**
  85932. * The max limit of the emission direction.
  85933. */
  85934. direction2?: Vector3);
  85935. /**
  85936. * Called by the particle System when the direction is computed for the created particle.
  85937. * @param worldMatrix is the world matrix of the particle system
  85938. * @param directionToUpdate is the direction vector to update with the result
  85939. * @param particle is the particle we are computed the direction for
  85940. */
  85941. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85942. /**
  85943. * Clones the current emitter and returns a copy of it
  85944. * @returns the new emitter
  85945. */
  85946. clone(): SphereDirectedParticleEmitter;
  85947. /**
  85948. * Called by the GPUParticleSystem to setup the update shader
  85949. * @param effect defines the update shader
  85950. */
  85951. applyToShader(effect: Effect): void;
  85952. /**
  85953. * Returns a string to use to update the GPU particles update shader
  85954. * @returns a string containng the defines string
  85955. */
  85956. getEffectDefines(): string;
  85957. /**
  85958. * Returns the string "SphereDirectedParticleEmitter"
  85959. * @returns a string containing the class name
  85960. */
  85961. getClassName(): string;
  85962. /**
  85963. * Serializes the particle system to a JSON object.
  85964. * @returns the JSON object
  85965. */
  85966. serialize(): any;
  85967. /**
  85968. * Parse properties from a JSON object
  85969. * @param serializationObject defines the JSON object
  85970. */
  85971. parse(serializationObject: any): void;
  85972. }
  85973. }
  85974. declare module BABYLON {
  85975. /**
  85976. * Interface representing a particle system in Babylon.js.
  85977. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  85978. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  85979. */
  85980. export interface IParticleSystem {
  85981. /**
  85982. * List of animations used by the particle system.
  85983. */
  85984. animations: Animation[];
  85985. /**
  85986. * The id of the Particle system.
  85987. */
  85988. id: string;
  85989. /**
  85990. * The name of the Particle system.
  85991. */
  85992. name: string;
  85993. /**
  85994. * The emitter represents the Mesh or position we are attaching the particle system to.
  85995. */
  85996. emitter: Nullable<AbstractMesh | Vector3>;
  85997. /**
  85998. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  85999. */
  86000. isBillboardBased: boolean;
  86001. /**
  86002. * The rendering group used by the Particle system to chose when to render.
  86003. */
  86004. renderingGroupId: number;
  86005. /**
  86006. * The layer mask we are rendering the particles through.
  86007. */
  86008. layerMask: number;
  86009. /**
  86010. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  86011. */
  86012. updateSpeed: number;
  86013. /**
  86014. * The amount of time the particle system is running (depends of the overall update speed).
  86015. */
  86016. targetStopDuration: number;
  86017. /**
  86018. * The texture used to render each particle. (this can be a spritesheet)
  86019. */
  86020. particleTexture: Nullable<Texture>;
  86021. /**
  86022. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  86023. */
  86024. blendMode: number;
  86025. /**
  86026. * Minimum life time of emitting particles.
  86027. */
  86028. minLifeTime: number;
  86029. /**
  86030. * Maximum life time of emitting particles.
  86031. */
  86032. maxLifeTime: number;
  86033. /**
  86034. * Minimum Size of emitting particles.
  86035. */
  86036. minSize: number;
  86037. /**
  86038. * Maximum Size of emitting particles.
  86039. */
  86040. maxSize: number;
  86041. /**
  86042. * Minimum scale of emitting particles on X axis.
  86043. */
  86044. minScaleX: number;
  86045. /**
  86046. * Maximum scale of emitting particles on X axis.
  86047. */
  86048. maxScaleX: number;
  86049. /**
  86050. * Minimum scale of emitting particles on Y axis.
  86051. */
  86052. minScaleY: number;
  86053. /**
  86054. * Maximum scale of emitting particles on Y axis.
  86055. */
  86056. maxScaleY: number;
  86057. /**
  86058. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  86059. */
  86060. color1: Color4;
  86061. /**
  86062. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  86063. */
  86064. color2: Color4;
  86065. /**
  86066. * Color the particle will have at the end of its lifetime.
  86067. */
  86068. colorDead: Color4;
  86069. /**
  86070. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  86071. */
  86072. emitRate: number;
  86073. /**
  86074. * You can use gravity if you want to give an orientation to your particles.
  86075. */
  86076. gravity: Vector3;
  86077. /**
  86078. * Minimum power of emitting particles.
  86079. */
  86080. minEmitPower: number;
  86081. /**
  86082. * Maximum power of emitting particles.
  86083. */
  86084. maxEmitPower: number;
  86085. /**
  86086. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  86087. */
  86088. minAngularSpeed: number;
  86089. /**
  86090. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  86091. */
  86092. maxAngularSpeed: number;
  86093. /**
  86094. * Gets or sets the minimal initial rotation in radians.
  86095. */
  86096. minInitialRotation: number;
  86097. /**
  86098. * Gets or sets the maximal initial rotation in radians.
  86099. */
  86100. maxInitialRotation: number;
  86101. /**
  86102. * The particle emitter type defines the emitter used by the particle system.
  86103. * It can be for example box, sphere, or cone...
  86104. */
  86105. particleEmitterType: Nullable<IParticleEmitterType>;
  86106. /**
  86107. * Defines the delay in milliseconds before starting the system (0 by default)
  86108. */
  86109. startDelay: number;
  86110. /**
  86111. * 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
  86112. */
  86113. preWarmCycles: number;
  86114. /**
  86115. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  86116. */
  86117. preWarmStepOffset: number;
  86118. /**
  86119. * 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)
  86120. */
  86121. spriteCellChangeSpeed: number;
  86122. /**
  86123. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  86124. */
  86125. startSpriteCellID: number;
  86126. /**
  86127. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  86128. */
  86129. endSpriteCellID: number;
  86130. /**
  86131. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  86132. */
  86133. spriteCellWidth: number;
  86134. /**
  86135. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  86136. */
  86137. spriteCellHeight: number;
  86138. /**
  86139. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  86140. */
  86141. spriteRandomStartCell: boolean;
  86142. /**
  86143. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  86144. */
  86145. isAnimationSheetEnabled: boolean;
  86146. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  86147. translationPivot: Vector2;
  86148. /**
  86149. * Gets or sets a texture used to add random noise to particle positions
  86150. */
  86151. noiseTexture: Nullable<BaseTexture>;
  86152. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  86153. noiseStrength: Vector3;
  86154. /**
  86155. * Gets or sets the billboard mode to use when isBillboardBased = true.
  86156. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  86157. */
  86158. billboardMode: number;
  86159. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  86160. limitVelocityDamping: number;
  86161. /**
  86162. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  86163. */
  86164. beginAnimationOnStart: boolean;
  86165. /**
  86166. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  86167. */
  86168. beginAnimationFrom: number;
  86169. /**
  86170. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  86171. */
  86172. beginAnimationTo: number;
  86173. /**
  86174. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  86175. */
  86176. beginAnimationLoop: boolean;
  86177. /**
  86178. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  86179. */
  86180. disposeOnStop: boolean;
  86181. /**
  86182. * Gets the maximum number of particles active at the same time.
  86183. * @returns The max number of active particles.
  86184. */
  86185. getCapacity(): number;
  86186. /**
  86187. * Gets if the system has been started. (Note: this will still be true after stop is called)
  86188. * @returns True if it has been started, otherwise false.
  86189. */
  86190. isStarted(): boolean;
  86191. /**
  86192. * Animates the particle system for this frame.
  86193. */
  86194. animate(): void;
  86195. /**
  86196. * Renders the particle system in its current state.
  86197. * @returns the current number of particles
  86198. */
  86199. render(): number;
  86200. /**
  86201. * Dispose the particle system and frees its associated resources.
  86202. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  86203. */
  86204. dispose(disposeTexture?: boolean): void;
  86205. /**
  86206. * Clones the particle system.
  86207. * @param name The name of the cloned object
  86208. * @param newEmitter The new emitter to use
  86209. * @returns the cloned particle system
  86210. */
  86211. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  86212. /**
  86213. * Serializes the particle system to a JSON object.
  86214. * @returns the JSON object
  86215. */
  86216. serialize(): any;
  86217. /**
  86218. * Rebuild the particle system
  86219. */
  86220. rebuild(): void;
  86221. /**
  86222. * Starts the particle system and begins to emit
  86223. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  86224. */
  86225. start(delay?: number): void;
  86226. /**
  86227. * Stops the particle system.
  86228. */
  86229. stop(): void;
  86230. /**
  86231. * Remove all active particles
  86232. */
  86233. reset(): void;
  86234. /**
  86235. * Is this system ready to be used/rendered
  86236. * @return true if the system is ready
  86237. */
  86238. isReady(): boolean;
  86239. /**
  86240. * Adds a new color gradient
  86241. * @param gradient defines the gradient to use (between 0 and 1)
  86242. * @param color1 defines the color to affect to the specified gradient
  86243. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  86244. * @returns the current particle system
  86245. */
  86246. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  86247. /**
  86248. * Remove a specific color gradient
  86249. * @param gradient defines the gradient to remove
  86250. * @returns the current particle system
  86251. */
  86252. removeColorGradient(gradient: number): IParticleSystem;
  86253. /**
  86254. * Adds a new size gradient
  86255. * @param gradient defines the gradient to use (between 0 and 1)
  86256. * @param factor defines the size factor to affect to the specified gradient
  86257. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86258. * @returns the current particle system
  86259. */
  86260. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86261. /**
  86262. * Remove a specific size gradient
  86263. * @param gradient defines the gradient to remove
  86264. * @returns the current particle system
  86265. */
  86266. removeSizeGradient(gradient: number): IParticleSystem;
  86267. /**
  86268. * Gets the current list of color gradients.
  86269. * You must use addColorGradient and removeColorGradient to udpate this list
  86270. * @returns the list of color gradients
  86271. */
  86272. getColorGradients(): Nullable<Array<ColorGradient>>;
  86273. /**
  86274. * Gets the current list of size gradients.
  86275. * You must use addSizeGradient and removeSizeGradient to udpate this list
  86276. * @returns the list of size gradients
  86277. */
  86278. getSizeGradients(): Nullable<Array<FactorGradient>>;
  86279. /**
  86280. * Gets the current list of angular speed gradients.
  86281. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  86282. * @returns the list of angular speed gradients
  86283. */
  86284. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  86285. /**
  86286. * Adds a new angular speed gradient
  86287. * @param gradient defines the gradient to use (between 0 and 1)
  86288. * @param factor defines the angular speed to affect to the specified gradient
  86289. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86290. * @returns the current particle system
  86291. */
  86292. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86293. /**
  86294. * Remove a specific angular speed gradient
  86295. * @param gradient defines the gradient to remove
  86296. * @returns the current particle system
  86297. */
  86298. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  86299. /**
  86300. * Gets the current list of velocity gradients.
  86301. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  86302. * @returns the list of velocity gradients
  86303. */
  86304. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  86305. /**
  86306. * Adds a new velocity gradient
  86307. * @param gradient defines the gradient to use (between 0 and 1)
  86308. * @param factor defines the velocity to affect to the specified gradient
  86309. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86310. * @returns the current particle system
  86311. */
  86312. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86313. /**
  86314. * Remove a specific velocity gradient
  86315. * @param gradient defines the gradient to remove
  86316. * @returns the current particle system
  86317. */
  86318. removeVelocityGradient(gradient: number): IParticleSystem;
  86319. /**
  86320. * Gets the current list of limit velocity gradients.
  86321. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  86322. * @returns the list of limit velocity gradients
  86323. */
  86324. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  86325. /**
  86326. * Adds a new limit velocity gradient
  86327. * @param gradient defines the gradient to use (between 0 and 1)
  86328. * @param factor defines the limit velocity to affect to the specified gradient
  86329. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86330. * @returns the current particle system
  86331. */
  86332. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86333. /**
  86334. * Remove a specific limit velocity gradient
  86335. * @param gradient defines the gradient to remove
  86336. * @returns the current particle system
  86337. */
  86338. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  86339. /**
  86340. * Adds a new drag gradient
  86341. * @param gradient defines the gradient to use (between 0 and 1)
  86342. * @param factor defines the drag to affect to the specified gradient
  86343. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86344. * @returns the current particle system
  86345. */
  86346. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86347. /**
  86348. * Remove a specific drag gradient
  86349. * @param gradient defines the gradient to remove
  86350. * @returns the current particle system
  86351. */
  86352. removeDragGradient(gradient: number): IParticleSystem;
  86353. /**
  86354. * Gets the current list of drag gradients.
  86355. * You must use addDragGradient and removeDragGradient to udpate this list
  86356. * @returns the list of drag gradients
  86357. */
  86358. getDragGradients(): Nullable<Array<FactorGradient>>;
  86359. /**
  86360. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  86361. * @param gradient defines the gradient to use (between 0 and 1)
  86362. * @param factor defines the emit rate to affect to the specified gradient
  86363. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86364. * @returns the current particle system
  86365. */
  86366. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86367. /**
  86368. * Remove a specific emit rate gradient
  86369. * @param gradient defines the gradient to remove
  86370. * @returns the current particle system
  86371. */
  86372. removeEmitRateGradient(gradient: number): IParticleSystem;
  86373. /**
  86374. * Gets the current list of emit rate gradients.
  86375. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  86376. * @returns the list of emit rate gradients
  86377. */
  86378. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  86379. /**
  86380. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  86381. * @param gradient defines the gradient to use (between 0 and 1)
  86382. * @param factor defines the start size to affect to the specified gradient
  86383. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86384. * @returns the current particle system
  86385. */
  86386. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86387. /**
  86388. * Remove a specific start size gradient
  86389. * @param gradient defines the gradient to remove
  86390. * @returns the current particle system
  86391. */
  86392. removeStartSizeGradient(gradient: number): IParticleSystem;
  86393. /**
  86394. * Gets the current list of start size gradients.
  86395. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  86396. * @returns the list of start size gradients
  86397. */
  86398. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  86399. /**
  86400. * Adds a new life time gradient
  86401. * @param gradient defines the gradient to use (between 0 and 1)
  86402. * @param factor defines the life time factor to affect to the specified gradient
  86403. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86404. * @returns the current particle system
  86405. */
  86406. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86407. /**
  86408. * Remove a specific life time gradient
  86409. * @param gradient defines the gradient to remove
  86410. * @returns the current particle system
  86411. */
  86412. removeLifeTimeGradient(gradient: number): IParticleSystem;
  86413. /**
  86414. * Gets the current list of life time gradients.
  86415. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  86416. * @returns the list of life time gradients
  86417. */
  86418. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  86419. /**
  86420. * Gets the current list of color gradients.
  86421. * You must use addColorGradient and removeColorGradient to udpate this list
  86422. * @returns the list of color gradients
  86423. */
  86424. getColorGradients(): Nullable<Array<ColorGradient>>;
  86425. /**
  86426. * Adds a new ramp gradient used to remap particle colors
  86427. * @param gradient defines the gradient to use (between 0 and 1)
  86428. * @param color defines the color to affect to the specified gradient
  86429. * @returns the current particle system
  86430. */
  86431. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  86432. /**
  86433. * Gets the current list of ramp gradients.
  86434. * You must use addRampGradient and removeRampGradient to udpate this list
  86435. * @returns the list of ramp gradients
  86436. */
  86437. getRampGradients(): Nullable<Array<Color3Gradient>>;
  86438. /** Gets or sets a boolean indicating that ramp gradients must be used
  86439. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  86440. */
  86441. useRampGradients: boolean;
  86442. /**
  86443. * Adds a new color remap gradient
  86444. * @param gradient defines the gradient to use (between 0 and 1)
  86445. * @param min defines the color remap minimal range
  86446. * @param max defines the color remap maximal range
  86447. * @returns the current particle system
  86448. */
  86449. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  86450. /**
  86451. * Gets the current list of color remap gradients.
  86452. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  86453. * @returns the list of color remap gradients
  86454. */
  86455. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  86456. /**
  86457. * Adds a new alpha remap gradient
  86458. * @param gradient defines the gradient to use (between 0 and 1)
  86459. * @param min defines the alpha remap minimal range
  86460. * @param max defines the alpha remap maximal range
  86461. * @returns the current particle system
  86462. */
  86463. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  86464. /**
  86465. * Gets the current list of alpha remap gradients.
  86466. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  86467. * @returns the list of alpha remap gradients
  86468. */
  86469. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  86470. /**
  86471. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  86472. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  86473. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  86474. * @returns the emitter
  86475. */
  86476. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  86477. /**
  86478. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  86479. * @param radius The radius of the hemisphere to emit from
  86480. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  86481. * @returns the emitter
  86482. */
  86483. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  86484. /**
  86485. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  86486. * @param radius The radius of the sphere to emit from
  86487. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  86488. * @returns the emitter
  86489. */
  86490. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  86491. /**
  86492. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  86493. * @param radius The radius of the sphere to emit from
  86494. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  86495. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  86496. * @returns the emitter
  86497. */
  86498. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  86499. /**
  86500. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  86501. * @param radius The radius of the emission cylinder
  86502. * @param height The height of the emission cylinder
  86503. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  86504. * @param directionRandomizer How much to randomize the particle direction [0-1]
  86505. * @returns the emitter
  86506. */
  86507. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  86508. /**
  86509. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  86510. * @param radius The radius of the cylinder to emit from
  86511. * @param height The height of the emission cylinder
  86512. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  86513. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  86514. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  86515. * @returns the emitter
  86516. */
  86517. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  86518. /**
  86519. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  86520. * @param radius The radius of the cone to emit from
  86521. * @param angle The base angle of the cone
  86522. * @returns the emitter
  86523. */
  86524. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  86525. /**
  86526. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  86527. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  86528. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  86529. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  86530. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  86531. * @returns the emitter
  86532. */
  86533. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  86534. /**
  86535. * Get hosting scene
  86536. * @returns the scene
  86537. */
  86538. getScene(): Scene;
  86539. }
  86540. }
  86541. declare module BABYLON {
  86542. /**
  86543. * Creates an instance based on a source mesh.
  86544. */
  86545. export class InstancedMesh extends AbstractMesh {
  86546. private _sourceMesh;
  86547. private _currentLOD;
  86548. /** @hidden */
  86549. _indexInSourceMeshInstanceArray: number;
  86550. constructor(name: string, source: Mesh);
  86551. /**
  86552. * Returns the string "InstancedMesh".
  86553. */
  86554. getClassName(): string;
  86555. /** Gets the list of lights affecting that mesh */
  86556. readonly lightSources: Light[];
  86557. _resyncLightSources(): void;
  86558. _resyncLighSource(light: Light): void;
  86559. _removeLightSource(light: Light, dispose: boolean): void;
  86560. /**
  86561. * If the source mesh receives shadows
  86562. */
  86563. readonly receiveShadows: boolean;
  86564. /**
  86565. * The material of the source mesh
  86566. */
  86567. readonly material: Nullable<Material>;
  86568. /**
  86569. * Visibility of the source mesh
  86570. */
  86571. readonly visibility: number;
  86572. /**
  86573. * Skeleton of the source mesh
  86574. */
  86575. readonly skeleton: Nullable<Skeleton>;
  86576. /**
  86577. * Rendering ground id of the source mesh
  86578. */
  86579. renderingGroupId: number;
  86580. /**
  86581. * Returns the total number of vertices (integer).
  86582. */
  86583. getTotalVertices(): number;
  86584. /**
  86585. * Returns a positive integer : the total number of indices in this mesh geometry.
  86586. * @returns the numner of indices or zero if the mesh has no geometry.
  86587. */
  86588. getTotalIndices(): number;
  86589. /**
  86590. * The source mesh of the instance
  86591. */
  86592. readonly sourceMesh: Mesh;
  86593. /**
  86594. * Is this node ready to be used/rendered
  86595. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  86596. * @return {boolean} is it ready
  86597. */
  86598. isReady(completeCheck?: boolean): boolean;
  86599. /**
  86600. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  86601. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  86602. * @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.
  86603. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  86604. */
  86605. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  86606. /**
  86607. * Sets the vertex data of the mesh geometry for the requested `kind`.
  86608. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  86609. * The `data` are either a numeric array either a Float32Array.
  86610. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  86611. * 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).
  86612. * Note that a new underlying VertexBuffer object is created each call.
  86613. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  86614. *
  86615. * Possible `kind` values :
  86616. * - VertexBuffer.PositionKind
  86617. * - VertexBuffer.UVKind
  86618. * - VertexBuffer.UV2Kind
  86619. * - VertexBuffer.UV3Kind
  86620. * - VertexBuffer.UV4Kind
  86621. * - VertexBuffer.UV5Kind
  86622. * - VertexBuffer.UV6Kind
  86623. * - VertexBuffer.ColorKind
  86624. * - VertexBuffer.MatricesIndicesKind
  86625. * - VertexBuffer.MatricesIndicesExtraKind
  86626. * - VertexBuffer.MatricesWeightsKind
  86627. * - VertexBuffer.MatricesWeightsExtraKind
  86628. *
  86629. * Returns the Mesh.
  86630. */
  86631. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  86632. /**
  86633. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  86634. * If the mesh has no geometry, it is simply returned as it is.
  86635. * The `data` are either a numeric array either a Float32Array.
  86636. * No new underlying VertexBuffer object is created.
  86637. * 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.
  86638. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  86639. *
  86640. * Possible `kind` values :
  86641. * - VertexBuffer.PositionKind
  86642. * - VertexBuffer.UVKind
  86643. * - VertexBuffer.UV2Kind
  86644. * - VertexBuffer.UV3Kind
  86645. * - VertexBuffer.UV4Kind
  86646. * - VertexBuffer.UV5Kind
  86647. * - VertexBuffer.UV6Kind
  86648. * - VertexBuffer.ColorKind
  86649. * - VertexBuffer.MatricesIndicesKind
  86650. * - VertexBuffer.MatricesIndicesExtraKind
  86651. * - VertexBuffer.MatricesWeightsKind
  86652. * - VertexBuffer.MatricesWeightsExtraKind
  86653. *
  86654. * Returns the Mesh.
  86655. */
  86656. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  86657. /**
  86658. * Sets the mesh indices.
  86659. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  86660. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  86661. * This method creates a new index buffer each call.
  86662. * Returns the Mesh.
  86663. */
  86664. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  86665. /**
  86666. * Boolean : True if the mesh owns the requested kind of data.
  86667. */
  86668. isVerticesDataPresent(kind: string): boolean;
  86669. /**
  86670. * Returns an array of indices (IndicesArray).
  86671. */
  86672. getIndices(): Nullable<IndicesArray>;
  86673. readonly _positions: Nullable<Vector3[]>;
  86674. /**
  86675. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  86676. * This means the mesh underlying bounding box and sphere are recomputed.
  86677. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  86678. * @returns the current mesh
  86679. */
  86680. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  86681. /** @hidden */
  86682. _preActivate(): InstancedMesh;
  86683. /** @hidden */
  86684. _activate(renderId: number, intermediateRendering: boolean): boolean;
  86685. /** @hidden */
  86686. _postActivate(): void;
  86687. getWorldMatrix(): Matrix;
  86688. readonly isAnInstance: boolean;
  86689. /**
  86690. * Returns the current associated LOD AbstractMesh.
  86691. */
  86692. getLOD(camera: Camera): AbstractMesh;
  86693. /** @hidden */
  86694. _syncSubMeshes(): InstancedMesh;
  86695. /** @hidden */
  86696. _generatePointsArray(): boolean;
  86697. /**
  86698. * Creates a new InstancedMesh from the current mesh.
  86699. * - name (string) : the cloned mesh name
  86700. * - newParent (optional Node) : the optional Node to parent the clone to.
  86701. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  86702. *
  86703. * Returns the clone.
  86704. */
  86705. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  86706. /**
  86707. * Disposes the InstancedMesh.
  86708. * Returns nothing.
  86709. */
  86710. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  86711. }
  86712. interface Mesh {
  86713. /**
  86714. * Register a custom buffer that will be instanced
  86715. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  86716. * @param kind defines the buffer kind
  86717. * @param stride defines the stride in floats
  86718. */
  86719. registerInstancedBuffer(kind: string, stride: number): void;
  86720. /** @hidden */
  86721. _userInstancedBuffersStorage: {
  86722. data: {
  86723. [key: string]: Float32Array;
  86724. };
  86725. sizes: {
  86726. [key: string]: number;
  86727. };
  86728. vertexBuffers: {
  86729. [key: string]: Nullable<VertexBuffer>;
  86730. };
  86731. strides: {
  86732. [key: string]: number;
  86733. };
  86734. };
  86735. }
  86736. interface AbstractMesh {
  86737. /**
  86738. * Object used to store instanced buffers defined by user
  86739. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  86740. */
  86741. instancedBuffers: {
  86742. [key: string]: any;
  86743. };
  86744. }
  86745. }
  86746. declare module BABYLON {
  86747. /**
  86748. * Defines the options associated with the creation of a shader material.
  86749. */
  86750. export interface IShaderMaterialOptions {
  86751. /**
  86752. * Does the material work in alpha blend mode
  86753. */
  86754. needAlphaBlending: boolean;
  86755. /**
  86756. * Does the material work in alpha test mode
  86757. */
  86758. needAlphaTesting: boolean;
  86759. /**
  86760. * The list of attribute names used in the shader
  86761. */
  86762. attributes: string[];
  86763. /**
  86764. * The list of unifrom names used in the shader
  86765. */
  86766. uniforms: string[];
  86767. /**
  86768. * The list of UBO names used in the shader
  86769. */
  86770. uniformBuffers: string[];
  86771. /**
  86772. * The list of sampler names used in the shader
  86773. */
  86774. samplers: string[];
  86775. /**
  86776. * The list of defines used in the shader
  86777. */
  86778. defines: string[];
  86779. }
  86780. /**
  86781. * 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.
  86782. *
  86783. * This returned material effects how the mesh will look based on the code in the shaders.
  86784. *
  86785. * @see http://doc.babylonjs.com/how_to/shader_material
  86786. */
  86787. export class ShaderMaterial extends Material {
  86788. private _shaderPath;
  86789. private _options;
  86790. private _textures;
  86791. private _textureArrays;
  86792. private _floats;
  86793. private _ints;
  86794. private _floatsArrays;
  86795. private _colors3;
  86796. private _colors3Arrays;
  86797. private _colors4;
  86798. private _colors4Arrays;
  86799. private _vectors2;
  86800. private _vectors3;
  86801. private _vectors4;
  86802. private _matrices;
  86803. private _matrices3x3;
  86804. private _matrices2x2;
  86805. private _vectors2Arrays;
  86806. private _vectors3Arrays;
  86807. private _vectors4Arrays;
  86808. private _cachedWorldViewMatrix;
  86809. private _cachedWorldViewProjectionMatrix;
  86810. private _renderId;
  86811. /**
  86812. * Instantiate a new shader material.
  86813. * 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.
  86814. * This returned material effects how the mesh will look based on the code in the shaders.
  86815. * @see http://doc.babylonjs.com/how_to/shader_material
  86816. * @param name Define the name of the material in the scene
  86817. * @param scene Define the scene the material belongs to
  86818. * @param shaderPath Defines the route to the shader code in one of three ways:
  86819. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  86820. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  86821. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  86822. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  86823. * @param options Define the options used to create the shader
  86824. */
  86825. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  86826. /**
  86827. * Gets the options used to compile the shader.
  86828. * They can be modified to trigger a new compilation
  86829. */
  86830. readonly options: IShaderMaterialOptions;
  86831. /**
  86832. * Gets the current class name of the material e.g. "ShaderMaterial"
  86833. * Mainly use in serialization.
  86834. * @returns the class name
  86835. */
  86836. getClassName(): string;
  86837. /**
  86838. * Specifies if the material will require alpha blending
  86839. * @returns a boolean specifying if alpha blending is needed
  86840. */
  86841. needAlphaBlending(): boolean;
  86842. /**
  86843. * Specifies if this material should be rendered in alpha test mode
  86844. * @returns a boolean specifying if an alpha test is needed.
  86845. */
  86846. needAlphaTesting(): boolean;
  86847. private _checkUniform;
  86848. /**
  86849. * Set a texture in the shader.
  86850. * @param name Define the name of the uniform samplers as defined in the shader
  86851. * @param texture Define the texture to bind to this sampler
  86852. * @return the material itself allowing "fluent" like uniform updates
  86853. */
  86854. setTexture(name: string, texture: Texture): ShaderMaterial;
  86855. /**
  86856. * Set a texture array in the shader.
  86857. * @param name Define the name of the uniform sampler array as defined in the shader
  86858. * @param textures Define the list of textures to bind to this sampler
  86859. * @return the material itself allowing "fluent" like uniform updates
  86860. */
  86861. setTextureArray(name: string, textures: Texture[]): ShaderMaterial;
  86862. /**
  86863. * Set a float in the shader.
  86864. * @param name Define the name of the uniform as defined in the shader
  86865. * @param value Define the value to give to the uniform
  86866. * @return the material itself allowing "fluent" like uniform updates
  86867. */
  86868. setFloat(name: string, value: number): ShaderMaterial;
  86869. /**
  86870. * Set a int in the shader.
  86871. * @param name Define the name of the uniform as defined in the shader
  86872. * @param value Define the value to give to the uniform
  86873. * @return the material itself allowing "fluent" like uniform updates
  86874. */
  86875. setInt(name: string, value: number): ShaderMaterial;
  86876. /**
  86877. * Set an array of floats in the shader.
  86878. * @param name Define the name of the uniform as defined in the shader
  86879. * @param value Define the value to give to the uniform
  86880. * @return the material itself allowing "fluent" like uniform updates
  86881. */
  86882. setFloats(name: string, value: number[]): ShaderMaterial;
  86883. /**
  86884. * Set a vec3 in the shader from a Color3.
  86885. * @param name Define the name of the uniform as defined in the shader
  86886. * @param value Define the value to give to the uniform
  86887. * @return the material itself allowing "fluent" like uniform updates
  86888. */
  86889. setColor3(name: string, value: Color3): ShaderMaterial;
  86890. /**
  86891. * Set a vec3 array in the shader from a Color3 array.
  86892. * @param name Define the name of the uniform as defined in the shader
  86893. * @param value Define the value to give to the uniform
  86894. * @return the material itself allowing "fluent" like uniform updates
  86895. */
  86896. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  86897. /**
  86898. * Set a vec4 in the shader from a Color4.
  86899. * @param name Define the name of the uniform as defined in the shader
  86900. * @param value Define the value to give to the uniform
  86901. * @return the material itself allowing "fluent" like uniform updates
  86902. */
  86903. setColor4(name: string, value: Color4): ShaderMaterial;
  86904. /**
  86905. * Set a vec4 array in the shader from a Color4 array.
  86906. * @param name Define the name of the uniform as defined in the shader
  86907. * @param value Define the value to give to the uniform
  86908. * @return the material itself allowing "fluent" like uniform updates
  86909. */
  86910. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  86911. /**
  86912. * Set a vec2 in the shader from a Vector2.
  86913. * @param name Define the name of the uniform as defined in the shader
  86914. * @param value Define the value to give to the uniform
  86915. * @return the material itself allowing "fluent" like uniform updates
  86916. */
  86917. setVector2(name: string, value: Vector2): ShaderMaterial;
  86918. /**
  86919. * Set a vec3 in the shader from a Vector3.
  86920. * @param name Define the name of the uniform as defined in the shader
  86921. * @param value Define the value to give to the uniform
  86922. * @return the material itself allowing "fluent" like uniform updates
  86923. */
  86924. setVector3(name: string, value: Vector3): ShaderMaterial;
  86925. /**
  86926. * Set a vec4 in the shader from a Vector4.
  86927. * @param name Define the name of the uniform as defined in the shader
  86928. * @param value Define the value to give to the uniform
  86929. * @return the material itself allowing "fluent" like uniform updates
  86930. */
  86931. setVector4(name: string, value: Vector4): ShaderMaterial;
  86932. /**
  86933. * Set a mat4 in the shader from a Matrix.
  86934. * @param name Define the name of the uniform as defined in the shader
  86935. * @param value Define the value to give to the uniform
  86936. * @return the material itself allowing "fluent" like uniform updates
  86937. */
  86938. setMatrix(name: string, value: Matrix): ShaderMaterial;
  86939. /**
  86940. * Set a mat3 in the shader from a Float32Array.
  86941. * @param name Define the name of the uniform as defined in the shader
  86942. * @param value Define the value to give to the uniform
  86943. * @return the material itself allowing "fluent" like uniform updates
  86944. */
  86945. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  86946. /**
  86947. * Set a mat2 in the shader from a Float32Array.
  86948. * @param name Define the name of the uniform as defined in the shader
  86949. * @param value Define the value to give to the uniform
  86950. * @return the material itself allowing "fluent" like uniform updates
  86951. */
  86952. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  86953. /**
  86954. * Set a vec2 array in the shader from a number array.
  86955. * @param name Define the name of the uniform as defined in the shader
  86956. * @param value Define the value to give to the uniform
  86957. * @return the material itself allowing "fluent" like uniform updates
  86958. */
  86959. setArray2(name: string, value: number[]): ShaderMaterial;
  86960. /**
  86961. * Set a vec3 array in the shader from a number array.
  86962. * @param name Define the name of the uniform as defined in the shader
  86963. * @param value Define the value to give to the uniform
  86964. * @return the material itself allowing "fluent" like uniform updates
  86965. */
  86966. setArray3(name: string, value: number[]): ShaderMaterial;
  86967. /**
  86968. * Set a vec4 array in the shader from a number array.
  86969. * @param name Define the name of the uniform as defined in the shader
  86970. * @param value Define the value to give to the uniform
  86971. * @return the material itself allowing "fluent" like uniform updates
  86972. */
  86973. setArray4(name: string, value: number[]): ShaderMaterial;
  86974. private _checkCache;
  86975. /**
  86976. * Specifies that the submesh is ready to be used
  86977. * @param mesh defines the mesh to check
  86978. * @param subMesh defines which submesh to check
  86979. * @param useInstances specifies that instances should be used
  86980. * @returns a boolean indicating that the submesh is ready or not
  86981. */
  86982. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  86983. /**
  86984. * Checks if the material is ready to render the requested mesh
  86985. * @param mesh Define the mesh to render
  86986. * @param useInstances Define whether or not the material is used with instances
  86987. * @returns true if ready, otherwise false
  86988. */
  86989. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  86990. /**
  86991. * Binds the world matrix to the material
  86992. * @param world defines the world transformation matrix
  86993. */
  86994. bindOnlyWorldMatrix(world: Matrix): void;
  86995. /**
  86996. * Binds the material to the mesh
  86997. * @param world defines the world transformation matrix
  86998. * @param mesh defines the mesh to bind the material to
  86999. */
  87000. bind(world: Matrix, mesh?: Mesh): void;
  87001. /**
  87002. * Gets the active textures from the material
  87003. * @returns an array of textures
  87004. */
  87005. getActiveTextures(): BaseTexture[];
  87006. /**
  87007. * Specifies if the material uses a texture
  87008. * @param texture defines the texture to check against the material
  87009. * @returns a boolean specifying if the material uses the texture
  87010. */
  87011. hasTexture(texture: BaseTexture): boolean;
  87012. /**
  87013. * Makes a duplicate of the material, and gives it a new name
  87014. * @param name defines the new name for the duplicated material
  87015. * @returns the cloned material
  87016. */
  87017. clone(name: string): ShaderMaterial;
  87018. /**
  87019. * Disposes the material
  87020. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  87021. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  87022. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  87023. */
  87024. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  87025. /**
  87026. * Serializes this material in a JSON representation
  87027. * @returns the serialized material object
  87028. */
  87029. serialize(): any;
  87030. /**
  87031. * Creates a shader material from parsed shader material data
  87032. * @param source defines the JSON represnetation of the material
  87033. * @param scene defines the hosting scene
  87034. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  87035. * @returns a new material
  87036. */
  87037. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  87038. }
  87039. }
  87040. declare module BABYLON {
  87041. /** @hidden */
  87042. export var colorPixelShader: {
  87043. name: string;
  87044. shader: string;
  87045. };
  87046. }
  87047. declare module BABYLON {
  87048. /** @hidden */
  87049. export var colorVertexShader: {
  87050. name: string;
  87051. shader: string;
  87052. };
  87053. }
  87054. declare module BABYLON {
  87055. /**
  87056. * Line mesh
  87057. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  87058. */
  87059. export class LinesMesh extends Mesh {
  87060. /**
  87061. * If vertex color should be applied to the mesh
  87062. */
  87063. readonly useVertexColor?: boolean | undefined;
  87064. /**
  87065. * If vertex alpha should be applied to the mesh
  87066. */
  87067. readonly useVertexAlpha?: boolean | undefined;
  87068. /**
  87069. * Color of the line (Default: White)
  87070. */
  87071. color: Color3;
  87072. /**
  87073. * Alpha of the line (Default: 1)
  87074. */
  87075. alpha: number;
  87076. /**
  87077. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  87078. * This margin is expressed in world space coordinates, so its value may vary.
  87079. * Default value is 0.1
  87080. */
  87081. intersectionThreshold: number;
  87082. private _colorShader;
  87083. private color4;
  87084. /**
  87085. * Creates a new LinesMesh
  87086. * @param name defines the name
  87087. * @param scene defines the hosting scene
  87088. * @param parent defines the parent mesh if any
  87089. * @param source defines the optional source LinesMesh used to clone data from
  87090. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  87091. * When false, achieved by calling a clone(), also passing False.
  87092. * This will make creation of children, recursive.
  87093. * @param useVertexColor defines if this LinesMesh supports vertex color
  87094. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  87095. */
  87096. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  87097. /**
  87098. * If vertex color should be applied to the mesh
  87099. */
  87100. useVertexColor?: boolean | undefined,
  87101. /**
  87102. * If vertex alpha should be applied to the mesh
  87103. */
  87104. useVertexAlpha?: boolean | undefined);
  87105. private _addClipPlaneDefine;
  87106. private _removeClipPlaneDefine;
  87107. isReady(): boolean;
  87108. /**
  87109. * Returns the string "LineMesh"
  87110. */
  87111. getClassName(): string;
  87112. /**
  87113. * @hidden
  87114. */
  87115. /**
  87116. * @hidden
  87117. */
  87118. material: Material;
  87119. /**
  87120. * @hidden
  87121. */
  87122. readonly checkCollisions: boolean;
  87123. /** @hidden */
  87124. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  87125. /** @hidden */
  87126. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  87127. /**
  87128. * Disposes of the line mesh
  87129. * @param doNotRecurse If children should be disposed
  87130. */
  87131. dispose(doNotRecurse?: boolean): void;
  87132. /**
  87133. * Returns a new LineMesh object cloned from the current one.
  87134. */
  87135. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  87136. /**
  87137. * Creates a new InstancedLinesMesh object from the mesh model.
  87138. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  87139. * @param name defines the name of the new instance
  87140. * @returns a new InstancedLinesMesh
  87141. */
  87142. createInstance(name: string): InstancedLinesMesh;
  87143. }
  87144. /**
  87145. * Creates an instance based on a source LinesMesh
  87146. */
  87147. export class InstancedLinesMesh extends InstancedMesh {
  87148. /**
  87149. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  87150. * This margin is expressed in world space coordinates, so its value may vary.
  87151. * Initilized with the intersectionThreshold value of the source LinesMesh
  87152. */
  87153. intersectionThreshold: number;
  87154. constructor(name: string, source: LinesMesh);
  87155. /**
  87156. * Returns the string "InstancedLinesMesh".
  87157. */
  87158. getClassName(): string;
  87159. }
  87160. }
  87161. declare module BABYLON {
  87162. /** @hidden */
  87163. export var linePixelShader: {
  87164. name: string;
  87165. shader: string;
  87166. };
  87167. }
  87168. declare module BABYLON {
  87169. /** @hidden */
  87170. export var lineVertexShader: {
  87171. name: string;
  87172. shader: string;
  87173. };
  87174. }
  87175. declare module BABYLON {
  87176. interface AbstractMesh {
  87177. /**
  87178. * Gets the edgesRenderer associated with the mesh
  87179. */
  87180. edgesRenderer: Nullable<EdgesRenderer>;
  87181. }
  87182. interface LinesMesh {
  87183. /**
  87184. * Enables the edge rendering mode on the mesh.
  87185. * This mode makes the mesh edges visible
  87186. * @param epsilon defines the maximal distance between two angles to detect a face
  87187. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  87188. * @returns the currentAbstractMesh
  87189. * @see https://www.babylonjs-playground.com/#19O9TU#0
  87190. */
  87191. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  87192. }
  87193. interface InstancedLinesMesh {
  87194. /**
  87195. * Enables the edge rendering mode on the mesh.
  87196. * This mode makes the mesh edges visible
  87197. * @param epsilon defines the maximal distance between two angles to detect a face
  87198. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  87199. * @returns the current InstancedLinesMesh
  87200. * @see https://www.babylonjs-playground.com/#19O9TU#0
  87201. */
  87202. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  87203. }
  87204. /**
  87205. * Defines the minimum contract an Edges renderer should follow.
  87206. */
  87207. export interface IEdgesRenderer extends IDisposable {
  87208. /**
  87209. * Gets or sets a boolean indicating if the edgesRenderer is active
  87210. */
  87211. isEnabled: boolean;
  87212. /**
  87213. * Renders the edges of the attached mesh,
  87214. */
  87215. render(): void;
  87216. /**
  87217. * Checks wether or not the edges renderer is ready to render.
  87218. * @return true if ready, otherwise false.
  87219. */
  87220. isReady(): boolean;
  87221. }
  87222. /**
  87223. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  87224. */
  87225. export class EdgesRenderer implements IEdgesRenderer {
  87226. /**
  87227. * Define the size of the edges with an orthographic camera
  87228. */
  87229. edgesWidthScalerForOrthographic: number;
  87230. /**
  87231. * Define the size of the edges with a perspective camera
  87232. */
  87233. edgesWidthScalerForPerspective: number;
  87234. protected _source: AbstractMesh;
  87235. protected _linesPositions: number[];
  87236. protected _linesNormals: number[];
  87237. protected _linesIndices: number[];
  87238. protected _epsilon: number;
  87239. protected _indicesCount: number;
  87240. protected _lineShader: ShaderMaterial;
  87241. protected _ib: DataBuffer;
  87242. protected _buffers: {
  87243. [key: string]: Nullable<VertexBuffer>;
  87244. };
  87245. protected _checkVerticesInsteadOfIndices: boolean;
  87246. private _meshRebuildObserver;
  87247. private _meshDisposeObserver;
  87248. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  87249. isEnabled: boolean;
  87250. /**
  87251. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  87252. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  87253. * @param source Mesh used to create edges
  87254. * @param epsilon sum of angles in adjacency to check for edge
  87255. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  87256. * @param generateEdgesLines - should generate Lines or only prepare resources.
  87257. */
  87258. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  87259. protected _prepareRessources(): void;
  87260. /** @hidden */
  87261. _rebuild(): void;
  87262. /**
  87263. * Releases the required resources for the edges renderer
  87264. */
  87265. dispose(): void;
  87266. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  87267. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  87268. /**
  87269. * Checks if the pair of p0 and p1 is en edge
  87270. * @param faceIndex
  87271. * @param edge
  87272. * @param faceNormals
  87273. * @param p0
  87274. * @param p1
  87275. * @private
  87276. */
  87277. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  87278. /**
  87279. * push line into the position, normal and index buffer
  87280. * @protected
  87281. */
  87282. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  87283. /**
  87284. * Generates lines edges from adjacencjes
  87285. * @private
  87286. */
  87287. _generateEdgesLines(): void;
  87288. /**
  87289. * Checks wether or not the edges renderer is ready to render.
  87290. * @return true if ready, otherwise false.
  87291. */
  87292. isReady(): boolean;
  87293. /**
  87294. * Renders the edges of the attached mesh,
  87295. */
  87296. render(): void;
  87297. }
  87298. /**
  87299. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  87300. */
  87301. export class LineEdgesRenderer extends EdgesRenderer {
  87302. /**
  87303. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  87304. * @param source LineMesh used to generate edges
  87305. * @param epsilon not important (specified angle for edge detection)
  87306. * @param checkVerticesInsteadOfIndices not important for LineMesh
  87307. */
  87308. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  87309. /**
  87310. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  87311. */
  87312. _generateEdgesLines(): void;
  87313. }
  87314. }
  87315. declare module BABYLON {
  87316. /**
  87317. * This represents the object necessary to create a rendering group.
  87318. * This is exclusively used and created by the rendering manager.
  87319. * To modify the behavior, you use the available helpers in your scene or meshes.
  87320. * @hidden
  87321. */
  87322. export class RenderingGroup {
  87323. index: number;
  87324. private static _zeroVector;
  87325. private _scene;
  87326. private _opaqueSubMeshes;
  87327. private _transparentSubMeshes;
  87328. private _alphaTestSubMeshes;
  87329. private _depthOnlySubMeshes;
  87330. private _particleSystems;
  87331. private _spriteManagers;
  87332. private _opaqueSortCompareFn;
  87333. private _alphaTestSortCompareFn;
  87334. private _transparentSortCompareFn;
  87335. private _renderOpaque;
  87336. private _renderAlphaTest;
  87337. private _renderTransparent;
  87338. /** @hidden */
  87339. _edgesRenderers: SmartArray<IEdgesRenderer>;
  87340. onBeforeTransparentRendering: () => void;
  87341. /**
  87342. * Set the opaque sort comparison function.
  87343. * If null the sub meshes will be render in the order they were created
  87344. */
  87345. opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  87346. /**
  87347. * Set the alpha test sort comparison function.
  87348. * If null the sub meshes will be render in the order they were created
  87349. */
  87350. alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  87351. /**
  87352. * Set the transparent sort comparison function.
  87353. * If null the sub meshes will be render in the order they were created
  87354. */
  87355. transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  87356. /**
  87357. * Creates a new rendering group.
  87358. * @param index The rendering group index
  87359. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  87360. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  87361. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  87362. */
  87363. 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>);
  87364. /**
  87365. * Render all the sub meshes contained in the group.
  87366. * @param customRenderFunction Used to override the default render behaviour of the group.
  87367. * @returns true if rendered some submeshes.
  87368. */
  87369. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  87370. /**
  87371. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  87372. * @param subMeshes The submeshes to render
  87373. */
  87374. private renderOpaqueSorted;
  87375. /**
  87376. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  87377. * @param subMeshes The submeshes to render
  87378. */
  87379. private renderAlphaTestSorted;
  87380. /**
  87381. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  87382. * @param subMeshes The submeshes to render
  87383. */
  87384. private renderTransparentSorted;
  87385. /**
  87386. * Renders the submeshes in a specified order.
  87387. * @param subMeshes The submeshes to sort before render
  87388. * @param sortCompareFn The comparison function use to sort
  87389. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  87390. * @param transparent Specifies to activate blending if true
  87391. */
  87392. private static renderSorted;
  87393. /**
  87394. * Renders the submeshes in the order they were dispatched (no sort applied).
  87395. * @param subMeshes The submeshes to render
  87396. */
  87397. private static renderUnsorted;
  87398. /**
  87399. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  87400. * are rendered back to front if in the same alpha index.
  87401. *
  87402. * @param a The first submesh
  87403. * @param b The second submesh
  87404. * @returns The result of the comparison
  87405. */
  87406. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  87407. /**
  87408. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  87409. * are rendered back to front.
  87410. *
  87411. * @param a The first submesh
  87412. * @param b The second submesh
  87413. * @returns The result of the comparison
  87414. */
  87415. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  87416. /**
  87417. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  87418. * are rendered front to back (prevent overdraw).
  87419. *
  87420. * @param a The first submesh
  87421. * @param b The second submesh
  87422. * @returns The result of the comparison
  87423. */
  87424. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  87425. /**
  87426. * Resets the different lists of submeshes to prepare a new frame.
  87427. */
  87428. prepare(): void;
  87429. dispose(): void;
  87430. /**
  87431. * Inserts the submesh in its correct queue depending on its material.
  87432. * @param subMesh The submesh to dispatch
  87433. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  87434. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  87435. */
  87436. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  87437. dispatchSprites(spriteManager: ISpriteManager): void;
  87438. dispatchParticles(particleSystem: IParticleSystem): void;
  87439. private _renderParticles;
  87440. private _renderSprites;
  87441. }
  87442. }
  87443. declare module BABYLON {
  87444. /**
  87445. * Interface describing the different options available in the rendering manager
  87446. * regarding Auto Clear between groups.
  87447. */
  87448. export interface IRenderingManagerAutoClearSetup {
  87449. /**
  87450. * Defines whether or not autoclear is enable.
  87451. */
  87452. autoClear: boolean;
  87453. /**
  87454. * Defines whether or not to autoclear the depth buffer.
  87455. */
  87456. depth: boolean;
  87457. /**
  87458. * Defines whether or not to autoclear the stencil buffer.
  87459. */
  87460. stencil: boolean;
  87461. }
  87462. /**
  87463. * This class is used by the onRenderingGroupObservable
  87464. */
  87465. export class RenderingGroupInfo {
  87466. /**
  87467. * The Scene that being rendered
  87468. */
  87469. scene: Scene;
  87470. /**
  87471. * The camera currently used for the rendering pass
  87472. */
  87473. camera: Nullable<Camera>;
  87474. /**
  87475. * The ID of the renderingGroup being processed
  87476. */
  87477. renderingGroupId: number;
  87478. }
  87479. /**
  87480. * This is the manager responsible of all the rendering for meshes sprites and particles.
  87481. * It is enable to manage the different groups as well as the different necessary sort functions.
  87482. * This should not be used directly aside of the few static configurations
  87483. */
  87484. export class RenderingManager {
  87485. /**
  87486. * The max id used for rendering groups (not included)
  87487. */
  87488. static MAX_RENDERINGGROUPS: number;
  87489. /**
  87490. * The min id used for rendering groups (included)
  87491. */
  87492. static MIN_RENDERINGGROUPS: number;
  87493. /**
  87494. * Used to globally prevent autoclearing scenes.
  87495. */
  87496. static AUTOCLEAR: boolean;
  87497. /**
  87498. * @hidden
  87499. */
  87500. _useSceneAutoClearSetup: boolean;
  87501. private _scene;
  87502. private _renderingGroups;
  87503. private _depthStencilBufferAlreadyCleaned;
  87504. private _autoClearDepthStencil;
  87505. private _customOpaqueSortCompareFn;
  87506. private _customAlphaTestSortCompareFn;
  87507. private _customTransparentSortCompareFn;
  87508. private _renderingGroupInfo;
  87509. /**
  87510. * Instantiates a new rendering group for a particular scene
  87511. * @param scene Defines the scene the groups belongs to
  87512. */
  87513. constructor(scene: Scene);
  87514. private _clearDepthStencilBuffer;
  87515. /**
  87516. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  87517. * @hidden
  87518. */
  87519. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  87520. /**
  87521. * Resets the different information of the group to prepare a new frame
  87522. * @hidden
  87523. */
  87524. reset(): void;
  87525. /**
  87526. * Dispose and release the group and its associated resources.
  87527. * @hidden
  87528. */
  87529. dispose(): void;
  87530. /**
  87531. * Clear the info related to rendering groups preventing retention points during dispose.
  87532. */
  87533. freeRenderingGroups(): void;
  87534. private _prepareRenderingGroup;
  87535. /**
  87536. * Add a sprite manager to the rendering manager in order to render it this frame.
  87537. * @param spriteManager Define the sprite manager to render
  87538. */
  87539. dispatchSprites(spriteManager: ISpriteManager): void;
  87540. /**
  87541. * Add a particle system to the rendering manager in order to render it this frame.
  87542. * @param particleSystem Define the particle system to render
  87543. */
  87544. dispatchParticles(particleSystem: IParticleSystem): void;
  87545. /**
  87546. * Add a submesh to the manager in order to render it this frame
  87547. * @param subMesh The submesh to dispatch
  87548. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  87549. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  87550. */
  87551. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  87552. /**
  87553. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  87554. * This allowed control for front to back rendering or reversly depending of the special needs.
  87555. *
  87556. * @param renderingGroupId The rendering group id corresponding to its index
  87557. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  87558. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  87559. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  87560. */
  87561. 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;
  87562. /**
  87563. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  87564. *
  87565. * @param renderingGroupId The rendering group id corresponding to its index
  87566. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  87567. * @param depth Automatically clears depth between groups if true and autoClear is true.
  87568. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  87569. */
  87570. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  87571. /**
  87572. * Gets the current auto clear configuration for one rendering group of the rendering
  87573. * manager.
  87574. * @param index the rendering group index to get the information for
  87575. * @returns The auto clear setup for the requested rendering group
  87576. */
  87577. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  87578. }
  87579. }
  87580. declare module BABYLON {
  87581. /**
  87582. * This Helps creating a texture that will be created from a camera in your scene.
  87583. * It is basically a dynamic texture that could be used to create special effects for instance.
  87584. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  87585. */
  87586. export class RenderTargetTexture extends Texture {
  87587. isCube: boolean;
  87588. /**
  87589. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  87590. */
  87591. static readonly REFRESHRATE_RENDER_ONCE: number;
  87592. /**
  87593. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  87594. */
  87595. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  87596. /**
  87597. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  87598. * the central point of your effect and can save a lot of performances.
  87599. */
  87600. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  87601. /**
  87602. * Use this predicate to dynamically define the list of mesh you want to render.
  87603. * If set, the renderList property will be overwritten.
  87604. */
  87605. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  87606. private _renderList;
  87607. /**
  87608. * Use this list to define the list of mesh you want to render.
  87609. */
  87610. renderList: Nullable<Array<AbstractMesh>>;
  87611. private _hookArray;
  87612. /**
  87613. * Define if particles should be rendered in your texture.
  87614. */
  87615. renderParticles: boolean;
  87616. /**
  87617. * Define if sprites should be rendered in your texture.
  87618. */
  87619. renderSprites: boolean;
  87620. /**
  87621. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  87622. */
  87623. coordinatesMode: number;
  87624. /**
  87625. * Define the camera used to render the texture.
  87626. */
  87627. activeCamera: Nullable<Camera>;
  87628. /**
  87629. * Override the render function of the texture with your own one.
  87630. */
  87631. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  87632. /**
  87633. * Define if camera post processes should be use while rendering the texture.
  87634. */
  87635. useCameraPostProcesses: boolean;
  87636. /**
  87637. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  87638. */
  87639. ignoreCameraViewport: boolean;
  87640. private _postProcessManager;
  87641. private _postProcesses;
  87642. private _resizeObserver;
  87643. /**
  87644. * An event triggered when the texture is unbind.
  87645. */
  87646. onBeforeBindObservable: Observable<RenderTargetTexture>;
  87647. /**
  87648. * An event triggered when the texture is unbind.
  87649. */
  87650. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  87651. private _onAfterUnbindObserver;
  87652. /**
  87653. * Set a after unbind callback in the texture.
  87654. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  87655. */
  87656. onAfterUnbind: () => void;
  87657. /**
  87658. * An event triggered before rendering the texture
  87659. */
  87660. onBeforeRenderObservable: Observable<number>;
  87661. private _onBeforeRenderObserver;
  87662. /**
  87663. * Set a before render callback in the texture.
  87664. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  87665. */
  87666. onBeforeRender: (faceIndex: number) => void;
  87667. /**
  87668. * An event triggered after rendering the texture
  87669. */
  87670. onAfterRenderObservable: Observable<number>;
  87671. private _onAfterRenderObserver;
  87672. /**
  87673. * Set a after render callback in the texture.
  87674. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  87675. */
  87676. onAfterRender: (faceIndex: number) => void;
  87677. /**
  87678. * An event triggered after the texture clear
  87679. */
  87680. onClearObservable: Observable<Engine>;
  87681. private _onClearObserver;
  87682. /**
  87683. * Set a clear callback in the texture.
  87684. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  87685. */
  87686. onClear: (Engine: Engine) => void;
  87687. /**
  87688. * An event triggered when the texture is resized.
  87689. */
  87690. onResizeObservable: Observable<RenderTargetTexture>;
  87691. /**
  87692. * Define the clear color of the Render Target if it should be different from the scene.
  87693. */
  87694. clearColor: Color4;
  87695. protected _size: number | {
  87696. width: number;
  87697. height: number;
  87698. };
  87699. protected _initialSizeParameter: number | {
  87700. width: number;
  87701. height: number;
  87702. } | {
  87703. ratio: number;
  87704. };
  87705. protected _sizeRatio: Nullable<number>;
  87706. /** @hidden */
  87707. _generateMipMaps: boolean;
  87708. protected _renderingManager: RenderingManager;
  87709. /** @hidden */
  87710. _waitingRenderList: string[];
  87711. protected _doNotChangeAspectRatio: boolean;
  87712. protected _currentRefreshId: number;
  87713. protected _refreshRate: number;
  87714. protected _textureMatrix: Matrix;
  87715. protected _samples: number;
  87716. protected _renderTargetOptions: RenderTargetCreationOptions;
  87717. /**
  87718. * Gets render target creation options that were used.
  87719. */
  87720. readonly renderTargetOptions: RenderTargetCreationOptions;
  87721. protected _engine: Engine;
  87722. protected _onRatioRescale(): void;
  87723. /**
  87724. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  87725. * It must define where the camera used to render the texture is set
  87726. */
  87727. boundingBoxPosition: Vector3;
  87728. private _boundingBoxSize;
  87729. /**
  87730. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  87731. * When defined, the cubemap will switch to local mode
  87732. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  87733. * @example https://www.babylonjs-playground.com/#RNASML
  87734. */
  87735. boundingBoxSize: Vector3;
  87736. /**
  87737. * In case the RTT has been created with a depth texture, get the associated
  87738. * depth texture.
  87739. * Otherwise, return null.
  87740. */
  87741. depthStencilTexture: Nullable<InternalTexture>;
  87742. /**
  87743. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  87744. * or used a shadow, depth texture...
  87745. * @param name The friendly name of the texture
  87746. * @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)
  87747. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  87748. * @param generateMipMaps True if mip maps need to be generated after render.
  87749. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  87750. * @param type The type of the buffer in the RTT (int, half float, float...)
  87751. * @param isCube True if a cube texture needs to be created
  87752. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  87753. * @param generateDepthBuffer True to generate a depth buffer
  87754. * @param generateStencilBuffer True to generate a stencil buffer
  87755. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  87756. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  87757. * @param delayAllocation if the texture allocation should be delayed (default: false)
  87758. */
  87759. constructor(name: string, size: number | {
  87760. width: number;
  87761. height: number;
  87762. } | {
  87763. ratio: number;
  87764. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  87765. /**
  87766. * Creates a depth stencil texture.
  87767. * This is only available in WebGL 2 or with the depth texture extension available.
  87768. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  87769. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  87770. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  87771. */
  87772. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  87773. private _processSizeParameter;
  87774. /**
  87775. * Define the number of samples to use in case of MSAA.
  87776. * It defaults to one meaning no MSAA has been enabled.
  87777. */
  87778. samples: number;
  87779. /**
  87780. * Resets the refresh counter of the texture and start bak from scratch.
  87781. * Could be useful to regenerate the texture if it is setup to render only once.
  87782. */
  87783. resetRefreshCounter(): void;
  87784. /**
  87785. * Define the refresh rate of the texture or the rendering frequency.
  87786. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  87787. */
  87788. refreshRate: number;
  87789. /**
  87790. * Adds a post process to the render target rendering passes.
  87791. * @param postProcess define the post process to add
  87792. */
  87793. addPostProcess(postProcess: PostProcess): void;
  87794. /**
  87795. * Clear all the post processes attached to the render target
  87796. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  87797. */
  87798. clearPostProcesses(dispose?: boolean): void;
  87799. /**
  87800. * Remove one of the post process from the list of attached post processes to the texture
  87801. * @param postProcess define the post process to remove from the list
  87802. */
  87803. removePostProcess(postProcess: PostProcess): void;
  87804. /** @hidden */
  87805. _shouldRender(): boolean;
  87806. /**
  87807. * Gets the actual render size of the texture.
  87808. * @returns the width of the render size
  87809. */
  87810. getRenderSize(): number;
  87811. /**
  87812. * Gets the actual render width of the texture.
  87813. * @returns the width of the render size
  87814. */
  87815. getRenderWidth(): number;
  87816. /**
  87817. * Gets the actual render height of the texture.
  87818. * @returns the height of the render size
  87819. */
  87820. getRenderHeight(): number;
  87821. /**
  87822. * Get if the texture can be rescaled or not.
  87823. */
  87824. readonly canRescale: boolean;
  87825. /**
  87826. * Resize the texture using a ratio.
  87827. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  87828. */
  87829. scale(ratio: number): void;
  87830. /**
  87831. * Get the texture reflection matrix used to rotate/transform the reflection.
  87832. * @returns the reflection matrix
  87833. */
  87834. getReflectionTextureMatrix(): Matrix;
  87835. /**
  87836. * Resize the texture to a new desired size.
  87837. * Be carrefull as it will recreate all the data in the new texture.
  87838. * @param size Define the new size. It can be:
  87839. * - a number for squared texture,
  87840. * - an object containing { width: number, height: number }
  87841. * - or an object containing a ratio { ratio: number }
  87842. */
  87843. resize(size: number | {
  87844. width: number;
  87845. height: number;
  87846. } | {
  87847. ratio: number;
  87848. }): void;
  87849. /**
  87850. * Renders all the objects from the render list into the texture.
  87851. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  87852. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  87853. */
  87854. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  87855. private _bestReflectionRenderTargetDimension;
  87856. /**
  87857. * @hidden
  87858. * @param faceIndex face index to bind to if this is a cubetexture
  87859. */
  87860. _bindFrameBuffer(faceIndex?: number): void;
  87861. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  87862. private renderToTarget;
  87863. /**
  87864. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  87865. * This allowed control for front to back rendering or reversly depending of the special needs.
  87866. *
  87867. * @param renderingGroupId The rendering group id corresponding to its index
  87868. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  87869. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  87870. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  87871. */
  87872. 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;
  87873. /**
  87874. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  87875. *
  87876. * @param renderingGroupId The rendering group id corresponding to its index
  87877. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  87878. */
  87879. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  87880. /**
  87881. * Clones the texture.
  87882. * @returns the cloned texture
  87883. */
  87884. clone(): RenderTargetTexture;
  87885. /**
  87886. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  87887. * @returns The JSON representation of the texture
  87888. */
  87889. serialize(): any;
  87890. /**
  87891. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  87892. */
  87893. disposeFramebufferObjects(): void;
  87894. /**
  87895. * Dispose the texture and release its associated resources.
  87896. */
  87897. dispose(): void;
  87898. /** @hidden */
  87899. _rebuild(): void;
  87900. /**
  87901. * Clear the info related to rendering groups preventing retention point in material dispose.
  87902. */
  87903. freeRenderingGroups(): void;
  87904. /**
  87905. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  87906. * @returns the view count
  87907. */
  87908. getViewCount(): number;
  87909. }
  87910. }
  87911. declare module BABYLON {
  87912. /**
  87913. * Options for compiling materials.
  87914. */
  87915. export interface IMaterialCompilationOptions {
  87916. /**
  87917. * Defines whether clip planes are enabled.
  87918. */
  87919. clipPlane: boolean;
  87920. /**
  87921. * Defines whether instances are enabled.
  87922. */
  87923. useInstances: boolean;
  87924. }
  87925. /**
  87926. * Base class for the main features of a material in Babylon.js
  87927. */
  87928. export class Material implements IAnimatable {
  87929. /**
  87930. * Returns the triangle fill mode
  87931. */
  87932. static readonly TriangleFillMode: number;
  87933. /**
  87934. * Returns the wireframe mode
  87935. */
  87936. static readonly WireFrameFillMode: number;
  87937. /**
  87938. * Returns the point fill mode
  87939. */
  87940. static readonly PointFillMode: number;
  87941. /**
  87942. * Returns the point list draw mode
  87943. */
  87944. static readonly PointListDrawMode: number;
  87945. /**
  87946. * Returns the line list draw mode
  87947. */
  87948. static readonly LineListDrawMode: number;
  87949. /**
  87950. * Returns the line loop draw mode
  87951. */
  87952. static readonly LineLoopDrawMode: number;
  87953. /**
  87954. * Returns the line strip draw mode
  87955. */
  87956. static readonly LineStripDrawMode: number;
  87957. /**
  87958. * Returns the triangle strip draw mode
  87959. */
  87960. static readonly TriangleStripDrawMode: number;
  87961. /**
  87962. * Returns the triangle fan draw mode
  87963. */
  87964. static readonly TriangleFanDrawMode: number;
  87965. /**
  87966. * Stores the clock-wise side orientation
  87967. */
  87968. static readonly ClockWiseSideOrientation: number;
  87969. /**
  87970. * Stores the counter clock-wise side orientation
  87971. */
  87972. static readonly CounterClockWiseSideOrientation: number;
  87973. /**
  87974. * The dirty texture flag value
  87975. */
  87976. static readonly TextureDirtyFlag: number;
  87977. /**
  87978. * The dirty light flag value
  87979. */
  87980. static readonly LightDirtyFlag: number;
  87981. /**
  87982. * The dirty fresnel flag value
  87983. */
  87984. static readonly FresnelDirtyFlag: number;
  87985. /**
  87986. * The dirty attribute flag value
  87987. */
  87988. static readonly AttributesDirtyFlag: number;
  87989. /**
  87990. * The dirty misc flag value
  87991. */
  87992. static readonly MiscDirtyFlag: number;
  87993. /**
  87994. * The all dirty flag value
  87995. */
  87996. static readonly AllDirtyFlag: number;
  87997. /**
  87998. * The ID of the material
  87999. */
  88000. id: string;
  88001. /**
  88002. * Gets or sets the unique id of the material
  88003. */
  88004. uniqueId: number;
  88005. /**
  88006. * The name of the material
  88007. */
  88008. name: string;
  88009. /**
  88010. * Gets or sets user defined metadata
  88011. */
  88012. metadata: any;
  88013. /**
  88014. * For internal use only. Please do not use.
  88015. */
  88016. reservedDataStore: any;
  88017. /**
  88018. * Specifies if the ready state should be checked on each call
  88019. */
  88020. checkReadyOnEveryCall: boolean;
  88021. /**
  88022. * Specifies if the ready state should be checked once
  88023. */
  88024. checkReadyOnlyOnce: boolean;
  88025. /**
  88026. * The state of the material
  88027. */
  88028. state: string;
  88029. /**
  88030. * The alpha value of the material
  88031. */
  88032. protected _alpha: number;
  88033. /**
  88034. * List of inspectable custom properties (used by the Inspector)
  88035. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  88036. */
  88037. inspectableCustomProperties: IInspectable[];
  88038. /**
  88039. * Sets the alpha value of the material
  88040. */
  88041. /**
  88042. * Gets the alpha value of the material
  88043. */
  88044. alpha: number;
  88045. /**
  88046. * Specifies if back face culling is enabled
  88047. */
  88048. protected _backFaceCulling: boolean;
  88049. /**
  88050. * Sets the back-face culling state
  88051. */
  88052. /**
  88053. * Gets the back-face culling state
  88054. */
  88055. backFaceCulling: boolean;
  88056. /**
  88057. * Stores the value for side orientation
  88058. */
  88059. sideOrientation: number;
  88060. /**
  88061. * Callback triggered when the material is compiled
  88062. */
  88063. onCompiled: Nullable<(effect: Effect) => void>;
  88064. /**
  88065. * Callback triggered when an error occurs
  88066. */
  88067. onError: Nullable<(effect: Effect, errors: string) => void>;
  88068. /**
  88069. * Callback triggered to get the render target textures
  88070. */
  88071. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  88072. /**
  88073. * Gets a boolean indicating that current material needs to register RTT
  88074. */
  88075. readonly hasRenderTargetTextures: boolean;
  88076. /**
  88077. * Specifies if the material should be serialized
  88078. */
  88079. doNotSerialize: boolean;
  88080. /**
  88081. * @hidden
  88082. */
  88083. _storeEffectOnSubMeshes: boolean;
  88084. /**
  88085. * Stores the animations for the material
  88086. */
  88087. animations: Nullable<Array<Animation>>;
  88088. /**
  88089. * An event triggered when the material is disposed
  88090. */
  88091. onDisposeObservable: Observable<Material>;
  88092. /**
  88093. * An observer which watches for dispose events
  88094. */
  88095. private _onDisposeObserver;
  88096. private _onUnBindObservable;
  88097. /**
  88098. * Called during a dispose event
  88099. */
  88100. onDispose: () => void;
  88101. private _onBindObservable;
  88102. /**
  88103. * An event triggered when the material is bound
  88104. */
  88105. readonly onBindObservable: Observable<AbstractMesh>;
  88106. /**
  88107. * An observer which watches for bind events
  88108. */
  88109. private _onBindObserver;
  88110. /**
  88111. * Called during a bind event
  88112. */
  88113. onBind: (Mesh: AbstractMesh) => void;
  88114. /**
  88115. * An event triggered when the material is unbound
  88116. */
  88117. readonly onUnBindObservable: Observable<Material>;
  88118. /**
  88119. * Stores the value of the alpha mode
  88120. */
  88121. private _alphaMode;
  88122. /**
  88123. * Sets the value of the alpha mode.
  88124. *
  88125. * | Value | Type | Description |
  88126. * | --- | --- | --- |
  88127. * | 0 | ALPHA_DISABLE | |
  88128. * | 1 | ALPHA_ADD | |
  88129. * | 2 | ALPHA_COMBINE | |
  88130. * | 3 | ALPHA_SUBTRACT | |
  88131. * | 4 | ALPHA_MULTIPLY | |
  88132. * | 5 | ALPHA_MAXIMIZED | |
  88133. * | 6 | ALPHA_ONEONE | |
  88134. * | 7 | ALPHA_PREMULTIPLIED | |
  88135. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  88136. * | 9 | ALPHA_INTERPOLATE | |
  88137. * | 10 | ALPHA_SCREENMODE | |
  88138. *
  88139. */
  88140. /**
  88141. * Gets the value of the alpha mode
  88142. */
  88143. alphaMode: number;
  88144. /**
  88145. * Stores the state of the need depth pre-pass value
  88146. */
  88147. private _needDepthPrePass;
  88148. /**
  88149. * Sets the need depth pre-pass value
  88150. */
  88151. /**
  88152. * Gets the depth pre-pass value
  88153. */
  88154. needDepthPrePass: boolean;
  88155. /**
  88156. * Specifies if depth writing should be disabled
  88157. */
  88158. disableDepthWrite: boolean;
  88159. /**
  88160. * Specifies if depth writing should be forced
  88161. */
  88162. forceDepthWrite: boolean;
  88163. /**
  88164. * Specifies if there should be a separate pass for culling
  88165. */
  88166. separateCullingPass: boolean;
  88167. /**
  88168. * Stores the state specifing if fog should be enabled
  88169. */
  88170. private _fogEnabled;
  88171. /**
  88172. * Sets the state for enabling fog
  88173. */
  88174. /**
  88175. * Gets the value of the fog enabled state
  88176. */
  88177. fogEnabled: boolean;
  88178. /**
  88179. * Stores the size of points
  88180. */
  88181. pointSize: number;
  88182. /**
  88183. * Stores the z offset value
  88184. */
  88185. zOffset: number;
  88186. /**
  88187. * Gets a value specifying if wireframe mode is enabled
  88188. */
  88189. /**
  88190. * Sets the state of wireframe mode
  88191. */
  88192. wireframe: boolean;
  88193. /**
  88194. * Gets the value specifying if point clouds are enabled
  88195. */
  88196. /**
  88197. * Sets the state of point cloud mode
  88198. */
  88199. pointsCloud: boolean;
  88200. /**
  88201. * Gets the material fill mode
  88202. */
  88203. /**
  88204. * Sets the material fill mode
  88205. */
  88206. fillMode: number;
  88207. /**
  88208. * @hidden
  88209. * Stores the effects for the material
  88210. */
  88211. _effect: Nullable<Effect>;
  88212. /**
  88213. * @hidden
  88214. * Specifies if the material was previously ready
  88215. */
  88216. _wasPreviouslyReady: boolean;
  88217. /**
  88218. * Specifies if uniform buffers should be used
  88219. */
  88220. private _useUBO;
  88221. /**
  88222. * Stores a reference to the scene
  88223. */
  88224. private _scene;
  88225. /**
  88226. * Stores the fill mode state
  88227. */
  88228. private _fillMode;
  88229. /**
  88230. * Specifies if the depth write state should be cached
  88231. */
  88232. private _cachedDepthWriteState;
  88233. /**
  88234. * Stores the uniform buffer
  88235. */
  88236. protected _uniformBuffer: UniformBuffer;
  88237. /** @hidden */
  88238. _indexInSceneMaterialArray: number;
  88239. /** @hidden */
  88240. meshMap: Nullable<{
  88241. [id: string]: AbstractMesh | undefined;
  88242. }>;
  88243. /**
  88244. * Creates a material instance
  88245. * @param name defines the name of the material
  88246. * @param scene defines the scene to reference
  88247. * @param doNotAdd specifies if the material should be added to the scene
  88248. */
  88249. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  88250. /**
  88251. * Returns a string representation of the current material
  88252. * @param fullDetails defines a boolean indicating which levels of logging is desired
  88253. * @returns a string with material information
  88254. */
  88255. toString(fullDetails?: boolean): string;
  88256. /**
  88257. * Gets the class name of the material
  88258. * @returns a string with the class name of the material
  88259. */
  88260. getClassName(): string;
  88261. /**
  88262. * Specifies if updates for the material been locked
  88263. */
  88264. readonly isFrozen: boolean;
  88265. /**
  88266. * Locks updates for the material
  88267. */
  88268. freeze(): void;
  88269. /**
  88270. * Unlocks updates for the material
  88271. */
  88272. unfreeze(): void;
  88273. /**
  88274. * Specifies if the material is ready to be used
  88275. * @param mesh defines the mesh to check
  88276. * @param useInstances specifies if instances should be used
  88277. * @returns a boolean indicating if the material is ready to be used
  88278. */
  88279. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  88280. /**
  88281. * Specifies that the submesh is ready to be used
  88282. * @param mesh defines the mesh to check
  88283. * @param subMesh defines which submesh to check
  88284. * @param useInstances specifies that instances should be used
  88285. * @returns a boolean indicating that the submesh is ready or not
  88286. */
  88287. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  88288. /**
  88289. * Returns the material effect
  88290. * @returns the effect associated with the material
  88291. */
  88292. getEffect(): Nullable<Effect>;
  88293. /**
  88294. * Returns the current scene
  88295. * @returns a Scene
  88296. */
  88297. getScene(): Scene;
  88298. /**
  88299. * Specifies if the material will require alpha blending
  88300. * @returns a boolean specifying if alpha blending is needed
  88301. */
  88302. needAlphaBlending(): boolean;
  88303. /**
  88304. * Specifies if the mesh will require alpha blending
  88305. * @param mesh defines the mesh to check
  88306. * @returns a boolean specifying if alpha blending is needed for the mesh
  88307. */
  88308. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  88309. /**
  88310. * Specifies if this material should be rendered in alpha test mode
  88311. * @returns a boolean specifying if an alpha test is needed.
  88312. */
  88313. needAlphaTesting(): boolean;
  88314. /**
  88315. * Gets the texture used for the alpha test
  88316. * @returns the texture to use for alpha testing
  88317. */
  88318. getAlphaTestTexture(): Nullable<BaseTexture>;
  88319. /**
  88320. * Marks the material to indicate that it needs to be re-calculated
  88321. */
  88322. markDirty(): void;
  88323. /** @hidden */
  88324. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  88325. /**
  88326. * Binds the material to the mesh
  88327. * @param world defines the world transformation matrix
  88328. * @param mesh defines the mesh to bind the material to
  88329. */
  88330. bind(world: Matrix, mesh?: Mesh): void;
  88331. /**
  88332. * Binds the submesh to the material
  88333. * @param world defines the world transformation matrix
  88334. * @param mesh defines the mesh containing the submesh
  88335. * @param subMesh defines the submesh to bind the material to
  88336. */
  88337. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  88338. /**
  88339. * Binds the world matrix to the material
  88340. * @param world defines the world transformation matrix
  88341. */
  88342. bindOnlyWorldMatrix(world: Matrix): void;
  88343. /**
  88344. * Binds the scene's uniform buffer to the effect.
  88345. * @param effect defines the effect to bind to the scene uniform buffer
  88346. * @param sceneUbo defines the uniform buffer storing scene data
  88347. */
  88348. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  88349. /**
  88350. * Binds the view matrix to the effect
  88351. * @param effect defines the effect to bind the view matrix to
  88352. */
  88353. bindView(effect: Effect): void;
  88354. /**
  88355. * Binds the view projection matrix to the effect
  88356. * @param effect defines the effect to bind the view projection matrix to
  88357. */
  88358. bindViewProjection(effect: Effect): void;
  88359. /**
  88360. * Specifies if material alpha testing should be turned on for the mesh
  88361. * @param mesh defines the mesh to check
  88362. */
  88363. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  88364. /**
  88365. * Processes to execute after binding the material to a mesh
  88366. * @param mesh defines the rendered mesh
  88367. */
  88368. protected _afterBind(mesh?: Mesh): void;
  88369. /**
  88370. * Unbinds the material from the mesh
  88371. */
  88372. unbind(): void;
  88373. /**
  88374. * Gets the active textures from the material
  88375. * @returns an array of textures
  88376. */
  88377. getActiveTextures(): BaseTexture[];
  88378. /**
  88379. * Specifies if the material uses a texture
  88380. * @param texture defines the texture to check against the material
  88381. * @returns a boolean specifying if the material uses the texture
  88382. */
  88383. hasTexture(texture: BaseTexture): boolean;
  88384. /**
  88385. * Makes a duplicate of the material, and gives it a new name
  88386. * @param name defines the new name for the duplicated material
  88387. * @returns the cloned material
  88388. */
  88389. clone(name: string): Nullable<Material>;
  88390. /**
  88391. * Gets the meshes bound to the material
  88392. * @returns an array of meshes bound to the material
  88393. */
  88394. getBindedMeshes(): AbstractMesh[];
  88395. /**
  88396. * Force shader compilation
  88397. * @param mesh defines the mesh associated with this material
  88398. * @param onCompiled defines a function to execute once the material is compiled
  88399. * @param options defines the options to configure the compilation
  88400. * @param onError defines a function to execute if the material fails compiling
  88401. */
  88402. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  88403. /**
  88404. * Force shader compilation
  88405. * @param mesh defines the mesh that will use this material
  88406. * @param options defines additional options for compiling the shaders
  88407. * @returns a promise that resolves when the compilation completes
  88408. */
  88409. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  88410. private static readonly _AllDirtyCallBack;
  88411. private static readonly _ImageProcessingDirtyCallBack;
  88412. private static readonly _TextureDirtyCallBack;
  88413. private static readonly _FresnelDirtyCallBack;
  88414. private static readonly _MiscDirtyCallBack;
  88415. private static readonly _LightsDirtyCallBack;
  88416. private static readonly _AttributeDirtyCallBack;
  88417. private static _FresnelAndMiscDirtyCallBack;
  88418. private static _TextureAndMiscDirtyCallBack;
  88419. private static readonly _DirtyCallbackArray;
  88420. private static readonly _RunDirtyCallBacks;
  88421. /**
  88422. * Marks a define in the material to indicate that it needs to be re-computed
  88423. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  88424. */
  88425. markAsDirty(flag: number): void;
  88426. /**
  88427. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  88428. * @param func defines a function which checks material defines against the submeshes
  88429. */
  88430. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  88431. /**
  88432. * Indicates that we need to re-calculated for all submeshes
  88433. */
  88434. protected _markAllSubMeshesAsAllDirty(): void;
  88435. /**
  88436. * Indicates that image processing needs to be re-calculated for all submeshes
  88437. */
  88438. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  88439. /**
  88440. * Indicates that textures need to be re-calculated for all submeshes
  88441. */
  88442. protected _markAllSubMeshesAsTexturesDirty(): void;
  88443. /**
  88444. * Indicates that fresnel needs to be re-calculated for all submeshes
  88445. */
  88446. protected _markAllSubMeshesAsFresnelDirty(): void;
  88447. /**
  88448. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  88449. */
  88450. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  88451. /**
  88452. * Indicates that lights need to be re-calculated for all submeshes
  88453. */
  88454. protected _markAllSubMeshesAsLightsDirty(): void;
  88455. /**
  88456. * Indicates that attributes need to be re-calculated for all submeshes
  88457. */
  88458. protected _markAllSubMeshesAsAttributesDirty(): void;
  88459. /**
  88460. * Indicates that misc needs to be re-calculated for all submeshes
  88461. */
  88462. protected _markAllSubMeshesAsMiscDirty(): void;
  88463. /**
  88464. * Indicates that textures and misc need to be re-calculated for all submeshes
  88465. */
  88466. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  88467. /**
  88468. * Disposes the material
  88469. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  88470. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  88471. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  88472. */
  88473. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  88474. /** @hidden */
  88475. private releaseVertexArrayObject;
  88476. /**
  88477. * Serializes this material
  88478. * @returns the serialized material object
  88479. */
  88480. serialize(): any;
  88481. /**
  88482. * Creates a material from parsed material data
  88483. * @param parsedMaterial defines parsed material data
  88484. * @param scene defines the hosting scene
  88485. * @param rootUrl defines the root URL to use to load textures
  88486. * @returns a new material
  88487. */
  88488. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  88489. }
  88490. }
  88491. declare module BABYLON {
  88492. /**
  88493. * A multi-material is used to apply different materials to different parts of the same object without the need of
  88494. * separate meshes. This can be use to improve performances.
  88495. * @see http://doc.babylonjs.com/how_to/multi_materials
  88496. */
  88497. export class MultiMaterial extends Material {
  88498. private _subMaterials;
  88499. /**
  88500. * Gets or Sets the list of Materials used within the multi material.
  88501. * They need to be ordered according to the submeshes order in the associated mesh
  88502. */
  88503. subMaterials: Nullable<Material>[];
  88504. /**
  88505. * Function used to align with Node.getChildren()
  88506. * @returns the list of Materials used within the multi material
  88507. */
  88508. getChildren(): Nullable<Material>[];
  88509. /**
  88510. * Instantiates a new Multi Material
  88511. * A multi-material is used to apply different materials to different parts of the same object without the need of
  88512. * separate meshes. This can be use to improve performances.
  88513. * @see http://doc.babylonjs.com/how_to/multi_materials
  88514. * @param name Define the name in the scene
  88515. * @param scene Define the scene the material belongs to
  88516. */
  88517. constructor(name: string, scene: Scene);
  88518. private _hookArray;
  88519. /**
  88520. * Get one of the submaterial by its index in the submaterials array
  88521. * @param index The index to look the sub material at
  88522. * @returns The Material if the index has been defined
  88523. */
  88524. getSubMaterial(index: number): Nullable<Material>;
  88525. /**
  88526. * Get the list of active textures for the whole sub materials list.
  88527. * @returns All the textures that will be used during the rendering
  88528. */
  88529. getActiveTextures(): BaseTexture[];
  88530. /**
  88531. * Gets the current class name of the material e.g. "MultiMaterial"
  88532. * Mainly use in serialization.
  88533. * @returns the class name
  88534. */
  88535. getClassName(): string;
  88536. /**
  88537. * Checks if the material is ready to render the requested sub mesh
  88538. * @param mesh Define the mesh the submesh belongs to
  88539. * @param subMesh Define the sub mesh to look readyness for
  88540. * @param useInstances Define whether or not the material is used with instances
  88541. * @returns true if ready, otherwise false
  88542. */
  88543. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  88544. /**
  88545. * Clones the current material and its related sub materials
  88546. * @param name Define the name of the newly cloned material
  88547. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  88548. * @returns the cloned material
  88549. */
  88550. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  88551. /**
  88552. * Serializes the materials into a JSON representation.
  88553. * @returns the JSON representation
  88554. */
  88555. serialize(): any;
  88556. /**
  88557. * Dispose the material and release its associated resources
  88558. * @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)
  88559. * @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)
  88560. * @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)
  88561. */
  88562. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  88563. /**
  88564. * Creates a MultiMaterial from parsed MultiMaterial data.
  88565. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  88566. * @param scene defines the hosting scene
  88567. * @returns a new MultiMaterial
  88568. */
  88569. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  88570. }
  88571. }
  88572. declare module BABYLON {
  88573. /**
  88574. * Base class for submeshes
  88575. */
  88576. export class BaseSubMesh {
  88577. /** @hidden */
  88578. _materialDefines: Nullable<MaterialDefines>;
  88579. /** @hidden */
  88580. _materialEffect: Nullable<Effect>;
  88581. /**
  88582. * Gets associated effect
  88583. */
  88584. readonly effect: Nullable<Effect>;
  88585. /**
  88586. * Sets associated effect (effect used to render this submesh)
  88587. * @param effect defines the effect to associate with
  88588. * @param defines defines the set of defines used to compile this effect
  88589. */
  88590. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  88591. }
  88592. /**
  88593. * Defines a subdivision inside a mesh
  88594. */
  88595. export class SubMesh extends BaseSubMesh implements ICullable {
  88596. /** the material index to use */
  88597. materialIndex: number;
  88598. /** vertex index start */
  88599. verticesStart: number;
  88600. /** vertices count */
  88601. verticesCount: number;
  88602. /** index start */
  88603. indexStart: number;
  88604. /** indices count */
  88605. indexCount: number;
  88606. /** @hidden */
  88607. _linesIndexCount: number;
  88608. private _mesh;
  88609. private _renderingMesh;
  88610. private _boundingInfo;
  88611. private _linesIndexBuffer;
  88612. /** @hidden */
  88613. _lastColliderWorldVertices: Nullable<Vector3[]>;
  88614. /** @hidden */
  88615. _trianglePlanes: Plane[];
  88616. /** @hidden */
  88617. _lastColliderTransformMatrix: Nullable<Matrix>;
  88618. /** @hidden */
  88619. _renderId: number;
  88620. /** @hidden */
  88621. _alphaIndex: number;
  88622. /** @hidden */
  88623. _distanceToCamera: number;
  88624. /** @hidden */
  88625. _id: number;
  88626. private _currentMaterial;
  88627. /**
  88628. * Add a new submesh to a mesh
  88629. * @param materialIndex defines the material index to use
  88630. * @param verticesStart defines vertex index start
  88631. * @param verticesCount defines vertices count
  88632. * @param indexStart defines index start
  88633. * @param indexCount defines indices count
  88634. * @param mesh defines the parent mesh
  88635. * @param renderingMesh defines an optional rendering mesh
  88636. * @param createBoundingBox defines if bounding box should be created for this submesh
  88637. * @returns the new submesh
  88638. */
  88639. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  88640. /**
  88641. * Creates a new submesh
  88642. * @param materialIndex defines the material index to use
  88643. * @param verticesStart defines vertex index start
  88644. * @param verticesCount defines vertices count
  88645. * @param indexStart defines index start
  88646. * @param indexCount defines indices count
  88647. * @param mesh defines the parent mesh
  88648. * @param renderingMesh defines an optional rendering mesh
  88649. * @param createBoundingBox defines if bounding box should be created for this submesh
  88650. */
  88651. constructor(
  88652. /** the material index to use */
  88653. materialIndex: number,
  88654. /** vertex index start */
  88655. verticesStart: number,
  88656. /** vertices count */
  88657. verticesCount: number,
  88658. /** index start */
  88659. indexStart: number,
  88660. /** indices count */
  88661. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean);
  88662. /**
  88663. * Returns true if this submesh covers the entire parent mesh
  88664. * @ignorenaming
  88665. */
  88666. readonly IsGlobal: boolean;
  88667. /**
  88668. * Returns the submesh BoudingInfo object
  88669. * @returns current bounding info (or mesh's one if the submesh is global)
  88670. */
  88671. getBoundingInfo(): BoundingInfo;
  88672. /**
  88673. * Sets the submesh BoundingInfo
  88674. * @param boundingInfo defines the new bounding info to use
  88675. * @returns the SubMesh
  88676. */
  88677. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  88678. /**
  88679. * Returns the mesh of the current submesh
  88680. * @return the parent mesh
  88681. */
  88682. getMesh(): AbstractMesh;
  88683. /**
  88684. * Returns the rendering mesh of the submesh
  88685. * @returns the rendering mesh (could be different from parent mesh)
  88686. */
  88687. getRenderingMesh(): Mesh;
  88688. /**
  88689. * Returns the submesh material
  88690. * @returns null or the current material
  88691. */
  88692. getMaterial(): Nullable<Material>;
  88693. /**
  88694. * Sets a new updated BoundingInfo object to the submesh
  88695. * @param data defines an optional position array to use to determine the bounding info
  88696. * @returns the SubMesh
  88697. */
  88698. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  88699. /** @hidden */
  88700. _checkCollision(collider: Collider): boolean;
  88701. /**
  88702. * Updates the submesh BoundingInfo
  88703. * @param world defines the world matrix to use to update the bounding info
  88704. * @returns the submesh
  88705. */
  88706. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  88707. /**
  88708. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  88709. * @param frustumPlanes defines the frustum planes
  88710. * @returns true if the submesh is intersecting with the frustum
  88711. */
  88712. isInFrustum(frustumPlanes: Plane[]): boolean;
  88713. /**
  88714. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  88715. * @param frustumPlanes defines the frustum planes
  88716. * @returns true if the submesh is inside the frustum
  88717. */
  88718. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  88719. /**
  88720. * Renders the submesh
  88721. * @param enableAlphaMode defines if alpha needs to be used
  88722. * @returns the submesh
  88723. */
  88724. render(enableAlphaMode: boolean): SubMesh;
  88725. /**
  88726. * @hidden
  88727. */
  88728. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  88729. /**
  88730. * Checks if the submesh intersects with a ray
  88731. * @param ray defines the ray to test
  88732. * @returns true is the passed ray intersects the submesh bounding box
  88733. */
  88734. canIntersects(ray: Ray): boolean;
  88735. /**
  88736. * Intersects current submesh with a ray
  88737. * @param ray defines the ray to test
  88738. * @param positions defines mesh's positions array
  88739. * @param indices defines mesh's indices array
  88740. * @param fastCheck defines if only bounding info should be used
  88741. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  88742. * @returns intersection info or null if no intersection
  88743. */
  88744. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  88745. /** @hidden */
  88746. private _intersectLines;
  88747. /** @hidden */
  88748. private _intersectUnIndexedLines;
  88749. /** @hidden */
  88750. private _intersectTriangles;
  88751. /** @hidden */
  88752. private _intersectUnIndexedTriangles;
  88753. /** @hidden */
  88754. _rebuild(): void;
  88755. /**
  88756. * Creates a new submesh from the passed mesh
  88757. * @param newMesh defines the new hosting mesh
  88758. * @param newRenderingMesh defines an optional rendering mesh
  88759. * @returns the new submesh
  88760. */
  88761. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  88762. /**
  88763. * Release associated resources
  88764. */
  88765. dispose(): void;
  88766. /**
  88767. * Gets the class name
  88768. * @returns the string "SubMesh".
  88769. */
  88770. getClassName(): string;
  88771. /**
  88772. * Creates a new submesh from indices data
  88773. * @param materialIndex the index of the main mesh material
  88774. * @param startIndex the index where to start the copy in the mesh indices array
  88775. * @param indexCount the number of indices to copy then from the startIndex
  88776. * @param mesh the main mesh to create the submesh from
  88777. * @param renderingMesh the optional rendering mesh
  88778. * @returns a new submesh
  88779. */
  88780. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  88781. }
  88782. }
  88783. declare module BABYLON {
  88784. /**
  88785. * Class used to represent data loading progression
  88786. */
  88787. export class SceneLoaderFlags {
  88788. private static _ForceFullSceneLoadingForIncremental;
  88789. private static _ShowLoadingScreen;
  88790. private static _CleanBoneMatrixWeights;
  88791. private static _loggingLevel;
  88792. /**
  88793. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  88794. */
  88795. static ForceFullSceneLoadingForIncremental: boolean;
  88796. /**
  88797. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  88798. */
  88799. static ShowLoadingScreen: boolean;
  88800. /**
  88801. * Defines the current logging level (while loading the scene)
  88802. * @ignorenaming
  88803. */
  88804. static loggingLevel: number;
  88805. /**
  88806. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  88807. */
  88808. static CleanBoneMatrixWeights: boolean;
  88809. }
  88810. }
  88811. declare module BABYLON {
  88812. /**
  88813. * Class used to store geometry data (vertex buffers + index buffer)
  88814. */
  88815. export class Geometry implements IGetSetVerticesData {
  88816. /**
  88817. * Gets or sets the ID of the geometry
  88818. */
  88819. id: string;
  88820. /**
  88821. * Gets or sets the unique ID of the geometry
  88822. */
  88823. uniqueId: number;
  88824. /**
  88825. * Gets the delay loading state of the geometry (none by default which means not delayed)
  88826. */
  88827. delayLoadState: number;
  88828. /**
  88829. * Gets the file containing the data to load when running in delay load state
  88830. */
  88831. delayLoadingFile: Nullable<string>;
  88832. /**
  88833. * Callback called when the geometry is updated
  88834. */
  88835. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  88836. private _scene;
  88837. private _engine;
  88838. private _meshes;
  88839. private _totalVertices;
  88840. /** @hidden */
  88841. _indices: IndicesArray;
  88842. /** @hidden */
  88843. _vertexBuffers: {
  88844. [key: string]: VertexBuffer;
  88845. };
  88846. private _isDisposed;
  88847. private _extend;
  88848. private _boundingBias;
  88849. /** @hidden */
  88850. _delayInfo: Array<string>;
  88851. private _indexBuffer;
  88852. private _indexBufferIsUpdatable;
  88853. /** @hidden */
  88854. _boundingInfo: Nullable<BoundingInfo>;
  88855. /** @hidden */
  88856. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  88857. /** @hidden */
  88858. _softwareSkinningFrameId: number;
  88859. private _vertexArrayObjects;
  88860. private _updatable;
  88861. /** @hidden */
  88862. _positions: Nullable<Vector3[]>;
  88863. /**
  88864. * 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
  88865. */
  88866. /**
  88867. * 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
  88868. */
  88869. boundingBias: Vector2;
  88870. /**
  88871. * Static function used to attach a new empty geometry to a mesh
  88872. * @param mesh defines the mesh to attach the geometry to
  88873. * @returns the new Geometry
  88874. */
  88875. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  88876. /**
  88877. * Creates a new geometry
  88878. * @param id defines the unique ID
  88879. * @param scene defines the hosting scene
  88880. * @param vertexData defines the VertexData used to get geometry data
  88881. * @param updatable defines if geometry must be updatable (false by default)
  88882. * @param mesh defines the mesh that will be associated with the geometry
  88883. */
  88884. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  88885. /**
  88886. * Gets the current extend of the geometry
  88887. */
  88888. readonly extend: {
  88889. minimum: Vector3;
  88890. maximum: Vector3;
  88891. };
  88892. /**
  88893. * Gets the hosting scene
  88894. * @returns the hosting Scene
  88895. */
  88896. getScene(): Scene;
  88897. /**
  88898. * Gets the hosting engine
  88899. * @returns the hosting Engine
  88900. */
  88901. getEngine(): Engine;
  88902. /**
  88903. * Defines if the geometry is ready to use
  88904. * @returns true if the geometry is ready to be used
  88905. */
  88906. isReady(): boolean;
  88907. /**
  88908. * Gets a value indicating that the geometry should not be serialized
  88909. */
  88910. readonly doNotSerialize: boolean;
  88911. /** @hidden */
  88912. _rebuild(): void;
  88913. /**
  88914. * Affects all geometry data in one call
  88915. * @param vertexData defines the geometry data
  88916. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  88917. */
  88918. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  88919. /**
  88920. * Set specific vertex data
  88921. * @param kind defines the data kind (Position, normal, etc...)
  88922. * @param data defines the vertex data to use
  88923. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  88924. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  88925. */
  88926. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  88927. /**
  88928. * Removes a specific vertex data
  88929. * @param kind defines the data kind (Position, normal, etc...)
  88930. */
  88931. removeVerticesData(kind: string): void;
  88932. /**
  88933. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  88934. * @param buffer defines the vertex buffer to use
  88935. * @param totalVertices defines the total number of vertices for position kind (could be null)
  88936. */
  88937. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  88938. /**
  88939. * Update a specific vertex buffer
  88940. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  88941. * It will do nothing if the buffer is not updatable
  88942. * @param kind defines the data kind (Position, normal, etc...)
  88943. * @param data defines the data to use
  88944. * @param offset defines the offset in the target buffer where to store the data
  88945. * @param useBytes set to true if the offset is in bytes
  88946. */
  88947. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  88948. /**
  88949. * Update a specific vertex buffer
  88950. * This function will create a new buffer if the current one is not updatable
  88951. * @param kind defines the data kind (Position, normal, etc...)
  88952. * @param data defines the data to use
  88953. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  88954. */
  88955. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  88956. private _updateBoundingInfo;
  88957. /** @hidden */
  88958. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  88959. /**
  88960. * Gets total number of vertices
  88961. * @returns the total number of vertices
  88962. */
  88963. getTotalVertices(): number;
  88964. /**
  88965. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  88966. * @param kind defines the data kind (Position, normal, etc...)
  88967. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  88968. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  88969. * @returns a float array containing vertex data
  88970. */
  88971. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  88972. /**
  88973. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  88974. * @param kind defines the data kind (Position, normal, etc...)
  88975. * @returns true if the vertex buffer with the specified kind is updatable
  88976. */
  88977. isVertexBufferUpdatable(kind: string): boolean;
  88978. /**
  88979. * Gets a specific vertex buffer
  88980. * @param kind defines the data kind (Position, normal, etc...)
  88981. * @returns a VertexBuffer
  88982. */
  88983. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  88984. /**
  88985. * Returns all vertex buffers
  88986. * @return an object holding all vertex buffers indexed by kind
  88987. */
  88988. getVertexBuffers(): Nullable<{
  88989. [key: string]: VertexBuffer;
  88990. }>;
  88991. /**
  88992. * Gets a boolean indicating if specific vertex buffer is present
  88993. * @param kind defines the data kind (Position, normal, etc...)
  88994. * @returns true if data is present
  88995. */
  88996. isVerticesDataPresent(kind: string): boolean;
  88997. /**
  88998. * Gets a list of all attached data kinds (Position, normal, etc...)
  88999. * @returns a list of string containing all kinds
  89000. */
  89001. getVerticesDataKinds(): string[];
  89002. /**
  89003. * Update index buffer
  89004. * @param indices defines the indices to store in the index buffer
  89005. * @param offset defines the offset in the target buffer where to store the data
  89006. * @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)
  89007. */
  89008. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  89009. /**
  89010. * Creates a new index buffer
  89011. * @param indices defines the indices to store in the index buffer
  89012. * @param totalVertices defines the total number of vertices (could be null)
  89013. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  89014. */
  89015. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  89016. /**
  89017. * Return the total number of indices
  89018. * @returns the total number of indices
  89019. */
  89020. getTotalIndices(): number;
  89021. /**
  89022. * Gets the index buffer array
  89023. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  89024. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89025. * @returns the index buffer array
  89026. */
  89027. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  89028. /**
  89029. * Gets the index buffer
  89030. * @return the index buffer
  89031. */
  89032. getIndexBuffer(): Nullable<DataBuffer>;
  89033. /** @hidden */
  89034. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  89035. /**
  89036. * Release the associated resources for a specific mesh
  89037. * @param mesh defines the source mesh
  89038. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  89039. */
  89040. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  89041. /**
  89042. * Apply current geometry to a given mesh
  89043. * @param mesh defines the mesh to apply geometry to
  89044. */
  89045. applyToMesh(mesh: Mesh): void;
  89046. private _updateExtend;
  89047. private _applyToMesh;
  89048. private notifyUpdate;
  89049. /**
  89050. * Load the geometry if it was flagged as delay loaded
  89051. * @param scene defines the hosting scene
  89052. * @param onLoaded defines a callback called when the geometry is loaded
  89053. */
  89054. load(scene: Scene, onLoaded?: () => void): void;
  89055. private _queueLoad;
  89056. /**
  89057. * Invert the geometry to move from a right handed system to a left handed one.
  89058. */
  89059. toLeftHanded(): void;
  89060. /** @hidden */
  89061. _resetPointsArrayCache(): void;
  89062. /** @hidden */
  89063. _generatePointsArray(): boolean;
  89064. /**
  89065. * Gets a value indicating if the geometry is disposed
  89066. * @returns true if the geometry was disposed
  89067. */
  89068. isDisposed(): boolean;
  89069. private _disposeVertexArrayObjects;
  89070. /**
  89071. * Free all associated resources
  89072. */
  89073. dispose(): void;
  89074. /**
  89075. * Clone the current geometry into a new geometry
  89076. * @param id defines the unique ID of the new geometry
  89077. * @returns a new geometry object
  89078. */
  89079. copy(id: string): Geometry;
  89080. /**
  89081. * Serialize the current geometry info (and not the vertices data) into a JSON object
  89082. * @return a JSON representation of the current geometry data (without the vertices data)
  89083. */
  89084. serialize(): any;
  89085. private toNumberArray;
  89086. /**
  89087. * Serialize all vertices data into a JSON oject
  89088. * @returns a JSON representation of the current geometry data
  89089. */
  89090. serializeVerticeData(): any;
  89091. /**
  89092. * Extracts a clone of a mesh geometry
  89093. * @param mesh defines the source mesh
  89094. * @param id defines the unique ID of the new geometry object
  89095. * @returns the new geometry object
  89096. */
  89097. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  89098. /**
  89099. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  89100. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  89101. * Be aware Math.random() could cause collisions, but:
  89102. * "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"
  89103. * @returns a string containing a new GUID
  89104. */
  89105. static RandomId(): string;
  89106. /** @hidden */
  89107. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  89108. private static _CleanMatricesWeights;
  89109. /**
  89110. * Create a new geometry from persisted data (Using .babylon file format)
  89111. * @param parsedVertexData defines the persisted data
  89112. * @param scene defines the hosting scene
  89113. * @param rootUrl defines the root url to use to load assets (like delayed data)
  89114. * @returns the new geometry object
  89115. */
  89116. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  89117. }
  89118. }
  89119. declare module BABYLON {
  89120. /**
  89121. * Define an interface for all classes that will get and set the data on vertices
  89122. */
  89123. export interface IGetSetVerticesData {
  89124. /**
  89125. * Gets a boolean indicating if specific vertex data is present
  89126. * @param kind defines the vertex data kind to use
  89127. * @returns true is data kind is present
  89128. */
  89129. isVerticesDataPresent(kind: string): boolean;
  89130. /**
  89131. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  89132. * @param kind defines the data kind (Position, normal, etc...)
  89133. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  89134. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89135. * @returns a float array containing vertex data
  89136. */
  89137. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  89138. /**
  89139. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  89140. * @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.
  89141. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89142. * @returns the indices array or an empty array if the mesh has no geometry
  89143. */
  89144. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  89145. /**
  89146. * Set specific vertex data
  89147. * @param kind defines the data kind (Position, normal, etc...)
  89148. * @param data defines the vertex data to use
  89149. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  89150. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  89151. */
  89152. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  89153. /**
  89154. * Update a specific associated vertex buffer
  89155. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  89156. * - VertexBuffer.PositionKind
  89157. * - VertexBuffer.UVKind
  89158. * - VertexBuffer.UV2Kind
  89159. * - VertexBuffer.UV3Kind
  89160. * - VertexBuffer.UV4Kind
  89161. * - VertexBuffer.UV5Kind
  89162. * - VertexBuffer.UV6Kind
  89163. * - VertexBuffer.ColorKind
  89164. * - VertexBuffer.MatricesIndicesKind
  89165. * - VertexBuffer.MatricesIndicesExtraKind
  89166. * - VertexBuffer.MatricesWeightsKind
  89167. * - VertexBuffer.MatricesWeightsExtraKind
  89168. * @param data defines the data source
  89169. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  89170. * @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)
  89171. */
  89172. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  89173. /**
  89174. * Creates a new index buffer
  89175. * @param indices defines the indices to store in the index buffer
  89176. * @param totalVertices defines the total number of vertices (could be null)
  89177. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  89178. */
  89179. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  89180. }
  89181. /**
  89182. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  89183. */
  89184. export class VertexData {
  89185. /**
  89186. * Mesh side orientation : usually the external or front surface
  89187. */
  89188. static readonly FRONTSIDE: number;
  89189. /**
  89190. * Mesh side orientation : usually the internal or back surface
  89191. */
  89192. static readonly BACKSIDE: number;
  89193. /**
  89194. * Mesh side orientation : both internal and external or front and back surfaces
  89195. */
  89196. static readonly DOUBLESIDE: number;
  89197. /**
  89198. * Mesh side orientation : by default, `FRONTSIDE`
  89199. */
  89200. static readonly DEFAULTSIDE: number;
  89201. /**
  89202. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  89203. */
  89204. positions: Nullable<FloatArray>;
  89205. /**
  89206. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  89207. */
  89208. normals: Nullable<FloatArray>;
  89209. /**
  89210. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  89211. */
  89212. tangents: Nullable<FloatArray>;
  89213. /**
  89214. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89215. */
  89216. uvs: Nullable<FloatArray>;
  89217. /**
  89218. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89219. */
  89220. uvs2: Nullable<FloatArray>;
  89221. /**
  89222. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89223. */
  89224. uvs3: Nullable<FloatArray>;
  89225. /**
  89226. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89227. */
  89228. uvs4: Nullable<FloatArray>;
  89229. /**
  89230. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89231. */
  89232. uvs5: Nullable<FloatArray>;
  89233. /**
  89234. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89235. */
  89236. uvs6: Nullable<FloatArray>;
  89237. /**
  89238. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  89239. */
  89240. colors: Nullable<FloatArray>;
  89241. /**
  89242. * 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).
  89243. */
  89244. matricesIndices: Nullable<FloatArray>;
  89245. /**
  89246. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  89247. */
  89248. matricesWeights: Nullable<FloatArray>;
  89249. /**
  89250. * An array extending the number of possible indices
  89251. */
  89252. matricesIndicesExtra: Nullable<FloatArray>;
  89253. /**
  89254. * An array extending the number of possible weights when the number of indices is extended
  89255. */
  89256. matricesWeightsExtra: Nullable<FloatArray>;
  89257. /**
  89258. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  89259. */
  89260. indices: Nullable<IndicesArray>;
  89261. /**
  89262. * Uses the passed data array to set the set the values for the specified kind of data
  89263. * @param data a linear array of floating numbers
  89264. * @param kind the type of data that is being set, eg positions, colors etc
  89265. */
  89266. set(data: FloatArray, kind: string): void;
  89267. /**
  89268. * Associates the vertexData to the passed Mesh.
  89269. * Sets it as updatable or not (default `false`)
  89270. * @param mesh the mesh the vertexData is applied to
  89271. * @param updatable when used and having the value true allows new data to update the vertexData
  89272. * @returns the VertexData
  89273. */
  89274. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  89275. /**
  89276. * Associates the vertexData to the passed Geometry.
  89277. * Sets it as updatable or not (default `false`)
  89278. * @param geometry the geometry the vertexData is applied to
  89279. * @param updatable when used and having the value true allows new data to update the vertexData
  89280. * @returns VertexData
  89281. */
  89282. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  89283. /**
  89284. * Updates the associated mesh
  89285. * @param mesh the mesh to be updated
  89286. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  89287. * @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
  89288. * @returns VertexData
  89289. */
  89290. updateMesh(mesh: Mesh): VertexData;
  89291. /**
  89292. * Updates the associated geometry
  89293. * @param geometry the geometry to be updated
  89294. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  89295. * @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
  89296. * @returns VertexData.
  89297. */
  89298. updateGeometry(geometry: Geometry): VertexData;
  89299. private _applyTo;
  89300. private _update;
  89301. /**
  89302. * Transforms each position and each normal of the vertexData according to the passed Matrix
  89303. * @param matrix the transforming matrix
  89304. * @returns the VertexData
  89305. */
  89306. transform(matrix: Matrix): VertexData;
  89307. /**
  89308. * Merges the passed VertexData into the current one
  89309. * @param other the VertexData to be merged into the current one
  89310. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  89311. * @returns the modified VertexData
  89312. */
  89313. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  89314. private _mergeElement;
  89315. private _validate;
  89316. /**
  89317. * Serializes the VertexData
  89318. * @returns a serialized object
  89319. */
  89320. serialize(): any;
  89321. /**
  89322. * Extracts the vertexData from a mesh
  89323. * @param mesh the mesh from which to extract the VertexData
  89324. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  89325. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  89326. * @returns the object VertexData associated to the passed mesh
  89327. */
  89328. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  89329. /**
  89330. * Extracts the vertexData from the geometry
  89331. * @param geometry the geometry from which to extract the VertexData
  89332. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  89333. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  89334. * @returns the object VertexData associated to the passed mesh
  89335. */
  89336. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  89337. private static _ExtractFrom;
  89338. /**
  89339. * Creates the VertexData for a Ribbon
  89340. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  89341. * * pathArray array of paths, each of which an array of successive Vector3
  89342. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  89343. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  89344. * * 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
  89345. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89346. * * 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)
  89347. * * 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)
  89348. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  89349. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  89350. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  89351. * @returns the VertexData of the ribbon
  89352. */
  89353. static CreateRibbon(options: {
  89354. pathArray: Vector3[][];
  89355. closeArray?: boolean;
  89356. closePath?: boolean;
  89357. offset?: number;
  89358. sideOrientation?: number;
  89359. frontUVs?: Vector4;
  89360. backUVs?: Vector4;
  89361. invertUV?: boolean;
  89362. uvs?: Vector2[];
  89363. colors?: Color4[];
  89364. }): VertexData;
  89365. /**
  89366. * Creates the VertexData for a box
  89367. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89368. * * size sets the width, height and depth of the box to the value of size, optional default 1
  89369. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  89370. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  89371. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  89372. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  89373. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  89374. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89375. * * 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)
  89376. * * 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)
  89377. * @returns the VertexData of the box
  89378. */
  89379. static CreateBox(options: {
  89380. size?: number;
  89381. width?: number;
  89382. height?: number;
  89383. depth?: number;
  89384. faceUV?: Vector4[];
  89385. faceColors?: Color4[];
  89386. sideOrientation?: number;
  89387. frontUVs?: Vector4;
  89388. backUVs?: Vector4;
  89389. }): VertexData;
  89390. /**
  89391. * Creates the VertexData for a tiled box
  89392. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89393. * * faceTiles sets the pattern, tile size and number of tiles for a face
  89394. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  89395. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  89396. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89397. * @returns the VertexData of the box
  89398. */
  89399. static CreateTiledBox(options: {
  89400. pattern?: number;
  89401. width?: number;
  89402. height?: number;
  89403. depth?: number;
  89404. tileSize?: number;
  89405. tileWidth?: number;
  89406. tileHeight?: number;
  89407. alignHorizontal?: number;
  89408. alignVertical?: number;
  89409. faceUV?: Vector4[];
  89410. faceColors?: Color4[];
  89411. sideOrientation?: number;
  89412. }): VertexData;
  89413. /**
  89414. * Creates the VertexData for a tiled plane
  89415. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89416. * * pattern a limited pattern arrangement depending on the number
  89417. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  89418. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  89419. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  89420. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89421. * * 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)
  89422. * * 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)
  89423. * @returns the VertexData of the tiled plane
  89424. */
  89425. static CreateTiledPlane(options: {
  89426. pattern?: number;
  89427. tileSize?: number;
  89428. tileWidth?: number;
  89429. tileHeight?: number;
  89430. size?: number;
  89431. width?: number;
  89432. height?: number;
  89433. alignHorizontal?: number;
  89434. alignVertical?: number;
  89435. sideOrientation?: number;
  89436. frontUVs?: Vector4;
  89437. backUVs?: Vector4;
  89438. }): VertexData;
  89439. /**
  89440. * Creates the VertexData for an ellipsoid, defaults to a sphere
  89441. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89442. * * segments sets the number of horizontal strips optional, default 32
  89443. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  89444. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  89445. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  89446. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  89447. * * 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
  89448. * * 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
  89449. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89450. * * 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)
  89451. * * 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)
  89452. * @returns the VertexData of the ellipsoid
  89453. */
  89454. static CreateSphere(options: {
  89455. segments?: number;
  89456. diameter?: number;
  89457. diameterX?: number;
  89458. diameterY?: number;
  89459. diameterZ?: number;
  89460. arc?: number;
  89461. slice?: number;
  89462. sideOrientation?: number;
  89463. frontUVs?: Vector4;
  89464. backUVs?: Vector4;
  89465. }): VertexData;
  89466. /**
  89467. * Creates the VertexData for a cylinder, cone or prism
  89468. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89469. * * height sets the height (y direction) of the cylinder, optional, default 2
  89470. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  89471. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  89472. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  89473. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  89474. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  89475. * * 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
  89476. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  89477. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  89478. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  89479. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  89480. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89481. * * 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)
  89482. * * 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)
  89483. * @returns the VertexData of the cylinder, cone or prism
  89484. */
  89485. static CreateCylinder(options: {
  89486. height?: number;
  89487. diameterTop?: number;
  89488. diameterBottom?: number;
  89489. diameter?: number;
  89490. tessellation?: number;
  89491. subdivisions?: number;
  89492. arc?: number;
  89493. faceColors?: Color4[];
  89494. faceUV?: Vector4[];
  89495. hasRings?: boolean;
  89496. enclose?: boolean;
  89497. sideOrientation?: number;
  89498. frontUVs?: Vector4;
  89499. backUVs?: Vector4;
  89500. }): VertexData;
  89501. /**
  89502. * Creates the VertexData for a torus
  89503. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89504. * * diameter the diameter of the torus, optional default 1
  89505. * * thickness the diameter of the tube forming the torus, optional default 0.5
  89506. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  89507. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89508. * * 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)
  89509. * * 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)
  89510. * @returns the VertexData of the torus
  89511. */
  89512. static CreateTorus(options: {
  89513. diameter?: number;
  89514. thickness?: number;
  89515. tessellation?: number;
  89516. sideOrientation?: number;
  89517. frontUVs?: Vector4;
  89518. backUVs?: Vector4;
  89519. }): VertexData;
  89520. /**
  89521. * Creates the VertexData of the LineSystem
  89522. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  89523. * - lines an array of lines, each line being an array of successive Vector3
  89524. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  89525. * @returns the VertexData of the LineSystem
  89526. */
  89527. static CreateLineSystem(options: {
  89528. lines: Vector3[][];
  89529. colors?: Nullable<Color4[][]>;
  89530. }): VertexData;
  89531. /**
  89532. * Create the VertexData for a DashedLines
  89533. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  89534. * - points an array successive Vector3
  89535. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  89536. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  89537. * - dashNb the intended total number of dashes, optional, default 200
  89538. * @returns the VertexData for the DashedLines
  89539. */
  89540. static CreateDashedLines(options: {
  89541. points: Vector3[];
  89542. dashSize?: number;
  89543. gapSize?: number;
  89544. dashNb?: number;
  89545. }): VertexData;
  89546. /**
  89547. * Creates the VertexData for a Ground
  89548. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  89549. * - width the width (x direction) of the ground, optional, default 1
  89550. * - height the height (z direction) of the ground, optional, default 1
  89551. * - subdivisions the number of subdivisions per side, optional, default 1
  89552. * @returns the VertexData of the Ground
  89553. */
  89554. static CreateGround(options: {
  89555. width?: number;
  89556. height?: number;
  89557. subdivisions?: number;
  89558. subdivisionsX?: number;
  89559. subdivisionsY?: number;
  89560. }): VertexData;
  89561. /**
  89562. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  89563. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  89564. * * xmin the ground minimum X coordinate, optional, default -1
  89565. * * zmin the ground minimum Z coordinate, optional, default -1
  89566. * * xmax the ground maximum X coordinate, optional, default 1
  89567. * * zmax the ground maximum Z coordinate, optional, default 1
  89568. * * 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}
  89569. * * 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}
  89570. * @returns the VertexData of the TiledGround
  89571. */
  89572. static CreateTiledGround(options: {
  89573. xmin: number;
  89574. zmin: number;
  89575. xmax: number;
  89576. zmax: number;
  89577. subdivisions?: {
  89578. w: number;
  89579. h: number;
  89580. };
  89581. precision?: {
  89582. w: number;
  89583. h: number;
  89584. };
  89585. }): VertexData;
  89586. /**
  89587. * Creates the VertexData of the Ground designed from a heightmap
  89588. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  89589. * * width the width (x direction) of the ground
  89590. * * height the height (z direction) of the ground
  89591. * * subdivisions the number of subdivisions per side
  89592. * * minHeight the minimum altitude on the ground, optional, default 0
  89593. * * maxHeight the maximum altitude on the ground, optional default 1
  89594. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  89595. * * buffer the array holding the image color data
  89596. * * bufferWidth the width of image
  89597. * * bufferHeight the height of image
  89598. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  89599. * @returns the VertexData of the Ground designed from a heightmap
  89600. */
  89601. static CreateGroundFromHeightMap(options: {
  89602. width: number;
  89603. height: number;
  89604. subdivisions: number;
  89605. minHeight: number;
  89606. maxHeight: number;
  89607. colorFilter: Color3;
  89608. buffer: Uint8Array;
  89609. bufferWidth: number;
  89610. bufferHeight: number;
  89611. alphaFilter: number;
  89612. }): VertexData;
  89613. /**
  89614. * Creates the VertexData for a Plane
  89615. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  89616. * * size sets the width and height of the plane to the value of size, optional default 1
  89617. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  89618. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  89619. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89620. * * 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)
  89621. * * 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)
  89622. * @returns the VertexData of the box
  89623. */
  89624. static CreatePlane(options: {
  89625. size?: number;
  89626. width?: number;
  89627. height?: number;
  89628. sideOrientation?: number;
  89629. frontUVs?: Vector4;
  89630. backUVs?: Vector4;
  89631. }): VertexData;
  89632. /**
  89633. * Creates the VertexData of the Disc or regular Polygon
  89634. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  89635. * * radius the radius of the disc, optional default 0.5
  89636. * * tessellation the number of polygon sides, optional, default 64
  89637. * * 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
  89638. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89639. * * 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)
  89640. * * 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)
  89641. * @returns the VertexData of the box
  89642. */
  89643. static CreateDisc(options: {
  89644. radius?: number;
  89645. tessellation?: number;
  89646. arc?: number;
  89647. sideOrientation?: number;
  89648. frontUVs?: Vector4;
  89649. backUVs?: Vector4;
  89650. }): VertexData;
  89651. /**
  89652. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  89653. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  89654. * @param polygon a mesh built from polygonTriangulation.build()
  89655. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89656. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  89657. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  89658. * @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)
  89659. * @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)
  89660. * @returns the VertexData of the Polygon
  89661. */
  89662. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4): VertexData;
  89663. /**
  89664. * Creates the VertexData of the IcoSphere
  89665. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  89666. * * radius the radius of the IcoSphere, optional default 1
  89667. * * radiusX allows stretching in the x direction, optional, default radius
  89668. * * radiusY allows stretching in the y direction, optional, default radius
  89669. * * radiusZ allows stretching in the z direction, optional, default radius
  89670. * * flat when true creates a flat shaded mesh, optional, default true
  89671. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  89672. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89673. * * 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)
  89674. * * 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)
  89675. * @returns the VertexData of the IcoSphere
  89676. */
  89677. static CreateIcoSphere(options: {
  89678. radius?: number;
  89679. radiusX?: number;
  89680. radiusY?: number;
  89681. radiusZ?: number;
  89682. flat?: boolean;
  89683. subdivisions?: number;
  89684. sideOrientation?: number;
  89685. frontUVs?: Vector4;
  89686. backUVs?: Vector4;
  89687. }): VertexData;
  89688. /**
  89689. * Creates the VertexData for a Polyhedron
  89690. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  89691. * * type provided types are:
  89692. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  89693. * * 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)
  89694. * * size the size of the IcoSphere, optional default 1
  89695. * * sizeX allows stretching in the x direction, optional, default size
  89696. * * sizeY allows stretching in the y direction, optional, default size
  89697. * * sizeZ allows stretching in the z direction, optional, default size
  89698. * * 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
  89699. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  89700. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  89701. * * flat when true creates a flat shaded mesh, optional, default true
  89702. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  89703. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89704. * * 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)
  89705. * * 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)
  89706. * @returns the VertexData of the Polyhedron
  89707. */
  89708. static CreatePolyhedron(options: {
  89709. type?: number;
  89710. size?: number;
  89711. sizeX?: number;
  89712. sizeY?: number;
  89713. sizeZ?: number;
  89714. custom?: any;
  89715. faceUV?: Vector4[];
  89716. faceColors?: Color4[];
  89717. flat?: boolean;
  89718. sideOrientation?: number;
  89719. frontUVs?: Vector4;
  89720. backUVs?: Vector4;
  89721. }): VertexData;
  89722. /**
  89723. * Creates the VertexData for a TorusKnot
  89724. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  89725. * * radius the radius of the torus knot, optional, default 2
  89726. * * tube the thickness of the tube, optional, default 0.5
  89727. * * radialSegments the number of sides on each tube segments, optional, default 32
  89728. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  89729. * * p the number of windings around the z axis, optional, default 2
  89730. * * q the number of windings around the x axis, optional, default 3
  89731. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89732. * * 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)
  89733. * * 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)
  89734. * @returns the VertexData of the Torus Knot
  89735. */
  89736. static CreateTorusKnot(options: {
  89737. radius?: number;
  89738. tube?: number;
  89739. radialSegments?: number;
  89740. tubularSegments?: number;
  89741. p?: number;
  89742. q?: number;
  89743. sideOrientation?: number;
  89744. frontUVs?: Vector4;
  89745. backUVs?: Vector4;
  89746. }): VertexData;
  89747. /**
  89748. * Compute normals for given positions and indices
  89749. * @param positions an array of vertex positions, [...., x, y, z, ......]
  89750. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  89751. * @param normals an array of vertex normals, [...., x, y, z, ......]
  89752. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  89753. * * facetNormals : optional array of facet normals (vector3)
  89754. * * facetPositions : optional array of facet positions (vector3)
  89755. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  89756. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  89757. * * bInfo : optional bounding info, required for facetPartitioning computation
  89758. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  89759. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  89760. * * useRightHandedSystem: optional boolean to for right handed system computation
  89761. * * depthSort : optional boolean to enable the facet depth sort computation
  89762. * * distanceTo : optional Vector3 to compute the facet depth from this location
  89763. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  89764. */
  89765. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  89766. facetNormals?: any;
  89767. facetPositions?: any;
  89768. facetPartitioning?: any;
  89769. ratio?: number;
  89770. bInfo?: any;
  89771. bbSize?: Vector3;
  89772. subDiv?: any;
  89773. useRightHandedSystem?: boolean;
  89774. depthSort?: boolean;
  89775. distanceTo?: Vector3;
  89776. depthSortedFacets?: any;
  89777. }): void;
  89778. /** @hidden */
  89779. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  89780. /**
  89781. * Applies VertexData created from the imported parameters to the geometry
  89782. * @param parsedVertexData the parsed data from an imported file
  89783. * @param geometry the geometry to apply the VertexData to
  89784. */
  89785. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  89786. }
  89787. }
  89788. declare module BABYLON {
  89789. /**
  89790. * Defines a target to use with MorphTargetManager
  89791. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  89792. */
  89793. export class MorphTarget implements IAnimatable {
  89794. /** defines the name of the target */
  89795. name: string;
  89796. /**
  89797. * Gets or sets the list of animations
  89798. */
  89799. animations: Animation[];
  89800. private _scene;
  89801. private _positions;
  89802. private _normals;
  89803. private _tangents;
  89804. private _uvs;
  89805. private _influence;
  89806. private _uniqueId;
  89807. /**
  89808. * Observable raised when the influence changes
  89809. */
  89810. onInfluenceChanged: Observable<boolean>;
  89811. /** @hidden */
  89812. _onDataLayoutChanged: Observable<void>;
  89813. /**
  89814. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  89815. */
  89816. influence: number;
  89817. /**
  89818. * Gets or sets the id of the morph Target
  89819. */
  89820. id: string;
  89821. private _animationPropertiesOverride;
  89822. /**
  89823. * Gets or sets the animation properties override
  89824. */
  89825. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  89826. /**
  89827. * Creates a new MorphTarget
  89828. * @param name defines the name of the target
  89829. * @param influence defines the influence to use
  89830. * @param scene defines the scene the morphtarget belongs to
  89831. */
  89832. constructor(
  89833. /** defines the name of the target */
  89834. name: string, influence?: number, scene?: Nullable<Scene>);
  89835. /**
  89836. * Gets the unique ID of this manager
  89837. */
  89838. readonly uniqueId: number;
  89839. /**
  89840. * Gets a boolean defining if the target contains position data
  89841. */
  89842. readonly hasPositions: boolean;
  89843. /**
  89844. * Gets a boolean defining if the target contains normal data
  89845. */
  89846. readonly hasNormals: boolean;
  89847. /**
  89848. * Gets a boolean defining if the target contains tangent data
  89849. */
  89850. readonly hasTangents: boolean;
  89851. /**
  89852. * Gets a boolean defining if the target contains texture coordinates data
  89853. */
  89854. readonly hasUVs: boolean;
  89855. /**
  89856. * Affects position data to this target
  89857. * @param data defines the position data to use
  89858. */
  89859. setPositions(data: Nullable<FloatArray>): void;
  89860. /**
  89861. * Gets the position data stored in this target
  89862. * @returns a FloatArray containing the position data (or null if not present)
  89863. */
  89864. getPositions(): Nullable<FloatArray>;
  89865. /**
  89866. * Affects normal data to this target
  89867. * @param data defines the normal data to use
  89868. */
  89869. setNormals(data: Nullable<FloatArray>): void;
  89870. /**
  89871. * Gets the normal data stored in this target
  89872. * @returns a FloatArray containing the normal data (or null if not present)
  89873. */
  89874. getNormals(): Nullable<FloatArray>;
  89875. /**
  89876. * Affects tangent data to this target
  89877. * @param data defines the tangent data to use
  89878. */
  89879. setTangents(data: Nullable<FloatArray>): void;
  89880. /**
  89881. * Gets the tangent data stored in this target
  89882. * @returns a FloatArray containing the tangent data (or null if not present)
  89883. */
  89884. getTangents(): Nullable<FloatArray>;
  89885. /**
  89886. * Affects texture coordinates data to this target
  89887. * @param data defines the texture coordinates data to use
  89888. */
  89889. setUVs(data: Nullable<FloatArray>): void;
  89890. /**
  89891. * Gets the texture coordinates data stored in this target
  89892. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  89893. */
  89894. getUVs(): Nullable<FloatArray>;
  89895. /**
  89896. * Clone the current target
  89897. * @returns a new MorphTarget
  89898. */
  89899. clone(): MorphTarget;
  89900. /**
  89901. * Serializes the current target into a Serialization object
  89902. * @returns the serialized object
  89903. */
  89904. serialize(): any;
  89905. /**
  89906. * Returns the string "MorphTarget"
  89907. * @returns "MorphTarget"
  89908. */
  89909. getClassName(): string;
  89910. /**
  89911. * Creates a new target from serialized data
  89912. * @param serializationObject defines the serialized data to use
  89913. * @returns a new MorphTarget
  89914. */
  89915. static Parse(serializationObject: any): MorphTarget;
  89916. /**
  89917. * Creates a MorphTarget from mesh data
  89918. * @param mesh defines the source mesh
  89919. * @param name defines the name to use for the new target
  89920. * @param influence defines the influence to attach to the target
  89921. * @returns a new MorphTarget
  89922. */
  89923. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  89924. }
  89925. }
  89926. declare module BABYLON {
  89927. /**
  89928. * This class is used to deform meshes using morphing between different targets
  89929. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  89930. */
  89931. export class MorphTargetManager {
  89932. private _targets;
  89933. private _targetInfluenceChangedObservers;
  89934. private _targetDataLayoutChangedObservers;
  89935. private _activeTargets;
  89936. private _scene;
  89937. private _influences;
  89938. private _supportsNormals;
  89939. private _supportsTangents;
  89940. private _supportsUVs;
  89941. private _vertexCount;
  89942. private _uniqueId;
  89943. private _tempInfluences;
  89944. /**
  89945. * Gets or sets a boolean indicating if normals must be morphed
  89946. */
  89947. enableNormalMorphing: boolean;
  89948. /**
  89949. * Gets or sets a boolean indicating if tangents must be morphed
  89950. */
  89951. enableTangentMorphing: boolean;
  89952. /**
  89953. * Gets or sets a boolean indicating if UV must be morphed
  89954. */
  89955. enableUVMorphing: boolean;
  89956. /**
  89957. * Creates a new MorphTargetManager
  89958. * @param scene defines the current scene
  89959. */
  89960. constructor(scene?: Nullable<Scene>);
  89961. /**
  89962. * Gets the unique ID of this manager
  89963. */
  89964. readonly uniqueId: number;
  89965. /**
  89966. * Gets the number of vertices handled by this manager
  89967. */
  89968. readonly vertexCount: number;
  89969. /**
  89970. * Gets a boolean indicating if this manager supports morphing of normals
  89971. */
  89972. readonly supportsNormals: boolean;
  89973. /**
  89974. * Gets a boolean indicating if this manager supports morphing of tangents
  89975. */
  89976. readonly supportsTangents: boolean;
  89977. /**
  89978. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  89979. */
  89980. readonly supportsUVs: boolean;
  89981. /**
  89982. * Gets the number of targets stored in this manager
  89983. */
  89984. readonly numTargets: number;
  89985. /**
  89986. * Gets the number of influencers (ie. the number of targets with influences > 0)
  89987. */
  89988. readonly numInfluencers: number;
  89989. /**
  89990. * Gets the list of influences (one per target)
  89991. */
  89992. readonly influences: Float32Array;
  89993. /**
  89994. * Gets the active target at specified index. An active target is a target with an influence > 0
  89995. * @param index defines the index to check
  89996. * @returns the requested target
  89997. */
  89998. getActiveTarget(index: number): MorphTarget;
  89999. /**
  90000. * Gets the target at specified index
  90001. * @param index defines the index to check
  90002. * @returns the requested target
  90003. */
  90004. getTarget(index: number): MorphTarget;
  90005. /**
  90006. * Add a new target to this manager
  90007. * @param target defines the target to add
  90008. */
  90009. addTarget(target: MorphTarget): void;
  90010. /**
  90011. * Removes a target from the manager
  90012. * @param target defines the target to remove
  90013. */
  90014. removeTarget(target: MorphTarget): void;
  90015. /**
  90016. * Clone the current manager
  90017. * @returns a new MorphTargetManager
  90018. */
  90019. clone(): MorphTargetManager;
  90020. /**
  90021. * Serializes the current manager into a Serialization object
  90022. * @returns the serialized object
  90023. */
  90024. serialize(): any;
  90025. private _syncActiveTargets;
  90026. /**
  90027. * Syncrhonize the targets with all the meshes using this morph target manager
  90028. */
  90029. synchronize(): void;
  90030. /**
  90031. * Creates a new MorphTargetManager from serialized data
  90032. * @param serializationObject defines the serialized data
  90033. * @param scene defines the hosting scene
  90034. * @returns the new MorphTargetManager
  90035. */
  90036. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  90037. }
  90038. }
  90039. declare module BABYLON {
  90040. /**
  90041. * Class used to represent a specific level of detail of a mesh
  90042. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  90043. */
  90044. export class MeshLODLevel {
  90045. /** Defines the distance where this level should start being displayed */
  90046. distance: number;
  90047. /** Defines the mesh to use to render this level */
  90048. mesh: Nullable<Mesh>;
  90049. /**
  90050. * Creates a new LOD level
  90051. * @param distance defines the distance where this level should star being displayed
  90052. * @param mesh defines the mesh to use to render this level
  90053. */
  90054. constructor(
  90055. /** Defines the distance where this level should start being displayed */
  90056. distance: number,
  90057. /** Defines the mesh to use to render this level */
  90058. mesh: Nullable<Mesh>);
  90059. }
  90060. }
  90061. declare module BABYLON {
  90062. /**
  90063. * Mesh representing the gorund
  90064. */
  90065. export class GroundMesh extends Mesh {
  90066. /** If octree should be generated */
  90067. generateOctree: boolean;
  90068. private _heightQuads;
  90069. /** @hidden */
  90070. _subdivisionsX: number;
  90071. /** @hidden */
  90072. _subdivisionsY: number;
  90073. /** @hidden */
  90074. _width: number;
  90075. /** @hidden */
  90076. _height: number;
  90077. /** @hidden */
  90078. _minX: number;
  90079. /** @hidden */
  90080. _maxX: number;
  90081. /** @hidden */
  90082. _minZ: number;
  90083. /** @hidden */
  90084. _maxZ: number;
  90085. constructor(name: string, scene: Scene);
  90086. /**
  90087. * "GroundMesh"
  90088. * @returns "GroundMesh"
  90089. */
  90090. getClassName(): string;
  90091. /**
  90092. * The minimum of x and y subdivisions
  90093. */
  90094. readonly subdivisions: number;
  90095. /**
  90096. * X subdivisions
  90097. */
  90098. readonly subdivisionsX: number;
  90099. /**
  90100. * Y subdivisions
  90101. */
  90102. readonly subdivisionsY: number;
  90103. /**
  90104. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  90105. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  90106. * @param chunksCount the number of subdivisions for x and y
  90107. * @param octreeBlocksSize (Default: 32)
  90108. */
  90109. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  90110. /**
  90111. * Returns a height (y) value in the Worl system :
  90112. * the ground altitude at the coordinates (x, z) expressed in the World system.
  90113. * @param x x coordinate
  90114. * @param z z coordinate
  90115. * @returns the ground y position if (x, z) are outside the ground surface.
  90116. */
  90117. getHeightAtCoordinates(x: number, z: number): number;
  90118. /**
  90119. * Returns a normalized vector (Vector3) orthogonal to the ground
  90120. * at the ground coordinates (x, z) expressed in the World system.
  90121. * @param x x coordinate
  90122. * @param z z coordinate
  90123. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  90124. */
  90125. getNormalAtCoordinates(x: number, z: number): Vector3;
  90126. /**
  90127. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  90128. * at the ground coordinates (x, z) expressed in the World system.
  90129. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  90130. * @param x x coordinate
  90131. * @param z z coordinate
  90132. * @param ref vector to store the result
  90133. * @returns the GroundMesh.
  90134. */
  90135. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  90136. /**
  90137. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  90138. * if the ground has been updated.
  90139. * This can be used in the render loop.
  90140. * @returns the GroundMesh.
  90141. */
  90142. updateCoordinateHeights(): GroundMesh;
  90143. private _getFacetAt;
  90144. private _initHeightQuads;
  90145. private _computeHeightQuads;
  90146. /**
  90147. * Serializes this ground mesh
  90148. * @param serializationObject object to write serialization to
  90149. */
  90150. serialize(serializationObject: any): void;
  90151. /**
  90152. * Parses a serialized ground mesh
  90153. * @param parsedMesh the serialized mesh
  90154. * @param scene the scene to create the ground mesh in
  90155. * @returns the created ground mesh
  90156. */
  90157. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  90158. }
  90159. }
  90160. declare module BABYLON {
  90161. /**
  90162. * Interface for Physics-Joint data
  90163. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90164. */
  90165. export interface PhysicsJointData {
  90166. /**
  90167. * The main pivot of the joint
  90168. */
  90169. mainPivot?: Vector3;
  90170. /**
  90171. * The connected pivot of the joint
  90172. */
  90173. connectedPivot?: Vector3;
  90174. /**
  90175. * The main axis of the joint
  90176. */
  90177. mainAxis?: Vector3;
  90178. /**
  90179. * The connected axis of the joint
  90180. */
  90181. connectedAxis?: Vector3;
  90182. /**
  90183. * The collision of the joint
  90184. */
  90185. collision?: boolean;
  90186. /**
  90187. * Native Oimo/Cannon/Energy data
  90188. */
  90189. nativeParams?: any;
  90190. }
  90191. /**
  90192. * This is a holder class for the physics joint created by the physics plugin
  90193. * It holds a set of functions to control the underlying joint
  90194. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90195. */
  90196. export class PhysicsJoint {
  90197. /**
  90198. * The type of the physics joint
  90199. */
  90200. type: number;
  90201. /**
  90202. * The data for the physics joint
  90203. */
  90204. jointData: PhysicsJointData;
  90205. private _physicsJoint;
  90206. protected _physicsPlugin: IPhysicsEnginePlugin;
  90207. /**
  90208. * Initializes the physics joint
  90209. * @param type The type of the physics joint
  90210. * @param jointData The data for the physics joint
  90211. */
  90212. constructor(
  90213. /**
  90214. * The type of the physics joint
  90215. */
  90216. type: number,
  90217. /**
  90218. * The data for the physics joint
  90219. */
  90220. jointData: PhysicsJointData);
  90221. /**
  90222. * Gets the physics joint
  90223. */
  90224. /**
  90225. * Sets the physics joint
  90226. */
  90227. physicsJoint: any;
  90228. /**
  90229. * Sets the physics plugin
  90230. */
  90231. physicsPlugin: IPhysicsEnginePlugin;
  90232. /**
  90233. * Execute a function that is physics-plugin specific.
  90234. * @param {Function} func the function that will be executed.
  90235. * It accepts two parameters: the physics world and the physics joint
  90236. */
  90237. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  90238. /**
  90239. * Distance-Joint type
  90240. */
  90241. static DistanceJoint: number;
  90242. /**
  90243. * Hinge-Joint type
  90244. */
  90245. static HingeJoint: number;
  90246. /**
  90247. * Ball-and-Socket joint type
  90248. */
  90249. static BallAndSocketJoint: number;
  90250. /**
  90251. * Wheel-Joint type
  90252. */
  90253. static WheelJoint: number;
  90254. /**
  90255. * Slider-Joint type
  90256. */
  90257. static SliderJoint: number;
  90258. /**
  90259. * Prismatic-Joint type
  90260. */
  90261. static PrismaticJoint: number;
  90262. /**
  90263. * Universal-Joint type
  90264. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  90265. */
  90266. static UniversalJoint: number;
  90267. /**
  90268. * Hinge-Joint 2 type
  90269. */
  90270. static Hinge2Joint: number;
  90271. /**
  90272. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  90273. */
  90274. static PointToPointJoint: number;
  90275. /**
  90276. * Spring-Joint type
  90277. */
  90278. static SpringJoint: number;
  90279. /**
  90280. * Lock-Joint type
  90281. */
  90282. static LockJoint: number;
  90283. }
  90284. /**
  90285. * A class representing a physics distance joint
  90286. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90287. */
  90288. export class DistanceJoint extends PhysicsJoint {
  90289. /**
  90290. *
  90291. * @param jointData The data for the Distance-Joint
  90292. */
  90293. constructor(jointData: DistanceJointData);
  90294. /**
  90295. * Update the predefined distance.
  90296. * @param maxDistance The maximum preferred distance
  90297. * @param minDistance The minimum preferred distance
  90298. */
  90299. updateDistance(maxDistance: number, minDistance?: number): void;
  90300. }
  90301. /**
  90302. * Represents a Motor-Enabled Joint
  90303. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90304. */
  90305. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  90306. /**
  90307. * Initializes the Motor-Enabled Joint
  90308. * @param type The type of the joint
  90309. * @param jointData The physica joint data for the joint
  90310. */
  90311. constructor(type: number, jointData: PhysicsJointData);
  90312. /**
  90313. * Set the motor values.
  90314. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90315. * @param force the force to apply
  90316. * @param maxForce max force for this motor.
  90317. */
  90318. setMotor(force?: number, maxForce?: number): void;
  90319. /**
  90320. * Set the motor's limits.
  90321. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90322. * @param upperLimit The upper limit of the motor
  90323. * @param lowerLimit The lower limit of the motor
  90324. */
  90325. setLimit(upperLimit: number, lowerLimit?: number): void;
  90326. }
  90327. /**
  90328. * This class represents a single physics Hinge-Joint
  90329. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90330. */
  90331. export class HingeJoint extends MotorEnabledJoint {
  90332. /**
  90333. * Initializes the Hinge-Joint
  90334. * @param jointData The joint data for the Hinge-Joint
  90335. */
  90336. constructor(jointData: PhysicsJointData);
  90337. /**
  90338. * Set the motor values.
  90339. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90340. * @param {number} force the force to apply
  90341. * @param {number} maxForce max force for this motor.
  90342. */
  90343. setMotor(force?: number, maxForce?: number): void;
  90344. /**
  90345. * Set the motor's limits.
  90346. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90347. * @param upperLimit The upper limit of the motor
  90348. * @param lowerLimit The lower limit of the motor
  90349. */
  90350. setLimit(upperLimit: number, lowerLimit?: number): void;
  90351. }
  90352. /**
  90353. * This class represents a dual hinge physics joint (same as wheel joint)
  90354. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90355. */
  90356. export class Hinge2Joint extends MotorEnabledJoint {
  90357. /**
  90358. * Initializes the Hinge2-Joint
  90359. * @param jointData The joint data for the Hinge2-Joint
  90360. */
  90361. constructor(jointData: PhysicsJointData);
  90362. /**
  90363. * Set the motor values.
  90364. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90365. * @param {number} targetSpeed the speed the motor is to reach
  90366. * @param {number} maxForce max force for this motor.
  90367. * @param {motorIndex} the motor's index, 0 or 1.
  90368. */
  90369. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  90370. /**
  90371. * Set the motor limits.
  90372. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90373. * @param {number} upperLimit the upper limit
  90374. * @param {number} lowerLimit lower limit
  90375. * @param {motorIndex} the motor's index, 0 or 1.
  90376. */
  90377. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  90378. }
  90379. /**
  90380. * Interface for a motor enabled joint
  90381. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90382. */
  90383. export interface IMotorEnabledJoint {
  90384. /**
  90385. * Physics joint
  90386. */
  90387. physicsJoint: any;
  90388. /**
  90389. * Sets the motor of the motor-enabled joint
  90390. * @param force The force of the motor
  90391. * @param maxForce The maximum force of the motor
  90392. * @param motorIndex The index of the motor
  90393. */
  90394. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  90395. /**
  90396. * Sets the limit of the motor
  90397. * @param upperLimit The upper limit of the motor
  90398. * @param lowerLimit The lower limit of the motor
  90399. * @param motorIndex The index of the motor
  90400. */
  90401. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  90402. }
  90403. /**
  90404. * Joint data for a Distance-Joint
  90405. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90406. */
  90407. export interface DistanceJointData extends PhysicsJointData {
  90408. /**
  90409. * Max distance the 2 joint objects can be apart
  90410. */
  90411. maxDistance: number;
  90412. }
  90413. /**
  90414. * Joint data from a spring joint
  90415. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90416. */
  90417. export interface SpringJointData extends PhysicsJointData {
  90418. /**
  90419. * Length of the spring
  90420. */
  90421. length: number;
  90422. /**
  90423. * Stiffness of the spring
  90424. */
  90425. stiffness: number;
  90426. /**
  90427. * Damping of the spring
  90428. */
  90429. damping: number;
  90430. /** this callback will be called when applying the force to the impostors. */
  90431. forceApplicationCallback: () => void;
  90432. }
  90433. }
  90434. declare module BABYLON {
  90435. /**
  90436. * Holds the data for the raycast result
  90437. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90438. */
  90439. export class PhysicsRaycastResult {
  90440. private _hasHit;
  90441. private _hitDistance;
  90442. private _hitNormalWorld;
  90443. private _hitPointWorld;
  90444. private _rayFromWorld;
  90445. private _rayToWorld;
  90446. /**
  90447. * Gets if there was a hit
  90448. */
  90449. readonly hasHit: boolean;
  90450. /**
  90451. * Gets the distance from the hit
  90452. */
  90453. readonly hitDistance: number;
  90454. /**
  90455. * Gets the hit normal/direction in the world
  90456. */
  90457. readonly hitNormalWorld: Vector3;
  90458. /**
  90459. * Gets the hit point in the world
  90460. */
  90461. readonly hitPointWorld: Vector3;
  90462. /**
  90463. * Gets the ray "start point" of the ray in the world
  90464. */
  90465. readonly rayFromWorld: Vector3;
  90466. /**
  90467. * Gets the ray "end point" of the ray in the world
  90468. */
  90469. readonly rayToWorld: Vector3;
  90470. /**
  90471. * Sets the hit data (normal & point in world space)
  90472. * @param hitNormalWorld defines the normal in world space
  90473. * @param hitPointWorld defines the point in world space
  90474. */
  90475. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  90476. /**
  90477. * Sets the distance from the start point to the hit point
  90478. * @param distance
  90479. */
  90480. setHitDistance(distance: number): void;
  90481. /**
  90482. * Calculates the distance manually
  90483. */
  90484. calculateHitDistance(): void;
  90485. /**
  90486. * Resets all the values to default
  90487. * @param from The from point on world space
  90488. * @param to The to point on world space
  90489. */
  90490. reset(from?: Vector3, to?: Vector3): void;
  90491. }
  90492. /**
  90493. * Interface for the size containing width and height
  90494. */
  90495. interface IXYZ {
  90496. /**
  90497. * X
  90498. */
  90499. x: number;
  90500. /**
  90501. * Y
  90502. */
  90503. y: number;
  90504. /**
  90505. * Z
  90506. */
  90507. z: number;
  90508. }
  90509. }
  90510. declare module BABYLON {
  90511. /**
  90512. * Interface used to describe a physics joint
  90513. */
  90514. export interface PhysicsImpostorJoint {
  90515. /** Defines the main impostor to which the joint is linked */
  90516. mainImpostor: PhysicsImpostor;
  90517. /** Defines the impostor that is connected to the main impostor using this joint */
  90518. connectedImpostor: PhysicsImpostor;
  90519. /** Defines the joint itself */
  90520. joint: PhysicsJoint;
  90521. }
  90522. /** @hidden */
  90523. export interface IPhysicsEnginePlugin {
  90524. world: any;
  90525. name: string;
  90526. setGravity(gravity: Vector3): void;
  90527. setTimeStep(timeStep: number): void;
  90528. getTimeStep(): number;
  90529. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  90530. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  90531. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  90532. generatePhysicsBody(impostor: PhysicsImpostor): void;
  90533. removePhysicsBody(impostor: PhysicsImpostor): void;
  90534. generateJoint(joint: PhysicsImpostorJoint): void;
  90535. removeJoint(joint: PhysicsImpostorJoint): void;
  90536. isSupported(): boolean;
  90537. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  90538. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  90539. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  90540. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  90541. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  90542. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  90543. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  90544. getBodyMass(impostor: PhysicsImpostor): number;
  90545. getBodyFriction(impostor: PhysicsImpostor): number;
  90546. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  90547. getBodyRestitution(impostor: PhysicsImpostor): number;
  90548. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  90549. getBodyPressure?(impostor: PhysicsImpostor): number;
  90550. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  90551. getBodyStiffness?(impostor: PhysicsImpostor): number;
  90552. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  90553. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  90554. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  90555. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  90556. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  90557. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  90558. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  90559. sleepBody(impostor: PhysicsImpostor): void;
  90560. wakeUpBody(impostor: PhysicsImpostor): void;
  90561. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  90562. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  90563. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  90564. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  90565. getRadius(impostor: PhysicsImpostor): number;
  90566. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  90567. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  90568. dispose(): void;
  90569. }
  90570. /**
  90571. * Interface used to define a physics engine
  90572. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  90573. */
  90574. export interface IPhysicsEngine {
  90575. /**
  90576. * Gets the gravity vector used by the simulation
  90577. */
  90578. gravity: Vector3;
  90579. /**
  90580. * Sets the gravity vector used by the simulation
  90581. * @param gravity defines the gravity vector to use
  90582. */
  90583. setGravity(gravity: Vector3): void;
  90584. /**
  90585. * Set the time step of the physics engine.
  90586. * Default is 1/60.
  90587. * To slow it down, enter 1/600 for example.
  90588. * To speed it up, 1/30
  90589. * @param newTimeStep the new timestep to apply to this world.
  90590. */
  90591. setTimeStep(newTimeStep: number): void;
  90592. /**
  90593. * Get the time step of the physics engine.
  90594. * @returns the current time step
  90595. */
  90596. getTimeStep(): number;
  90597. /**
  90598. * Release all resources
  90599. */
  90600. dispose(): void;
  90601. /**
  90602. * Gets the name of the current physics plugin
  90603. * @returns the name of the plugin
  90604. */
  90605. getPhysicsPluginName(): string;
  90606. /**
  90607. * Adding a new impostor for the impostor tracking.
  90608. * This will be done by the impostor itself.
  90609. * @param impostor the impostor to add
  90610. */
  90611. addImpostor(impostor: PhysicsImpostor): void;
  90612. /**
  90613. * Remove an impostor from the engine.
  90614. * This impostor and its mesh will not longer be updated by the physics engine.
  90615. * @param impostor the impostor to remove
  90616. */
  90617. removeImpostor(impostor: PhysicsImpostor): void;
  90618. /**
  90619. * Add a joint to the physics engine
  90620. * @param mainImpostor defines the main impostor to which the joint is added.
  90621. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  90622. * @param joint defines the joint that will connect both impostors.
  90623. */
  90624. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  90625. /**
  90626. * Removes a joint from the simulation
  90627. * @param mainImpostor defines the impostor used with the joint
  90628. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  90629. * @param joint defines the joint to remove
  90630. */
  90631. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  90632. /**
  90633. * Gets the current plugin used to run the simulation
  90634. * @returns current plugin
  90635. */
  90636. getPhysicsPlugin(): IPhysicsEnginePlugin;
  90637. /**
  90638. * Gets the list of physic impostors
  90639. * @returns an array of PhysicsImpostor
  90640. */
  90641. getImpostors(): Array<PhysicsImpostor>;
  90642. /**
  90643. * Gets the impostor for a physics enabled object
  90644. * @param object defines the object impersonated by the impostor
  90645. * @returns the PhysicsImpostor or null if not found
  90646. */
  90647. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  90648. /**
  90649. * Gets the impostor for a physics body object
  90650. * @param body defines physics body used by the impostor
  90651. * @returns the PhysicsImpostor or null if not found
  90652. */
  90653. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  90654. /**
  90655. * Does a raycast in the physics world
  90656. * @param from when should the ray start?
  90657. * @param to when should the ray end?
  90658. * @returns PhysicsRaycastResult
  90659. */
  90660. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  90661. /**
  90662. * Called by the scene. No need to call it.
  90663. * @param delta defines the timespam between frames
  90664. */
  90665. _step(delta: number): void;
  90666. }
  90667. }
  90668. declare module BABYLON {
  90669. /**
  90670. * The interface for the physics imposter parameters
  90671. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90672. */
  90673. export interface PhysicsImpostorParameters {
  90674. /**
  90675. * The mass of the physics imposter
  90676. */
  90677. mass: number;
  90678. /**
  90679. * The friction of the physics imposter
  90680. */
  90681. friction?: number;
  90682. /**
  90683. * The coefficient of restitution of the physics imposter
  90684. */
  90685. restitution?: number;
  90686. /**
  90687. * The native options of the physics imposter
  90688. */
  90689. nativeOptions?: any;
  90690. /**
  90691. * Specifies if the parent should be ignored
  90692. */
  90693. ignoreParent?: boolean;
  90694. /**
  90695. * Specifies if bi-directional transformations should be disabled
  90696. */
  90697. disableBidirectionalTransformation?: boolean;
  90698. /**
  90699. * The pressure inside the physics imposter, soft object only
  90700. */
  90701. pressure?: number;
  90702. /**
  90703. * The stiffness the physics imposter, soft object only
  90704. */
  90705. stiffness?: number;
  90706. /**
  90707. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  90708. */
  90709. velocityIterations?: number;
  90710. /**
  90711. * The number of iterations used in maintaining consistent vertex positions, soft object only
  90712. */
  90713. positionIterations?: number;
  90714. /**
  90715. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  90716. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  90717. * Add to fix multiple points
  90718. */
  90719. fixedPoints?: number;
  90720. /**
  90721. * The collision margin around a soft object
  90722. */
  90723. margin?: number;
  90724. /**
  90725. * The collision margin around a soft object
  90726. */
  90727. damping?: number;
  90728. /**
  90729. * The path for a rope based on an extrusion
  90730. */
  90731. path?: any;
  90732. /**
  90733. * The shape of an extrusion used for a rope based on an extrusion
  90734. */
  90735. shape?: any;
  90736. }
  90737. /**
  90738. * Interface for a physics-enabled object
  90739. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90740. */
  90741. export interface IPhysicsEnabledObject {
  90742. /**
  90743. * The position of the physics-enabled object
  90744. */
  90745. position: Vector3;
  90746. /**
  90747. * The rotation of the physics-enabled object
  90748. */
  90749. rotationQuaternion: Nullable<Quaternion>;
  90750. /**
  90751. * The scale of the physics-enabled object
  90752. */
  90753. scaling: Vector3;
  90754. /**
  90755. * The rotation of the physics-enabled object
  90756. */
  90757. rotation?: Vector3;
  90758. /**
  90759. * The parent of the physics-enabled object
  90760. */
  90761. parent?: any;
  90762. /**
  90763. * The bounding info of the physics-enabled object
  90764. * @returns The bounding info of the physics-enabled object
  90765. */
  90766. getBoundingInfo(): BoundingInfo;
  90767. /**
  90768. * Computes the world matrix
  90769. * @param force Specifies if the world matrix should be computed by force
  90770. * @returns A world matrix
  90771. */
  90772. computeWorldMatrix(force: boolean): Matrix;
  90773. /**
  90774. * Gets the world matrix
  90775. * @returns A world matrix
  90776. */
  90777. getWorldMatrix?(): Matrix;
  90778. /**
  90779. * Gets the child meshes
  90780. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  90781. * @returns An array of abstract meshes
  90782. */
  90783. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  90784. /**
  90785. * Gets the vertex data
  90786. * @param kind The type of vertex data
  90787. * @returns A nullable array of numbers, or a float32 array
  90788. */
  90789. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  90790. /**
  90791. * Gets the indices from the mesh
  90792. * @returns A nullable array of index arrays
  90793. */
  90794. getIndices?(): Nullable<IndicesArray>;
  90795. /**
  90796. * Gets the scene from the mesh
  90797. * @returns the indices array or null
  90798. */
  90799. getScene?(): Scene;
  90800. /**
  90801. * Gets the absolute position from the mesh
  90802. * @returns the absolute position
  90803. */
  90804. getAbsolutePosition(): Vector3;
  90805. /**
  90806. * Gets the absolute pivot point from the mesh
  90807. * @returns the absolute pivot point
  90808. */
  90809. getAbsolutePivotPoint(): Vector3;
  90810. /**
  90811. * Rotates the mesh
  90812. * @param axis The axis of rotation
  90813. * @param amount The amount of rotation
  90814. * @param space The space of the rotation
  90815. * @returns The rotation transform node
  90816. */
  90817. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  90818. /**
  90819. * Translates the mesh
  90820. * @param axis The axis of translation
  90821. * @param distance The distance of translation
  90822. * @param space The space of the translation
  90823. * @returns The transform node
  90824. */
  90825. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  90826. /**
  90827. * Sets the absolute position of the mesh
  90828. * @param absolutePosition The absolute position of the mesh
  90829. * @returns The transform node
  90830. */
  90831. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  90832. /**
  90833. * Gets the class name of the mesh
  90834. * @returns The class name
  90835. */
  90836. getClassName(): string;
  90837. }
  90838. /**
  90839. * Represents a physics imposter
  90840. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90841. */
  90842. export class PhysicsImpostor {
  90843. /**
  90844. * The physics-enabled object used as the physics imposter
  90845. */
  90846. object: IPhysicsEnabledObject;
  90847. /**
  90848. * The type of the physics imposter
  90849. */
  90850. type: number;
  90851. private _options;
  90852. private _scene?;
  90853. /**
  90854. * The default object size of the imposter
  90855. */
  90856. static DEFAULT_OBJECT_SIZE: Vector3;
  90857. /**
  90858. * The identity quaternion of the imposter
  90859. */
  90860. static IDENTITY_QUATERNION: Quaternion;
  90861. /** @hidden */
  90862. _pluginData: any;
  90863. private _physicsEngine;
  90864. private _physicsBody;
  90865. private _bodyUpdateRequired;
  90866. private _onBeforePhysicsStepCallbacks;
  90867. private _onAfterPhysicsStepCallbacks;
  90868. /** @hidden */
  90869. _onPhysicsCollideCallbacks: Array<{
  90870. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  90871. otherImpostors: Array<PhysicsImpostor>;
  90872. }>;
  90873. private _deltaPosition;
  90874. private _deltaRotation;
  90875. private _deltaRotationConjugated;
  90876. /** @hidden */
  90877. _isFromLine: boolean;
  90878. private _parent;
  90879. private _isDisposed;
  90880. private static _tmpVecs;
  90881. private static _tmpQuat;
  90882. /**
  90883. * Specifies if the physics imposter is disposed
  90884. */
  90885. readonly isDisposed: boolean;
  90886. /**
  90887. * Gets the mass of the physics imposter
  90888. */
  90889. mass: number;
  90890. /**
  90891. * Gets the coefficient of friction
  90892. */
  90893. /**
  90894. * Sets the coefficient of friction
  90895. */
  90896. friction: number;
  90897. /**
  90898. * Gets the coefficient of restitution
  90899. */
  90900. /**
  90901. * Sets the coefficient of restitution
  90902. */
  90903. restitution: number;
  90904. /**
  90905. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  90906. */
  90907. /**
  90908. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  90909. */
  90910. pressure: number;
  90911. /**
  90912. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  90913. */
  90914. /**
  90915. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  90916. */
  90917. stiffness: number;
  90918. /**
  90919. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  90920. */
  90921. /**
  90922. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  90923. */
  90924. velocityIterations: number;
  90925. /**
  90926. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  90927. */
  90928. /**
  90929. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  90930. */
  90931. positionIterations: number;
  90932. /**
  90933. * The unique id of the physics imposter
  90934. * set by the physics engine when adding this impostor to the array
  90935. */
  90936. uniqueId: number;
  90937. /**
  90938. * @hidden
  90939. */
  90940. soft: boolean;
  90941. /**
  90942. * @hidden
  90943. */
  90944. segments: number;
  90945. private _joints;
  90946. /**
  90947. * Initializes the physics imposter
  90948. * @param object The physics-enabled object used as the physics imposter
  90949. * @param type The type of the physics imposter
  90950. * @param _options The options for the physics imposter
  90951. * @param _scene The Babylon scene
  90952. */
  90953. constructor(
  90954. /**
  90955. * The physics-enabled object used as the physics imposter
  90956. */
  90957. object: IPhysicsEnabledObject,
  90958. /**
  90959. * The type of the physics imposter
  90960. */
  90961. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  90962. /**
  90963. * This function will completly initialize this impostor.
  90964. * It will create a new body - but only if this mesh has no parent.
  90965. * If it has, this impostor will not be used other than to define the impostor
  90966. * of the child mesh.
  90967. * @hidden
  90968. */
  90969. _init(): void;
  90970. private _getPhysicsParent;
  90971. /**
  90972. * Should a new body be generated.
  90973. * @returns boolean specifying if body initialization is required
  90974. */
  90975. isBodyInitRequired(): boolean;
  90976. /**
  90977. * Sets the updated scaling
  90978. * @param updated Specifies if the scaling is updated
  90979. */
  90980. setScalingUpdated(): void;
  90981. /**
  90982. * Force a regeneration of this or the parent's impostor's body.
  90983. * Use under cautious - This will remove all joints already implemented.
  90984. */
  90985. forceUpdate(): void;
  90986. /**
  90987. * Gets the body that holds this impostor. Either its own, or its parent.
  90988. */
  90989. /**
  90990. * Set the physics body. Used mainly by the physics engine/plugin
  90991. */
  90992. physicsBody: any;
  90993. /**
  90994. * Get the parent of the physics imposter
  90995. * @returns Physics imposter or null
  90996. */
  90997. /**
  90998. * Sets the parent of the physics imposter
  90999. */
  91000. parent: Nullable<PhysicsImpostor>;
  91001. /**
  91002. * Resets the update flags
  91003. */
  91004. resetUpdateFlags(): void;
  91005. /**
  91006. * Gets the object extend size
  91007. * @returns the object extend size
  91008. */
  91009. getObjectExtendSize(): Vector3;
  91010. /**
  91011. * Gets the object center
  91012. * @returns The object center
  91013. */
  91014. getObjectCenter(): Vector3;
  91015. /**
  91016. * Get a specific parametes from the options parameter
  91017. * @param paramName The object parameter name
  91018. * @returns The object parameter
  91019. */
  91020. getParam(paramName: string): any;
  91021. /**
  91022. * Sets a specific parameter in the options given to the physics plugin
  91023. * @param paramName The parameter name
  91024. * @param value The value of the parameter
  91025. */
  91026. setParam(paramName: string, value: number): void;
  91027. /**
  91028. * Specifically change the body's mass option. Won't recreate the physics body object
  91029. * @param mass The mass of the physics imposter
  91030. */
  91031. setMass(mass: number): void;
  91032. /**
  91033. * Gets the linear velocity
  91034. * @returns linear velocity or null
  91035. */
  91036. getLinearVelocity(): Nullable<Vector3>;
  91037. /**
  91038. * Sets the linear velocity
  91039. * @param velocity linear velocity or null
  91040. */
  91041. setLinearVelocity(velocity: Nullable<Vector3>): void;
  91042. /**
  91043. * Gets the angular velocity
  91044. * @returns angular velocity or null
  91045. */
  91046. getAngularVelocity(): Nullable<Vector3>;
  91047. /**
  91048. * Sets the angular velocity
  91049. * @param velocity The velocity or null
  91050. */
  91051. setAngularVelocity(velocity: Nullable<Vector3>): void;
  91052. /**
  91053. * Execute a function with the physics plugin native code
  91054. * Provide a function the will have two variables - the world object and the physics body object
  91055. * @param func The function to execute with the physics plugin native code
  91056. */
  91057. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  91058. /**
  91059. * Register a function that will be executed before the physics world is stepping forward
  91060. * @param func The function to execute before the physics world is stepped forward
  91061. */
  91062. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91063. /**
  91064. * Unregister a function that will be executed before the physics world is stepping forward
  91065. * @param func The function to execute before the physics world is stepped forward
  91066. */
  91067. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91068. /**
  91069. * Register a function that will be executed after the physics step
  91070. * @param func The function to execute after physics step
  91071. */
  91072. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91073. /**
  91074. * Unregisters a function that will be executed after the physics step
  91075. * @param func The function to execute after physics step
  91076. */
  91077. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91078. /**
  91079. * register a function that will be executed when this impostor collides against a different body
  91080. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  91081. * @param func Callback that is executed on collision
  91082. */
  91083. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  91084. /**
  91085. * Unregisters the physics imposter on contact
  91086. * @param collideAgainst The physics object to collide against
  91087. * @param func Callback to execute on collision
  91088. */
  91089. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  91090. private _tmpQuat;
  91091. private _tmpQuat2;
  91092. /**
  91093. * Get the parent rotation
  91094. * @returns The parent rotation
  91095. */
  91096. getParentsRotation(): Quaternion;
  91097. /**
  91098. * this function is executed by the physics engine.
  91099. */
  91100. beforeStep: () => void;
  91101. /**
  91102. * this function is executed by the physics engine
  91103. */
  91104. afterStep: () => void;
  91105. /**
  91106. * Legacy collision detection event support
  91107. */
  91108. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  91109. /**
  91110. * event and body object due to cannon's event-based architecture.
  91111. */
  91112. onCollide: (e: {
  91113. body: any;
  91114. }) => void;
  91115. /**
  91116. * Apply a force
  91117. * @param force The force to apply
  91118. * @param contactPoint The contact point for the force
  91119. * @returns The physics imposter
  91120. */
  91121. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  91122. /**
  91123. * Apply an impulse
  91124. * @param force The impulse force
  91125. * @param contactPoint The contact point for the impulse force
  91126. * @returns The physics imposter
  91127. */
  91128. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  91129. /**
  91130. * A help function to create a joint
  91131. * @param otherImpostor A physics imposter used to create a joint
  91132. * @param jointType The type of joint
  91133. * @param jointData The data for the joint
  91134. * @returns The physics imposter
  91135. */
  91136. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  91137. /**
  91138. * Add a joint to this impostor with a different impostor
  91139. * @param otherImpostor A physics imposter used to add a joint
  91140. * @param joint The joint to add
  91141. * @returns The physics imposter
  91142. */
  91143. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  91144. /**
  91145. * Add an anchor to a cloth impostor
  91146. * @param otherImpostor rigid impostor to anchor to
  91147. * @param width ratio across width from 0 to 1
  91148. * @param height ratio up height from 0 to 1
  91149. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  91150. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  91151. * @returns impostor the soft imposter
  91152. */
  91153. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  91154. /**
  91155. * Add a hook to a rope impostor
  91156. * @param otherImpostor rigid impostor to anchor to
  91157. * @param length ratio across rope from 0 to 1
  91158. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  91159. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  91160. * @returns impostor the rope imposter
  91161. */
  91162. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  91163. /**
  91164. * Will keep this body still, in a sleep mode.
  91165. * @returns the physics imposter
  91166. */
  91167. sleep(): PhysicsImpostor;
  91168. /**
  91169. * Wake the body up.
  91170. * @returns The physics imposter
  91171. */
  91172. wakeUp(): PhysicsImpostor;
  91173. /**
  91174. * Clones the physics imposter
  91175. * @param newObject The physics imposter clones to this physics-enabled object
  91176. * @returns A nullable physics imposter
  91177. */
  91178. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  91179. /**
  91180. * Disposes the physics imposter
  91181. */
  91182. dispose(): void;
  91183. /**
  91184. * Sets the delta position
  91185. * @param position The delta position amount
  91186. */
  91187. setDeltaPosition(position: Vector3): void;
  91188. /**
  91189. * Sets the delta rotation
  91190. * @param rotation The delta rotation amount
  91191. */
  91192. setDeltaRotation(rotation: Quaternion): void;
  91193. /**
  91194. * Gets the box size of the physics imposter and stores the result in the input parameter
  91195. * @param result Stores the box size
  91196. * @returns The physics imposter
  91197. */
  91198. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  91199. /**
  91200. * Gets the radius of the physics imposter
  91201. * @returns Radius of the physics imposter
  91202. */
  91203. getRadius(): number;
  91204. /**
  91205. * Sync a bone with this impostor
  91206. * @param bone The bone to sync to the impostor.
  91207. * @param boneMesh The mesh that the bone is influencing.
  91208. * @param jointPivot The pivot of the joint / bone in local space.
  91209. * @param distToJoint Optional distance from the impostor to the joint.
  91210. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  91211. */
  91212. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  91213. /**
  91214. * Sync impostor to a bone
  91215. * @param bone The bone that the impostor will be synced to.
  91216. * @param boneMesh The mesh that the bone is influencing.
  91217. * @param jointPivot The pivot of the joint / bone in local space.
  91218. * @param distToJoint Optional distance from the impostor to the joint.
  91219. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  91220. * @param boneAxis Optional vector3 axis the bone is aligned with
  91221. */
  91222. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  91223. /**
  91224. * No-Imposter type
  91225. */
  91226. static NoImpostor: number;
  91227. /**
  91228. * Sphere-Imposter type
  91229. */
  91230. static SphereImpostor: number;
  91231. /**
  91232. * Box-Imposter type
  91233. */
  91234. static BoxImpostor: number;
  91235. /**
  91236. * Plane-Imposter type
  91237. */
  91238. static PlaneImpostor: number;
  91239. /**
  91240. * Mesh-imposter type
  91241. */
  91242. static MeshImpostor: number;
  91243. /**
  91244. * Capsule-Impostor type (Ammo.js plugin only)
  91245. */
  91246. static CapsuleImpostor: number;
  91247. /**
  91248. * Cylinder-Imposter type
  91249. */
  91250. static CylinderImpostor: number;
  91251. /**
  91252. * Particle-Imposter type
  91253. */
  91254. static ParticleImpostor: number;
  91255. /**
  91256. * Heightmap-Imposter type
  91257. */
  91258. static HeightmapImpostor: number;
  91259. /**
  91260. * ConvexHull-Impostor type (Ammo.js plugin only)
  91261. */
  91262. static ConvexHullImpostor: number;
  91263. /**
  91264. * Rope-Imposter type
  91265. */
  91266. static RopeImpostor: number;
  91267. /**
  91268. * Cloth-Imposter type
  91269. */
  91270. static ClothImpostor: number;
  91271. /**
  91272. * Softbody-Imposter type
  91273. */
  91274. static SoftbodyImpostor: number;
  91275. }
  91276. }
  91277. declare module BABYLON {
  91278. /**
  91279. * @hidden
  91280. **/
  91281. export class _CreationDataStorage {
  91282. closePath?: boolean;
  91283. closeArray?: boolean;
  91284. idx: number[];
  91285. dashSize: number;
  91286. gapSize: number;
  91287. path3D: Path3D;
  91288. pathArray: Vector3[][];
  91289. arc: number;
  91290. radius: number;
  91291. cap: number;
  91292. tessellation: number;
  91293. }
  91294. /**
  91295. * @hidden
  91296. **/
  91297. class _InstanceDataStorage {
  91298. visibleInstances: any;
  91299. batchCache: _InstancesBatch;
  91300. instancesBufferSize: number;
  91301. instancesBuffer: Nullable<Buffer>;
  91302. instancesData: Float32Array;
  91303. overridenInstanceCount: number;
  91304. isFrozen: boolean;
  91305. previousBatch: Nullable<_InstancesBatch>;
  91306. hardwareInstancedRendering: boolean;
  91307. sideOrientation: number;
  91308. }
  91309. /**
  91310. * @hidden
  91311. **/
  91312. export class _InstancesBatch {
  91313. mustReturn: boolean;
  91314. visibleInstances: Nullable<InstancedMesh[]>[];
  91315. renderSelf: boolean[];
  91316. hardwareInstancedRendering: boolean[];
  91317. }
  91318. /**
  91319. * Class used to represent renderable models
  91320. */
  91321. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  91322. /**
  91323. * Mesh side orientation : usually the external or front surface
  91324. */
  91325. static readonly FRONTSIDE: number;
  91326. /**
  91327. * Mesh side orientation : usually the internal or back surface
  91328. */
  91329. static readonly BACKSIDE: number;
  91330. /**
  91331. * Mesh side orientation : both internal and external or front and back surfaces
  91332. */
  91333. static readonly DOUBLESIDE: number;
  91334. /**
  91335. * Mesh side orientation : by default, `FRONTSIDE`
  91336. */
  91337. static readonly DEFAULTSIDE: number;
  91338. /**
  91339. * Mesh cap setting : no cap
  91340. */
  91341. static readonly NO_CAP: number;
  91342. /**
  91343. * Mesh cap setting : one cap at the beginning of the mesh
  91344. */
  91345. static readonly CAP_START: number;
  91346. /**
  91347. * Mesh cap setting : one cap at the end of the mesh
  91348. */
  91349. static readonly CAP_END: number;
  91350. /**
  91351. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  91352. */
  91353. static readonly CAP_ALL: number;
  91354. /**
  91355. * Mesh pattern setting : no flip or rotate
  91356. */
  91357. static readonly NO_FLIP: number;
  91358. /**
  91359. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  91360. */
  91361. static readonly FLIP_TILE: number;
  91362. /**
  91363. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  91364. */
  91365. static readonly ROTATE_TILE: number;
  91366. /**
  91367. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  91368. */
  91369. static readonly FLIP_ROW: number;
  91370. /**
  91371. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  91372. */
  91373. static readonly ROTATE_ROW: number;
  91374. /**
  91375. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  91376. */
  91377. static readonly FLIP_N_ROTATE_TILE: number;
  91378. /**
  91379. * Mesh pattern setting : rotate pattern and rotate
  91380. */
  91381. static readonly FLIP_N_ROTATE_ROW: number;
  91382. /**
  91383. * Mesh tile positioning : part tiles same on left/right or top/bottom
  91384. */
  91385. static readonly CENTER: number;
  91386. /**
  91387. * Mesh tile positioning : part tiles on left
  91388. */
  91389. static readonly LEFT: number;
  91390. /**
  91391. * Mesh tile positioning : part tiles on right
  91392. */
  91393. static readonly RIGHT: number;
  91394. /**
  91395. * Mesh tile positioning : part tiles on top
  91396. */
  91397. static readonly TOP: number;
  91398. /**
  91399. * Mesh tile positioning : part tiles on bottom
  91400. */
  91401. static readonly BOTTOM: number;
  91402. /**
  91403. * Gets the default side orientation.
  91404. * @param orientation the orientation to value to attempt to get
  91405. * @returns the default orientation
  91406. * @hidden
  91407. */
  91408. static _GetDefaultSideOrientation(orientation?: number): number;
  91409. private _internalMeshDataInfo;
  91410. /**
  91411. * An event triggered before rendering the mesh
  91412. */
  91413. readonly onBeforeRenderObservable: Observable<Mesh>;
  91414. /**
  91415. * An event triggered before binding the mesh
  91416. */
  91417. readonly onBeforeBindObservable: Observable<Mesh>;
  91418. /**
  91419. * An event triggered after rendering the mesh
  91420. */
  91421. readonly onAfterRenderObservable: Observable<Mesh>;
  91422. /**
  91423. * An event triggered before drawing the mesh
  91424. */
  91425. readonly onBeforeDrawObservable: Observable<Mesh>;
  91426. private _onBeforeDrawObserver;
  91427. /**
  91428. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  91429. */
  91430. onBeforeDraw: () => void;
  91431. readonly hasInstances: boolean;
  91432. /**
  91433. * Gets the delay loading state of the mesh (when delay loading is turned on)
  91434. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  91435. */
  91436. delayLoadState: number;
  91437. /**
  91438. * Gets the list of instances created from this mesh
  91439. * it is not supposed to be modified manually.
  91440. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  91441. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  91442. */
  91443. instances: InstancedMesh[];
  91444. /**
  91445. * Gets the file containing delay loading data for this mesh
  91446. */
  91447. delayLoadingFile: string;
  91448. /** @hidden */
  91449. _binaryInfo: any;
  91450. /**
  91451. * User defined function used to change how LOD level selection is done
  91452. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  91453. */
  91454. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  91455. /**
  91456. * Gets or sets the morph target manager
  91457. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  91458. */
  91459. morphTargetManager: Nullable<MorphTargetManager>;
  91460. /** @hidden */
  91461. _creationDataStorage: Nullable<_CreationDataStorage>;
  91462. /** @hidden */
  91463. _geometry: Nullable<Geometry>;
  91464. /** @hidden */
  91465. _delayInfo: Array<string>;
  91466. /** @hidden */
  91467. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  91468. /** @hidden */
  91469. _instanceDataStorage: _InstanceDataStorage;
  91470. private _effectiveMaterial;
  91471. /** @hidden */
  91472. _shouldGenerateFlatShading: boolean;
  91473. /** @hidden */
  91474. _originalBuilderSideOrientation: number;
  91475. /**
  91476. * Use this property to change the original side orientation defined at construction time
  91477. */
  91478. overrideMaterialSideOrientation: Nullable<number>;
  91479. /**
  91480. * Gets the source mesh (the one used to clone this one from)
  91481. */
  91482. readonly source: Nullable<Mesh>;
  91483. /**
  91484. * Gets or sets a boolean indicating that this mesh does not use index buffer
  91485. */
  91486. isUnIndexed: boolean;
  91487. /**
  91488. * @constructor
  91489. * @param name The value used by scene.getMeshByName() to do a lookup.
  91490. * @param scene The scene to add this mesh to.
  91491. * @param parent The parent of this mesh, if it has one
  91492. * @param source An optional Mesh from which geometry is shared, cloned.
  91493. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  91494. * When false, achieved by calling a clone(), also passing False.
  91495. * This will make creation of children, recursive.
  91496. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  91497. */
  91498. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  91499. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  91500. doNotInstantiate: boolean;
  91501. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  91502. /**
  91503. * Gets the class name
  91504. * @returns the string "Mesh".
  91505. */
  91506. getClassName(): string;
  91507. /** @hidden */
  91508. readonly _isMesh: boolean;
  91509. /**
  91510. * Returns a description of this mesh
  91511. * @param fullDetails define if full details about this mesh must be used
  91512. * @returns a descriptive string representing this mesh
  91513. */
  91514. toString(fullDetails?: boolean): string;
  91515. /** @hidden */
  91516. _unBindEffect(): void;
  91517. /**
  91518. * Gets a boolean indicating if this mesh has LOD
  91519. */
  91520. readonly hasLODLevels: boolean;
  91521. /**
  91522. * Gets the list of MeshLODLevel associated with the current mesh
  91523. * @returns an array of MeshLODLevel
  91524. */
  91525. getLODLevels(): MeshLODLevel[];
  91526. private _sortLODLevels;
  91527. /**
  91528. * Add a mesh as LOD level triggered at the given distance.
  91529. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  91530. * @param distance The distance from the center of the object to show this level
  91531. * @param mesh The mesh to be added as LOD level (can be null)
  91532. * @return This mesh (for chaining)
  91533. */
  91534. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  91535. /**
  91536. * Returns the LOD level mesh at the passed distance or null if not found.
  91537. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  91538. * @param distance The distance from the center of the object to show this level
  91539. * @returns a Mesh or `null`
  91540. */
  91541. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  91542. /**
  91543. * Remove a mesh from the LOD array
  91544. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  91545. * @param mesh defines the mesh to be removed
  91546. * @return This mesh (for chaining)
  91547. */
  91548. removeLODLevel(mesh: Mesh): Mesh;
  91549. /**
  91550. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  91551. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  91552. * @param camera defines the camera to use to compute distance
  91553. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  91554. * @return This mesh (for chaining)
  91555. */
  91556. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  91557. /**
  91558. * Gets the mesh internal Geometry object
  91559. */
  91560. readonly geometry: Nullable<Geometry>;
  91561. /**
  91562. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  91563. * @returns the total number of vertices
  91564. */
  91565. getTotalVertices(): number;
  91566. /**
  91567. * Returns the content of an associated vertex buffer
  91568. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  91569. * - VertexBuffer.PositionKind
  91570. * - VertexBuffer.UVKind
  91571. * - VertexBuffer.UV2Kind
  91572. * - VertexBuffer.UV3Kind
  91573. * - VertexBuffer.UV4Kind
  91574. * - VertexBuffer.UV5Kind
  91575. * - VertexBuffer.UV6Kind
  91576. * - VertexBuffer.ColorKind
  91577. * - VertexBuffer.MatricesIndicesKind
  91578. * - VertexBuffer.MatricesIndicesExtraKind
  91579. * - VertexBuffer.MatricesWeightsKind
  91580. * - VertexBuffer.MatricesWeightsExtraKind
  91581. * @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
  91582. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  91583. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  91584. */
  91585. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  91586. /**
  91587. * Returns the mesh VertexBuffer object from the requested `kind`
  91588. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  91589. * - VertexBuffer.PositionKind
  91590. * - VertexBuffer.NormalKind
  91591. * - VertexBuffer.UVKind
  91592. * - VertexBuffer.UV2Kind
  91593. * - VertexBuffer.UV3Kind
  91594. * - VertexBuffer.UV4Kind
  91595. * - VertexBuffer.UV5Kind
  91596. * - VertexBuffer.UV6Kind
  91597. * - VertexBuffer.ColorKind
  91598. * - VertexBuffer.MatricesIndicesKind
  91599. * - VertexBuffer.MatricesIndicesExtraKind
  91600. * - VertexBuffer.MatricesWeightsKind
  91601. * - VertexBuffer.MatricesWeightsExtraKind
  91602. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  91603. */
  91604. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  91605. /**
  91606. * Tests if a specific vertex buffer is associated with this mesh
  91607. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  91608. * - VertexBuffer.PositionKind
  91609. * - VertexBuffer.NormalKind
  91610. * - VertexBuffer.UVKind
  91611. * - VertexBuffer.UV2Kind
  91612. * - VertexBuffer.UV3Kind
  91613. * - VertexBuffer.UV4Kind
  91614. * - VertexBuffer.UV5Kind
  91615. * - VertexBuffer.UV6Kind
  91616. * - VertexBuffer.ColorKind
  91617. * - VertexBuffer.MatricesIndicesKind
  91618. * - VertexBuffer.MatricesIndicesExtraKind
  91619. * - VertexBuffer.MatricesWeightsKind
  91620. * - VertexBuffer.MatricesWeightsExtraKind
  91621. * @returns a boolean
  91622. */
  91623. isVerticesDataPresent(kind: string): boolean;
  91624. /**
  91625. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  91626. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  91627. * - VertexBuffer.PositionKind
  91628. * - VertexBuffer.UVKind
  91629. * - VertexBuffer.UV2Kind
  91630. * - VertexBuffer.UV3Kind
  91631. * - VertexBuffer.UV4Kind
  91632. * - VertexBuffer.UV5Kind
  91633. * - VertexBuffer.UV6Kind
  91634. * - VertexBuffer.ColorKind
  91635. * - VertexBuffer.MatricesIndicesKind
  91636. * - VertexBuffer.MatricesIndicesExtraKind
  91637. * - VertexBuffer.MatricesWeightsKind
  91638. * - VertexBuffer.MatricesWeightsExtraKind
  91639. * @returns a boolean
  91640. */
  91641. isVertexBufferUpdatable(kind: string): boolean;
  91642. /**
  91643. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  91644. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  91645. * - VertexBuffer.PositionKind
  91646. * - VertexBuffer.NormalKind
  91647. * - VertexBuffer.UVKind
  91648. * - VertexBuffer.UV2Kind
  91649. * - VertexBuffer.UV3Kind
  91650. * - VertexBuffer.UV4Kind
  91651. * - VertexBuffer.UV5Kind
  91652. * - VertexBuffer.UV6Kind
  91653. * - VertexBuffer.ColorKind
  91654. * - VertexBuffer.MatricesIndicesKind
  91655. * - VertexBuffer.MatricesIndicesExtraKind
  91656. * - VertexBuffer.MatricesWeightsKind
  91657. * - VertexBuffer.MatricesWeightsExtraKind
  91658. * @returns an array of strings
  91659. */
  91660. getVerticesDataKinds(): string[];
  91661. /**
  91662. * Returns a positive integer : the total number of indices in this mesh geometry.
  91663. * @returns the numner of indices or zero if the mesh has no geometry.
  91664. */
  91665. getTotalIndices(): number;
  91666. /**
  91667. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  91668. * @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.
  91669. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  91670. * @returns the indices array or an empty array if the mesh has no geometry
  91671. */
  91672. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  91673. readonly isBlocked: boolean;
  91674. /**
  91675. * Determine if the current mesh is ready to be rendered
  91676. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  91677. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  91678. * @returns true if all associated assets are ready (material, textures, shaders)
  91679. */
  91680. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  91681. /**
  91682. * 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.
  91683. */
  91684. readonly areNormalsFrozen: boolean;
  91685. /**
  91686. * 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.
  91687. * @returns the current mesh
  91688. */
  91689. freezeNormals(): Mesh;
  91690. /**
  91691. * 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
  91692. * @returns the current mesh
  91693. */
  91694. unfreezeNormals(): Mesh;
  91695. /**
  91696. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  91697. */
  91698. overridenInstanceCount: number;
  91699. /** @hidden */
  91700. _preActivate(): Mesh;
  91701. /** @hidden */
  91702. _preActivateForIntermediateRendering(renderId: number): Mesh;
  91703. /** @hidden */
  91704. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  91705. /**
  91706. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  91707. * This means the mesh underlying bounding box and sphere are recomputed.
  91708. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  91709. * @returns the current mesh
  91710. */
  91711. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  91712. /** @hidden */
  91713. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  91714. /**
  91715. * This function will subdivide the mesh into multiple submeshes
  91716. * @param count defines the expected number of submeshes
  91717. */
  91718. subdivide(count: number): void;
  91719. /**
  91720. * Copy a FloatArray into a specific associated vertex buffer
  91721. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  91722. * - VertexBuffer.PositionKind
  91723. * - VertexBuffer.UVKind
  91724. * - VertexBuffer.UV2Kind
  91725. * - VertexBuffer.UV3Kind
  91726. * - VertexBuffer.UV4Kind
  91727. * - VertexBuffer.UV5Kind
  91728. * - VertexBuffer.UV6Kind
  91729. * - VertexBuffer.ColorKind
  91730. * - VertexBuffer.MatricesIndicesKind
  91731. * - VertexBuffer.MatricesIndicesExtraKind
  91732. * - VertexBuffer.MatricesWeightsKind
  91733. * - VertexBuffer.MatricesWeightsExtraKind
  91734. * @param data defines the data source
  91735. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  91736. * @param stride defines the data stride size (can be null)
  91737. * @returns the current mesh
  91738. */
  91739. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  91740. /**
  91741. * Delete a vertex buffer associated with this mesh
  91742. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  91743. * - VertexBuffer.PositionKind
  91744. * - VertexBuffer.UVKind
  91745. * - VertexBuffer.UV2Kind
  91746. * - VertexBuffer.UV3Kind
  91747. * - VertexBuffer.UV4Kind
  91748. * - VertexBuffer.UV5Kind
  91749. * - VertexBuffer.UV6Kind
  91750. * - VertexBuffer.ColorKind
  91751. * - VertexBuffer.MatricesIndicesKind
  91752. * - VertexBuffer.MatricesIndicesExtraKind
  91753. * - VertexBuffer.MatricesWeightsKind
  91754. * - VertexBuffer.MatricesWeightsExtraKind
  91755. */
  91756. removeVerticesData(kind: string): void;
  91757. /**
  91758. * Flags an associated vertex buffer as updatable
  91759. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  91760. * - VertexBuffer.PositionKind
  91761. * - VertexBuffer.UVKind
  91762. * - VertexBuffer.UV2Kind
  91763. * - VertexBuffer.UV3Kind
  91764. * - VertexBuffer.UV4Kind
  91765. * - VertexBuffer.UV5Kind
  91766. * - VertexBuffer.UV6Kind
  91767. * - VertexBuffer.ColorKind
  91768. * - VertexBuffer.MatricesIndicesKind
  91769. * - VertexBuffer.MatricesIndicesExtraKind
  91770. * - VertexBuffer.MatricesWeightsKind
  91771. * - VertexBuffer.MatricesWeightsExtraKind
  91772. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  91773. */
  91774. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  91775. /**
  91776. * Sets the mesh global Vertex Buffer
  91777. * @param buffer defines the buffer to use
  91778. * @returns the current mesh
  91779. */
  91780. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  91781. /**
  91782. * Update a specific associated vertex buffer
  91783. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  91784. * - VertexBuffer.PositionKind
  91785. * - VertexBuffer.UVKind
  91786. * - VertexBuffer.UV2Kind
  91787. * - VertexBuffer.UV3Kind
  91788. * - VertexBuffer.UV4Kind
  91789. * - VertexBuffer.UV5Kind
  91790. * - VertexBuffer.UV6Kind
  91791. * - VertexBuffer.ColorKind
  91792. * - VertexBuffer.MatricesIndicesKind
  91793. * - VertexBuffer.MatricesIndicesExtraKind
  91794. * - VertexBuffer.MatricesWeightsKind
  91795. * - VertexBuffer.MatricesWeightsExtraKind
  91796. * @param data defines the data source
  91797. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  91798. * @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)
  91799. * @returns the current mesh
  91800. */
  91801. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  91802. /**
  91803. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  91804. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  91805. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  91806. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  91807. * @returns the current mesh
  91808. */
  91809. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  91810. /**
  91811. * Creates a un-shared specific occurence of the geometry for the mesh.
  91812. * @returns the current mesh
  91813. */
  91814. makeGeometryUnique(): Mesh;
  91815. /**
  91816. * Set the index buffer of this mesh
  91817. * @param indices defines the source data
  91818. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  91819. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  91820. * @returns the current mesh
  91821. */
  91822. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  91823. /**
  91824. * Update the current index buffer
  91825. * @param indices defines the source data
  91826. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  91827. * @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)
  91828. * @returns the current mesh
  91829. */
  91830. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  91831. /**
  91832. * Invert the geometry to move from a right handed system to a left handed one.
  91833. * @returns the current mesh
  91834. */
  91835. toLeftHanded(): Mesh;
  91836. /** @hidden */
  91837. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  91838. /** @hidden */
  91839. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  91840. /**
  91841. * Registers for this mesh a javascript function called just before the rendering process
  91842. * @param func defines the function to call before rendering this mesh
  91843. * @returns the current mesh
  91844. */
  91845. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  91846. /**
  91847. * Disposes a previously registered javascript function called before the rendering
  91848. * @param func defines the function to remove
  91849. * @returns the current mesh
  91850. */
  91851. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  91852. /**
  91853. * Registers for this mesh a javascript function called just after the rendering is complete
  91854. * @param func defines the function to call after rendering this mesh
  91855. * @returns the current mesh
  91856. */
  91857. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  91858. /**
  91859. * Disposes a previously registered javascript function called after the rendering.
  91860. * @param func defines the function to remove
  91861. * @returns the current mesh
  91862. */
  91863. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  91864. /** @hidden */
  91865. _getInstancesRenderList(subMeshId: number): _InstancesBatch;
  91866. /** @hidden */
  91867. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  91868. /** @hidden */
  91869. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  91870. /** @hidden */
  91871. _processRendering(subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  91872. /** @hidden */
  91873. _rebuild(): void;
  91874. /** @hidden */
  91875. _freeze(): void;
  91876. /** @hidden */
  91877. _unFreeze(): void;
  91878. /**
  91879. * 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
  91880. * @param subMesh defines the subMesh to render
  91881. * @param enableAlphaMode defines if alpha mode can be changed
  91882. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  91883. * @returns the current mesh
  91884. */
  91885. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  91886. private _onBeforeDraw;
  91887. /**
  91888. * Renormalize the mesh and patch it up if there are no weights
  91889. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  91890. * However in the case of zero weights then we set just a single influence to 1.
  91891. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  91892. */
  91893. cleanMatrixWeights(): void;
  91894. private normalizeSkinFourWeights;
  91895. private normalizeSkinWeightsAndExtra;
  91896. /**
  91897. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  91898. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  91899. * the user know there was an issue with importing the mesh
  91900. * @returns a validation object with skinned, valid and report string
  91901. */
  91902. validateSkinning(): {
  91903. skinned: boolean;
  91904. valid: boolean;
  91905. report: string;
  91906. };
  91907. /** @hidden */
  91908. _checkDelayState(): Mesh;
  91909. private _queueLoad;
  91910. /**
  91911. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  91912. * A mesh is in the frustum if its bounding box intersects the frustum
  91913. * @param frustumPlanes defines the frustum to test
  91914. * @returns true if the mesh is in the frustum planes
  91915. */
  91916. isInFrustum(frustumPlanes: Plane[]): boolean;
  91917. /**
  91918. * Sets the mesh material by the material or multiMaterial `id` property
  91919. * @param id is a string identifying the material or the multiMaterial
  91920. * @returns the current mesh
  91921. */
  91922. setMaterialByID(id: string): Mesh;
  91923. /**
  91924. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  91925. * @returns an array of IAnimatable
  91926. */
  91927. getAnimatables(): IAnimatable[];
  91928. /**
  91929. * Modifies the mesh geometry according to the passed transformation matrix.
  91930. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  91931. * The mesh normals are modified using the same transformation.
  91932. * Note that, under the hood, this method sets a new VertexBuffer each call.
  91933. * @param transform defines the transform matrix to use
  91934. * @see http://doc.babylonjs.com/resources/baking_transformations
  91935. * @returns the current mesh
  91936. */
  91937. bakeTransformIntoVertices(transform: Matrix): Mesh;
  91938. /**
  91939. * Modifies the mesh geometry according to its own current World Matrix.
  91940. * The mesh World Matrix is then reset.
  91941. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  91942. * Note that, under the hood, this method sets a new VertexBuffer each call.
  91943. * @see http://doc.babylonjs.com/resources/baking_transformations
  91944. * @returns the current mesh
  91945. */
  91946. bakeCurrentTransformIntoVertices(): Mesh;
  91947. /** @hidden */
  91948. readonly _positions: Nullable<Vector3[]>;
  91949. /** @hidden */
  91950. _resetPointsArrayCache(): Mesh;
  91951. /** @hidden */
  91952. _generatePointsArray(): boolean;
  91953. /**
  91954. * Returns a new Mesh object generated from the current mesh properties.
  91955. * This method must not get confused with createInstance()
  91956. * @param name is a string, the name given to the new mesh
  91957. * @param newParent can be any Node object (default `null`)
  91958. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  91959. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  91960. * @returns a new mesh
  91961. */
  91962. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Nullable<AbstractMesh>;
  91963. /**
  91964. * Releases resources associated with this mesh.
  91965. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  91966. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  91967. */
  91968. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  91969. /** @hidden */
  91970. _disposeInstanceSpecificData(): void;
  91971. /**
  91972. * Modifies the mesh geometry according to a displacement map.
  91973. * 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.
  91974. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  91975. * @param url is a string, the URL from the image file is to be downloaded.
  91976. * @param minHeight is the lower limit of the displacement.
  91977. * @param maxHeight is the upper limit of the displacement.
  91978. * @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.
  91979. * @param uvOffset is an optional vector2 used to offset UV.
  91980. * @param uvScale is an optional vector2 used to scale UV.
  91981. * @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.
  91982. * @returns the Mesh.
  91983. */
  91984. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  91985. /**
  91986. * Modifies the mesh geometry according to a displacementMap buffer.
  91987. * 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.
  91988. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  91989. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  91990. * @param heightMapWidth is the width of the buffer image.
  91991. * @param heightMapHeight is the height of the buffer image.
  91992. * @param minHeight is the lower limit of the displacement.
  91993. * @param maxHeight is the upper limit of the displacement.
  91994. * @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.
  91995. * @param uvOffset is an optional vector2 used to offset UV.
  91996. * @param uvScale is an optional vector2 used to scale UV.
  91997. * @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.
  91998. * @returns the Mesh.
  91999. */
  92000. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  92001. /**
  92002. * Modify the mesh to get a flat shading rendering.
  92003. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  92004. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  92005. * @returns current mesh
  92006. */
  92007. convertToFlatShadedMesh(): Mesh;
  92008. /**
  92009. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  92010. * In other words, more vertices, no more indices and a single bigger VBO.
  92011. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  92012. * @returns current mesh
  92013. */
  92014. convertToUnIndexedMesh(): Mesh;
  92015. /**
  92016. * Inverses facet orientations.
  92017. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92018. * @param flipNormals will also inverts the normals
  92019. * @returns current mesh
  92020. */
  92021. flipFaces(flipNormals?: boolean): Mesh;
  92022. /**
  92023. * Increase the number of facets and hence vertices in a mesh
  92024. * Vertex normals are interpolated from existing vertex normals
  92025. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92026. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  92027. */
  92028. increaseVertices(numberPerEdge: number): void;
  92029. /**
  92030. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  92031. * This will undo any application of covertToFlatShadedMesh
  92032. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92033. */
  92034. forceSharedVertices(): void;
  92035. /** @hidden */
  92036. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  92037. /** @hidden */
  92038. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  92039. /**
  92040. * Creates a new InstancedMesh object from the mesh model.
  92041. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  92042. * @param name defines the name of the new instance
  92043. * @returns a new InstancedMesh
  92044. */
  92045. createInstance(name: string): InstancedMesh;
  92046. /**
  92047. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  92048. * After this call, all the mesh instances have the same submeshes than the current mesh.
  92049. * @returns the current mesh
  92050. */
  92051. synchronizeInstances(): Mesh;
  92052. /**
  92053. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  92054. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  92055. * This should be used together with the simplification to avoid disappearing triangles.
  92056. * @param successCallback an optional success callback to be called after the optimization finished.
  92057. * @returns the current mesh
  92058. */
  92059. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  92060. /**
  92061. * Serialize current mesh
  92062. * @param serializationObject defines the object which will receive the serialization data
  92063. */
  92064. serialize(serializationObject: any): void;
  92065. /** @hidden */
  92066. _syncGeometryWithMorphTargetManager(): void;
  92067. /** @hidden */
  92068. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  92069. /**
  92070. * Returns a new Mesh object parsed from the source provided.
  92071. * @param parsedMesh is the source
  92072. * @param scene defines the hosting scene
  92073. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  92074. * @returns a new Mesh
  92075. */
  92076. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  92077. /**
  92078. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  92079. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  92080. * @param name defines the name of the mesh to create
  92081. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  92082. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  92083. * @param closePath creates a seam between the first and the last points of each path of the path array
  92084. * @param offset is taken in account only if the `pathArray` is containing a single path
  92085. * @param scene defines the hosting scene
  92086. * @param updatable defines if the mesh must be flagged as updatable
  92087. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92088. * @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)
  92089. * @returns a new Mesh
  92090. */
  92091. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  92092. /**
  92093. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  92094. * @param name defines the name of the mesh to create
  92095. * @param radius sets the radius size (float) of the polygon (default 0.5)
  92096. * @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
  92097. * @param scene defines the hosting scene
  92098. * @param updatable defines if the mesh must be flagged as updatable
  92099. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92100. * @returns a new Mesh
  92101. */
  92102. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  92103. /**
  92104. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  92105. * @param name defines the name of the mesh to create
  92106. * @param size sets the size (float) of each box side (default 1)
  92107. * @param scene defines the hosting scene
  92108. * @param updatable defines if the mesh must be flagged as updatable
  92109. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92110. * @returns a new Mesh
  92111. */
  92112. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  92113. /**
  92114. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  92115. * @param name defines the name of the mesh to create
  92116. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  92117. * @param diameter sets the diameter size (float) of the sphere (default 1)
  92118. * @param scene defines the hosting scene
  92119. * @param updatable defines if the mesh must be flagged as updatable
  92120. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92121. * @returns a new Mesh
  92122. */
  92123. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92124. /**
  92125. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  92126. * @param name defines the name of the mesh to create
  92127. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  92128. * @param diameter sets the diameter size (float) of the sphere (default 1)
  92129. * @param scene defines the hosting scene
  92130. * @returns a new Mesh
  92131. */
  92132. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  92133. /**
  92134. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  92135. * @param name defines the name of the mesh to create
  92136. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  92137. * @param diameterTop set the top cap diameter (floats, default 1)
  92138. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  92139. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  92140. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  92141. * @param scene defines the hosting scene
  92142. * @param updatable defines if the mesh must be flagged as updatable
  92143. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92144. * @returns a new Mesh
  92145. */
  92146. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  92147. /**
  92148. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  92149. * @param name defines the name of the mesh to create
  92150. * @param diameter sets the diameter size (float) of the torus (default 1)
  92151. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  92152. * @param tessellation sets the number of torus sides (postive integer, default 16)
  92153. * @param scene defines the hosting scene
  92154. * @param updatable defines if the mesh must be flagged as updatable
  92155. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92156. * @returns a new Mesh
  92157. */
  92158. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92159. /**
  92160. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  92161. * @param name defines the name of the mesh to create
  92162. * @param radius sets the global radius size (float) of the torus knot (default 2)
  92163. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  92164. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  92165. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  92166. * @param p the number of windings on X axis (positive integers, default 2)
  92167. * @param q the number of windings on Y axis (positive integers, default 3)
  92168. * @param scene defines the hosting scene
  92169. * @param updatable defines if the mesh must be flagged as updatable
  92170. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92171. * @returns a new Mesh
  92172. */
  92173. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92174. /**
  92175. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  92176. * @param name defines the name of the mesh to create
  92177. * @param points is an array successive Vector3
  92178. * @param scene defines the hosting scene
  92179. * @param updatable defines if the mesh must be flagged as updatable
  92180. * @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).
  92181. * @returns a new Mesh
  92182. */
  92183. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  92184. /**
  92185. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  92186. * @param name defines the name of the mesh to create
  92187. * @param points is an array successive Vector3
  92188. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  92189. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  92190. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  92191. * @param scene defines the hosting scene
  92192. * @param updatable defines if the mesh must be flagged as updatable
  92193. * @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)
  92194. * @returns a new Mesh
  92195. */
  92196. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  92197. /**
  92198. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  92199. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  92200. * 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.
  92201. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  92202. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  92203. * Remember you can only change the shape positions, not their number when updating a polygon.
  92204. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  92205. * @param name defines the name of the mesh to create
  92206. * @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
  92207. * @param scene defines the hosting scene
  92208. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  92209. * @param updatable defines if the mesh must be flagged as updatable
  92210. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92211. * @param earcutInjection can be used to inject your own earcut reference
  92212. * @returns a new Mesh
  92213. */
  92214. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  92215. /**
  92216. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  92217. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  92218. * @param name defines the name of the mesh to create
  92219. * @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
  92220. * @param depth defines the height of extrusion
  92221. * @param scene defines the hosting scene
  92222. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  92223. * @param updatable defines if the mesh must be flagged as updatable
  92224. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92225. * @param earcutInjection can be used to inject your own earcut reference
  92226. * @returns a new Mesh
  92227. */
  92228. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  92229. /**
  92230. * Creates an extruded shape mesh.
  92231. * 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
  92232. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  92233. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  92234. * @param name defines the name of the mesh to create
  92235. * @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
  92236. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  92237. * @param scale is the value to scale the shape
  92238. * @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
  92239. * @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
  92240. * @param scene defines the hosting scene
  92241. * @param updatable defines if the mesh must be flagged as updatable
  92242. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92243. * @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)
  92244. * @returns a new Mesh
  92245. */
  92246. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  92247. /**
  92248. * Creates an custom extruded shape mesh.
  92249. * The custom extrusion is a parametric shape.
  92250. * It has no predefined shape. Its final shape will depend on the input parameters.
  92251. * Please consider using the same method from the MeshBuilder class instead
  92252. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  92253. * @param name defines the name of the mesh to create
  92254. * @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
  92255. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  92256. * @param scaleFunction is a custom Javascript function called on each path point
  92257. * @param rotationFunction is a custom Javascript function called on each path point
  92258. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  92259. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  92260. * @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
  92261. * @param scene defines the hosting scene
  92262. * @param updatable defines if the mesh must be flagged as updatable
  92263. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92264. * @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)
  92265. * @returns a new Mesh
  92266. */
  92267. 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;
  92268. /**
  92269. * Creates lathe mesh.
  92270. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  92271. * Please consider using the same method from the MeshBuilder class instead
  92272. * @param name defines the name of the mesh to create
  92273. * @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
  92274. * @param radius is the radius value of the lathe
  92275. * @param tessellation is the side number of the lathe.
  92276. * @param scene defines the hosting scene
  92277. * @param updatable defines if the mesh must be flagged as updatable
  92278. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92279. * @returns a new Mesh
  92280. */
  92281. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92282. /**
  92283. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  92284. * @param name defines the name of the mesh to create
  92285. * @param size sets the size (float) of both sides of the plane at once (default 1)
  92286. * @param scene defines the hosting scene
  92287. * @param updatable defines if the mesh must be flagged as updatable
  92288. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92289. * @returns a new Mesh
  92290. */
  92291. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92292. /**
  92293. * Creates a ground mesh.
  92294. * Please consider using the same method from the MeshBuilder class instead
  92295. * @param name defines the name of the mesh to create
  92296. * @param width set the width of the ground
  92297. * @param height set the height of the ground
  92298. * @param subdivisions sets the number of subdivisions per side
  92299. * @param scene defines the hosting scene
  92300. * @param updatable defines if the mesh must be flagged as updatable
  92301. * @returns a new Mesh
  92302. */
  92303. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  92304. /**
  92305. * Creates a tiled ground mesh.
  92306. * Please consider using the same method from the MeshBuilder class instead
  92307. * @param name defines the name of the mesh to create
  92308. * @param xmin set the ground minimum X coordinate
  92309. * @param zmin set the ground minimum Y coordinate
  92310. * @param xmax set the ground maximum X coordinate
  92311. * @param zmax set the ground maximum Z coordinate
  92312. * @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
  92313. * @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
  92314. * @param scene defines the hosting scene
  92315. * @param updatable defines if the mesh must be flagged as updatable
  92316. * @returns a new Mesh
  92317. */
  92318. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  92319. w: number;
  92320. h: number;
  92321. }, precision: {
  92322. w: number;
  92323. h: number;
  92324. }, scene: Scene, updatable?: boolean): Mesh;
  92325. /**
  92326. * Creates a ground mesh from a height map.
  92327. * Please consider using the same method from the MeshBuilder class instead
  92328. * @see http://doc.babylonjs.com/babylon101/height_map
  92329. * @param name defines the name of the mesh to create
  92330. * @param url sets the URL of the height map image resource
  92331. * @param width set the ground width size
  92332. * @param height set the ground height size
  92333. * @param subdivisions sets the number of subdivision per side
  92334. * @param minHeight is the minimum altitude on the ground
  92335. * @param maxHeight is the maximum altitude on the ground
  92336. * @param scene defines the hosting scene
  92337. * @param updatable defines if the mesh must be flagged as updatable
  92338. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  92339. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  92340. * @returns a new Mesh
  92341. */
  92342. 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;
  92343. /**
  92344. * Creates a tube mesh.
  92345. * The tube is a parametric shape.
  92346. * It has no predefined shape. Its final shape will depend on the input parameters.
  92347. * Please consider using the same method from the MeshBuilder class instead
  92348. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  92349. * @param name defines the name of the mesh to create
  92350. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  92351. * @param radius sets the tube radius size
  92352. * @param tessellation is the number of sides on the tubular surface
  92353. * @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
  92354. * @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
  92355. * @param scene defines the hosting scene
  92356. * @param updatable defines if the mesh must be flagged as updatable
  92357. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92358. * @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)
  92359. * @returns a new Mesh
  92360. */
  92361. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  92362. (i: number, distance: number): number;
  92363. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  92364. /**
  92365. * Creates a polyhedron mesh.
  92366. * Please consider using the same method from the MeshBuilder class instead.
  92367. * * 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
  92368. * * The parameter `size` (positive float, default 1) sets the polygon size
  92369. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  92370. * * 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`
  92371. * * 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
  92372. * * 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)`)
  92373. * * 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
  92374. * * 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
  92375. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  92376. * * If you create a double-sided mesh, you can choose what parts of 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
  92377. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  92378. * @param name defines the name of the mesh to create
  92379. * @param options defines the options used to create the mesh
  92380. * @param scene defines the hosting scene
  92381. * @returns a new Mesh
  92382. */
  92383. static CreatePolyhedron(name: string, options: {
  92384. type?: number;
  92385. size?: number;
  92386. sizeX?: number;
  92387. sizeY?: number;
  92388. sizeZ?: number;
  92389. custom?: any;
  92390. faceUV?: Vector4[];
  92391. faceColors?: Color4[];
  92392. updatable?: boolean;
  92393. sideOrientation?: number;
  92394. }, scene: Scene): Mesh;
  92395. /**
  92396. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  92397. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  92398. * * 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`)
  92399. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  92400. * * 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
  92401. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  92402. * * If you create a double-sided mesh, you can choose what parts of 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
  92403. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  92404. * @param name defines the name of the mesh
  92405. * @param options defines the options used to create the mesh
  92406. * @param scene defines the hosting scene
  92407. * @returns a new Mesh
  92408. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  92409. */
  92410. static CreateIcoSphere(name: string, options: {
  92411. radius?: number;
  92412. flat?: boolean;
  92413. subdivisions?: number;
  92414. sideOrientation?: number;
  92415. updatable?: boolean;
  92416. }, scene: Scene): Mesh;
  92417. /**
  92418. * Creates a decal mesh.
  92419. * Please consider using the same method from the MeshBuilder class instead.
  92420. * A decal is a mesh usually applied as a model onto the surface of another mesh
  92421. * @param name defines the name of the mesh
  92422. * @param sourceMesh defines the mesh receiving the decal
  92423. * @param position sets the position of the decal in world coordinates
  92424. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  92425. * @param size sets the decal scaling
  92426. * @param angle sets the angle to rotate the decal
  92427. * @returns a new Mesh
  92428. */
  92429. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  92430. /**
  92431. * Prepare internal position array for software CPU skinning
  92432. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  92433. */
  92434. setPositionsForCPUSkinning(): Float32Array;
  92435. /**
  92436. * Prepare internal normal array for software CPU skinning
  92437. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  92438. */
  92439. setNormalsForCPUSkinning(): Float32Array;
  92440. /**
  92441. * Updates the vertex buffer by applying transformation from the bones
  92442. * @param skeleton defines the skeleton to apply to current mesh
  92443. * @returns the current mesh
  92444. */
  92445. applySkeleton(skeleton: Skeleton): Mesh;
  92446. /**
  92447. * 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
  92448. * @param meshes defines the list of meshes to scan
  92449. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  92450. */
  92451. static MinMax(meshes: AbstractMesh[]): {
  92452. min: Vector3;
  92453. max: Vector3;
  92454. };
  92455. /**
  92456. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  92457. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  92458. * @returns a vector3
  92459. */
  92460. static Center(meshesOrMinMaxVector: {
  92461. min: Vector3;
  92462. max: Vector3;
  92463. } | AbstractMesh[]): Vector3;
  92464. /**
  92465. * Merge the array of meshes into a single mesh for performance reasons.
  92466. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  92467. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  92468. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  92469. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  92470. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  92471. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  92472. * @returns a new mesh
  92473. */
  92474. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  92475. /** @hidden */
  92476. addInstance(instance: InstancedMesh): void;
  92477. /** @hidden */
  92478. removeInstance(instance: InstancedMesh): void;
  92479. }
  92480. }
  92481. declare module BABYLON {
  92482. /**
  92483. * This is the base class of all the camera used in the application.
  92484. * @see http://doc.babylonjs.com/features/cameras
  92485. */
  92486. export class Camera extends Node {
  92487. /** @hidden */
  92488. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  92489. /**
  92490. * This is the default projection mode used by the cameras.
  92491. * It helps recreating a feeling of perspective and better appreciate depth.
  92492. * This is the best way to simulate real life cameras.
  92493. */
  92494. static readonly PERSPECTIVE_CAMERA: number;
  92495. /**
  92496. * This helps creating camera with an orthographic mode.
  92497. * 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.
  92498. */
  92499. static readonly ORTHOGRAPHIC_CAMERA: number;
  92500. /**
  92501. * This is the default FOV mode for perspective cameras.
  92502. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  92503. */
  92504. static readonly FOVMODE_VERTICAL_FIXED: number;
  92505. /**
  92506. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  92507. */
  92508. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  92509. /**
  92510. * This specifies ther is no need for a camera rig.
  92511. * Basically only one eye is rendered corresponding to the camera.
  92512. */
  92513. static readonly RIG_MODE_NONE: number;
  92514. /**
  92515. * Simulates a camera Rig with one blue eye and one red eye.
  92516. * This can be use with 3d blue and red glasses.
  92517. */
  92518. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  92519. /**
  92520. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  92521. */
  92522. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  92523. /**
  92524. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  92525. */
  92526. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  92527. /**
  92528. * Defines that both eyes of the camera will be rendered over under each other.
  92529. */
  92530. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  92531. /**
  92532. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  92533. */
  92534. static readonly RIG_MODE_VR: number;
  92535. /**
  92536. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  92537. */
  92538. static readonly RIG_MODE_WEBVR: number;
  92539. /**
  92540. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  92541. */
  92542. static readonly RIG_MODE_CUSTOM: number;
  92543. /**
  92544. * Defines if by default attaching controls should prevent the default javascript event to continue.
  92545. */
  92546. static ForceAttachControlToAlwaysPreventDefault: boolean;
  92547. /**
  92548. * Define the input manager associated with the camera.
  92549. */
  92550. inputs: CameraInputsManager<Camera>;
  92551. /** @hidden */
  92552. _position: Vector3;
  92553. /**
  92554. * Define the current local position of the camera in the scene
  92555. */
  92556. position: Vector3;
  92557. /**
  92558. * The vector the camera should consider as up.
  92559. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  92560. */
  92561. upVector: Vector3;
  92562. /**
  92563. * Define the current limit on the left side for an orthographic camera
  92564. * In scene unit
  92565. */
  92566. orthoLeft: Nullable<number>;
  92567. /**
  92568. * Define the current limit on the right side for an orthographic camera
  92569. * In scene unit
  92570. */
  92571. orthoRight: Nullable<number>;
  92572. /**
  92573. * Define the current limit on the bottom side for an orthographic camera
  92574. * In scene unit
  92575. */
  92576. orthoBottom: Nullable<number>;
  92577. /**
  92578. * Define the current limit on the top side for an orthographic camera
  92579. * In scene unit
  92580. */
  92581. orthoTop: Nullable<number>;
  92582. /**
  92583. * Field Of View is set in Radians. (default is 0.8)
  92584. */
  92585. fov: number;
  92586. /**
  92587. * Define the minimum distance the camera can see from.
  92588. * This is important to note that the depth buffer are not infinite and the closer it starts
  92589. * the more your scene might encounter depth fighting issue.
  92590. */
  92591. minZ: number;
  92592. /**
  92593. * Define the maximum distance the camera can see to.
  92594. * This is important to note that the depth buffer are not infinite and the further it end
  92595. * the more your scene might encounter depth fighting issue.
  92596. */
  92597. maxZ: number;
  92598. /**
  92599. * Define the default inertia of the camera.
  92600. * This helps giving a smooth feeling to the camera movement.
  92601. */
  92602. inertia: number;
  92603. /**
  92604. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  92605. */
  92606. mode: number;
  92607. /**
  92608. * Define wether the camera is intermediate.
  92609. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  92610. */
  92611. isIntermediate: boolean;
  92612. /**
  92613. * Define the viewport of the camera.
  92614. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  92615. */
  92616. viewport: Viewport;
  92617. /**
  92618. * Restricts the camera to viewing objects with the same layerMask.
  92619. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  92620. */
  92621. layerMask: number;
  92622. /**
  92623. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  92624. */
  92625. fovMode: number;
  92626. /**
  92627. * Rig mode of the camera.
  92628. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  92629. * This is normally controlled byt the camera themselves as internal use.
  92630. */
  92631. cameraRigMode: number;
  92632. /**
  92633. * Defines the distance between both "eyes" in case of a RIG
  92634. */
  92635. interaxialDistance: number;
  92636. /**
  92637. * Defines if stereoscopic rendering is done side by side or over under.
  92638. */
  92639. isStereoscopicSideBySide: boolean;
  92640. /**
  92641. * 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
  92642. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  92643. * else in the scene. (Eg. security camera)
  92644. *
  92645. * 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)
  92646. */
  92647. customRenderTargets: RenderTargetTexture[];
  92648. /**
  92649. * When set, the camera will render to this render target instead of the default canvas
  92650. *
  92651. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  92652. */
  92653. outputRenderTarget: Nullable<RenderTargetTexture>;
  92654. /**
  92655. * Observable triggered when the camera view matrix has changed.
  92656. */
  92657. onViewMatrixChangedObservable: Observable<Camera>;
  92658. /**
  92659. * Observable triggered when the camera Projection matrix has changed.
  92660. */
  92661. onProjectionMatrixChangedObservable: Observable<Camera>;
  92662. /**
  92663. * Observable triggered when the inputs have been processed.
  92664. */
  92665. onAfterCheckInputsObservable: Observable<Camera>;
  92666. /**
  92667. * Observable triggered when reset has been called and applied to the camera.
  92668. */
  92669. onRestoreStateObservable: Observable<Camera>;
  92670. /** @hidden */
  92671. _cameraRigParams: any;
  92672. /** @hidden */
  92673. _rigCameras: Camera[];
  92674. /** @hidden */
  92675. _rigPostProcess: Nullable<PostProcess>;
  92676. protected _webvrViewMatrix: Matrix;
  92677. /** @hidden */
  92678. _skipRendering: boolean;
  92679. /** @hidden */
  92680. _projectionMatrix: Matrix;
  92681. /** @hidden */
  92682. _postProcesses: Nullable<PostProcess>[];
  92683. /** @hidden */
  92684. _activeMeshes: SmartArray<AbstractMesh>;
  92685. protected _globalPosition: Vector3;
  92686. /** @hidden */
  92687. _computedViewMatrix: Matrix;
  92688. private _doNotComputeProjectionMatrix;
  92689. private _transformMatrix;
  92690. private _frustumPlanes;
  92691. private _refreshFrustumPlanes;
  92692. private _storedFov;
  92693. private _stateStored;
  92694. /**
  92695. * Instantiates a new camera object.
  92696. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  92697. * @see http://doc.babylonjs.com/features/cameras
  92698. * @param name Defines the name of the camera in the scene
  92699. * @param position Defines the position of the camera
  92700. * @param scene Defines the scene the camera belongs too
  92701. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  92702. */
  92703. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  92704. /**
  92705. * Store current camera state (fov, position, etc..)
  92706. * @returns the camera
  92707. */
  92708. storeState(): Camera;
  92709. /**
  92710. * Restores the camera state values if it has been stored. You must call storeState() first
  92711. */
  92712. protected _restoreStateValues(): boolean;
  92713. /**
  92714. * Restored camera state. You must call storeState() first.
  92715. * @returns true if restored and false otherwise
  92716. */
  92717. restoreState(): boolean;
  92718. /**
  92719. * Gets the class name of the camera.
  92720. * @returns the class name
  92721. */
  92722. getClassName(): string;
  92723. /** @hidden */
  92724. readonly _isCamera: boolean;
  92725. /**
  92726. * Gets a string representation of the camera useful for debug purpose.
  92727. * @param fullDetails Defines that a more verboe level of logging is required
  92728. * @returns the string representation
  92729. */
  92730. toString(fullDetails?: boolean): string;
  92731. /**
  92732. * Gets the current world space position of the camera.
  92733. */
  92734. readonly globalPosition: Vector3;
  92735. /**
  92736. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  92737. * @returns the active meshe list
  92738. */
  92739. getActiveMeshes(): SmartArray<AbstractMesh>;
  92740. /**
  92741. * Check wether a mesh is part of the current active mesh list of the camera
  92742. * @param mesh Defines the mesh to check
  92743. * @returns true if active, false otherwise
  92744. */
  92745. isActiveMesh(mesh: Mesh): boolean;
  92746. /**
  92747. * Is this camera ready to be used/rendered
  92748. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  92749. * @return true if the camera is ready
  92750. */
  92751. isReady(completeCheck?: boolean): boolean;
  92752. /** @hidden */
  92753. _initCache(): void;
  92754. /** @hidden */
  92755. _updateCache(ignoreParentClass?: boolean): void;
  92756. /** @hidden */
  92757. _isSynchronized(): boolean;
  92758. /** @hidden */
  92759. _isSynchronizedViewMatrix(): boolean;
  92760. /** @hidden */
  92761. _isSynchronizedProjectionMatrix(): boolean;
  92762. /**
  92763. * Attach the input controls to a specific dom element to get the input from.
  92764. * @param element Defines the element the controls should be listened from
  92765. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  92766. */
  92767. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  92768. /**
  92769. * Detach the current controls from the specified dom element.
  92770. * @param element Defines the element to stop listening the inputs from
  92771. */
  92772. detachControl(element: HTMLElement): void;
  92773. /**
  92774. * Update the camera state according to the different inputs gathered during the frame.
  92775. */
  92776. update(): void;
  92777. /** @hidden */
  92778. _checkInputs(): void;
  92779. /** @hidden */
  92780. readonly rigCameras: Camera[];
  92781. /**
  92782. * Gets the post process used by the rig cameras
  92783. */
  92784. readonly rigPostProcess: Nullable<PostProcess>;
  92785. /**
  92786. * Internal, gets the first post proces.
  92787. * @returns the first post process to be run on this camera.
  92788. */
  92789. _getFirstPostProcess(): Nullable<PostProcess>;
  92790. private _cascadePostProcessesToRigCams;
  92791. /**
  92792. * Attach a post process to the camera.
  92793. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  92794. * @param postProcess The post process to attach to the camera
  92795. * @param insertAt The position of the post process in case several of them are in use in the scene
  92796. * @returns the position the post process has been inserted at
  92797. */
  92798. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  92799. /**
  92800. * Detach a post process to the camera.
  92801. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  92802. * @param postProcess The post process to detach from the camera
  92803. */
  92804. detachPostProcess(postProcess: PostProcess): void;
  92805. /**
  92806. * Gets the current world matrix of the camera
  92807. */
  92808. getWorldMatrix(): Matrix;
  92809. /** @hidden */
  92810. _getViewMatrix(): Matrix;
  92811. /**
  92812. * Gets the current view matrix of the camera.
  92813. * @param force forces the camera to recompute the matrix without looking at the cached state
  92814. * @returns the view matrix
  92815. */
  92816. getViewMatrix(force?: boolean): Matrix;
  92817. /**
  92818. * Freeze the projection matrix.
  92819. * It will prevent the cache check of the camera projection compute and can speed up perf
  92820. * if no parameter of the camera are meant to change
  92821. * @param projection Defines manually a projection if necessary
  92822. */
  92823. freezeProjectionMatrix(projection?: Matrix): void;
  92824. /**
  92825. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  92826. */
  92827. unfreezeProjectionMatrix(): void;
  92828. /**
  92829. * Gets the current projection matrix of the camera.
  92830. * @param force forces the camera to recompute the matrix without looking at the cached state
  92831. * @returns the projection matrix
  92832. */
  92833. getProjectionMatrix(force?: boolean): Matrix;
  92834. /**
  92835. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  92836. * @returns a Matrix
  92837. */
  92838. getTransformationMatrix(): Matrix;
  92839. private _updateFrustumPlanes;
  92840. /**
  92841. * Checks if a cullable object (mesh...) is in the camera frustum
  92842. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  92843. * @param target The object to check
  92844. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  92845. * @returns true if the object is in frustum otherwise false
  92846. */
  92847. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  92848. /**
  92849. * Checks if a cullable object (mesh...) is in the camera frustum
  92850. * Unlike isInFrustum this cheks the full bounding box
  92851. * @param target The object to check
  92852. * @returns true if the object is in frustum otherwise false
  92853. */
  92854. isCompletelyInFrustum(target: ICullable): boolean;
  92855. /**
  92856. * Gets a ray in the forward direction from the camera.
  92857. * @param length Defines the length of the ray to create
  92858. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  92859. * @param origin Defines the start point of the ray which defaults to the camera position
  92860. * @returns the forward ray
  92861. */
  92862. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  92863. /**
  92864. * Releases resources associated with this node.
  92865. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  92866. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  92867. */
  92868. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  92869. /** @hidden */
  92870. _isLeftCamera: boolean;
  92871. /**
  92872. * Gets the left camera of a rig setup in case of Rigged Camera
  92873. */
  92874. readonly isLeftCamera: boolean;
  92875. /** @hidden */
  92876. _isRightCamera: boolean;
  92877. /**
  92878. * Gets the right camera of a rig setup in case of Rigged Camera
  92879. */
  92880. readonly isRightCamera: boolean;
  92881. /**
  92882. * Gets the left camera of a rig setup in case of Rigged Camera
  92883. */
  92884. readonly leftCamera: Nullable<FreeCamera>;
  92885. /**
  92886. * Gets the right camera of a rig setup in case of Rigged Camera
  92887. */
  92888. readonly rightCamera: Nullable<FreeCamera>;
  92889. /**
  92890. * Gets the left camera target of a rig setup in case of Rigged Camera
  92891. * @returns the target position
  92892. */
  92893. getLeftTarget(): Nullable<Vector3>;
  92894. /**
  92895. * Gets the right camera target of a rig setup in case of Rigged Camera
  92896. * @returns the target position
  92897. */
  92898. getRightTarget(): Nullable<Vector3>;
  92899. /**
  92900. * @hidden
  92901. */
  92902. setCameraRigMode(mode: number, rigParams: any): void;
  92903. /** @hidden */
  92904. static _setStereoscopicRigMode(camera: Camera): void;
  92905. /** @hidden */
  92906. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  92907. /** @hidden */
  92908. static _setVRRigMode(camera: Camera, rigParams: any): void;
  92909. /** @hidden */
  92910. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  92911. /** @hidden */
  92912. _getVRProjectionMatrix(): Matrix;
  92913. protected _updateCameraRotationMatrix(): void;
  92914. protected _updateWebVRCameraRotationMatrix(): void;
  92915. /**
  92916. * This function MUST be overwritten by the different WebVR cameras available.
  92917. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  92918. * @hidden
  92919. */
  92920. _getWebVRProjectionMatrix(): Matrix;
  92921. /**
  92922. * This function MUST be overwritten by the different WebVR cameras available.
  92923. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  92924. * @hidden
  92925. */
  92926. _getWebVRViewMatrix(): Matrix;
  92927. /** @hidden */
  92928. setCameraRigParameter(name: string, value: any): void;
  92929. /**
  92930. * needs to be overridden by children so sub has required properties to be copied
  92931. * @hidden
  92932. */
  92933. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  92934. /**
  92935. * May need to be overridden by children
  92936. * @hidden
  92937. */
  92938. _updateRigCameras(): void;
  92939. /** @hidden */
  92940. _setupInputs(): void;
  92941. /**
  92942. * Serialiaze the camera setup to a json represention
  92943. * @returns the JSON representation
  92944. */
  92945. serialize(): any;
  92946. /**
  92947. * Clones the current camera.
  92948. * @param name The cloned camera name
  92949. * @returns the cloned camera
  92950. */
  92951. clone(name: string): Camera;
  92952. /**
  92953. * Gets the direction of the camera relative to a given local axis.
  92954. * @param localAxis Defines the reference axis to provide a relative direction.
  92955. * @return the direction
  92956. */
  92957. getDirection(localAxis: Vector3): Vector3;
  92958. /**
  92959. * Returns the current camera absolute rotation
  92960. */
  92961. readonly absoluteRotation: Quaternion;
  92962. /**
  92963. * Gets the direction of the camera relative to a given local axis into a passed vector.
  92964. * @param localAxis Defines the reference axis to provide a relative direction.
  92965. * @param result Defines the vector to store the result in
  92966. */
  92967. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  92968. /**
  92969. * Gets a camera constructor for a given camera type
  92970. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  92971. * @param name The name of the camera the result will be able to instantiate
  92972. * @param scene The scene the result will construct the camera in
  92973. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  92974. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  92975. * @returns a factory method to construc the camera
  92976. */
  92977. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  92978. /**
  92979. * Compute the world matrix of the camera.
  92980. * @returns the camera world matrix
  92981. */
  92982. computeWorldMatrix(): Matrix;
  92983. /**
  92984. * Parse a JSON and creates the camera from the parsed information
  92985. * @param parsedCamera The JSON to parse
  92986. * @param scene The scene to instantiate the camera in
  92987. * @returns the newly constructed camera
  92988. */
  92989. static Parse(parsedCamera: any, scene: Scene): Camera;
  92990. }
  92991. }
  92992. declare module BABYLON {
  92993. /**
  92994. * Class containing static functions to help procedurally build meshes
  92995. */
  92996. export class DiscBuilder {
  92997. /**
  92998. * Creates a plane polygonal mesh. By default, this is a disc
  92999. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  93000. * * 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
  93001. * * 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
  93002. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  93003. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  93004. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  93005. * @param name defines the name of the mesh
  93006. * @param options defines the options used to create the mesh
  93007. * @param scene defines the hosting scene
  93008. * @returns the plane polygonal mesh
  93009. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  93010. */
  93011. static CreateDisc(name: string, options: {
  93012. radius?: number;
  93013. tessellation?: number;
  93014. arc?: number;
  93015. updatable?: boolean;
  93016. sideOrientation?: number;
  93017. frontUVs?: Vector4;
  93018. backUVs?: Vector4;
  93019. }, scene?: Nullable<Scene>): Mesh;
  93020. }
  93021. }
  93022. declare module BABYLON {
  93023. /**
  93024. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  93025. *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.
  93026. * The SPS is also a particle system. It provides some methods to manage the particles.
  93027. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  93028. *
  93029. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  93030. */
  93031. export class SolidParticleSystem implements IDisposable {
  93032. /**
  93033. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  93034. * Example : var p = SPS.particles[i];
  93035. */
  93036. particles: SolidParticle[];
  93037. /**
  93038. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  93039. */
  93040. nbParticles: number;
  93041. /**
  93042. * If the particles must ever face the camera (default false). Useful for planar particles.
  93043. */
  93044. billboard: boolean;
  93045. /**
  93046. * Recompute normals when adding a shape
  93047. */
  93048. recomputeNormals: boolean;
  93049. /**
  93050. * This a counter ofr your own usage. It's not set by any SPS functions.
  93051. */
  93052. counter: number;
  93053. /**
  93054. * The SPS name. This name is also given to the underlying mesh.
  93055. */
  93056. name: string;
  93057. /**
  93058. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  93059. */
  93060. mesh: Mesh;
  93061. /**
  93062. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  93063. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  93064. */
  93065. vars: any;
  93066. /**
  93067. * This array is populated when the SPS is set as 'pickable'.
  93068. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  93069. * Each element of this array is an object `{idx: int, faceId: int}`.
  93070. * `idx` is the picked particle index in the `SPS.particles` array
  93071. * `faceId` is the picked face index counted within this particle.
  93072. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  93073. */
  93074. pickedParticles: {
  93075. idx: number;
  93076. faceId: number;
  93077. }[];
  93078. /**
  93079. * This array is populated when `enableDepthSort` is set to true.
  93080. * Each element of this array is an instance of the class DepthSortedParticle.
  93081. */
  93082. depthSortedParticles: DepthSortedParticle[];
  93083. /**
  93084. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  93085. * @hidden
  93086. */
  93087. _bSphereOnly: boolean;
  93088. /**
  93089. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  93090. * @hidden
  93091. */
  93092. _bSphereRadiusFactor: number;
  93093. private _scene;
  93094. private _positions;
  93095. private _indices;
  93096. private _normals;
  93097. private _colors;
  93098. private _uvs;
  93099. private _indices32;
  93100. private _positions32;
  93101. private _normals32;
  93102. private _fixedNormal32;
  93103. private _colors32;
  93104. private _uvs32;
  93105. private _index;
  93106. private _updatable;
  93107. private _pickable;
  93108. private _isVisibilityBoxLocked;
  93109. private _alwaysVisible;
  93110. private _depthSort;
  93111. private _expandable;
  93112. private _shapeCounter;
  93113. private _copy;
  93114. private _color;
  93115. private _computeParticleColor;
  93116. private _computeParticleTexture;
  93117. private _computeParticleRotation;
  93118. private _computeParticleVertex;
  93119. private _computeBoundingBox;
  93120. private _depthSortParticles;
  93121. private _camera;
  93122. private _mustUnrotateFixedNormals;
  93123. private _particlesIntersect;
  93124. private _needs32Bits;
  93125. private _isNotBuilt;
  93126. /**
  93127. * Creates a SPS (Solid Particle System) object.
  93128. * @param name (String) is the SPS name, this will be the underlying mesh name.
  93129. * @param scene (Scene) is the scene in which the SPS is added.
  93130. * @param options defines the options of the sps e.g.
  93131. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  93132. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  93133. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  93134. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  93135. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  93136. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  93137. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  93138. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  93139. */
  93140. constructor(name: string, scene: Scene, options?: {
  93141. updatable?: boolean;
  93142. isPickable?: boolean;
  93143. enableDepthSort?: boolean;
  93144. particleIntersection?: boolean;
  93145. boundingSphereOnly?: boolean;
  93146. bSphereRadiusFactor?: number;
  93147. expandable?: boolean;
  93148. });
  93149. /**
  93150. * Builds the SPS underlying mesh. Returns a standard Mesh.
  93151. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  93152. * @returns the created mesh
  93153. */
  93154. buildMesh(): Mesh;
  93155. /**
  93156. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  93157. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  93158. * Thus the particles generated from `digest()` have their property `position` set yet.
  93159. * @param mesh ( Mesh ) is the mesh to be digested
  93160. * @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
  93161. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  93162. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  93163. * @returns the current SPS
  93164. */
  93165. digest(mesh: Mesh, options?: {
  93166. facetNb?: number;
  93167. number?: number;
  93168. delta?: number;
  93169. }): SolidParticleSystem;
  93170. private _unrotateFixedNormals;
  93171. private _resetCopy;
  93172. private _meshBuilder;
  93173. private _posToShape;
  93174. private _uvsToShapeUV;
  93175. private _addParticle;
  93176. /**
  93177. * Adds some particles to the SPS from the model shape. Returns the shape id.
  93178. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  93179. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  93180. * @param nb (positive integer) the number of particles to be created from this model
  93181. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  93182. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  93183. * @returns the number of shapes in the system
  93184. */
  93185. addShape(mesh: Mesh, nb: number, options?: {
  93186. positionFunction?: any;
  93187. vertexFunction?: any;
  93188. }): number;
  93189. private _rebuildParticle;
  93190. /**
  93191. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  93192. * @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.
  93193. * @returns the SPS.
  93194. */
  93195. rebuildMesh(reset?: boolean): SolidParticleSystem;
  93196. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  93197. * Returns an array with the removed particles.
  93198. * 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.
  93199. * The SPS can't be empty so at least one particle needs to remain in place.
  93200. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  93201. * @param start index of the first particle to remove
  93202. * @param end index of the last particle to remove (included)
  93203. * @returns an array populated with the removed particles
  93204. */
  93205. removeParticles(start: number, end: number): SolidParticle[];
  93206. /**
  93207. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  93208. * This method calls `updateParticle()` for each particle of the SPS.
  93209. * For an animated SPS, it is usually called within the render loop.
  93210. * 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.
  93211. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  93212. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  93213. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  93214. * @returns the SPS.
  93215. */
  93216. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  93217. /**
  93218. * Disposes the SPS.
  93219. */
  93220. dispose(): void;
  93221. /**
  93222. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  93223. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93224. * @returns the SPS.
  93225. */
  93226. refreshVisibleSize(): SolidParticleSystem;
  93227. /**
  93228. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  93229. * @param size the size (float) of the visibility box
  93230. * note : this doesn't lock the SPS mesh bounding box.
  93231. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93232. */
  93233. setVisibilityBox(size: number): void;
  93234. /**
  93235. * Gets whether the SPS as always visible or not
  93236. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93237. */
  93238. /**
  93239. * Sets the SPS as always visible or not
  93240. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93241. */
  93242. isAlwaysVisible: boolean;
  93243. /**
  93244. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  93245. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93246. */
  93247. /**
  93248. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  93249. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93250. */
  93251. isVisibilityBoxLocked: boolean;
  93252. /**
  93253. * Tells to `setParticles()` to compute the particle rotations or not.
  93254. * Default value : true. The SPS is faster when it's set to false.
  93255. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  93256. */
  93257. /**
  93258. * Gets if `setParticles()` computes the particle rotations or not.
  93259. * Default value : true. The SPS is faster when it's set to false.
  93260. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  93261. */
  93262. computeParticleRotation: boolean;
  93263. /**
  93264. * Tells to `setParticles()` to compute the particle colors or not.
  93265. * Default value : true. The SPS is faster when it's set to false.
  93266. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  93267. */
  93268. /**
  93269. * Gets if `setParticles()` computes the particle colors or not.
  93270. * Default value : true. The SPS is faster when it's set to false.
  93271. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  93272. */
  93273. computeParticleColor: boolean;
  93274. /**
  93275. * Gets if `setParticles()` computes the particle textures or not.
  93276. * Default value : true. The SPS is faster when it's set to false.
  93277. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  93278. */
  93279. computeParticleTexture: boolean;
  93280. /**
  93281. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  93282. * Default value : false. The SPS is faster when it's set to false.
  93283. * Note : the particle custom vertex positions aren't stored values.
  93284. */
  93285. /**
  93286. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  93287. * Default value : false. The SPS is faster when it's set to false.
  93288. * Note : the particle custom vertex positions aren't stored values.
  93289. */
  93290. computeParticleVertex: boolean;
  93291. /**
  93292. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  93293. */
  93294. /**
  93295. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  93296. */
  93297. computeBoundingBox: boolean;
  93298. /**
  93299. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  93300. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  93301. * Default : `true`
  93302. */
  93303. /**
  93304. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  93305. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  93306. * Default : `true`
  93307. */
  93308. depthSortParticles: boolean;
  93309. /**
  93310. * Gets if the SPS is created as expandable at construction time.
  93311. * Default : `false`
  93312. */
  93313. readonly expandable: boolean;
  93314. /**
  93315. * This function does nothing. It may be overwritten to set all the particle first values.
  93316. * The SPS doesn't call this function, you may have to call it by your own.
  93317. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  93318. */
  93319. initParticles(): void;
  93320. /**
  93321. * This function does nothing. It may be overwritten to recycle a particle.
  93322. * The SPS doesn't call this function, you may have to call it by your own.
  93323. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  93324. * @param particle The particle to recycle
  93325. * @returns the recycled particle
  93326. */
  93327. recycleParticle(particle: SolidParticle): SolidParticle;
  93328. /**
  93329. * Updates a particle : this function should be overwritten by the user.
  93330. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  93331. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  93332. * @example : just set a particle position or velocity and recycle conditions
  93333. * @param particle The particle to update
  93334. * @returns the updated particle
  93335. */
  93336. updateParticle(particle: SolidParticle): SolidParticle;
  93337. /**
  93338. * Updates a vertex of a particle : it can be overwritten by the user.
  93339. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  93340. * @param particle the current particle
  93341. * @param vertex the current index of the current particle
  93342. * @param pt the index of the current vertex in the particle shape
  93343. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  93344. * @example : just set a vertex particle position
  93345. * @returns the updated vertex
  93346. */
  93347. updateParticleVertex(particle: SolidParticle, vertex: Vector3, pt: number): Vector3;
  93348. /**
  93349. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  93350. * This does nothing and may be overwritten by the user.
  93351. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  93352. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  93353. * @param update the boolean update value actually passed to setParticles()
  93354. */
  93355. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  93356. /**
  93357. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  93358. * This will be passed three parameters.
  93359. * This does nothing and may be overwritten by the user.
  93360. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  93361. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  93362. * @param update the boolean update value actually passed to setParticles()
  93363. */
  93364. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  93365. }
  93366. }
  93367. declare module BABYLON {
  93368. /**
  93369. * Represents one particle of a solid particle system.
  93370. */
  93371. export class SolidParticle {
  93372. /**
  93373. * particle global index
  93374. */
  93375. idx: number;
  93376. /**
  93377. * The color of the particle
  93378. */
  93379. color: Nullable<Color4>;
  93380. /**
  93381. * The world space position of the particle.
  93382. */
  93383. position: Vector3;
  93384. /**
  93385. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  93386. */
  93387. rotation: Vector3;
  93388. /**
  93389. * The world space rotation quaternion of the particle.
  93390. */
  93391. rotationQuaternion: Nullable<Quaternion>;
  93392. /**
  93393. * The scaling of the particle.
  93394. */
  93395. scaling: Vector3;
  93396. /**
  93397. * The uvs of the particle.
  93398. */
  93399. uvs: Vector4;
  93400. /**
  93401. * The current speed of the particle.
  93402. */
  93403. velocity: Vector3;
  93404. /**
  93405. * The pivot point in the particle local space.
  93406. */
  93407. pivot: Vector3;
  93408. /**
  93409. * Must the particle be translated from its pivot point in its local space ?
  93410. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  93411. * Default : false
  93412. */
  93413. translateFromPivot: boolean;
  93414. /**
  93415. * Is the particle active or not ?
  93416. */
  93417. alive: boolean;
  93418. /**
  93419. * Is the particle visible or not ?
  93420. */
  93421. isVisible: boolean;
  93422. /**
  93423. * Index of this particle in the global "positions" array (Internal use)
  93424. * @hidden
  93425. */
  93426. _pos: number;
  93427. /**
  93428. * @hidden Index of this particle in the global "indices" array (Internal use)
  93429. */
  93430. _ind: number;
  93431. /**
  93432. * @hidden ModelShape of this particle (Internal use)
  93433. */
  93434. _model: ModelShape;
  93435. /**
  93436. * ModelShape id of this particle
  93437. */
  93438. shapeId: number;
  93439. /**
  93440. * Index of the particle in its shape id
  93441. */
  93442. idxInShape: number;
  93443. /**
  93444. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  93445. */
  93446. _modelBoundingInfo: BoundingInfo;
  93447. /**
  93448. * @hidden Particle BoundingInfo object (Internal use)
  93449. */
  93450. _boundingInfo: BoundingInfo;
  93451. /**
  93452. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  93453. */
  93454. _sps: SolidParticleSystem;
  93455. /**
  93456. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  93457. */
  93458. _stillInvisible: boolean;
  93459. /**
  93460. * @hidden Last computed particle rotation matrix
  93461. */
  93462. _rotationMatrix: number[];
  93463. /**
  93464. * Parent particle Id, if any.
  93465. * Default null.
  93466. */
  93467. parentId: Nullable<number>;
  93468. /**
  93469. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  93470. * The possible values are :
  93471. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  93472. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  93473. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  93474. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  93475. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  93476. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  93477. * */
  93478. cullingStrategy: number;
  93479. /**
  93480. * @hidden Internal global position in the SPS.
  93481. */
  93482. _globalPosition: Vector3;
  93483. /**
  93484. * Creates a Solid Particle object.
  93485. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  93486. * @param particleIndex (integer) is the particle index in the Solid Particle System pool. It's also the particle identifier.
  93487. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  93488. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  93489. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  93490. * @param shapeId (integer) is the model shape identifier in the SPS.
  93491. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  93492. * @param sps defines the sps it is associated to
  93493. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  93494. */
  93495. constructor(particleIndex: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>);
  93496. /**
  93497. * Legacy support, changed scale to scaling
  93498. */
  93499. /**
  93500. * Legacy support, changed scale to scaling
  93501. */
  93502. scale: Vector3;
  93503. /**
  93504. * Legacy support, changed quaternion to rotationQuaternion
  93505. */
  93506. /**
  93507. * Legacy support, changed quaternion to rotationQuaternion
  93508. */
  93509. quaternion: Nullable<Quaternion>;
  93510. /**
  93511. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  93512. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  93513. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  93514. * @returns true if it intersects
  93515. */
  93516. intersectsMesh(target: Mesh | SolidParticle): boolean;
  93517. /**
  93518. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  93519. * A particle is in the frustum if its bounding box intersects the frustum
  93520. * @param frustumPlanes defines the frustum to test
  93521. * @returns true if the particle is in the frustum planes
  93522. */
  93523. isInFrustum(frustumPlanes: Plane[]): boolean;
  93524. /**
  93525. * get the rotation matrix of the particle
  93526. * @hidden
  93527. */
  93528. getRotationMatrix(m: Matrix): void;
  93529. }
  93530. /**
  93531. * Represents the shape of the model used by one particle of a solid particle system.
  93532. * SPS internal tool, don't use it manually.
  93533. */
  93534. export class ModelShape {
  93535. /**
  93536. * The shape id
  93537. * @hidden
  93538. */
  93539. shapeID: number;
  93540. /**
  93541. * flat array of model positions (internal use)
  93542. * @hidden
  93543. */
  93544. _shape: Vector3[];
  93545. /**
  93546. * flat array of model UVs (internal use)
  93547. * @hidden
  93548. */
  93549. _shapeUV: number[];
  93550. /**
  93551. * color array of the model
  93552. * @hidden
  93553. */
  93554. _shapeColors: number[];
  93555. /**
  93556. * indices array of the model
  93557. * @hidden
  93558. */
  93559. _indices: number[];
  93560. /**
  93561. * normals array of the model
  93562. * @hidden
  93563. */
  93564. _normals: number[];
  93565. /**
  93566. * length of the shape in the model indices array (internal use)
  93567. * @hidden
  93568. */
  93569. _indicesLength: number;
  93570. /**
  93571. * Custom position function (internal use)
  93572. * @hidden
  93573. */
  93574. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  93575. /**
  93576. * Custom vertex function (internal use)
  93577. * @hidden
  93578. */
  93579. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  93580. /**
  93581. * 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.
  93582. * SPS internal tool, don't use it manually.
  93583. * @hidden
  93584. */
  93585. 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>);
  93586. }
  93587. /**
  93588. * Represents a Depth Sorted Particle in the solid particle system.
  93589. */
  93590. export class DepthSortedParticle {
  93591. /**
  93592. * Index of the particle in the "indices" array
  93593. */
  93594. ind: number;
  93595. /**
  93596. * Length of the particle shape in the "indices" array
  93597. */
  93598. indicesLength: number;
  93599. /**
  93600. * Squared distance from the particle to the camera
  93601. */
  93602. sqDistance: number;
  93603. }
  93604. }
  93605. declare module BABYLON {
  93606. /**
  93607. * @hidden
  93608. */
  93609. export class _MeshCollisionData {
  93610. _checkCollisions: boolean;
  93611. _collisionMask: number;
  93612. _collisionGroup: number;
  93613. _collider: Nullable<Collider>;
  93614. _oldPositionForCollisions: Vector3;
  93615. _diffPositionForCollisions: Vector3;
  93616. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  93617. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  93618. }
  93619. }
  93620. declare module BABYLON {
  93621. /** @hidden */
  93622. class _FacetDataStorage {
  93623. facetPositions: Vector3[];
  93624. facetNormals: Vector3[];
  93625. facetPartitioning: number[][];
  93626. facetNb: number;
  93627. partitioningSubdivisions: number;
  93628. partitioningBBoxRatio: number;
  93629. facetDataEnabled: boolean;
  93630. facetParameters: any;
  93631. bbSize: Vector3;
  93632. subDiv: {
  93633. max: number;
  93634. X: number;
  93635. Y: number;
  93636. Z: number;
  93637. };
  93638. facetDepthSort: boolean;
  93639. facetDepthSortEnabled: boolean;
  93640. depthSortedIndices: IndicesArray;
  93641. depthSortedFacets: {
  93642. ind: number;
  93643. sqDistance: number;
  93644. }[];
  93645. facetDepthSortFunction: (f1: {
  93646. ind: number;
  93647. sqDistance: number;
  93648. }, f2: {
  93649. ind: number;
  93650. sqDistance: number;
  93651. }) => number;
  93652. facetDepthSortFrom: Vector3;
  93653. facetDepthSortOrigin: Vector3;
  93654. invertedMatrix: Matrix;
  93655. }
  93656. /**
  93657. * @hidden
  93658. **/
  93659. class _InternalAbstractMeshDataInfo {
  93660. _hasVertexAlpha: boolean;
  93661. _useVertexColors: boolean;
  93662. _numBoneInfluencers: number;
  93663. _applyFog: boolean;
  93664. _receiveShadows: boolean;
  93665. _facetData: _FacetDataStorage;
  93666. _visibility: number;
  93667. _skeleton: Nullable<Skeleton>;
  93668. _layerMask: number;
  93669. _computeBonesUsingShaders: boolean;
  93670. _isActive: boolean;
  93671. _onlyForInstances: boolean;
  93672. _isActiveIntermediate: boolean;
  93673. _onlyForInstancesIntermediate: boolean;
  93674. _actAsRegularMesh: boolean;
  93675. }
  93676. /**
  93677. * Class used to store all common mesh properties
  93678. */
  93679. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  93680. /** No occlusion */
  93681. static OCCLUSION_TYPE_NONE: number;
  93682. /** Occlusion set to optimisitic */
  93683. static OCCLUSION_TYPE_OPTIMISTIC: number;
  93684. /** Occlusion set to strict */
  93685. static OCCLUSION_TYPE_STRICT: number;
  93686. /** Use an accurante occlusion algorithm */
  93687. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  93688. /** Use a conservative occlusion algorithm */
  93689. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  93690. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  93691. * Test order :
  93692. * Is the bounding sphere outside the frustum ?
  93693. * If not, are the bounding box vertices outside the frustum ?
  93694. * It not, then the cullable object is in the frustum.
  93695. */
  93696. static readonly CULLINGSTRATEGY_STANDARD: number;
  93697. /** Culling strategy : Bounding Sphere Only.
  93698. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  93699. * It's also less accurate than the standard because some not visible objects can still be selected.
  93700. * Test : is the bounding sphere outside the frustum ?
  93701. * If not, then the cullable object is in the frustum.
  93702. */
  93703. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  93704. /** Culling strategy : Optimistic Inclusion.
  93705. * This in an inclusion test first, then the standard exclusion test.
  93706. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  93707. * 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.
  93708. * Anyway, it's as accurate as the standard strategy.
  93709. * Test :
  93710. * Is the cullable object bounding sphere center in the frustum ?
  93711. * If not, apply the default culling strategy.
  93712. */
  93713. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  93714. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  93715. * This in an inclusion test first, then the bounding sphere only exclusion test.
  93716. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  93717. * 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.
  93718. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  93719. * Test :
  93720. * Is the cullable object bounding sphere center in the frustum ?
  93721. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  93722. */
  93723. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  93724. /**
  93725. * No billboard
  93726. */
  93727. static readonly BILLBOARDMODE_NONE: number;
  93728. /** Billboard on X axis */
  93729. static readonly BILLBOARDMODE_X: number;
  93730. /** Billboard on Y axis */
  93731. static readonly BILLBOARDMODE_Y: number;
  93732. /** Billboard on Z axis */
  93733. static readonly BILLBOARDMODE_Z: number;
  93734. /** Billboard on all axes */
  93735. static readonly BILLBOARDMODE_ALL: number;
  93736. /** Billboard on using position instead of orientation */
  93737. static readonly BILLBOARDMODE_USE_POSITION: number;
  93738. /** @hidden */
  93739. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  93740. /**
  93741. * The culling strategy to use to check whether the mesh must be rendered or not.
  93742. * This value can be changed at any time and will be used on the next render mesh selection.
  93743. * The possible values are :
  93744. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  93745. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  93746. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  93747. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  93748. * Please read each static variable documentation to get details about the culling process.
  93749. * */
  93750. cullingStrategy: number;
  93751. /**
  93752. * Gets the number of facets in the mesh
  93753. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  93754. */
  93755. readonly facetNb: number;
  93756. /**
  93757. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  93758. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  93759. */
  93760. partitioningSubdivisions: number;
  93761. /**
  93762. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  93763. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  93764. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  93765. */
  93766. partitioningBBoxRatio: number;
  93767. /**
  93768. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  93769. * Works only for updatable meshes.
  93770. * Doesn't work with multi-materials
  93771. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  93772. */
  93773. mustDepthSortFacets: boolean;
  93774. /**
  93775. * The location (Vector3) where the facet depth sort must be computed from.
  93776. * By default, the active camera position.
  93777. * Used only when facet depth sort is enabled
  93778. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  93779. */
  93780. facetDepthSortFrom: Vector3;
  93781. /**
  93782. * gets a boolean indicating if facetData is enabled
  93783. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  93784. */
  93785. readonly isFacetDataEnabled: boolean;
  93786. /** @hidden */
  93787. _updateNonUniformScalingState(value: boolean): boolean;
  93788. /**
  93789. * An event triggered when this mesh collides with another one
  93790. */
  93791. onCollideObservable: Observable<AbstractMesh>;
  93792. /** Set a function to call when this mesh collides with another one */
  93793. onCollide: () => void;
  93794. /**
  93795. * An event triggered when the collision's position changes
  93796. */
  93797. onCollisionPositionChangeObservable: Observable<Vector3>;
  93798. /** Set a function to call when the collision's position changes */
  93799. onCollisionPositionChange: () => void;
  93800. /**
  93801. * An event triggered when material is changed
  93802. */
  93803. onMaterialChangedObservable: Observable<AbstractMesh>;
  93804. /**
  93805. * Gets or sets the orientation for POV movement & rotation
  93806. */
  93807. definedFacingForward: boolean;
  93808. /** @hidden */
  93809. _occlusionQuery: Nullable<WebGLQuery>;
  93810. /** @hidden */
  93811. _renderingGroup: Nullable<RenderingGroup>;
  93812. /**
  93813. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  93814. */
  93815. /**
  93816. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  93817. */
  93818. visibility: number;
  93819. /** Gets or sets the alpha index used to sort transparent meshes
  93820. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  93821. */
  93822. alphaIndex: number;
  93823. /**
  93824. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  93825. */
  93826. isVisible: boolean;
  93827. /**
  93828. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  93829. */
  93830. isPickable: boolean;
  93831. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  93832. showSubMeshesBoundingBox: boolean;
  93833. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  93834. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  93835. */
  93836. isBlocker: boolean;
  93837. /**
  93838. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  93839. */
  93840. enablePointerMoveEvents: boolean;
  93841. /**
  93842. * Specifies the rendering group id for this mesh (0 by default)
  93843. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  93844. */
  93845. renderingGroupId: number;
  93846. private _material;
  93847. /** Gets or sets current material */
  93848. material: Nullable<Material>;
  93849. /**
  93850. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  93851. * @see http://doc.babylonjs.com/babylon101/shadows
  93852. */
  93853. receiveShadows: boolean;
  93854. /** Defines color to use when rendering outline */
  93855. outlineColor: Color3;
  93856. /** Define width to use when rendering outline */
  93857. outlineWidth: number;
  93858. /** Defines color to use when rendering overlay */
  93859. overlayColor: Color3;
  93860. /** Defines alpha to use when rendering overlay */
  93861. overlayAlpha: number;
  93862. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  93863. hasVertexAlpha: boolean;
  93864. /** 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) */
  93865. useVertexColors: boolean;
  93866. /**
  93867. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  93868. */
  93869. computeBonesUsingShaders: boolean;
  93870. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  93871. numBoneInfluencers: number;
  93872. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  93873. applyFog: boolean;
  93874. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  93875. useOctreeForRenderingSelection: boolean;
  93876. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  93877. useOctreeForPicking: boolean;
  93878. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  93879. useOctreeForCollisions: boolean;
  93880. /**
  93881. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  93882. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  93883. */
  93884. layerMask: number;
  93885. /**
  93886. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  93887. */
  93888. alwaysSelectAsActiveMesh: boolean;
  93889. /**
  93890. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  93891. */
  93892. doNotSyncBoundingInfo: boolean;
  93893. /**
  93894. * Gets or sets the current action manager
  93895. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  93896. */
  93897. actionManager: Nullable<AbstractActionManager>;
  93898. private _meshCollisionData;
  93899. /**
  93900. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  93901. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  93902. */
  93903. ellipsoid: Vector3;
  93904. /**
  93905. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  93906. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  93907. */
  93908. ellipsoidOffset: Vector3;
  93909. /**
  93910. * Gets or sets a collision mask used to mask collisions (default is -1).
  93911. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  93912. */
  93913. collisionMask: number;
  93914. /**
  93915. * Gets or sets the current collision group mask (-1 by default).
  93916. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  93917. */
  93918. collisionGroup: number;
  93919. /**
  93920. * Defines edge width used when edgesRenderer is enabled
  93921. * @see https://www.babylonjs-playground.com/#10OJSG#13
  93922. */
  93923. edgesWidth: number;
  93924. /**
  93925. * Defines edge color used when edgesRenderer is enabled
  93926. * @see https://www.babylonjs-playground.com/#10OJSG#13
  93927. */
  93928. edgesColor: Color4;
  93929. /** @hidden */
  93930. _edgesRenderer: Nullable<IEdgesRenderer>;
  93931. /** @hidden */
  93932. _masterMesh: Nullable<AbstractMesh>;
  93933. /** @hidden */
  93934. _boundingInfo: Nullable<BoundingInfo>;
  93935. /** @hidden */
  93936. _renderId: number;
  93937. /**
  93938. * Gets or sets the list of subMeshes
  93939. * @see http://doc.babylonjs.com/how_to/multi_materials
  93940. */
  93941. subMeshes: SubMesh[];
  93942. /** @hidden */
  93943. _intersectionsInProgress: AbstractMesh[];
  93944. /** @hidden */
  93945. _unIndexed: boolean;
  93946. /** @hidden */
  93947. _lightSources: Light[];
  93948. /** Gets the list of lights affecting that mesh */
  93949. readonly lightSources: Light[];
  93950. /** @hidden */
  93951. readonly _positions: Nullable<Vector3[]>;
  93952. /** @hidden */
  93953. _waitingData: {
  93954. lods: Nullable<any>;
  93955. actions: Nullable<any>;
  93956. freezeWorldMatrix: Nullable<boolean>;
  93957. };
  93958. /** @hidden */
  93959. _bonesTransformMatrices: Nullable<Float32Array>;
  93960. /** @hidden */
  93961. _transformMatrixTexture: Nullable<RawTexture>;
  93962. /**
  93963. * Gets or sets a skeleton to apply skining transformations
  93964. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  93965. */
  93966. skeleton: Nullable<Skeleton>;
  93967. /**
  93968. * An event triggered when the mesh is rebuilt.
  93969. */
  93970. onRebuildObservable: Observable<AbstractMesh>;
  93971. /**
  93972. * Creates a new AbstractMesh
  93973. * @param name defines the name of the mesh
  93974. * @param scene defines the hosting scene
  93975. */
  93976. constructor(name: string, scene?: Nullable<Scene>);
  93977. /**
  93978. * Returns the string "AbstractMesh"
  93979. * @returns "AbstractMesh"
  93980. */
  93981. getClassName(): string;
  93982. /**
  93983. * Gets a string representation of the current mesh
  93984. * @param fullDetails defines a boolean indicating if full details must be included
  93985. * @returns a string representation of the current mesh
  93986. */
  93987. toString(fullDetails?: boolean): string;
  93988. /**
  93989. * @hidden
  93990. */
  93991. protected _getEffectiveParent(): Nullable<Node>;
  93992. /** @hidden */
  93993. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  93994. /** @hidden */
  93995. _rebuild(): void;
  93996. /** @hidden */
  93997. _resyncLightSources(): void;
  93998. /** @hidden */
  93999. _resyncLighSource(light: Light): void;
  94000. /** @hidden */
  94001. _unBindEffect(): void;
  94002. /** @hidden */
  94003. _removeLightSource(light: Light, dispose: boolean): void;
  94004. private _markSubMeshesAsDirty;
  94005. /** @hidden */
  94006. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  94007. /** @hidden */
  94008. _markSubMeshesAsAttributesDirty(): void;
  94009. /** @hidden */
  94010. _markSubMeshesAsMiscDirty(): void;
  94011. /**
  94012. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  94013. */
  94014. scaling: Vector3;
  94015. /**
  94016. * Returns true if the mesh is blocked. Implemented by child classes
  94017. */
  94018. readonly isBlocked: boolean;
  94019. /**
  94020. * Returns the mesh itself by default. Implemented by child classes
  94021. * @param camera defines the camera to use to pick the right LOD level
  94022. * @returns the currentAbstractMesh
  94023. */
  94024. getLOD(camera: Camera): Nullable<AbstractMesh>;
  94025. /**
  94026. * Returns 0 by default. Implemented by child classes
  94027. * @returns an integer
  94028. */
  94029. getTotalVertices(): number;
  94030. /**
  94031. * Returns a positive integer : the total number of indices in this mesh geometry.
  94032. * @returns the numner of indices or zero if the mesh has no geometry.
  94033. */
  94034. getTotalIndices(): number;
  94035. /**
  94036. * Returns null by default. Implemented by child classes
  94037. * @returns null
  94038. */
  94039. getIndices(): Nullable<IndicesArray>;
  94040. /**
  94041. * Returns the array of the requested vertex data kind. Implemented by child classes
  94042. * @param kind defines the vertex data kind to use
  94043. * @returns null
  94044. */
  94045. getVerticesData(kind: string): Nullable<FloatArray>;
  94046. /**
  94047. * Sets the vertex data of the mesh geometry for the requested `kind`.
  94048. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  94049. * Note that a new underlying VertexBuffer object is created each call.
  94050. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  94051. * @param kind defines vertex data kind:
  94052. * * VertexBuffer.PositionKind
  94053. * * VertexBuffer.UVKind
  94054. * * VertexBuffer.UV2Kind
  94055. * * VertexBuffer.UV3Kind
  94056. * * VertexBuffer.UV4Kind
  94057. * * VertexBuffer.UV5Kind
  94058. * * VertexBuffer.UV6Kind
  94059. * * VertexBuffer.ColorKind
  94060. * * VertexBuffer.MatricesIndicesKind
  94061. * * VertexBuffer.MatricesIndicesExtraKind
  94062. * * VertexBuffer.MatricesWeightsKind
  94063. * * VertexBuffer.MatricesWeightsExtraKind
  94064. * @param data defines the data source
  94065. * @param updatable defines if the data must be flagged as updatable (or static)
  94066. * @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
  94067. * @returns the current mesh
  94068. */
  94069. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  94070. /**
  94071. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  94072. * If the mesh has no geometry, it is simply returned as it is.
  94073. * @param kind defines vertex data kind:
  94074. * * VertexBuffer.PositionKind
  94075. * * VertexBuffer.UVKind
  94076. * * VertexBuffer.UV2Kind
  94077. * * VertexBuffer.UV3Kind
  94078. * * VertexBuffer.UV4Kind
  94079. * * VertexBuffer.UV5Kind
  94080. * * VertexBuffer.UV6Kind
  94081. * * VertexBuffer.ColorKind
  94082. * * VertexBuffer.MatricesIndicesKind
  94083. * * VertexBuffer.MatricesIndicesExtraKind
  94084. * * VertexBuffer.MatricesWeightsKind
  94085. * * VertexBuffer.MatricesWeightsExtraKind
  94086. * @param data defines the data source
  94087. * @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
  94088. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  94089. * @returns the current mesh
  94090. */
  94091. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  94092. /**
  94093. * Sets the mesh indices,
  94094. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  94095. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  94096. * @param totalVertices Defines the total number of vertices
  94097. * @returns the current mesh
  94098. */
  94099. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  94100. /**
  94101. * Gets a boolean indicating if specific vertex data is present
  94102. * @param kind defines the vertex data kind to use
  94103. * @returns true is data kind is present
  94104. */
  94105. isVerticesDataPresent(kind: string): boolean;
  94106. /**
  94107. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  94108. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  94109. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  94110. * @returns a BoundingInfo
  94111. */
  94112. getBoundingInfo(): BoundingInfo;
  94113. /**
  94114. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  94115. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  94116. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  94117. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  94118. * @returns the current mesh
  94119. */
  94120. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  94121. /**
  94122. * Overwrite the current bounding info
  94123. * @param boundingInfo defines the new bounding info
  94124. * @returns the current mesh
  94125. */
  94126. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  94127. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  94128. readonly useBones: boolean;
  94129. /** @hidden */
  94130. _preActivate(): void;
  94131. /** @hidden */
  94132. _preActivateForIntermediateRendering(renderId: number): void;
  94133. /** @hidden */
  94134. _activate(renderId: number, intermediateRendering: boolean): boolean;
  94135. /** @hidden */
  94136. _postActivate(): void;
  94137. /** @hidden */
  94138. _freeze(): void;
  94139. /** @hidden */
  94140. _unFreeze(): void;
  94141. /**
  94142. * Gets the current world matrix
  94143. * @returns a Matrix
  94144. */
  94145. getWorldMatrix(): Matrix;
  94146. /** @hidden */
  94147. _getWorldMatrixDeterminant(): number;
  94148. /**
  94149. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  94150. */
  94151. readonly isAnInstance: boolean;
  94152. /**
  94153. * Gets a boolean indicating if this mesh has instances
  94154. */
  94155. readonly hasInstances: boolean;
  94156. /**
  94157. * Perform relative position change from the point of view of behind the front of the mesh.
  94158. * This is performed taking into account the meshes current rotation, so you do not have to care.
  94159. * Supports definition of mesh facing forward or backward
  94160. * @param amountRight defines the distance on the right axis
  94161. * @param amountUp defines the distance on the up axis
  94162. * @param amountForward defines the distance on the forward axis
  94163. * @returns the current mesh
  94164. */
  94165. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  94166. /**
  94167. * Calculate relative position change from the point of view of behind the front of the mesh.
  94168. * This is performed taking into account the meshes current rotation, so you do not have to care.
  94169. * Supports definition of mesh facing forward or backward
  94170. * @param amountRight defines the distance on the right axis
  94171. * @param amountUp defines the distance on the up axis
  94172. * @param amountForward defines the distance on the forward axis
  94173. * @returns the new displacement vector
  94174. */
  94175. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  94176. /**
  94177. * Perform relative rotation change from the point of view of behind the front of the mesh.
  94178. * Supports definition of mesh facing forward or backward
  94179. * @param flipBack defines the flip
  94180. * @param twirlClockwise defines the twirl
  94181. * @param tiltRight defines the tilt
  94182. * @returns the current mesh
  94183. */
  94184. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  94185. /**
  94186. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  94187. * Supports definition of mesh facing forward or backward.
  94188. * @param flipBack defines the flip
  94189. * @param twirlClockwise defines the twirl
  94190. * @param tiltRight defines the tilt
  94191. * @returns the new rotation vector
  94192. */
  94193. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  94194. /**
  94195. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  94196. * This means the mesh underlying bounding box and sphere are recomputed.
  94197. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  94198. * @returns the current mesh
  94199. */
  94200. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  94201. /** @hidden */
  94202. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  94203. /** @hidden */
  94204. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  94205. /** @hidden */
  94206. _updateBoundingInfo(): AbstractMesh;
  94207. /** @hidden */
  94208. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  94209. /** @hidden */
  94210. protected _afterComputeWorldMatrix(): void;
  94211. /** @hidden */
  94212. readonly _effectiveMesh: AbstractMesh;
  94213. /**
  94214. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  94215. * A mesh is in the frustum if its bounding box intersects the frustum
  94216. * @param frustumPlanes defines the frustum to test
  94217. * @returns true if the mesh is in the frustum planes
  94218. */
  94219. isInFrustum(frustumPlanes: Plane[]): boolean;
  94220. /**
  94221. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  94222. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  94223. * @param frustumPlanes defines the frustum to test
  94224. * @returns true if the mesh is completely in the frustum planes
  94225. */
  94226. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  94227. /**
  94228. * True if the mesh intersects another mesh or a SolidParticle object
  94229. * @param mesh defines a target mesh or SolidParticle to test
  94230. * @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)
  94231. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  94232. * @returns true if there is an intersection
  94233. */
  94234. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  94235. /**
  94236. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  94237. * @param point defines the point to test
  94238. * @returns true if there is an intersection
  94239. */
  94240. intersectsPoint(point: Vector3): boolean;
  94241. /**
  94242. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  94243. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94244. */
  94245. checkCollisions: boolean;
  94246. /**
  94247. * Gets Collider object used to compute collisions (not physics)
  94248. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94249. */
  94250. readonly collider: Nullable<Collider>;
  94251. /**
  94252. * Move the mesh using collision engine
  94253. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94254. * @param displacement defines the requested displacement vector
  94255. * @returns the current mesh
  94256. */
  94257. moveWithCollisions(displacement: Vector3): AbstractMesh;
  94258. private _onCollisionPositionChange;
  94259. /** @hidden */
  94260. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  94261. /** @hidden */
  94262. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  94263. /** @hidden */
  94264. _checkCollision(collider: Collider): AbstractMesh;
  94265. /** @hidden */
  94266. _generatePointsArray(): boolean;
  94267. /**
  94268. * Checks if the passed Ray intersects with the mesh
  94269. * @param ray defines the ray to use
  94270. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  94271. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  94272. * @returns the picking info
  94273. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  94274. */
  94275. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): PickingInfo;
  94276. /**
  94277. * Clones the current mesh
  94278. * @param name defines the mesh name
  94279. * @param newParent defines the new mesh parent
  94280. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  94281. * @returns the new mesh
  94282. */
  94283. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  94284. /**
  94285. * Disposes all the submeshes of the current meshnp
  94286. * @returns the current mesh
  94287. */
  94288. releaseSubMeshes(): AbstractMesh;
  94289. /**
  94290. * Releases resources associated with this abstract mesh.
  94291. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  94292. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  94293. */
  94294. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94295. /**
  94296. * Adds the passed mesh as a child to the current mesh
  94297. * @param mesh defines the child mesh
  94298. * @returns the current mesh
  94299. */
  94300. addChild(mesh: AbstractMesh): AbstractMesh;
  94301. /**
  94302. * Removes the passed mesh from the current mesh children list
  94303. * @param mesh defines the child mesh
  94304. * @returns the current mesh
  94305. */
  94306. removeChild(mesh: AbstractMesh): AbstractMesh;
  94307. /** @hidden */
  94308. private _initFacetData;
  94309. /**
  94310. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  94311. * This method can be called within the render loop.
  94312. * 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
  94313. * @returns the current mesh
  94314. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94315. */
  94316. updateFacetData(): AbstractMesh;
  94317. /**
  94318. * Returns the facetLocalNormals array.
  94319. * The normals are expressed in the mesh local spac
  94320. * @returns an array of Vector3
  94321. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94322. */
  94323. getFacetLocalNormals(): Vector3[];
  94324. /**
  94325. * Returns the facetLocalPositions array.
  94326. * The facet positions are expressed in the mesh local space
  94327. * @returns an array of Vector3
  94328. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94329. */
  94330. getFacetLocalPositions(): Vector3[];
  94331. /**
  94332. * Returns the facetLocalPartioning array
  94333. * @returns an array of array of numbers
  94334. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94335. */
  94336. getFacetLocalPartitioning(): number[][];
  94337. /**
  94338. * Returns the i-th facet position in the world system.
  94339. * This method allocates a new Vector3 per call
  94340. * @param i defines the facet index
  94341. * @returns a new Vector3
  94342. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94343. */
  94344. getFacetPosition(i: number): Vector3;
  94345. /**
  94346. * Sets the reference Vector3 with the i-th facet position in the world system
  94347. * @param i defines the facet index
  94348. * @param ref defines the target vector
  94349. * @returns the current mesh
  94350. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94351. */
  94352. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  94353. /**
  94354. * Returns the i-th facet normal in the world system.
  94355. * This method allocates a new Vector3 per call
  94356. * @param i defines the facet index
  94357. * @returns a new Vector3
  94358. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94359. */
  94360. getFacetNormal(i: number): Vector3;
  94361. /**
  94362. * Sets the reference Vector3 with the i-th facet normal in the world system
  94363. * @param i defines the facet index
  94364. * @param ref defines the target vector
  94365. * @returns the current mesh
  94366. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94367. */
  94368. getFacetNormalToRef(i: number, ref: Vector3): this;
  94369. /**
  94370. * 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)
  94371. * @param x defines x coordinate
  94372. * @param y defines y coordinate
  94373. * @param z defines z coordinate
  94374. * @returns the array of facet indexes
  94375. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94376. */
  94377. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  94378. /**
  94379. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  94380. * @param projected sets as the (x,y,z) world projection on the facet
  94381. * @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
  94382. * @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
  94383. * @param x defines x coordinate
  94384. * @param y defines y coordinate
  94385. * @param z defines z coordinate
  94386. * @returns the face index if found (or null instead)
  94387. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94388. */
  94389. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  94390. /**
  94391. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  94392. * @param projected sets as the (x,y,z) local projection on the facet
  94393. * @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
  94394. * @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
  94395. * @param x defines x coordinate
  94396. * @param y defines y coordinate
  94397. * @param z defines z coordinate
  94398. * @returns the face index if found (or null instead)
  94399. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94400. */
  94401. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  94402. /**
  94403. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  94404. * @returns the parameters
  94405. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94406. */
  94407. getFacetDataParameters(): any;
  94408. /**
  94409. * Disables the feature FacetData and frees the related memory
  94410. * @returns the current mesh
  94411. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94412. */
  94413. disableFacetData(): AbstractMesh;
  94414. /**
  94415. * Updates the AbstractMesh indices array
  94416. * @param indices defines the data source
  94417. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  94418. * @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)
  94419. * @returns the current mesh
  94420. */
  94421. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  94422. /**
  94423. * Creates new normals data for the mesh
  94424. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  94425. * @returns the current mesh
  94426. */
  94427. createNormals(updatable: boolean): AbstractMesh;
  94428. /**
  94429. * Align the mesh with a normal
  94430. * @param normal defines the normal to use
  94431. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  94432. * @returns the current mesh
  94433. */
  94434. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  94435. /** @hidden */
  94436. _checkOcclusionQuery(): boolean;
  94437. /**
  94438. * Disables the mesh edge rendering mode
  94439. * @returns the currentAbstractMesh
  94440. */
  94441. disableEdgesRendering(): AbstractMesh;
  94442. /**
  94443. * Enables the edge rendering mode on the mesh.
  94444. * This mode makes the mesh edges visible
  94445. * @param epsilon defines the maximal distance between two angles to detect a face
  94446. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  94447. * @returns the currentAbstractMesh
  94448. * @see https://www.babylonjs-playground.com/#19O9TU#0
  94449. */
  94450. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  94451. }
  94452. }
  94453. declare module BABYLON {
  94454. /**
  94455. * Interface used to define ActionEvent
  94456. */
  94457. export interface IActionEvent {
  94458. /** The mesh or sprite that triggered the action */
  94459. source: any;
  94460. /** The X mouse cursor position at the time of the event */
  94461. pointerX: number;
  94462. /** The Y mouse cursor position at the time of the event */
  94463. pointerY: number;
  94464. /** The mesh that is currently pointed at (can be null) */
  94465. meshUnderPointer: Nullable<AbstractMesh>;
  94466. /** the original (browser) event that triggered the ActionEvent */
  94467. sourceEvent?: any;
  94468. /** additional data for the event */
  94469. additionalData?: any;
  94470. }
  94471. /**
  94472. * ActionEvent is the event being sent when an action is triggered.
  94473. */
  94474. export class ActionEvent implements IActionEvent {
  94475. /** The mesh or sprite that triggered the action */
  94476. source: any;
  94477. /** The X mouse cursor position at the time of the event */
  94478. pointerX: number;
  94479. /** The Y mouse cursor position at the time of the event */
  94480. pointerY: number;
  94481. /** The mesh that is currently pointed at (can be null) */
  94482. meshUnderPointer: Nullable<AbstractMesh>;
  94483. /** the original (browser) event that triggered the ActionEvent */
  94484. sourceEvent?: any;
  94485. /** additional data for the event */
  94486. additionalData?: any;
  94487. /**
  94488. * Creates a new ActionEvent
  94489. * @param source The mesh or sprite that triggered the action
  94490. * @param pointerX The X mouse cursor position at the time of the event
  94491. * @param pointerY The Y mouse cursor position at the time of the event
  94492. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  94493. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  94494. * @param additionalData additional data for the event
  94495. */
  94496. constructor(
  94497. /** The mesh or sprite that triggered the action */
  94498. source: any,
  94499. /** The X mouse cursor position at the time of the event */
  94500. pointerX: number,
  94501. /** The Y mouse cursor position at the time of the event */
  94502. pointerY: number,
  94503. /** The mesh that is currently pointed at (can be null) */
  94504. meshUnderPointer: Nullable<AbstractMesh>,
  94505. /** the original (browser) event that triggered the ActionEvent */
  94506. sourceEvent?: any,
  94507. /** additional data for the event */
  94508. additionalData?: any);
  94509. /**
  94510. * Helper function to auto-create an ActionEvent from a source mesh.
  94511. * @param source The source mesh that triggered the event
  94512. * @param evt The original (browser) event
  94513. * @param additionalData additional data for the event
  94514. * @returns the new ActionEvent
  94515. */
  94516. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  94517. /**
  94518. * Helper function to auto-create an ActionEvent from a source sprite
  94519. * @param source The source sprite that triggered the event
  94520. * @param scene Scene associated with the sprite
  94521. * @param evt The original (browser) event
  94522. * @param additionalData additional data for the event
  94523. * @returns the new ActionEvent
  94524. */
  94525. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  94526. /**
  94527. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  94528. * @param scene the scene where the event occurred
  94529. * @param evt The original (browser) event
  94530. * @returns the new ActionEvent
  94531. */
  94532. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  94533. /**
  94534. * Helper function to auto-create an ActionEvent from a primitive
  94535. * @param prim defines the target primitive
  94536. * @param pointerPos defines the pointer position
  94537. * @param evt The original (browser) event
  94538. * @param additionalData additional data for the event
  94539. * @returns the new ActionEvent
  94540. */
  94541. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  94542. }
  94543. }
  94544. declare module BABYLON {
  94545. /**
  94546. * Abstract class used to decouple action Manager from scene and meshes.
  94547. * Do not instantiate.
  94548. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  94549. */
  94550. export abstract class AbstractActionManager implements IDisposable {
  94551. /** Gets the list of active triggers */
  94552. static Triggers: {
  94553. [key: string]: number;
  94554. };
  94555. /** Gets the cursor to use when hovering items */
  94556. hoverCursor: string;
  94557. /** Gets the list of actions */
  94558. actions: IAction[];
  94559. /**
  94560. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  94561. */
  94562. isRecursive: boolean;
  94563. /**
  94564. * Releases all associated resources
  94565. */
  94566. abstract dispose(): void;
  94567. /**
  94568. * Does this action manager has pointer triggers
  94569. */
  94570. abstract readonly hasPointerTriggers: boolean;
  94571. /**
  94572. * Does this action manager has pick triggers
  94573. */
  94574. abstract readonly hasPickTriggers: boolean;
  94575. /**
  94576. * Process a specific trigger
  94577. * @param trigger defines the trigger to process
  94578. * @param evt defines the event details to be processed
  94579. */
  94580. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  94581. /**
  94582. * Does this action manager handles actions of any of the given triggers
  94583. * @param triggers defines the triggers to be tested
  94584. * @return a boolean indicating whether one (or more) of the triggers is handled
  94585. */
  94586. abstract hasSpecificTriggers(triggers: number[]): boolean;
  94587. /**
  94588. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  94589. * speed.
  94590. * @param triggerA defines the trigger to be tested
  94591. * @param triggerB defines the trigger to be tested
  94592. * @return a boolean indicating whether one (or more) of the triggers is handled
  94593. */
  94594. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  94595. /**
  94596. * Does this action manager handles actions of a given trigger
  94597. * @param trigger defines the trigger to be tested
  94598. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  94599. * @return whether the trigger is handled
  94600. */
  94601. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  94602. /**
  94603. * Serialize this manager to a JSON object
  94604. * @param name defines the property name to store this manager
  94605. * @returns a JSON representation of this manager
  94606. */
  94607. abstract serialize(name: string): any;
  94608. /**
  94609. * Registers an action to this action manager
  94610. * @param action defines the action to be registered
  94611. * @return the action amended (prepared) after registration
  94612. */
  94613. abstract registerAction(action: IAction): Nullable<IAction>;
  94614. /**
  94615. * Unregisters an action to this action manager
  94616. * @param action defines the action to be unregistered
  94617. * @return a boolean indicating whether the action has been unregistered
  94618. */
  94619. abstract unregisterAction(action: IAction): Boolean;
  94620. /**
  94621. * Does exist one action manager with at least one trigger
  94622. **/
  94623. static readonly HasTriggers: boolean;
  94624. /**
  94625. * Does exist one action manager with at least one pick trigger
  94626. **/
  94627. static readonly HasPickTriggers: boolean;
  94628. /**
  94629. * Does exist one action manager that handles actions of a given trigger
  94630. * @param trigger defines the trigger to be tested
  94631. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  94632. **/
  94633. static HasSpecificTrigger(trigger: number): boolean;
  94634. }
  94635. }
  94636. declare module BABYLON {
  94637. /**
  94638. * Defines how a node can be built from a string name.
  94639. */
  94640. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  94641. /**
  94642. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  94643. */
  94644. export class Node implements IBehaviorAware<Node> {
  94645. /** @hidden */
  94646. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  94647. private static _NodeConstructors;
  94648. /**
  94649. * Add a new node constructor
  94650. * @param type defines the type name of the node to construct
  94651. * @param constructorFunc defines the constructor function
  94652. */
  94653. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  94654. /**
  94655. * Returns a node constructor based on type name
  94656. * @param type defines the type name
  94657. * @param name defines the new node name
  94658. * @param scene defines the hosting scene
  94659. * @param options defines optional options to transmit to constructors
  94660. * @returns the new constructor or null
  94661. */
  94662. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  94663. /**
  94664. * Gets or sets the name of the node
  94665. */
  94666. name: string;
  94667. /**
  94668. * Gets or sets the id of the node
  94669. */
  94670. id: string;
  94671. /**
  94672. * Gets or sets the unique id of the node
  94673. */
  94674. uniqueId: number;
  94675. /**
  94676. * Gets or sets a string used to store user defined state for the node
  94677. */
  94678. state: string;
  94679. /**
  94680. * Gets or sets an object used to store user defined information for the node
  94681. */
  94682. metadata: any;
  94683. /**
  94684. * For internal use only. Please do not use.
  94685. */
  94686. reservedDataStore: any;
  94687. /**
  94688. * List of inspectable custom properties (used by the Inspector)
  94689. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  94690. */
  94691. inspectableCustomProperties: IInspectable[];
  94692. private _doNotSerialize;
  94693. /**
  94694. * Gets or sets a boolean used to define if the node must be serialized
  94695. */
  94696. doNotSerialize: boolean;
  94697. /** @hidden */
  94698. _isDisposed: boolean;
  94699. /**
  94700. * Gets a list of Animations associated with the node
  94701. */
  94702. animations: Animation[];
  94703. protected _ranges: {
  94704. [name: string]: Nullable<AnimationRange>;
  94705. };
  94706. /**
  94707. * Callback raised when the node is ready to be used
  94708. */
  94709. onReady: Nullable<(node: Node) => void>;
  94710. private _isEnabled;
  94711. private _isParentEnabled;
  94712. private _isReady;
  94713. /** @hidden */
  94714. _currentRenderId: number;
  94715. private _parentUpdateId;
  94716. /** @hidden */
  94717. _childUpdateId: number;
  94718. /** @hidden */
  94719. _waitingParentId: Nullable<string>;
  94720. /** @hidden */
  94721. _scene: Scene;
  94722. /** @hidden */
  94723. _cache: any;
  94724. private _parentNode;
  94725. private _children;
  94726. /** @hidden */
  94727. _worldMatrix: Matrix;
  94728. /** @hidden */
  94729. _worldMatrixDeterminant: number;
  94730. /** @hidden */
  94731. _worldMatrixDeterminantIsDirty: boolean;
  94732. /** @hidden */
  94733. private _sceneRootNodesIndex;
  94734. /**
  94735. * Gets a boolean indicating if the node has been disposed
  94736. * @returns true if the node was disposed
  94737. */
  94738. isDisposed(): boolean;
  94739. /**
  94740. * Gets or sets the parent of the node (without keeping the current position in the scene)
  94741. * @see https://doc.babylonjs.com/how_to/parenting
  94742. */
  94743. parent: Nullable<Node>;
  94744. /** @hidden */
  94745. _addToSceneRootNodes(): void;
  94746. /** @hidden */
  94747. _removeFromSceneRootNodes(): void;
  94748. private _animationPropertiesOverride;
  94749. /**
  94750. * Gets or sets the animation properties override
  94751. */
  94752. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  94753. /**
  94754. * Gets a string idenfifying the name of the class
  94755. * @returns "Node" string
  94756. */
  94757. getClassName(): string;
  94758. /** @hidden */
  94759. readonly _isNode: boolean;
  94760. /**
  94761. * An event triggered when the mesh is disposed
  94762. */
  94763. onDisposeObservable: Observable<Node>;
  94764. private _onDisposeObserver;
  94765. /**
  94766. * Sets a callback that will be raised when the node will be disposed
  94767. */
  94768. onDispose: () => void;
  94769. /**
  94770. * Creates a new Node
  94771. * @param name the name and id to be given to this node
  94772. * @param scene the scene this node will be added to
  94773. */
  94774. constructor(name: string, scene?: Nullable<Scene>);
  94775. /**
  94776. * Gets the scene of the node
  94777. * @returns a scene
  94778. */
  94779. getScene(): Scene;
  94780. /**
  94781. * Gets the engine of the node
  94782. * @returns a Engine
  94783. */
  94784. getEngine(): Engine;
  94785. private _behaviors;
  94786. /**
  94787. * Attach a behavior to the node
  94788. * @see http://doc.babylonjs.com/features/behaviour
  94789. * @param behavior defines the behavior to attach
  94790. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  94791. * @returns the current Node
  94792. */
  94793. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  94794. /**
  94795. * Remove an attached behavior
  94796. * @see http://doc.babylonjs.com/features/behaviour
  94797. * @param behavior defines the behavior to attach
  94798. * @returns the current Node
  94799. */
  94800. removeBehavior(behavior: Behavior<Node>): Node;
  94801. /**
  94802. * Gets the list of attached behaviors
  94803. * @see http://doc.babylonjs.com/features/behaviour
  94804. */
  94805. readonly behaviors: Behavior<Node>[];
  94806. /**
  94807. * Gets an attached behavior by name
  94808. * @param name defines the name of the behavior to look for
  94809. * @see http://doc.babylonjs.com/features/behaviour
  94810. * @returns null if behavior was not found else the requested behavior
  94811. */
  94812. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  94813. /**
  94814. * Returns the latest update of the World matrix
  94815. * @returns a Matrix
  94816. */
  94817. getWorldMatrix(): Matrix;
  94818. /** @hidden */
  94819. _getWorldMatrixDeterminant(): number;
  94820. /**
  94821. * Returns directly the latest state of the mesh World matrix.
  94822. * A Matrix is returned.
  94823. */
  94824. readonly worldMatrixFromCache: Matrix;
  94825. /** @hidden */
  94826. _initCache(): void;
  94827. /** @hidden */
  94828. updateCache(force?: boolean): void;
  94829. /** @hidden */
  94830. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  94831. /** @hidden */
  94832. _updateCache(ignoreParentClass?: boolean): void;
  94833. /** @hidden */
  94834. _isSynchronized(): boolean;
  94835. /** @hidden */
  94836. _markSyncedWithParent(): void;
  94837. /** @hidden */
  94838. isSynchronizedWithParent(): boolean;
  94839. /** @hidden */
  94840. isSynchronized(): boolean;
  94841. /**
  94842. * Is this node ready to be used/rendered
  94843. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  94844. * @return true if the node is ready
  94845. */
  94846. isReady(completeCheck?: boolean): boolean;
  94847. /**
  94848. * Is this node enabled?
  94849. * 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
  94850. * @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
  94851. * @return whether this node (and its parent) is enabled
  94852. */
  94853. isEnabled(checkAncestors?: boolean): boolean;
  94854. /** @hidden */
  94855. protected _syncParentEnabledState(): void;
  94856. /**
  94857. * Set the enabled state of this node
  94858. * @param value defines the new enabled state
  94859. */
  94860. setEnabled(value: boolean): void;
  94861. /**
  94862. * Is this node a descendant of the given node?
  94863. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  94864. * @param ancestor defines the parent node to inspect
  94865. * @returns a boolean indicating if this node is a descendant of the given node
  94866. */
  94867. isDescendantOf(ancestor: Node): boolean;
  94868. /** @hidden */
  94869. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  94870. /**
  94871. * Will return all nodes that have this node as ascendant
  94872. * @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
  94873. * @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
  94874. * @return all children nodes of all types
  94875. */
  94876. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  94877. /**
  94878. * Get all child-meshes of this node
  94879. * @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)
  94880. * @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
  94881. * @returns an array of AbstractMesh
  94882. */
  94883. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  94884. /**
  94885. * Get all direct children of this node
  94886. * @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
  94887. * @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)
  94888. * @returns an array of Node
  94889. */
  94890. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  94891. /** @hidden */
  94892. _setReady(state: boolean): void;
  94893. /**
  94894. * Get an animation by name
  94895. * @param name defines the name of the animation to look for
  94896. * @returns null if not found else the requested animation
  94897. */
  94898. getAnimationByName(name: string): Nullable<Animation>;
  94899. /**
  94900. * Creates an animation range for this node
  94901. * @param name defines the name of the range
  94902. * @param from defines the starting key
  94903. * @param to defines the end key
  94904. */
  94905. createAnimationRange(name: string, from: number, to: number): void;
  94906. /**
  94907. * Delete a specific animation range
  94908. * @param name defines the name of the range to delete
  94909. * @param deleteFrames defines if animation frames from the range must be deleted as well
  94910. */
  94911. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  94912. /**
  94913. * Get an animation range by name
  94914. * @param name defines the name of the animation range to look for
  94915. * @returns null if not found else the requested animation range
  94916. */
  94917. getAnimationRange(name: string): Nullable<AnimationRange>;
  94918. /**
  94919. * Gets the list of all animation ranges defined on this node
  94920. * @returns an array
  94921. */
  94922. getAnimationRanges(): Nullable<AnimationRange>[];
  94923. /**
  94924. * Will start the animation sequence
  94925. * @param name defines the range frames for animation sequence
  94926. * @param loop defines if the animation should loop (false by default)
  94927. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  94928. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  94929. * @returns the object created for this animation. If range does not exist, it will return null
  94930. */
  94931. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  94932. /**
  94933. * Serialize animation ranges into a JSON compatible object
  94934. * @returns serialization object
  94935. */
  94936. serializeAnimationRanges(): any;
  94937. /**
  94938. * Computes the world matrix of the node
  94939. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  94940. * @returns the world matrix
  94941. */
  94942. computeWorldMatrix(force?: boolean): Matrix;
  94943. /**
  94944. * Releases resources associated with this node.
  94945. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  94946. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  94947. */
  94948. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94949. /**
  94950. * Parse animation range data from a serialization object and store them into a given node
  94951. * @param node defines where to store the animation ranges
  94952. * @param parsedNode defines the serialization object to read data from
  94953. * @param scene defines the hosting scene
  94954. */
  94955. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  94956. /**
  94957. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  94958. * @param includeDescendants Include bounding info from descendants as well (true by default)
  94959. * @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
  94960. * @returns the new bounding vectors
  94961. */
  94962. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  94963. min: Vector3;
  94964. max: Vector3;
  94965. };
  94966. }
  94967. }
  94968. declare module BABYLON {
  94969. /**
  94970. * @hidden
  94971. */
  94972. export class _IAnimationState {
  94973. key: number;
  94974. repeatCount: number;
  94975. workValue?: any;
  94976. loopMode?: number;
  94977. offsetValue?: any;
  94978. highLimitValue?: any;
  94979. }
  94980. /**
  94981. * Class used to store any kind of animation
  94982. */
  94983. export class Animation {
  94984. /**Name of the animation */
  94985. name: string;
  94986. /**Property to animate */
  94987. targetProperty: string;
  94988. /**The frames per second of the animation */
  94989. framePerSecond: number;
  94990. /**The data type of the animation */
  94991. dataType: number;
  94992. /**The loop mode of the animation */
  94993. loopMode?: number | undefined;
  94994. /**Specifies if blending should be enabled */
  94995. enableBlending?: boolean | undefined;
  94996. /**
  94997. * Use matrix interpolation instead of using direct key value when animating matrices
  94998. */
  94999. static AllowMatricesInterpolation: boolean;
  95000. /**
  95001. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  95002. */
  95003. static AllowMatrixDecomposeForInterpolation: boolean;
  95004. /**
  95005. * Stores the key frames of the animation
  95006. */
  95007. private _keys;
  95008. /**
  95009. * Stores the easing function of the animation
  95010. */
  95011. private _easingFunction;
  95012. /**
  95013. * @hidden Internal use only
  95014. */
  95015. _runtimeAnimations: RuntimeAnimation[];
  95016. /**
  95017. * The set of event that will be linked to this animation
  95018. */
  95019. private _events;
  95020. /**
  95021. * Stores an array of target property paths
  95022. */
  95023. targetPropertyPath: string[];
  95024. /**
  95025. * Stores the blending speed of the animation
  95026. */
  95027. blendingSpeed: number;
  95028. /**
  95029. * Stores the animation ranges for the animation
  95030. */
  95031. private _ranges;
  95032. /**
  95033. * @hidden Internal use
  95034. */
  95035. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  95036. /**
  95037. * Sets up an animation
  95038. * @param property The property to animate
  95039. * @param animationType The animation type to apply
  95040. * @param framePerSecond The frames per second of the animation
  95041. * @param easingFunction The easing function used in the animation
  95042. * @returns The created animation
  95043. */
  95044. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  95045. /**
  95046. * Create and start an animation on a node
  95047. * @param name defines the name of the global animation that will be run on all nodes
  95048. * @param node defines the root node where the animation will take place
  95049. * @param targetProperty defines property to animate
  95050. * @param framePerSecond defines the number of frame per second yo use
  95051. * @param totalFrame defines the number of frames in total
  95052. * @param from defines the initial value
  95053. * @param to defines the final value
  95054. * @param loopMode defines which loop mode you want to use (off by default)
  95055. * @param easingFunction defines the easing function to use (linear by default)
  95056. * @param onAnimationEnd defines the callback to call when animation end
  95057. * @returns the animatable created for this animation
  95058. */
  95059. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  95060. /**
  95061. * Create and start an animation on a node and its descendants
  95062. * @param name defines the name of the global animation that will be run on all nodes
  95063. * @param node defines the root node where the animation will take place
  95064. * @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
  95065. * @param targetProperty defines property to animate
  95066. * @param framePerSecond defines the number of frame per second to use
  95067. * @param totalFrame defines the number of frames in total
  95068. * @param from defines the initial value
  95069. * @param to defines the final value
  95070. * @param loopMode defines which loop mode you want to use (off by default)
  95071. * @param easingFunction defines the easing function to use (linear by default)
  95072. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95073. * @returns the list of animatables created for all nodes
  95074. * @example https://www.babylonjs-playground.com/#MH0VLI
  95075. */
  95076. 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[]>;
  95077. /**
  95078. * Creates a new animation, merges it with the existing animations and starts it
  95079. * @param name Name of the animation
  95080. * @param node Node which contains the scene that begins the animations
  95081. * @param targetProperty Specifies which property to animate
  95082. * @param framePerSecond The frames per second of the animation
  95083. * @param totalFrame The total number of frames
  95084. * @param from The frame at the beginning of the animation
  95085. * @param to The frame at the end of the animation
  95086. * @param loopMode Specifies the loop mode of the animation
  95087. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  95088. * @param onAnimationEnd Callback to run once the animation is complete
  95089. * @returns Nullable animation
  95090. */
  95091. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  95092. /**
  95093. * Transition property of an host to the target Value
  95094. * @param property The property to transition
  95095. * @param targetValue The target Value of the property
  95096. * @param host The object where the property to animate belongs
  95097. * @param scene Scene used to run the animation
  95098. * @param frameRate Framerate (in frame/s) to use
  95099. * @param transition The transition type we want to use
  95100. * @param duration The duration of the animation, in milliseconds
  95101. * @param onAnimationEnd Callback trigger at the end of the animation
  95102. * @returns Nullable animation
  95103. */
  95104. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  95105. /**
  95106. * Return the array of runtime animations currently using this animation
  95107. */
  95108. readonly runtimeAnimations: RuntimeAnimation[];
  95109. /**
  95110. * Specifies if any of the runtime animations are currently running
  95111. */
  95112. readonly hasRunningRuntimeAnimations: boolean;
  95113. /**
  95114. * Initializes the animation
  95115. * @param name Name of the animation
  95116. * @param targetProperty Property to animate
  95117. * @param framePerSecond The frames per second of the animation
  95118. * @param dataType The data type of the animation
  95119. * @param loopMode The loop mode of the animation
  95120. * @param enableBlending Specifies if blending should be enabled
  95121. */
  95122. constructor(
  95123. /**Name of the animation */
  95124. name: string,
  95125. /**Property to animate */
  95126. targetProperty: string,
  95127. /**The frames per second of the animation */
  95128. framePerSecond: number,
  95129. /**The data type of the animation */
  95130. dataType: number,
  95131. /**The loop mode of the animation */
  95132. loopMode?: number | undefined,
  95133. /**Specifies if blending should be enabled */
  95134. enableBlending?: boolean | undefined);
  95135. /**
  95136. * Converts the animation to a string
  95137. * @param fullDetails support for multiple levels of logging within scene loading
  95138. * @returns String form of the animation
  95139. */
  95140. toString(fullDetails?: boolean): string;
  95141. /**
  95142. * Add an event to this animation
  95143. * @param event Event to add
  95144. */
  95145. addEvent(event: AnimationEvent): void;
  95146. /**
  95147. * Remove all events found at the given frame
  95148. * @param frame The frame to remove events from
  95149. */
  95150. removeEvents(frame: number): void;
  95151. /**
  95152. * Retrieves all the events from the animation
  95153. * @returns Events from the animation
  95154. */
  95155. getEvents(): AnimationEvent[];
  95156. /**
  95157. * Creates an animation range
  95158. * @param name Name of the animation range
  95159. * @param from Starting frame of the animation range
  95160. * @param to Ending frame of the animation
  95161. */
  95162. createRange(name: string, from: number, to: number): void;
  95163. /**
  95164. * Deletes an animation range by name
  95165. * @param name Name of the animation range to delete
  95166. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  95167. */
  95168. deleteRange(name: string, deleteFrames?: boolean): void;
  95169. /**
  95170. * Gets the animation range by name, or null if not defined
  95171. * @param name Name of the animation range
  95172. * @returns Nullable animation range
  95173. */
  95174. getRange(name: string): Nullable<AnimationRange>;
  95175. /**
  95176. * Gets the key frames from the animation
  95177. * @returns The key frames of the animation
  95178. */
  95179. getKeys(): Array<IAnimationKey>;
  95180. /**
  95181. * Gets the highest frame rate of the animation
  95182. * @returns Highest frame rate of the animation
  95183. */
  95184. getHighestFrame(): number;
  95185. /**
  95186. * Gets the easing function of the animation
  95187. * @returns Easing function of the animation
  95188. */
  95189. getEasingFunction(): IEasingFunction;
  95190. /**
  95191. * Sets the easing function of the animation
  95192. * @param easingFunction A custom mathematical formula for animation
  95193. */
  95194. setEasingFunction(easingFunction: EasingFunction): void;
  95195. /**
  95196. * Interpolates a scalar linearly
  95197. * @param startValue Start value of the animation curve
  95198. * @param endValue End value of the animation curve
  95199. * @param gradient Scalar amount to interpolate
  95200. * @returns Interpolated scalar value
  95201. */
  95202. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  95203. /**
  95204. * Interpolates a scalar cubically
  95205. * @param startValue Start value of the animation curve
  95206. * @param outTangent End tangent of the animation
  95207. * @param endValue End value of the animation curve
  95208. * @param inTangent Start tangent of the animation curve
  95209. * @param gradient Scalar amount to interpolate
  95210. * @returns Interpolated scalar value
  95211. */
  95212. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  95213. /**
  95214. * Interpolates a quaternion using a spherical linear interpolation
  95215. * @param startValue Start value of the animation curve
  95216. * @param endValue End value of the animation curve
  95217. * @param gradient Scalar amount to interpolate
  95218. * @returns Interpolated quaternion value
  95219. */
  95220. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  95221. /**
  95222. * Interpolates a quaternion cubically
  95223. * @param startValue Start value of the animation curve
  95224. * @param outTangent End tangent of the animation curve
  95225. * @param endValue End value of the animation curve
  95226. * @param inTangent Start tangent of the animation curve
  95227. * @param gradient Scalar amount to interpolate
  95228. * @returns Interpolated quaternion value
  95229. */
  95230. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  95231. /**
  95232. * Interpolates a Vector3 linearl
  95233. * @param startValue Start value of the animation curve
  95234. * @param endValue End value of the animation curve
  95235. * @param gradient Scalar amount to interpolate
  95236. * @returns Interpolated scalar value
  95237. */
  95238. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  95239. /**
  95240. * Interpolates a Vector3 cubically
  95241. * @param startValue Start value of the animation curve
  95242. * @param outTangent End tangent of the animation
  95243. * @param endValue End value of the animation curve
  95244. * @param inTangent Start tangent of the animation curve
  95245. * @param gradient Scalar amount to interpolate
  95246. * @returns InterpolatedVector3 value
  95247. */
  95248. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  95249. /**
  95250. * Interpolates a Vector2 linearly
  95251. * @param startValue Start value of the animation curve
  95252. * @param endValue End value of the animation curve
  95253. * @param gradient Scalar amount to interpolate
  95254. * @returns Interpolated Vector2 value
  95255. */
  95256. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  95257. /**
  95258. * Interpolates a Vector2 cubically
  95259. * @param startValue Start value of the animation curve
  95260. * @param outTangent End tangent of the animation
  95261. * @param endValue End value of the animation curve
  95262. * @param inTangent Start tangent of the animation curve
  95263. * @param gradient Scalar amount to interpolate
  95264. * @returns Interpolated Vector2 value
  95265. */
  95266. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  95267. /**
  95268. * Interpolates a size linearly
  95269. * @param startValue Start value of the animation curve
  95270. * @param endValue End value of the animation curve
  95271. * @param gradient Scalar amount to interpolate
  95272. * @returns Interpolated Size value
  95273. */
  95274. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  95275. /**
  95276. * Interpolates a Color3 linearly
  95277. * @param startValue Start value of the animation curve
  95278. * @param endValue End value of the animation curve
  95279. * @param gradient Scalar amount to interpolate
  95280. * @returns Interpolated Color3 value
  95281. */
  95282. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  95283. /**
  95284. * Interpolates a Color4 linearly
  95285. * @param startValue Start value of the animation curve
  95286. * @param endValue End value of the animation curve
  95287. * @param gradient Scalar amount to interpolate
  95288. * @returns Interpolated Color3 value
  95289. */
  95290. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  95291. /**
  95292. * @hidden Internal use only
  95293. */
  95294. _getKeyValue(value: any): any;
  95295. /**
  95296. * @hidden Internal use only
  95297. */
  95298. _interpolate(currentFrame: number, state: _IAnimationState): any;
  95299. /**
  95300. * Defines the function to use to interpolate matrices
  95301. * @param startValue defines the start matrix
  95302. * @param endValue defines the end matrix
  95303. * @param gradient defines the gradient between both matrices
  95304. * @param result defines an optional target matrix where to store the interpolation
  95305. * @returns the interpolated matrix
  95306. */
  95307. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  95308. /**
  95309. * Makes a copy of the animation
  95310. * @returns Cloned animation
  95311. */
  95312. clone(): Animation;
  95313. /**
  95314. * Sets the key frames of the animation
  95315. * @param values The animation key frames to set
  95316. */
  95317. setKeys(values: Array<IAnimationKey>): void;
  95318. /**
  95319. * Serializes the animation to an object
  95320. * @returns Serialized object
  95321. */
  95322. serialize(): any;
  95323. /**
  95324. * Float animation type
  95325. */
  95326. static readonly ANIMATIONTYPE_FLOAT: number;
  95327. /**
  95328. * Vector3 animation type
  95329. */
  95330. static readonly ANIMATIONTYPE_VECTOR3: number;
  95331. /**
  95332. * Quaternion animation type
  95333. */
  95334. static readonly ANIMATIONTYPE_QUATERNION: number;
  95335. /**
  95336. * Matrix animation type
  95337. */
  95338. static readonly ANIMATIONTYPE_MATRIX: number;
  95339. /**
  95340. * Color3 animation type
  95341. */
  95342. static readonly ANIMATIONTYPE_COLOR3: number;
  95343. /**
  95344. * Color3 animation type
  95345. */
  95346. static readonly ANIMATIONTYPE_COLOR4: number;
  95347. /**
  95348. * Vector2 animation type
  95349. */
  95350. static readonly ANIMATIONTYPE_VECTOR2: number;
  95351. /**
  95352. * Size animation type
  95353. */
  95354. static readonly ANIMATIONTYPE_SIZE: number;
  95355. /**
  95356. * Relative Loop Mode
  95357. */
  95358. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  95359. /**
  95360. * Cycle Loop Mode
  95361. */
  95362. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  95363. /**
  95364. * Constant Loop Mode
  95365. */
  95366. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  95367. /** @hidden */
  95368. static _UniversalLerp(left: any, right: any, amount: number): any;
  95369. /**
  95370. * Parses an animation object and creates an animation
  95371. * @param parsedAnimation Parsed animation object
  95372. * @returns Animation object
  95373. */
  95374. static Parse(parsedAnimation: any): Animation;
  95375. /**
  95376. * Appends the serialized animations from the source animations
  95377. * @param source Source containing the animations
  95378. * @param destination Target to store the animations
  95379. */
  95380. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  95381. }
  95382. }
  95383. declare module BABYLON {
  95384. /**
  95385. * Interface containing an array of animations
  95386. */
  95387. export interface IAnimatable {
  95388. /**
  95389. * Array of animations
  95390. */
  95391. animations: Nullable<Array<Animation>>;
  95392. }
  95393. }
  95394. declare module BABYLON {
  95395. /**
  95396. * This represents all the required information to add a fresnel effect on a material:
  95397. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  95398. */
  95399. export class FresnelParameters {
  95400. private _isEnabled;
  95401. /**
  95402. * Define if the fresnel effect is enable or not.
  95403. */
  95404. isEnabled: boolean;
  95405. /**
  95406. * Define the color used on edges (grazing angle)
  95407. */
  95408. leftColor: Color3;
  95409. /**
  95410. * Define the color used on center
  95411. */
  95412. rightColor: Color3;
  95413. /**
  95414. * Define bias applied to computed fresnel term
  95415. */
  95416. bias: number;
  95417. /**
  95418. * Defined the power exponent applied to fresnel term
  95419. */
  95420. power: number;
  95421. /**
  95422. * Clones the current fresnel and its valuues
  95423. * @returns a clone fresnel configuration
  95424. */
  95425. clone(): FresnelParameters;
  95426. /**
  95427. * Serializes the current fresnel parameters to a JSON representation.
  95428. * @return the JSON serialization
  95429. */
  95430. serialize(): any;
  95431. /**
  95432. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  95433. * @param parsedFresnelParameters Define the JSON representation
  95434. * @returns the parsed parameters
  95435. */
  95436. static Parse(parsedFresnelParameters: any): FresnelParameters;
  95437. }
  95438. }
  95439. declare module BABYLON {
  95440. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  95441. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95442. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95443. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95444. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95445. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95446. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95447. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95448. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95449. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95450. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95451. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95452. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95453. /**
  95454. * Decorator used to define property that can be serialized as reference to a camera
  95455. * @param sourceName defines the name of the property to decorate
  95456. */
  95457. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95458. /**
  95459. * Class used to help serialization objects
  95460. */
  95461. export class SerializationHelper {
  95462. /** @hidden */
  95463. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  95464. /** @hidden */
  95465. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  95466. /** @hidden */
  95467. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  95468. /** @hidden */
  95469. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  95470. /**
  95471. * Appends the serialized animations from the source animations
  95472. * @param source Source containing the animations
  95473. * @param destination Target to store the animations
  95474. */
  95475. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  95476. /**
  95477. * Static function used to serialized a specific entity
  95478. * @param entity defines the entity to serialize
  95479. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  95480. * @returns a JSON compatible object representing the serialization of the entity
  95481. */
  95482. static Serialize<T>(entity: T, serializationObject?: any): any;
  95483. /**
  95484. * Creates a new entity from a serialization data object
  95485. * @param creationFunction defines a function used to instanciated the new entity
  95486. * @param source defines the source serialization data
  95487. * @param scene defines the hosting scene
  95488. * @param rootUrl defines the root url for resources
  95489. * @returns a new entity
  95490. */
  95491. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  95492. /**
  95493. * Clones an object
  95494. * @param creationFunction defines the function used to instanciate the new object
  95495. * @param source defines the source object
  95496. * @returns the cloned object
  95497. */
  95498. static Clone<T>(creationFunction: () => T, source: T): T;
  95499. /**
  95500. * Instanciates a new object based on a source one (some data will be shared between both object)
  95501. * @param creationFunction defines the function used to instanciate the new object
  95502. * @param source defines the source object
  95503. * @returns the new object
  95504. */
  95505. static Instanciate<T>(creationFunction: () => T, source: T): T;
  95506. }
  95507. }
  95508. declare module BABYLON {
  95509. /**
  95510. * Class used to manipulate GUIDs
  95511. */
  95512. export class GUID {
  95513. /**
  95514. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  95515. * Be aware Math.random() could cause collisions, but:
  95516. * "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"
  95517. * @returns a pseudo random id
  95518. */
  95519. static RandomId(): string;
  95520. }
  95521. }
  95522. declare module BABYLON {
  95523. /**
  95524. * Base class of all the textures in babylon.
  95525. * It groups all the common properties the materials, post process, lights... might need
  95526. * in order to make a correct use of the texture.
  95527. */
  95528. export class BaseTexture implements IAnimatable {
  95529. /**
  95530. * Default anisotropic filtering level for the application.
  95531. * It is set to 4 as a good tradeoff between perf and quality.
  95532. */
  95533. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  95534. /**
  95535. * Gets or sets the unique id of the texture
  95536. */
  95537. uniqueId: number;
  95538. /**
  95539. * Define the name of the texture.
  95540. */
  95541. name: string;
  95542. /**
  95543. * Gets or sets an object used to store user defined information.
  95544. */
  95545. metadata: any;
  95546. /**
  95547. * For internal use only. Please do not use.
  95548. */
  95549. reservedDataStore: any;
  95550. private _hasAlpha;
  95551. /**
  95552. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  95553. */
  95554. hasAlpha: boolean;
  95555. /**
  95556. * Defines if the alpha value should be determined via the rgb values.
  95557. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  95558. */
  95559. getAlphaFromRGB: boolean;
  95560. /**
  95561. * Intensity or strength of the texture.
  95562. * It is commonly used by materials to fine tune the intensity of the texture
  95563. */
  95564. level: number;
  95565. /**
  95566. * Define the UV chanel to use starting from 0 and defaulting to 0.
  95567. * This is part of the texture as textures usually maps to one uv set.
  95568. */
  95569. coordinatesIndex: number;
  95570. private _coordinatesMode;
  95571. /**
  95572. * How a texture is mapped.
  95573. *
  95574. * | Value | Type | Description |
  95575. * | ----- | ----------------------------------- | ----------- |
  95576. * | 0 | EXPLICIT_MODE | |
  95577. * | 1 | SPHERICAL_MODE | |
  95578. * | 2 | PLANAR_MODE | |
  95579. * | 3 | CUBIC_MODE | |
  95580. * | 4 | PROJECTION_MODE | |
  95581. * | 5 | SKYBOX_MODE | |
  95582. * | 6 | INVCUBIC_MODE | |
  95583. * | 7 | EQUIRECTANGULAR_MODE | |
  95584. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  95585. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  95586. */
  95587. coordinatesMode: number;
  95588. /**
  95589. * | Value | Type | Description |
  95590. * | ----- | ------------------ | ----------- |
  95591. * | 0 | CLAMP_ADDRESSMODE | |
  95592. * | 1 | WRAP_ADDRESSMODE | |
  95593. * | 2 | MIRROR_ADDRESSMODE | |
  95594. */
  95595. wrapU: number;
  95596. /**
  95597. * | Value | Type | Description |
  95598. * | ----- | ------------------ | ----------- |
  95599. * | 0 | CLAMP_ADDRESSMODE | |
  95600. * | 1 | WRAP_ADDRESSMODE | |
  95601. * | 2 | MIRROR_ADDRESSMODE | |
  95602. */
  95603. wrapV: number;
  95604. /**
  95605. * | Value | Type | Description |
  95606. * | ----- | ------------------ | ----------- |
  95607. * | 0 | CLAMP_ADDRESSMODE | |
  95608. * | 1 | WRAP_ADDRESSMODE | |
  95609. * | 2 | MIRROR_ADDRESSMODE | |
  95610. */
  95611. wrapR: number;
  95612. /**
  95613. * With compliant hardware and browser (supporting anisotropic filtering)
  95614. * this defines the level of anisotropic filtering in the texture.
  95615. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  95616. */
  95617. anisotropicFilteringLevel: number;
  95618. /**
  95619. * Define if the texture is a cube texture or if false a 2d texture.
  95620. */
  95621. isCube: boolean;
  95622. /**
  95623. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  95624. */
  95625. is3D: boolean;
  95626. /**
  95627. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  95628. * HDR texture are usually stored in linear space.
  95629. * This only impacts the PBR and Background materials
  95630. */
  95631. gammaSpace: boolean;
  95632. /**
  95633. * Gets or sets whether or not the texture contains RGBD data.
  95634. */
  95635. isRGBD: boolean;
  95636. /**
  95637. * Is Z inverted in the texture (useful in a cube texture).
  95638. */
  95639. invertZ: boolean;
  95640. /**
  95641. * Are mip maps generated for this texture or not.
  95642. */
  95643. readonly noMipmap: boolean;
  95644. /**
  95645. * @hidden
  95646. */
  95647. lodLevelInAlpha: boolean;
  95648. /**
  95649. * With prefiltered texture, defined the offset used during the prefiltering steps.
  95650. */
  95651. lodGenerationOffset: number;
  95652. /**
  95653. * With prefiltered texture, defined the scale used during the prefiltering steps.
  95654. */
  95655. lodGenerationScale: number;
  95656. /**
  95657. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  95658. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  95659. * average roughness values.
  95660. */
  95661. linearSpecularLOD: boolean;
  95662. /**
  95663. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  95664. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  95665. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  95666. */
  95667. irradianceTexture: Nullable<BaseTexture>;
  95668. /**
  95669. * Define if the texture is a render target.
  95670. */
  95671. isRenderTarget: boolean;
  95672. /**
  95673. * Define the unique id of the texture in the scene.
  95674. */
  95675. readonly uid: string;
  95676. /**
  95677. * Return a string representation of the texture.
  95678. * @returns the texture as a string
  95679. */
  95680. toString(): string;
  95681. /**
  95682. * Get the class name of the texture.
  95683. * @returns "BaseTexture"
  95684. */
  95685. getClassName(): string;
  95686. /**
  95687. * Define the list of animation attached to the texture.
  95688. */
  95689. animations: Animation[];
  95690. /**
  95691. * An event triggered when the texture is disposed.
  95692. */
  95693. onDisposeObservable: Observable<BaseTexture>;
  95694. private _onDisposeObserver;
  95695. /**
  95696. * Callback triggered when the texture has been disposed.
  95697. * Kept for back compatibility, you can use the onDisposeObservable instead.
  95698. */
  95699. onDispose: () => void;
  95700. /**
  95701. * Define the current state of the loading sequence when in delayed load mode.
  95702. */
  95703. delayLoadState: number;
  95704. private _scene;
  95705. /** @hidden */
  95706. _texture: Nullable<InternalTexture>;
  95707. private _uid;
  95708. /**
  95709. * Define if the texture is preventinga material to render or not.
  95710. * If not and the texture is not ready, the engine will use a default black texture instead.
  95711. */
  95712. readonly isBlocking: boolean;
  95713. /**
  95714. * Instantiates a new BaseTexture.
  95715. * Base class of all the textures in babylon.
  95716. * It groups all the common properties the materials, post process, lights... might need
  95717. * in order to make a correct use of the texture.
  95718. * @param scene Define the scene the texture blongs to
  95719. */
  95720. constructor(scene: Nullable<Scene>);
  95721. /**
  95722. * Get the scene the texture belongs to.
  95723. * @returns the scene or null if undefined
  95724. */
  95725. getScene(): Nullable<Scene>;
  95726. /**
  95727. * Get the texture transform matrix used to offset tile the texture for istance.
  95728. * @returns the transformation matrix
  95729. */
  95730. getTextureMatrix(): Matrix;
  95731. /**
  95732. * Get the texture reflection matrix used to rotate/transform the reflection.
  95733. * @returns the reflection matrix
  95734. */
  95735. getReflectionTextureMatrix(): Matrix;
  95736. /**
  95737. * Get the underlying lower level texture from Babylon.
  95738. * @returns the insternal texture
  95739. */
  95740. getInternalTexture(): Nullable<InternalTexture>;
  95741. /**
  95742. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  95743. * @returns true if ready or not blocking
  95744. */
  95745. isReadyOrNotBlocking(): boolean;
  95746. /**
  95747. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  95748. * @returns true if fully ready
  95749. */
  95750. isReady(): boolean;
  95751. private _cachedSize;
  95752. /**
  95753. * Get the size of the texture.
  95754. * @returns the texture size.
  95755. */
  95756. getSize(): ISize;
  95757. /**
  95758. * Get the base size of the texture.
  95759. * It can be different from the size if the texture has been resized for POT for instance
  95760. * @returns the base size
  95761. */
  95762. getBaseSize(): ISize;
  95763. /**
  95764. * Update the sampling mode of the texture.
  95765. * Default is Trilinear mode.
  95766. *
  95767. * | Value | Type | Description |
  95768. * | ----- | ------------------ | ----------- |
  95769. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  95770. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  95771. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  95772. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  95773. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  95774. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  95775. * | 7 | NEAREST_LINEAR | |
  95776. * | 8 | NEAREST_NEAREST | |
  95777. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  95778. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  95779. * | 11 | LINEAR_LINEAR | |
  95780. * | 12 | LINEAR_NEAREST | |
  95781. *
  95782. * > _mag_: magnification filter (close to the viewer)
  95783. * > _min_: minification filter (far from the viewer)
  95784. * > _mip_: filter used between mip map levels
  95785. *@param samplingMode Define the new sampling mode of the texture
  95786. */
  95787. updateSamplingMode(samplingMode: number): void;
  95788. /**
  95789. * Scales the texture if is `canRescale()`
  95790. * @param ratio the resize factor we want to use to rescale
  95791. */
  95792. scale(ratio: number): void;
  95793. /**
  95794. * Get if the texture can rescale.
  95795. */
  95796. readonly canRescale: boolean;
  95797. /** @hidden */
  95798. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  95799. /** @hidden */
  95800. _rebuild(): void;
  95801. /**
  95802. * Triggers the load sequence in delayed load mode.
  95803. */
  95804. delayLoad(): void;
  95805. /**
  95806. * Clones the texture.
  95807. * @returns the cloned texture
  95808. */
  95809. clone(): Nullable<BaseTexture>;
  95810. /**
  95811. * Get the texture underlying type (INT, FLOAT...)
  95812. */
  95813. readonly textureType: number;
  95814. /**
  95815. * Get the texture underlying format (RGB, RGBA...)
  95816. */
  95817. readonly textureFormat: number;
  95818. /**
  95819. * Indicates that textures need to be re-calculated for all materials
  95820. */
  95821. protected _markAllSubMeshesAsTexturesDirty(): void;
  95822. /**
  95823. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  95824. * This will returns an RGBA array buffer containing either in values (0-255) or
  95825. * float values (0-1) depending of the underlying buffer type.
  95826. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  95827. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  95828. * @param buffer defines a user defined buffer to fill with data (can be null)
  95829. * @returns The Array buffer containing the pixels data.
  95830. */
  95831. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  95832. /**
  95833. * Release and destroy the underlying lower level texture aka internalTexture.
  95834. */
  95835. releaseInternalTexture(): void;
  95836. /** @hidden */
  95837. readonly _lodTextureHigh: Nullable<BaseTexture>;
  95838. /** @hidden */
  95839. readonly _lodTextureMid: Nullable<BaseTexture>;
  95840. /** @hidden */
  95841. readonly _lodTextureLow: Nullable<BaseTexture>;
  95842. /**
  95843. * Dispose the texture and release its associated resources.
  95844. */
  95845. dispose(): void;
  95846. /**
  95847. * Serialize the texture into a JSON representation that can be parsed later on.
  95848. * @returns the JSON representation of the texture
  95849. */
  95850. serialize(): any;
  95851. /**
  95852. * Helper function to be called back once a list of texture contains only ready textures.
  95853. * @param textures Define the list of textures to wait for
  95854. * @param callback Define the callback triggered once the entire list will be ready
  95855. */
  95856. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  95857. }
  95858. }
  95859. declare module BABYLON {
  95860. /**
  95861. * Options to be used when creating an effect.
  95862. */
  95863. export interface IEffectCreationOptions {
  95864. /**
  95865. * Atrributes that will be used in the shader.
  95866. */
  95867. attributes: string[];
  95868. /**
  95869. * Uniform varible names that will be set in the shader.
  95870. */
  95871. uniformsNames: string[];
  95872. /**
  95873. * Uniform buffer varible names that will be set in the shader.
  95874. */
  95875. uniformBuffersNames: string[];
  95876. /**
  95877. * Sampler texture variable names that will be set in the shader.
  95878. */
  95879. samplers: string[];
  95880. /**
  95881. * Define statements that will be set in the shader.
  95882. */
  95883. defines: any;
  95884. /**
  95885. * Possible fallbacks for this effect to improve performance when needed.
  95886. */
  95887. fallbacks: Nullable<IEffectFallbacks>;
  95888. /**
  95889. * Callback that will be called when the shader is compiled.
  95890. */
  95891. onCompiled: Nullable<(effect: Effect) => void>;
  95892. /**
  95893. * Callback that will be called if an error occurs during shader compilation.
  95894. */
  95895. onError: Nullable<(effect: Effect, errors: string) => void>;
  95896. /**
  95897. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  95898. */
  95899. indexParameters?: any;
  95900. /**
  95901. * Max number of lights that can be used in the shader.
  95902. */
  95903. maxSimultaneousLights?: number;
  95904. /**
  95905. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  95906. */
  95907. transformFeedbackVaryings?: Nullable<string[]>;
  95908. }
  95909. /**
  95910. * Effect containing vertex and fragment shader that can be executed on an object.
  95911. */
  95912. export class Effect implements IDisposable {
  95913. /**
  95914. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  95915. */
  95916. static ShadersRepository: string;
  95917. /**
  95918. * Name of the effect.
  95919. */
  95920. name: any;
  95921. /**
  95922. * String container all the define statements that should be set on the shader.
  95923. */
  95924. defines: string;
  95925. /**
  95926. * Callback that will be called when the shader is compiled.
  95927. */
  95928. onCompiled: Nullable<(effect: Effect) => void>;
  95929. /**
  95930. * Callback that will be called if an error occurs during shader compilation.
  95931. */
  95932. onError: Nullable<(effect: Effect, errors: string) => void>;
  95933. /**
  95934. * Callback that will be called when effect is bound.
  95935. */
  95936. onBind: Nullable<(effect: Effect) => void>;
  95937. /**
  95938. * Unique ID of the effect.
  95939. */
  95940. uniqueId: number;
  95941. /**
  95942. * Observable that will be called when the shader is compiled.
  95943. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  95944. */
  95945. onCompileObservable: Observable<Effect>;
  95946. /**
  95947. * Observable that will be called if an error occurs during shader compilation.
  95948. */
  95949. onErrorObservable: Observable<Effect>;
  95950. /** @hidden */
  95951. _onBindObservable: Nullable<Observable<Effect>>;
  95952. /**
  95953. * Observable that will be called when effect is bound.
  95954. */
  95955. readonly onBindObservable: Observable<Effect>;
  95956. /** @hidden */
  95957. _bonesComputationForcedToCPU: boolean;
  95958. private static _uniqueIdSeed;
  95959. private _engine;
  95960. private _uniformBuffersNames;
  95961. private _uniformsNames;
  95962. private _samplerList;
  95963. private _samplers;
  95964. private _isReady;
  95965. private _compilationError;
  95966. private _allFallbacksProcessed;
  95967. private _attributesNames;
  95968. private _attributes;
  95969. private _uniforms;
  95970. /**
  95971. * Key for the effect.
  95972. * @hidden
  95973. */
  95974. _key: string;
  95975. private _indexParameters;
  95976. private _fallbacks;
  95977. private _vertexSourceCode;
  95978. private _fragmentSourceCode;
  95979. private _vertexSourceCodeOverride;
  95980. private _fragmentSourceCodeOverride;
  95981. private _transformFeedbackVaryings;
  95982. /**
  95983. * Compiled shader to webGL program.
  95984. * @hidden
  95985. */
  95986. _pipelineContext: Nullable<IPipelineContext>;
  95987. private _valueCache;
  95988. private static _baseCache;
  95989. /**
  95990. * Instantiates an effect.
  95991. * An effect can be used to create/manage/execute vertex and fragment shaders.
  95992. * @param baseName Name of the effect.
  95993. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  95994. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  95995. * @param samplers List of sampler variables that will be passed to the shader.
  95996. * @param engine Engine to be used to render the effect
  95997. * @param defines Define statements to be added to the shader.
  95998. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  95999. * @param onCompiled Callback that will be called when the shader is compiled.
  96000. * @param onError Callback that will be called if an error occurs during shader compilation.
  96001. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  96002. */
  96003. 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);
  96004. private _useFinalCode;
  96005. /**
  96006. * Unique key for this effect
  96007. */
  96008. readonly key: string;
  96009. /**
  96010. * If the effect has been compiled and prepared.
  96011. * @returns if the effect is compiled and prepared.
  96012. */
  96013. isReady(): boolean;
  96014. private _isReadyInternal;
  96015. /**
  96016. * The engine the effect was initialized with.
  96017. * @returns the engine.
  96018. */
  96019. getEngine(): Engine;
  96020. /**
  96021. * The pipeline context for this effect
  96022. * @returns the associated pipeline context
  96023. */
  96024. getPipelineContext(): Nullable<IPipelineContext>;
  96025. /**
  96026. * The set of names of attribute variables for the shader.
  96027. * @returns An array of attribute names.
  96028. */
  96029. getAttributesNames(): string[];
  96030. /**
  96031. * Returns the attribute at the given index.
  96032. * @param index The index of the attribute.
  96033. * @returns The location of the attribute.
  96034. */
  96035. getAttributeLocation(index: number): number;
  96036. /**
  96037. * Returns the attribute based on the name of the variable.
  96038. * @param name of the attribute to look up.
  96039. * @returns the attribute location.
  96040. */
  96041. getAttributeLocationByName(name: string): number;
  96042. /**
  96043. * The number of attributes.
  96044. * @returns the numnber of attributes.
  96045. */
  96046. getAttributesCount(): number;
  96047. /**
  96048. * Gets the index of a uniform variable.
  96049. * @param uniformName of the uniform to look up.
  96050. * @returns the index.
  96051. */
  96052. getUniformIndex(uniformName: string): number;
  96053. /**
  96054. * Returns the attribute based on the name of the variable.
  96055. * @param uniformName of the uniform to look up.
  96056. * @returns the location of the uniform.
  96057. */
  96058. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  96059. /**
  96060. * Returns an array of sampler variable names
  96061. * @returns The array of sampler variable neames.
  96062. */
  96063. getSamplers(): string[];
  96064. /**
  96065. * The error from the last compilation.
  96066. * @returns the error string.
  96067. */
  96068. getCompilationError(): string;
  96069. /**
  96070. * Gets a boolean indicating that all fallbacks were used during compilation
  96071. * @returns true if all fallbacks were used
  96072. */
  96073. allFallbacksProcessed(): boolean;
  96074. /**
  96075. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  96076. * @param func The callback to be used.
  96077. */
  96078. executeWhenCompiled(func: (effect: Effect) => void): void;
  96079. private _checkIsReady;
  96080. private _loadShader;
  96081. /**
  96082. * Recompiles the webGL program
  96083. * @param vertexSourceCode The source code for the vertex shader.
  96084. * @param fragmentSourceCode The source code for the fragment shader.
  96085. * @param onCompiled Callback called when completed.
  96086. * @param onError Callback called on error.
  96087. * @hidden
  96088. */
  96089. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  96090. /**
  96091. * Prepares the effect
  96092. * @hidden
  96093. */
  96094. _prepareEffect(): void;
  96095. private _processCompilationErrors;
  96096. /**
  96097. * Checks if the effect is supported. (Must be called after compilation)
  96098. */
  96099. readonly isSupported: boolean;
  96100. /**
  96101. * Binds a texture to the engine to be used as output of the shader.
  96102. * @param channel Name of the output variable.
  96103. * @param texture Texture to bind.
  96104. * @hidden
  96105. */
  96106. _bindTexture(channel: string, texture: InternalTexture): void;
  96107. /**
  96108. * Sets a texture on the engine to be used in the shader.
  96109. * @param channel Name of the sampler variable.
  96110. * @param texture Texture to set.
  96111. */
  96112. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  96113. /**
  96114. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  96115. * @param channel Name of the sampler variable.
  96116. * @param texture Texture to set.
  96117. */
  96118. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  96119. /**
  96120. * Sets an array of textures on the engine to be used in the shader.
  96121. * @param channel Name of the variable.
  96122. * @param textures Textures to set.
  96123. */
  96124. setTextureArray(channel: string, textures: BaseTexture[]): void;
  96125. /**
  96126. * 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)
  96127. * @param channel Name of the sampler variable.
  96128. * @param postProcess Post process to get the input texture from.
  96129. */
  96130. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  96131. /**
  96132. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  96133. * 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)
  96134. * @param channel Name of the sampler variable.
  96135. * @param postProcess Post process to get the output texture from.
  96136. */
  96137. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  96138. /** @hidden */
  96139. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  96140. /** @hidden */
  96141. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  96142. /** @hidden */
  96143. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  96144. /** @hidden */
  96145. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  96146. /**
  96147. * Binds a buffer to a uniform.
  96148. * @param buffer Buffer to bind.
  96149. * @param name Name of the uniform variable to bind to.
  96150. */
  96151. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  96152. /**
  96153. * Binds block to a uniform.
  96154. * @param blockName Name of the block to bind.
  96155. * @param index Index to bind.
  96156. */
  96157. bindUniformBlock(blockName: string, index: number): void;
  96158. /**
  96159. * Sets an interger value on a uniform variable.
  96160. * @param uniformName Name of the variable.
  96161. * @param value Value to be set.
  96162. * @returns this effect.
  96163. */
  96164. setInt(uniformName: string, value: number): Effect;
  96165. /**
  96166. * Sets an int array on a uniform variable.
  96167. * @param uniformName Name of the variable.
  96168. * @param array array to be set.
  96169. * @returns this effect.
  96170. */
  96171. setIntArray(uniformName: string, array: Int32Array): Effect;
  96172. /**
  96173. * 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)
  96174. * @param uniformName Name of the variable.
  96175. * @param array array to be set.
  96176. * @returns this effect.
  96177. */
  96178. setIntArray2(uniformName: string, array: Int32Array): Effect;
  96179. /**
  96180. * 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)
  96181. * @param uniformName Name of the variable.
  96182. * @param array array to be set.
  96183. * @returns this effect.
  96184. */
  96185. setIntArray3(uniformName: string, array: Int32Array): Effect;
  96186. /**
  96187. * 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)
  96188. * @param uniformName Name of the variable.
  96189. * @param array array to be set.
  96190. * @returns this effect.
  96191. */
  96192. setIntArray4(uniformName: string, array: Int32Array): Effect;
  96193. /**
  96194. * Sets an float array on a uniform variable.
  96195. * @param uniformName Name of the variable.
  96196. * @param array array to be set.
  96197. * @returns this effect.
  96198. */
  96199. setFloatArray(uniformName: string, array: Float32Array): Effect;
  96200. /**
  96201. * 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)
  96202. * @param uniformName Name of the variable.
  96203. * @param array array to be set.
  96204. * @returns this effect.
  96205. */
  96206. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  96207. /**
  96208. * 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)
  96209. * @param uniformName Name of the variable.
  96210. * @param array array to be set.
  96211. * @returns this effect.
  96212. */
  96213. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  96214. /**
  96215. * 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)
  96216. * @param uniformName Name of the variable.
  96217. * @param array array to be set.
  96218. * @returns this effect.
  96219. */
  96220. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  96221. /**
  96222. * Sets an array on a uniform variable.
  96223. * @param uniformName Name of the variable.
  96224. * @param array array to be set.
  96225. * @returns this effect.
  96226. */
  96227. setArray(uniformName: string, array: number[]): Effect;
  96228. /**
  96229. * 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)
  96230. * @param uniformName Name of the variable.
  96231. * @param array array to be set.
  96232. * @returns this effect.
  96233. */
  96234. setArray2(uniformName: string, array: number[]): Effect;
  96235. /**
  96236. * 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)
  96237. * @param uniformName Name of the variable.
  96238. * @param array array to be set.
  96239. * @returns this effect.
  96240. */
  96241. setArray3(uniformName: string, array: number[]): Effect;
  96242. /**
  96243. * 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)
  96244. * @param uniformName Name of the variable.
  96245. * @param array array to be set.
  96246. * @returns this effect.
  96247. */
  96248. setArray4(uniformName: string, array: number[]): Effect;
  96249. /**
  96250. * Sets matrices on a uniform variable.
  96251. * @param uniformName Name of the variable.
  96252. * @param matrices matrices to be set.
  96253. * @returns this effect.
  96254. */
  96255. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  96256. /**
  96257. * Sets matrix on a uniform variable.
  96258. * @param uniformName Name of the variable.
  96259. * @param matrix matrix to be set.
  96260. * @returns this effect.
  96261. */
  96262. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  96263. /**
  96264. * 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)
  96265. * @param uniformName Name of the variable.
  96266. * @param matrix matrix to be set.
  96267. * @returns this effect.
  96268. */
  96269. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  96270. /**
  96271. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  96272. * @param uniformName Name of the variable.
  96273. * @param matrix matrix to be set.
  96274. * @returns this effect.
  96275. */
  96276. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  96277. /**
  96278. * Sets a float on a uniform variable.
  96279. * @param uniformName Name of the variable.
  96280. * @param value value to be set.
  96281. * @returns this effect.
  96282. */
  96283. setFloat(uniformName: string, value: number): Effect;
  96284. /**
  96285. * Sets a boolean on a uniform variable.
  96286. * @param uniformName Name of the variable.
  96287. * @param bool value to be set.
  96288. * @returns this effect.
  96289. */
  96290. setBool(uniformName: string, bool: boolean): Effect;
  96291. /**
  96292. * Sets a Vector2 on a uniform variable.
  96293. * @param uniformName Name of the variable.
  96294. * @param vector2 vector2 to be set.
  96295. * @returns this effect.
  96296. */
  96297. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  96298. /**
  96299. * Sets a float2 on a uniform variable.
  96300. * @param uniformName Name of the variable.
  96301. * @param x First float in float2.
  96302. * @param y Second float in float2.
  96303. * @returns this effect.
  96304. */
  96305. setFloat2(uniformName: string, x: number, y: number): Effect;
  96306. /**
  96307. * Sets a Vector3 on a uniform variable.
  96308. * @param uniformName Name of the variable.
  96309. * @param vector3 Value to be set.
  96310. * @returns this effect.
  96311. */
  96312. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  96313. /**
  96314. * Sets a float3 on a uniform variable.
  96315. * @param uniformName Name of the variable.
  96316. * @param x First float in float3.
  96317. * @param y Second float in float3.
  96318. * @param z Third float in float3.
  96319. * @returns this effect.
  96320. */
  96321. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  96322. /**
  96323. * Sets a Vector4 on a uniform variable.
  96324. * @param uniformName Name of the variable.
  96325. * @param vector4 Value to be set.
  96326. * @returns this effect.
  96327. */
  96328. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  96329. /**
  96330. * Sets a float4 on a uniform variable.
  96331. * @param uniformName Name of the variable.
  96332. * @param x First float in float4.
  96333. * @param y Second float in float4.
  96334. * @param z Third float in float4.
  96335. * @param w Fourth float in float4.
  96336. * @returns this effect.
  96337. */
  96338. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  96339. /**
  96340. * Sets a Color3 on a uniform variable.
  96341. * @param uniformName Name of the variable.
  96342. * @param color3 Value to be set.
  96343. * @returns this effect.
  96344. */
  96345. setColor3(uniformName: string, color3: IColor3Like): Effect;
  96346. /**
  96347. * Sets a Color4 on a uniform variable.
  96348. * @param uniformName Name of the variable.
  96349. * @param color3 Value to be set.
  96350. * @param alpha Alpha value to be set.
  96351. * @returns this effect.
  96352. */
  96353. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  96354. /**
  96355. * Sets a Color4 on a uniform variable
  96356. * @param uniformName defines the name of the variable
  96357. * @param color4 defines the value to be set
  96358. * @returns this effect.
  96359. */
  96360. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  96361. /** Release all associated resources */
  96362. dispose(): void;
  96363. /**
  96364. * This function will add a new shader to the shader store
  96365. * @param name the name of the shader
  96366. * @param pixelShader optional pixel shader content
  96367. * @param vertexShader optional vertex shader content
  96368. */
  96369. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  96370. /**
  96371. * Store of each shader (The can be looked up using effect.key)
  96372. */
  96373. static ShadersStore: {
  96374. [key: string]: string;
  96375. };
  96376. /**
  96377. * Store of each included file for a shader (The can be looked up using effect.key)
  96378. */
  96379. static IncludesShadersStore: {
  96380. [key: string]: string;
  96381. };
  96382. /**
  96383. * Resets the cache of effects.
  96384. */
  96385. static ResetCache(): void;
  96386. }
  96387. }
  96388. declare module BABYLON {
  96389. /**
  96390. * Interface used to describe the capabilities of the engine relatively to the current browser
  96391. */
  96392. export interface EngineCapabilities {
  96393. /** Maximum textures units per fragment shader */
  96394. maxTexturesImageUnits: number;
  96395. /** Maximum texture units per vertex shader */
  96396. maxVertexTextureImageUnits: number;
  96397. /** Maximum textures units in the entire pipeline */
  96398. maxCombinedTexturesImageUnits: number;
  96399. /** Maximum texture size */
  96400. maxTextureSize: number;
  96401. /** Maximum cube texture size */
  96402. maxCubemapTextureSize: number;
  96403. /** Maximum render texture size */
  96404. maxRenderTextureSize: number;
  96405. /** Maximum number of vertex attributes */
  96406. maxVertexAttribs: number;
  96407. /** Maximum number of varyings */
  96408. maxVaryingVectors: number;
  96409. /** Maximum number of uniforms per vertex shader */
  96410. maxVertexUniformVectors: number;
  96411. /** Maximum number of uniforms per fragment shader */
  96412. maxFragmentUniformVectors: number;
  96413. /** Defines if standard derivates (dx/dy) are supported */
  96414. standardDerivatives: boolean;
  96415. /** Defines if s3tc texture compression is supported */
  96416. s3tc?: WEBGL_compressed_texture_s3tc;
  96417. /** Defines if pvrtc texture compression is supported */
  96418. pvrtc: any;
  96419. /** Defines if etc1 texture compression is supported */
  96420. etc1: any;
  96421. /** Defines if etc2 texture compression is supported */
  96422. etc2: any;
  96423. /** Defines if astc texture compression is supported */
  96424. astc: any;
  96425. /** Defines if float textures are supported */
  96426. textureFloat: boolean;
  96427. /** Defines if vertex array objects are supported */
  96428. vertexArrayObject: boolean;
  96429. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  96430. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  96431. /** Gets the maximum level of anisotropy supported */
  96432. maxAnisotropy: number;
  96433. /** Defines if instancing is supported */
  96434. instancedArrays: boolean;
  96435. /** Defines if 32 bits indices are supported */
  96436. uintIndices: boolean;
  96437. /** Defines if high precision shaders are supported */
  96438. highPrecisionShaderSupported: boolean;
  96439. /** Defines if depth reading in the fragment shader is supported */
  96440. fragmentDepthSupported: boolean;
  96441. /** Defines if float texture linear filtering is supported*/
  96442. textureFloatLinearFiltering: boolean;
  96443. /** Defines if rendering to float textures is supported */
  96444. textureFloatRender: boolean;
  96445. /** Defines if half float textures are supported*/
  96446. textureHalfFloat: boolean;
  96447. /** Defines if half float texture linear filtering is supported*/
  96448. textureHalfFloatLinearFiltering: boolean;
  96449. /** Defines if rendering to half float textures is supported */
  96450. textureHalfFloatRender: boolean;
  96451. /** Defines if textureLOD shader command is supported */
  96452. textureLOD: boolean;
  96453. /** Defines if draw buffers extension is supported */
  96454. drawBuffersExtension: boolean;
  96455. /** Defines if depth textures are supported */
  96456. depthTextureExtension: boolean;
  96457. /** Defines if float color buffer are supported */
  96458. colorBufferFloat: boolean;
  96459. /** Gets disjoint timer query extension (null if not supported) */
  96460. timerQuery?: EXT_disjoint_timer_query;
  96461. /** Defines if timestamp can be used with timer query */
  96462. canUseTimestampForTimerQuery: boolean;
  96463. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  96464. multiview?: any;
  96465. /** Function used to let the system compiles shaders in background */
  96466. parallelShaderCompile?: {
  96467. COMPLETION_STATUS_KHR: number;
  96468. };
  96469. /** Max number of texture samples for MSAA */
  96470. maxMSAASamples: number;
  96471. /** Defines if the blend min max extension is supported */
  96472. blendMinMax: boolean;
  96473. }
  96474. }
  96475. declare module BABYLON {
  96476. /**
  96477. * @hidden
  96478. **/
  96479. export class DepthCullingState {
  96480. private _isDepthTestDirty;
  96481. private _isDepthMaskDirty;
  96482. private _isDepthFuncDirty;
  96483. private _isCullFaceDirty;
  96484. private _isCullDirty;
  96485. private _isZOffsetDirty;
  96486. private _isFrontFaceDirty;
  96487. private _depthTest;
  96488. private _depthMask;
  96489. private _depthFunc;
  96490. private _cull;
  96491. private _cullFace;
  96492. private _zOffset;
  96493. private _frontFace;
  96494. /**
  96495. * Initializes the state.
  96496. */
  96497. constructor();
  96498. readonly isDirty: boolean;
  96499. zOffset: number;
  96500. cullFace: Nullable<number>;
  96501. cull: Nullable<boolean>;
  96502. depthFunc: Nullable<number>;
  96503. depthMask: boolean;
  96504. depthTest: boolean;
  96505. frontFace: Nullable<number>;
  96506. reset(): void;
  96507. apply(gl: WebGLRenderingContext): void;
  96508. }
  96509. }
  96510. declare module BABYLON {
  96511. /**
  96512. * @hidden
  96513. **/
  96514. export class StencilState {
  96515. /** 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 */
  96516. static readonly ALWAYS: number;
  96517. /** Passed to stencilOperation to specify that stencil value must be kept */
  96518. static readonly KEEP: number;
  96519. /** Passed to stencilOperation to specify that stencil value must be replaced */
  96520. static readonly REPLACE: number;
  96521. private _isStencilTestDirty;
  96522. private _isStencilMaskDirty;
  96523. private _isStencilFuncDirty;
  96524. private _isStencilOpDirty;
  96525. private _stencilTest;
  96526. private _stencilMask;
  96527. private _stencilFunc;
  96528. private _stencilFuncRef;
  96529. private _stencilFuncMask;
  96530. private _stencilOpStencilFail;
  96531. private _stencilOpDepthFail;
  96532. private _stencilOpStencilDepthPass;
  96533. readonly isDirty: boolean;
  96534. stencilFunc: number;
  96535. stencilFuncRef: number;
  96536. stencilFuncMask: number;
  96537. stencilOpStencilFail: number;
  96538. stencilOpDepthFail: number;
  96539. stencilOpStencilDepthPass: number;
  96540. stencilMask: number;
  96541. stencilTest: boolean;
  96542. constructor();
  96543. reset(): void;
  96544. apply(gl: WebGLRenderingContext): void;
  96545. }
  96546. }
  96547. declare module BABYLON {
  96548. /**
  96549. * @hidden
  96550. **/
  96551. export class AlphaState {
  96552. private _isAlphaBlendDirty;
  96553. private _isBlendFunctionParametersDirty;
  96554. private _isBlendEquationParametersDirty;
  96555. private _isBlendConstantsDirty;
  96556. private _alphaBlend;
  96557. private _blendFunctionParameters;
  96558. private _blendEquationParameters;
  96559. private _blendConstants;
  96560. /**
  96561. * Initializes the state.
  96562. */
  96563. constructor();
  96564. readonly isDirty: boolean;
  96565. alphaBlend: boolean;
  96566. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  96567. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  96568. setAlphaEquationParameters(rgb: number, alpha: number): void;
  96569. reset(): void;
  96570. apply(gl: WebGLRenderingContext): void;
  96571. }
  96572. }
  96573. declare module BABYLON {
  96574. /** @hidden */
  96575. export class WebGL2ShaderProcessor implements IShaderProcessor {
  96576. attributeProcessor(attribute: string): string;
  96577. varyingProcessor(varying: string, isFragment: boolean): string;
  96578. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  96579. }
  96580. }
  96581. declare module BABYLON {
  96582. /**
  96583. * Interface for attribute information associated with buffer instanciation
  96584. */
  96585. export interface InstancingAttributeInfo {
  96586. /**
  96587. * Index/offset of the attribute in the vertex shader
  96588. */
  96589. index: number;
  96590. /**
  96591. * size of the attribute, 1, 2, 3 or 4
  96592. */
  96593. attributeSize: number;
  96594. /**
  96595. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  96596. * default is FLOAT
  96597. */
  96598. attributeType: number;
  96599. /**
  96600. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  96601. */
  96602. normalized: boolean;
  96603. /**
  96604. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  96605. */
  96606. offset: number;
  96607. /**
  96608. * Name of the GLSL attribute, for debugging purpose only
  96609. */
  96610. attributeName: string;
  96611. }
  96612. }
  96613. declare module BABYLON {
  96614. interface ThinEngine {
  96615. /**
  96616. * Update a video texture
  96617. * @param texture defines the texture to update
  96618. * @param video defines the video element to use
  96619. * @param invertY defines if data must be stored with Y axis inverted
  96620. */
  96621. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  96622. }
  96623. }
  96624. declare module BABYLON {
  96625. /**
  96626. * Settings for finer control over video usage
  96627. */
  96628. export interface VideoTextureSettings {
  96629. /**
  96630. * Applies `autoplay` to video, if specified
  96631. */
  96632. autoPlay?: boolean;
  96633. /**
  96634. * Applies `loop` to video, if specified
  96635. */
  96636. loop?: boolean;
  96637. /**
  96638. * Automatically updates internal texture from video at every frame in the render loop
  96639. */
  96640. autoUpdateTexture: boolean;
  96641. /**
  96642. * Image src displayed during the video loading or until the user interacts with the video.
  96643. */
  96644. poster?: string;
  96645. }
  96646. /**
  96647. * If you want to display a video in your scene, this is the special texture for that.
  96648. * This special texture works similar to other textures, with the exception of a few parameters.
  96649. * @see https://doc.babylonjs.com/how_to/video_texture
  96650. */
  96651. export class VideoTexture extends Texture {
  96652. /**
  96653. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  96654. */
  96655. readonly autoUpdateTexture: boolean;
  96656. /**
  96657. * The video instance used by the texture internally
  96658. */
  96659. readonly video: HTMLVideoElement;
  96660. private _onUserActionRequestedObservable;
  96661. /**
  96662. * Event triggerd when a dom action is required by the user to play the video.
  96663. * This happens due to recent changes in browser policies preventing video to auto start.
  96664. */
  96665. readonly onUserActionRequestedObservable: Observable<Texture>;
  96666. private _generateMipMaps;
  96667. private _engine;
  96668. private _stillImageCaptured;
  96669. private _displayingPosterTexture;
  96670. private _settings;
  96671. private _createInternalTextureOnEvent;
  96672. private _frameId;
  96673. /**
  96674. * Creates a video texture.
  96675. * If you want to display a video in your scene, this is the special texture for that.
  96676. * This special texture works similar to other textures, with the exception of a few parameters.
  96677. * @see https://doc.babylonjs.com/how_to/video_texture
  96678. * @param name optional name, will detect from video source, if not defined
  96679. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  96680. * @param scene is obviously the current scene.
  96681. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  96682. * @param invertY is false by default but can be used to invert video on Y axis
  96683. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  96684. * @param settings allows finer control over video usage
  96685. */
  96686. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  96687. private _getName;
  96688. private _getVideo;
  96689. private _createInternalTexture;
  96690. private reset;
  96691. /**
  96692. * @hidden Internal method to initiate `update`.
  96693. */
  96694. _rebuild(): void;
  96695. /**
  96696. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  96697. */
  96698. update(): void;
  96699. /**
  96700. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  96701. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  96702. */
  96703. updateTexture(isVisible: boolean): void;
  96704. protected _updateInternalTexture: () => void;
  96705. /**
  96706. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  96707. * @param url New url.
  96708. */
  96709. updateURL(url: string): void;
  96710. /**
  96711. * Dispose the texture and release its associated resources.
  96712. */
  96713. dispose(): void;
  96714. /**
  96715. * Creates a video texture straight from a stream.
  96716. * @param scene Define the scene the texture should be created in
  96717. * @param stream Define the stream the texture should be created from
  96718. * @returns The created video texture as a promise
  96719. */
  96720. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  96721. /**
  96722. * Creates a video texture straight from your WebCam video feed.
  96723. * @param scene Define the scene the texture should be created in
  96724. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  96725. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  96726. * @returns The created video texture as a promise
  96727. */
  96728. static CreateFromWebCamAsync(scene: Scene, constraints: {
  96729. minWidth: number;
  96730. maxWidth: number;
  96731. minHeight: number;
  96732. maxHeight: number;
  96733. deviceId: string;
  96734. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  96735. /**
  96736. * Creates a video texture straight from your WebCam video feed.
  96737. * @param scene Define the scene the texture should be created in
  96738. * @param onReady Define a callback to triggered once the texture will be ready
  96739. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  96740. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  96741. */
  96742. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  96743. minWidth: number;
  96744. maxWidth: number;
  96745. minHeight: number;
  96746. maxHeight: number;
  96747. deviceId: string;
  96748. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  96749. }
  96750. }
  96751. declare module BABYLON {
  96752. /**
  96753. * Defines the interface used by objects working like Scene
  96754. * @hidden
  96755. */
  96756. interface ISceneLike {
  96757. _addPendingData(data: any): void;
  96758. _removePendingData(data: any): void;
  96759. offlineProvider: IOfflineProvider;
  96760. }
  96761. /** Interface defining initialization parameters for Engine class */
  96762. export interface EngineOptions extends WebGLContextAttributes {
  96763. /**
  96764. * Defines if the engine should no exceed a specified device ratio
  96765. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  96766. */
  96767. limitDeviceRatio?: number;
  96768. /**
  96769. * Defines if webvr should be enabled automatically
  96770. * @see http://doc.babylonjs.com/how_to/webvr_camera
  96771. */
  96772. autoEnableWebVR?: boolean;
  96773. /**
  96774. * Defines if webgl2 should be turned off even if supported
  96775. * @see http://doc.babylonjs.com/features/webgl2
  96776. */
  96777. disableWebGL2Support?: boolean;
  96778. /**
  96779. * Defines if webaudio should be initialized as well
  96780. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  96781. */
  96782. audioEngine?: boolean;
  96783. /**
  96784. * Defines if animations should run using a deterministic lock step
  96785. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  96786. */
  96787. deterministicLockstep?: boolean;
  96788. /** Defines the maximum steps to use with deterministic lock step mode */
  96789. lockstepMaxSteps?: number;
  96790. /**
  96791. * Defines that engine should ignore context lost events
  96792. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  96793. */
  96794. doNotHandleContextLost?: boolean;
  96795. /**
  96796. * Defines that engine should ignore modifying touch action attribute and style
  96797. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  96798. */
  96799. doNotHandleTouchAction?: boolean;
  96800. /**
  96801. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  96802. */
  96803. useHighPrecisionFloats?: boolean;
  96804. }
  96805. /**
  96806. * The base engine class (root of all engines)
  96807. */
  96808. export class ThinEngine {
  96809. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  96810. static ExceptionList: ({
  96811. key: string;
  96812. capture: string;
  96813. captureConstraint: number;
  96814. targets: string[];
  96815. } | {
  96816. key: string;
  96817. capture: null;
  96818. captureConstraint: null;
  96819. targets: string[];
  96820. })[];
  96821. /** @hidden */
  96822. static _TextureLoaders: IInternalTextureLoader[];
  96823. /**
  96824. * Returns the current npm package of the sdk
  96825. */
  96826. static readonly NpmPackage: string;
  96827. /**
  96828. * Returns the current version of the framework
  96829. */
  96830. static readonly Version: string;
  96831. /**
  96832. * Returns a string describing the current engine
  96833. */
  96834. readonly description: string;
  96835. /**
  96836. * Gets or sets the epsilon value used by collision engine
  96837. */
  96838. static CollisionsEpsilon: number;
  96839. /**
  96840. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  96841. */
  96842. static ShadersRepository: string;
  96843. /** @hidden */
  96844. _shaderProcessor: IShaderProcessor;
  96845. /**
  96846. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  96847. */
  96848. forcePOTTextures: boolean;
  96849. /**
  96850. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  96851. */
  96852. isFullscreen: boolean;
  96853. /**
  96854. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  96855. */
  96856. cullBackFaces: boolean;
  96857. /**
  96858. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  96859. */
  96860. renderEvenInBackground: boolean;
  96861. /**
  96862. * Gets or sets a boolean indicating that cache can be kept between frames
  96863. */
  96864. preventCacheWipeBetweenFrames: boolean;
  96865. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  96866. validateShaderPrograms: boolean;
  96867. /**
  96868. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  96869. */
  96870. disableUniformBuffers: boolean;
  96871. /** @hidden */
  96872. _uniformBuffers: UniformBuffer[];
  96873. /**
  96874. * Gets a boolean indicating that the engine supports uniform buffers
  96875. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  96876. */
  96877. readonly supportsUniformBuffers: boolean;
  96878. /** @hidden */
  96879. _gl: WebGLRenderingContext;
  96880. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  96881. protected _windowIsBackground: boolean;
  96882. protected _webGLVersion: number;
  96883. protected _creationOptions: EngineOptions;
  96884. protected _highPrecisionShadersAllowed: boolean;
  96885. /** @hidden */
  96886. readonly _shouldUseHighPrecisionShader: boolean;
  96887. /**
  96888. * Gets a boolean indicating that only power of 2 textures are supported
  96889. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  96890. */
  96891. readonly needPOTTextures: boolean;
  96892. /** @hidden */
  96893. _badOS: boolean;
  96894. /** @hidden */
  96895. _badDesktopOS: boolean;
  96896. private _hardwareScalingLevel;
  96897. /** @hidden */
  96898. _caps: EngineCapabilities;
  96899. private _isStencilEnable;
  96900. protected _colorWrite: boolean;
  96901. private _glVersion;
  96902. private _glRenderer;
  96903. private _glVendor;
  96904. /** @hidden */
  96905. _videoTextureSupported: boolean;
  96906. protected _renderingQueueLaunched: boolean;
  96907. protected _activeRenderLoops: (() => void)[];
  96908. /**
  96909. * Observable signaled when a context lost event is raised
  96910. */
  96911. onContextLostObservable: Observable<ThinEngine>;
  96912. /**
  96913. * Observable signaled when a context restored event is raised
  96914. */
  96915. onContextRestoredObservable: Observable<ThinEngine>;
  96916. private _onContextLost;
  96917. private _onContextRestored;
  96918. protected _contextWasLost: boolean;
  96919. /** @hidden */
  96920. _doNotHandleContextLost: boolean;
  96921. /**
  96922. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  96923. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  96924. */
  96925. doNotHandleContextLost: boolean;
  96926. /**
  96927. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  96928. */
  96929. disableVertexArrayObjects: boolean;
  96930. /** @hidden */
  96931. protected _depthCullingState: DepthCullingState;
  96932. /** @hidden */
  96933. protected _stencilState: StencilState;
  96934. /** @hidden */
  96935. protected _alphaState: AlphaState;
  96936. /** @hidden */
  96937. _internalTexturesCache: InternalTexture[];
  96938. /** @hidden */
  96939. protected _activeChannel: number;
  96940. private _currentTextureChannel;
  96941. /** @hidden */
  96942. protected _boundTexturesCache: {
  96943. [key: string]: Nullable<InternalTexture>;
  96944. };
  96945. /** @hidden */
  96946. protected _currentEffect: Nullable<Effect>;
  96947. /** @hidden */
  96948. protected _currentProgram: Nullable<WebGLProgram>;
  96949. private _compiledEffects;
  96950. private _vertexAttribArraysEnabled;
  96951. /** @hidden */
  96952. protected _cachedViewport: Nullable<IViewportLike>;
  96953. private _cachedVertexArrayObject;
  96954. /** @hidden */
  96955. protected _cachedVertexBuffers: any;
  96956. /** @hidden */
  96957. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  96958. /** @hidden */
  96959. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  96960. /** @hidden */
  96961. _currentRenderTarget: Nullable<InternalTexture>;
  96962. private _uintIndicesCurrentlySet;
  96963. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  96964. /** @hidden */
  96965. protected _currentFramebuffer: Nullable<WebGLFramebuffer>;
  96966. private _currentBufferPointers;
  96967. private _currentInstanceLocations;
  96968. private _currentInstanceBuffers;
  96969. private _textureUnits;
  96970. /** @hidden */
  96971. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  96972. /** @hidden */
  96973. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  96974. /** @hidden */
  96975. _bindedRenderFunction: any;
  96976. private _vaoRecordInProgress;
  96977. private _mustWipeVertexAttributes;
  96978. private _emptyTexture;
  96979. private _emptyCubeTexture;
  96980. private _emptyTexture3D;
  96981. /** @hidden */
  96982. _frameHandler: number;
  96983. private _nextFreeTextureSlots;
  96984. private _maxSimultaneousTextures;
  96985. private _activeRequests;
  96986. protected _texturesSupported: string[];
  96987. /** @hidden */
  96988. _textureFormatInUse: Nullable<string>;
  96989. protected readonly _supportsHardwareTextureRescaling: boolean;
  96990. /**
  96991. * Gets the list of texture formats supported
  96992. */
  96993. readonly texturesSupported: Array<string>;
  96994. /**
  96995. * Gets the list of texture formats in use
  96996. */
  96997. readonly textureFormatInUse: Nullable<string>;
  96998. /**
  96999. * Gets the current viewport
  97000. */
  97001. readonly currentViewport: Nullable<IViewportLike>;
  97002. /**
  97003. * Gets the default empty texture
  97004. */
  97005. readonly emptyTexture: InternalTexture;
  97006. /**
  97007. * Gets the default empty 3D texture
  97008. */
  97009. readonly emptyTexture3D: InternalTexture;
  97010. /**
  97011. * Gets the default empty cube texture
  97012. */
  97013. readonly emptyCubeTexture: InternalTexture;
  97014. /**
  97015. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  97016. */
  97017. readonly premultipliedAlpha: boolean;
  97018. /**
  97019. * Observable event triggered before each texture is initialized
  97020. */
  97021. onBeforeTextureInitObservable: Observable<Texture>;
  97022. /**
  97023. * Creates a new engine
  97024. * @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
  97025. * @param antialias defines enable antialiasing (default: false)
  97026. * @param options defines further options to be sent to the getContext() function
  97027. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  97028. */
  97029. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  97030. private _rebuildInternalTextures;
  97031. private _rebuildEffects;
  97032. /**
  97033. * Gets a boolean indicating if all created effects are ready
  97034. * @returns true if all effects are ready
  97035. */
  97036. areAllEffectsReady(): boolean;
  97037. protected _rebuildBuffers(): void;
  97038. private _initGLContext;
  97039. /**
  97040. * Gets version of the current webGL context
  97041. */
  97042. readonly webGLVersion: number;
  97043. /**
  97044. * Gets a string idenfifying the name of the class
  97045. * @returns "Engine" string
  97046. */
  97047. getClassName(): string;
  97048. /**
  97049. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  97050. */
  97051. readonly isStencilEnable: boolean;
  97052. /** @hidden */
  97053. _prepareWorkingCanvas(): void;
  97054. /**
  97055. * Reset the texture cache to empty state
  97056. */
  97057. resetTextureCache(): void;
  97058. /**
  97059. * Gets an object containing information about the current webGL context
  97060. * @returns an object containing the vender, the renderer and the version of the current webGL context
  97061. */
  97062. getGlInfo(): {
  97063. vendor: string;
  97064. renderer: string;
  97065. version: string;
  97066. };
  97067. /**
  97068. * Defines the hardware scaling level.
  97069. * By default the hardware scaling level is computed from the window device ratio.
  97070. * 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.
  97071. * @param level defines the level to use
  97072. */
  97073. setHardwareScalingLevel(level: number): void;
  97074. /**
  97075. * Gets the current hardware scaling level.
  97076. * By default the hardware scaling level is computed from the window device ratio.
  97077. * 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.
  97078. * @returns a number indicating the current hardware scaling level
  97079. */
  97080. getHardwareScalingLevel(): number;
  97081. /**
  97082. * Gets the list of loaded textures
  97083. * @returns an array containing all loaded textures
  97084. */
  97085. getLoadedTexturesCache(): InternalTexture[];
  97086. /**
  97087. * Gets the object containing all engine capabilities
  97088. * @returns the EngineCapabilities object
  97089. */
  97090. getCaps(): EngineCapabilities;
  97091. /**
  97092. * stop executing a render loop function and remove it from the execution array
  97093. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  97094. */
  97095. stopRenderLoop(renderFunction?: () => void): void;
  97096. /** @hidden */
  97097. _renderLoop(): void;
  97098. /**
  97099. * Gets the HTML canvas attached with the current webGL context
  97100. * @returns a HTML canvas
  97101. */
  97102. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  97103. /**
  97104. * Gets host window
  97105. * @returns the host window object
  97106. */
  97107. getHostWindow(): Nullable<Window>;
  97108. /**
  97109. * Gets the current render width
  97110. * @param useScreen defines if screen size must be used (or the current render target if any)
  97111. * @returns a number defining the current render width
  97112. */
  97113. getRenderWidth(useScreen?: boolean): number;
  97114. /**
  97115. * Gets the current render height
  97116. * @param useScreen defines if screen size must be used (or the current render target if any)
  97117. * @returns a number defining the current render height
  97118. */
  97119. getRenderHeight(useScreen?: boolean): number;
  97120. /**
  97121. * Can be used to override the current requestAnimationFrame requester.
  97122. * @hidden
  97123. */
  97124. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  97125. /**
  97126. * Register and execute a render loop. The engine can have more than one render function
  97127. * @param renderFunction defines the function to continuously execute
  97128. */
  97129. runRenderLoop(renderFunction: () => void): void;
  97130. /**
  97131. * Clear the current render buffer or the current render target (if any is set up)
  97132. * @param color defines the color to use
  97133. * @param backBuffer defines if the back buffer must be cleared
  97134. * @param depth defines if the depth buffer must be cleared
  97135. * @param stencil defines if the stencil buffer must be cleared
  97136. */
  97137. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  97138. private _viewportCached;
  97139. /** @hidden */
  97140. _viewport(x: number, y: number, width: number, height: number): void;
  97141. /**
  97142. * Set the WebGL's viewport
  97143. * @param viewport defines the viewport element to be used
  97144. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  97145. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  97146. */
  97147. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  97148. /**
  97149. * Begin a new frame
  97150. */
  97151. beginFrame(): void;
  97152. /**
  97153. * Enf the current frame
  97154. */
  97155. endFrame(): void;
  97156. /**
  97157. * Resize the view according to the canvas' size
  97158. */
  97159. resize(): void;
  97160. /**
  97161. * Force a specific size of the canvas
  97162. * @param width defines the new canvas' width
  97163. * @param height defines the new canvas' height
  97164. */
  97165. setSize(width: number, height: number): void;
  97166. /**
  97167. * Binds the frame buffer to the specified texture.
  97168. * @param texture The texture to render to or null for the default canvas
  97169. * @param faceIndex The face of the texture to render to in case of cube texture
  97170. * @param requiredWidth The width of the target to render to
  97171. * @param requiredHeight The height of the target to render to
  97172. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  97173. * @param depthStencilTexture The depth stencil texture to use to render
  97174. * @param lodLevel defines le lod level to bind to the frame buffer
  97175. */
  97176. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel?: number): void;
  97177. /** @hidden */
  97178. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  97179. /**
  97180. * Unbind the current render target texture from the webGL context
  97181. * @param texture defines the render target texture to unbind
  97182. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  97183. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  97184. */
  97185. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  97186. /**
  97187. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  97188. */
  97189. flushFramebuffer(): void;
  97190. /**
  97191. * Unbind the current render target and bind the default framebuffer
  97192. */
  97193. restoreDefaultFramebuffer(): void;
  97194. /** @hidden */
  97195. protected _resetVertexBufferBinding(): void;
  97196. /**
  97197. * Creates a vertex buffer
  97198. * @param data the data for the vertex buffer
  97199. * @returns the new WebGL static buffer
  97200. */
  97201. createVertexBuffer(data: DataArray): DataBuffer;
  97202. private _createVertexBuffer;
  97203. /**
  97204. * Creates a dynamic vertex buffer
  97205. * @param data the data for the dynamic vertex buffer
  97206. * @returns the new WebGL dynamic buffer
  97207. */
  97208. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  97209. protected _resetIndexBufferBinding(): void;
  97210. /**
  97211. * Creates a new index buffer
  97212. * @param indices defines the content of the index buffer
  97213. * @param updatable defines if the index buffer must be updatable
  97214. * @returns a new webGL buffer
  97215. */
  97216. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  97217. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  97218. /**
  97219. * Bind a webGL buffer to the webGL context
  97220. * @param buffer defines the buffer to bind
  97221. */
  97222. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  97223. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  97224. private bindBuffer;
  97225. /**
  97226. * update the bound buffer with the given data
  97227. * @param data defines the data to update
  97228. */
  97229. updateArrayBuffer(data: Float32Array): void;
  97230. private _vertexAttribPointer;
  97231. private _bindIndexBufferWithCache;
  97232. private _bindVertexBuffersAttributes;
  97233. /**
  97234. * Records a vertex array object
  97235. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  97236. * @param vertexBuffers defines the list of vertex buffers to store
  97237. * @param indexBuffer defines the index buffer to store
  97238. * @param effect defines the effect to store
  97239. * @returns the new vertex array object
  97240. */
  97241. recordVertexArrayObject(vertexBuffers: {
  97242. [key: string]: VertexBuffer;
  97243. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  97244. /**
  97245. * Bind a specific vertex array object
  97246. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  97247. * @param vertexArrayObject defines the vertex array object to bind
  97248. * @param indexBuffer defines the index buffer to bind
  97249. */
  97250. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  97251. /**
  97252. * Bind webGl buffers directly to the webGL context
  97253. * @param vertexBuffer defines the vertex buffer to bind
  97254. * @param indexBuffer defines the index buffer to bind
  97255. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  97256. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  97257. * @param effect defines the effect associated with the vertex buffer
  97258. */
  97259. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  97260. private _unbindVertexArrayObject;
  97261. /**
  97262. * Bind a list of vertex buffers to the webGL context
  97263. * @param vertexBuffers defines the list of vertex buffers to bind
  97264. * @param indexBuffer defines the index buffer to bind
  97265. * @param effect defines the effect associated with the vertex buffers
  97266. */
  97267. bindBuffers(vertexBuffers: {
  97268. [key: string]: Nullable<VertexBuffer>;
  97269. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  97270. /**
  97271. * Unbind all instance attributes
  97272. */
  97273. unbindInstanceAttributes(): void;
  97274. /**
  97275. * Release and free the memory of a vertex array object
  97276. * @param vao defines the vertex array object to delete
  97277. */
  97278. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  97279. /** @hidden */
  97280. _releaseBuffer(buffer: DataBuffer): boolean;
  97281. protected _deleteBuffer(buffer: DataBuffer): void;
  97282. /**
  97283. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  97284. * @param instancesBuffer defines the webGL buffer to update and bind
  97285. * @param data defines the data to store in the buffer
  97286. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  97287. */
  97288. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  97289. /**
  97290. * Apply all cached states (depth, culling, stencil and alpha)
  97291. */
  97292. applyStates(): void;
  97293. /**
  97294. * Send a draw order
  97295. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  97296. * @param indexStart defines the starting index
  97297. * @param indexCount defines the number of index to draw
  97298. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97299. */
  97300. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  97301. /**
  97302. * Draw a list of points
  97303. * @param verticesStart defines the index of first vertex to draw
  97304. * @param verticesCount defines the count of vertices to draw
  97305. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97306. */
  97307. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  97308. /**
  97309. * Draw a list of unindexed primitives
  97310. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  97311. * @param verticesStart defines the index of first vertex to draw
  97312. * @param verticesCount defines the count of vertices to draw
  97313. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97314. */
  97315. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  97316. /**
  97317. * Draw a list of indexed primitives
  97318. * @param fillMode defines the primitive to use
  97319. * @param indexStart defines the starting index
  97320. * @param indexCount defines the number of index to draw
  97321. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97322. */
  97323. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  97324. /**
  97325. * Draw a list of unindexed primitives
  97326. * @param fillMode defines the primitive to use
  97327. * @param verticesStart defines the index of first vertex to draw
  97328. * @param verticesCount defines the count of vertices to draw
  97329. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97330. */
  97331. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  97332. private _drawMode;
  97333. /** @hidden */
  97334. protected _reportDrawCall(): void;
  97335. /** @hidden */
  97336. _releaseEffect(effect: Effect): void;
  97337. /** @hidden */
  97338. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  97339. /**
  97340. * Create a new effect (used to store vertex/fragment shaders)
  97341. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  97342. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  97343. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  97344. * @param samplers defines an array of string used to represent textures
  97345. * @param defines defines the string containing the defines to use to compile the shaders
  97346. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  97347. * @param onCompiled defines a function to call when the effect creation is successful
  97348. * @param onError defines a function to call when the effect creation has failed
  97349. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  97350. * @returns the new Effect
  97351. */
  97352. 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;
  97353. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  97354. private _compileShader;
  97355. private _compileRawShader;
  97356. /**
  97357. * Directly creates a webGL program
  97358. * @param pipelineContext defines the pipeline context to attach to
  97359. * @param vertexCode defines the vertex shader code to use
  97360. * @param fragmentCode defines the fragment shader code to use
  97361. * @param context defines the webGL context to use (if not set, the current one will be used)
  97362. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  97363. * @returns the new webGL program
  97364. */
  97365. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  97366. /**
  97367. * Creates a webGL program
  97368. * @param pipelineContext defines the pipeline context to attach to
  97369. * @param vertexCode defines the vertex shader code to use
  97370. * @param fragmentCode defines the fragment shader code to use
  97371. * @param defines defines the string containing the defines to use to compile the shaders
  97372. * @param context defines the webGL context to use (if not set, the current one will be used)
  97373. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  97374. * @returns the new webGL program
  97375. */
  97376. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  97377. /**
  97378. * Creates a new pipeline context
  97379. * @returns the new pipeline
  97380. */
  97381. createPipelineContext(): IPipelineContext;
  97382. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  97383. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  97384. /** @hidden */
  97385. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  97386. /** @hidden */
  97387. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  97388. /** @hidden */
  97389. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  97390. /**
  97391. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  97392. * @param pipelineContext defines the pipeline context to use
  97393. * @param uniformsNames defines the list of uniform names
  97394. * @returns an array of webGL uniform locations
  97395. */
  97396. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  97397. /**
  97398. * Gets the lsit of active attributes for a given webGL program
  97399. * @param pipelineContext defines the pipeline context to use
  97400. * @param attributesNames defines the list of attribute names to get
  97401. * @returns an array of indices indicating the offset of each attribute
  97402. */
  97403. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  97404. /**
  97405. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  97406. * @param effect defines the effect to activate
  97407. */
  97408. enableEffect(effect: Nullable<Effect>): void;
  97409. /**
  97410. * Set the value of an uniform to a number (int)
  97411. * @param uniform defines the webGL uniform location where to store the value
  97412. * @param value defines the int number to store
  97413. */
  97414. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  97415. /**
  97416. * Set the value of an uniform to an array of int32
  97417. * @param uniform defines the webGL uniform location where to store the value
  97418. * @param array defines the array of int32 to store
  97419. */
  97420. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  97421. /**
  97422. * Set the value of an uniform to an array of int32 (stored as vec2)
  97423. * @param uniform defines the webGL uniform location where to store the value
  97424. * @param array defines the array of int32 to store
  97425. */
  97426. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  97427. /**
  97428. * Set the value of an uniform to an array of int32 (stored as vec3)
  97429. * @param uniform defines the webGL uniform location where to store the value
  97430. * @param array defines the array of int32 to store
  97431. */
  97432. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  97433. /**
  97434. * Set the value of an uniform to an array of int32 (stored as vec4)
  97435. * @param uniform defines the webGL uniform location where to store the value
  97436. * @param array defines the array of int32 to store
  97437. */
  97438. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  97439. /**
  97440. * Set the value of an uniform to an array of number
  97441. * @param uniform defines the webGL uniform location where to store the value
  97442. * @param array defines the array of number to store
  97443. */
  97444. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  97445. /**
  97446. * Set the value of an uniform to an array of number (stored as vec2)
  97447. * @param uniform defines the webGL uniform location where to store the value
  97448. * @param array defines the array of number to store
  97449. */
  97450. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  97451. /**
  97452. * Set the value of an uniform to an array of number (stored as vec3)
  97453. * @param uniform defines the webGL uniform location where to store the value
  97454. * @param array defines the array of number to store
  97455. */
  97456. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  97457. /**
  97458. * Set the value of an uniform to an array of number (stored as vec4)
  97459. * @param uniform defines the webGL uniform location where to store the value
  97460. * @param array defines the array of number to store
  97461. */
  97462. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  97463. /**
  97464. * Set the value of an uniform to an array of float32 (stored as matrices)
  97465. * @param uniform defines the webGL uniform location where to store the value
  97466. * @param matrices defines the array of float32 to store
  97467. */
  97468. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  97469. /**
  97470. * Set the value of an uniform to a matrix (3x3)
  97471. * @param uniform defines the webGL uniform location where to store the value
  97472. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  97473. */
  97474. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  97475. /**
  97476. * Set the value of an uniform to a matrix (2x2)
  97477. * @param uniform defines the webGL uniform location where to store the value
  97478. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  97479. */
  97480. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  97481. /**
  97482. * Set the value of an uniform to a number (float)
  97483. * @param uniform defines the webGL uniform location where to store the value
  97484. * @param value defines the float number to store
  97485. */
  97486. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  97487. /**
  97488. * Set the value of an uniform to a vec2
  97489. * @param uniform defines the webGL uniform location where to store the value
  97490. * @param x defines the 1st component of the value
  97491. * @param y defines the 2nd component of the value
  97492. */
  97493. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  97494. /**
  97495. * Set the value of an uniform to a vec3
  97496. * @param uniform defines the webGL uniform location where to store the value
  97497. * @param x defines the 1st component of the value
  97498. * @param y defines the 2nd component of the value
  97499. * @param z defines the 3rd component of the value
  97500. */
  97501. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  97502. /**
  97503. * Set the value of an uniform to a vec4
  97504. * @param uniform defines the webGL uniform location where to store the value
  97505. * @param x defines the 1st component of the value
  97506. * @param y defines the 2nd component of the value
  97507. * @param z defines the 3rd component of the value
  97508. * @param w defines the 4th component of the value
  97509. */
  97510. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  97511. /**
  97512. * Gets the depth culling state manager
  97513. */
  97514. readonly depthCullingState: DepthCullingState;
  97515. /**
  97516. * Gets the alpha state manager
  97517. */
  97518. readonly alphaState: AlphaState;
  97519. /**
  97520. * Gets the stencil state manager
  97521. */
  97522. readonly stencilState: StencilState;
  97523. /**
  97524. * Clears the list of texture accessible through engine.
  97525. * This can help preventing texture load conflict due to name collision.
  97526. */
  97527. clearInternalTexturesCache(): void;
  97528. /**
  97529. * Force the entire cache to be cleared
  97530. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  97531. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  97532. */
  97533. wipeCaches(bruteForce?: boolean): void;
  97534. /** @hidden */
  97535. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  97536. min: number;
  97537. mag: number;
  97538. };
  97539. /** @hidden */
  97540. _createTexture(): WebGLTexture;
  97541. /**
  97542. * Usually called from Texture.ts.
  97543. * Passed information to create a WebGLTexture
  97544. * @param urlArg defines a value which contains one of the following:
  97545. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  97546. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  97547. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  97548. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  97549. * @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)
  97550. * @param scene needed for loading to the correct scene
  97551. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  97552. * @param onLoad optional callback to be called upon successful completion
  97553. * @param onError optional callback to be called upon failure
  97554. * @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
  97555. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  97556. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  97557. * @param forcedExtension defines the extension to use to pick the right loader
  97558. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  97559. * @param mimeType defines an optional mime type
  97560. * @returns a InternalTexture for assignment back into BABYLON.Texture
  97561. */
  97562. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, excludeLoaders?: Array<IInternalTextureLoader>, mimeType?: string): InternalTexture;
  97563. /**
  97564. * @hidden
  97565. */
  97566. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  97567. /**
  97568. * Creates a raw texture
  97569. * @param data defines the data to store in the texture
  97570. * @param width defines the width of the texture
  97571. * @param height defines the height of the texture
  97572. * @param format defines the format of the data
  97573. * @param generateMipMaps defines if the engine should generate the mip levels
  97574. * @param invertY defines if data must be stored with Y axis inverted
  97575. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  97576. * @param compression defines the compression used (null by default)
  97577. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  97578. * @returns the raw texture inside an InternalTexture
  97579. */
  97580. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, type?: number): InternalTexture;
  97581. /**
  97582. * Creates a new raw cube texture
  97583. * @param data defines the array of data to use to create each face
  97584. * @param size defines the size of the textures
  97585. * @param format defines the format of the data
  97586. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  97587. * @param generateMipMaps defines if the engine should generate the mip levels
  97588. * @param invertY defines if data must be stored with Y axis inverted
  97589. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  97590. * @param compression defines the compression used (null by default)
  97591. * @returns the cube texture as an InternalTexture
  97592. */
  97593. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>): InternalTexture;
  97594. /**
  97595. * Creates a new raw 3D texture
  97596. * @param data defines the data used to create the texture
  97597. * @param width defines the width of the texture
  97598. * @param height defines the height of the texture
  97599. * @param depth defines the depth of the texture
  97600. * @param format defines the format of the texture
  97601. * @param generateMipMaps defines if the engine must generate mip levels
  97602. * @param invertY defines if data must be stored with Y axis inverted
  97603. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  97604. * @param compression defines the compressed used (can be null)
  97605. * @param textureType defines the compressed used (can be null)
  97606. * @returns a new raw 3D texture (stored in an InternalTexture)
  97607. */
  97608. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  97609. private _unpackFlipYCached;
  97610. /**
  97611. * In case you are sharing the context with other applications, it might
  97612. * be interested to not cache the unpack flip y state to ensure a consistent
  97613. * value would be set.
  97614. */
  97615. enableUnpackFlipYCached: boolean;
  97616. /** @hidden */
  97617. _unpackFlipY(value: boolean): void;
  97618. /** @hidden */
  97619. _getUnpackAlignement(): number;
  97620. /**
  97621. * Update the sampling mode of a given texture
  97622. * @param samplingMode defines the required sampling mode
  97623. * @param texture defines the texture to update
  97624. */
  97625. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  97626. /** @hidden */
  97627. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  97628. width: number;
  97629. height: number;
  97630. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  97631. /** @hidden */
  97632. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  97633. /** @hidden */
  97634. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  97635. /** @hidden */
  97636. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  97637. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  97638. private _prepareWebGLTexture;
  97639. /** @hidden */
  97640. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  97641. /** @hidden */
  97642. _releaseFramebufferObjects(texture: InternalTexture): void;
  97643. /** @hidden */
  97644. _releaseTexture(texture: InternalTexture): void;
  97645. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  97646. protected _setProgram(program: WebGLProgram): void;
  97647. protected _boundUniforms: {
  97648. [key: number]: WebGLUniformLocation;
  97649. };
  97650. /**
  97651. * Binds an effect to the webGL context
  97652. * @param effect defines the effect to bind
  97653. */
  97654. bindSamplers(effect: Effect): void;
  97655. private _activateCurrentTexture;
  97656. /** @hidden */
  97657. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  97658. /** @hidden */
  97659. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  97660. /**
  97661. * Unbind all textures from the webGL context
  97662. */
  97663. unbindAllTextures(): void;
  97664. /**
  97665. * Sets a texture to the according uniform.
  97666. * @param channel The texture channel
  97667. * @param uniform The uniform to set
  97668. * @param texture The texture to apply
  97669. */
  97670. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  97671. private _bindSamplerUniformToChannel;
  97672. private _getTextureWrapMode;
  97673. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  97674. /**
  97675. * Sets an array of texture to the webGL context
  97676. * @param channel defines the channel where the texture array must be set
  97677. * @param uniform defines the associated uniform location
  97678. * @param textures defines the array of textures to bind
  97679. */
  97680. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  97681. /** @hidden */
  97682. _setAnisotropicLevel(target: number, texture: BaseTexture): void;
  97683. private _setTextureParameterFloat;
  97684. private _setTextureParameterInteger;
  97685. /**
  97686. * Unbind all vertex attributes from the webGL context
  97687. */
  97688. unbindAllAttributes(): void;
  97689. /**
  97690. * 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
  97691. */
  97692. releaseEffects(): void;
  97693. /**
  97694. * Dispose and release all associated resources
  97695. */
  97696. dispose(): void;
  97697. /**
  97698. * Attach a new callback raised when context lost event is fired
  97699. * @param callback defines the callback to call
  97700. */
  97701. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  97702. /**
  97703. * Attach a new callback raised when context restored event is fired
  97704. * @param callback defines the callback to call
  97705. */
  97706. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  97707. /**
  97708. * Get the current error code of the webGL context
  97709. * @returns the error code
  97710. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  97711. */
  97712. getError(): number;
  97713. private _canRenderToFloatFramebuffer;
  97714. private _canRenderToHalfFloatFramebuffer;
  97715. private _canRenderToFramebuffer;
  97716. /** @hidden */
  97717. _getWebGLTextureType(type: number): number;
  97718. /** @hidden */
  97719. _getInternalFormat(format: number): number;
  97720. /** @hidden */
  97721. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  97722. /** @hidden */
  97723. _getRGBAMultiSampleBufferFormat(type: number): number;
  97724. /** @hidden */
  97725. _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;
  97726. /**
  97727. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  97728. * @returns true if the engine can be created
  97729. * @ignorenaming
  97730. */
  97731. static isSupported(): boolean;
  97732. /**
  97733. * Find the next highest power of two.
  97734. * @param x Number to start search from.
  97735. * @return Next highest power of two.
  97736. */
  97737. static CeilingPOT(x: number): number;
  97738. /**
  97739. * Find the next lowest power of two.
  97740. * @param x Number to start search from.
  97741. * @return Next lowest power of two.
  97742. */
  97743. static FloorPOT(x: number): number;
  97744. /**
  97745. * Find the nearest power of two.
  97746. * @param x Number to start search from.
  97747. * @return Next nearest power of two.
  97748. */
  97749. static NearestPOT(x: number): number;
  97750. /**
  97751. * Get the closest exponent of two
  97752. * @param value defines the value to approximate
  97753. * @param max defines the maximum value to return
  97754. * @param mode defines how to define the closest value
  97755. * @returns closest exponent of two of the given value
  97756. */
  97757. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  97758. /**
  97759. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  97760. * @param func - the function to be called
  97761. * @param requester - the object that will request the next frame. Falls back to window.
  97762. * @returns frame number
  97763. */
  97764. static QueueNewFrame(func: () => void, requester?: any): number;
  97765. }
  97766. }
  97767. declare module BABYLON {
  97768. /**
  97769. * Class representing spherical harmonics coefficients to the 3rd degree
  97770. */
  97771. export class SphericalHarmonics {
  97772. /**
  97773. * Defines whether or not the harmonics have been prescaled for rendering.
  97774. */
  97775. preScaled: boolean;
  97776. /**
  97777. * The l0,0 coefficients of the spherical harmonics
  97778. */
  97779. l00: Vector3;
  97780. /**
  97781. * The l1,-1 coefficients of the spherical harmonics
  97782. */
  97783. l1_1: Vector3;
  97784. /**
  97785. * The l1,0 coefficients of the spherical harmonics
  97786. */
  97787. l10: Vector3;
  97788. /**
  97789. * The l1,1 coefficients of the spherical harmonics
  97790. */
  97791. l11: Vector3;
  97792. /**
  97793. * The l2,-2 coefficients of the spherical harmonics
  97794. */
  97795. l2_2: Vector3;
  97796. /**
  97797. * The l2,-1 coefficients of the spherical harmonics
  97798. */
  97799. l2_1: Vector3;
  97800. /**
  97801. * The l2,0 coefficients of the spherical harmonics
  97802. */
  97803. l20: Vector3;
  97804. /**
  97805. * The l2,1 coefficients of the spherical harmonics
  97806. */
  97807. l21: Vector3;
  97808. /**
  97809. * The l2,2 coefficients of the spherical harmonics
  97810. */
  97811. l22: Vector3;
  97812. /**
  97813. * Adds a light to the spherical harmonics
  97814. * @param direction the direction of the light
  97815. * @param color the color of the light
  97816. * @param deltaSolidAngle the delta solid angle of the light
  97817. */
  97818. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  97819. /**
  97820. * Scales the spherical harmonics by the given amount
  97821. * @param scale the amount to scale
  97822. */
  97823. scaleInPlace(scale: number): void;
  97824. /**
  97825. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  97826. *
  97827. * ```
  97828. * E_lm = A_l * L_lm
  97829. * ```
  97830. *
  97831. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  97832. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  97833. * the scaling factors are given in equation 9.
  97834. */
  97835. convertIncidentRadianceToIrradiance(): void;
  97836. /**
  97837. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  97838. *
  97839. * ```
  97840. * L = (1/pi) * E * rho
  97841. * ```
  97842. *
  97843. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  97844. */
  97845. convertIrradianceToLambertianRadiance(): void;
  97846. /**
  97847. * Integrates the reconstruction coefficients directly in to the SH preventing further
  97848. * required operations at run time.
  97849. *
  97850. * This is simply done by scaling back the SH with Ylm constants parameter.
  97851. * The trigonometric part being applied by the shader at run time.
  97852. */
  97853. preScaleForRendering(): void;
  97854. /**
  97855. * Constructs a spherical harmonics from an array.
  97856. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  97857. * @returns the spherical harmonics
  97858. */
  97859. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  97860. /**
  97861. * Gets the spherical harmonics from polynomial
  97862. * @param polynomial the spherical polynomial
  97863. * @returns the spherical harmonics
  97864. */
  97865. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  97866. }
  97867. /**
  97868. * Class representing spherical polynomial coefficients to the 3rd degree
  97869. */
  97870. export class SphericalPolynomial {
  97871. private _harmonics;
  97872. /**
  97873. * The spherical harmonics used to create the polynomials.
  97874. */
  97875. readonly preScaledHarmonics: SphericalHarmonics;
  97876. /**
  97877. * The x coefficients of the spherical polynomial
  97878. */
  97879. x: Vector3;
  97880. /**
  97881. * The y coefficients of the spherical polynomial
  97882. */
  97883. y: Vector3;
  97884. /**
  97885. * The z coefficients of the spherical polynomial
  97886. */
  97887. z: Vector3;
  97888. /**
  97889. * The xx coefficients of the spherical polynomial
  97890. */
  97891. xx: Vector3;
  97892. /**
  97893. * The yy coefficients of the spherical polynomial
  97894. */
  97895. yy: Vector3;
  97896. /**
  97897. * The zz coefficients of the spherical polynomial
  97898. */
  97899. zz: Vector3;
  97900. /**
  97901. * The xy coefficients of the spherical polynomial
  97902. */
  97903. xy: Vector3;
  97904. /**
  97905. * The yz coefficients of the spherical polynomial
  97906. */
  97907. yz: Vector3;
  97908. /**
  97909. * The zx coefficients of the spherical polynomial
  97910. */
  97911. zx: Vector3;
  97912. /**
  97913. * Adds an ambient color to the spherical polynomial
  97914. * @param color the color to add
  97915. */
  97916. addAmbient(color: Color3): void;
  97917. /**
  97918. * Scales the spherical polynomial by the given amount
  97919. * @param scale the amount to scale
  97920. */
  97921. scaleInPlace(scale: number): void;
  97922. /**
  97923. * Gets the spherical polynomial from harmonics
  97924. * @param harmonics the spherical harmonics
  97925. * @returns the spherical polynomial
  97926. */
  97927. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  97928. /**
  97929. * Constructs a spherical polynomial from an array.
  97930. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  97931. * @returns the spherical polynomial
  97932. */
  97933. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  97934. }
  97935. }
  97936. declare module BABYLON {
  97937. /**
  97938. * Defines the source of the internal texture
  97939. */
  97940. export enum InternalTextureSource {
  97941. /**
  97942. * The source of the texture data is unknown
  97943. */
  97944. Unknown = 0,
  97945. /**
  97946. * Texture data comes from an URL
  97947. */
  97948. Url = 1,
  97949. /**
  97950. * Texture data is only used for temporary storage
  97951. */
  97952. Temp = 2,
  97953. /**
  97954. * Texture data comes from raw data (ArrayBuffer)
  97955. */
  97956. Raw = 3,
  97957. /**
  97958. * Texture content is dynamic (video or dynamic texture)
  97959. */
  97960. Dynamic = 4,
  97961. /**
  97962. * Texture content is generated by rendering to it
  97963. */
  97964. RenderTarget = 5,
  97965. /**
  97966. * Texture content is part of a multi render target process
  97967. */
  97968. MultiRenderTarget = 6,
  97969. /**
  97970. * Texture data comes from a cube data file
  97971. */
  97972. Cube = 7,
  97973. /**
  97974. * Texture data comes from a raw cube data
  97975. */
  97976. CubeRaw = 8,
  97977. /**
  97978. * Texture data come from a prefiltered cube data file
  97979. */
  97980. CubePrefiltered = 9,
  97981. /**
  97982. * Texture content is raw 3D data
  97983. */
  97984. Raw3D = 10,
  97985. /**
  97986. * Texture content is a depth texture
  97987. */
  97988. Depth = 11,
  97989. /**
  97990. * Texture data comes from a raw cube data encoded with RGBD
  97991. */
  97992. CubeRawRGBD = 12
  97993. }
  97994. /**
  97995. * Class used to store data associated with WebGL texture data for the engine
  97996. * This class should not be used directly
  97997. */
  97998. export class InternalTexture {
  97999. /** @hidden */
  98000. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  98001. /**
  98002. * Defines if the texture is ready
  98003. */
  98004. isReady: boolean;
  98005. /**
  98006. * Defines if the texture is a cube texture
  98007. */
  98008. isCube: boolean;
  98009. /**
  98010. * Defines if the texture contains 3D data
  98011. */
  98012. is3D: boolean;
  98013. /**
  98014. * Defines if the texture contains multiview data
  98015. */
  98016. isMultiview: boolean;
  98017. /**
  98018. * Gets the URL used to load this texture
  98019. */
  98020. url: string;
  98021. /**
  98022. * Gets the sampling mode of the texture
  98023. */
  98024. samplingMode: number;
  98025. /**
  98026. * Gets a boolean indicating if the texture needs mipmaps generation
  98027. */
  98028. generateMipMaps: boolean;
  98029. /**
  98030. * Gets the number of samples used by the texture (WebGL2+ only)
  98031. */
  98032. samples: number;
  98033. /**
  98034. * Gets the type of the texture (int, float...)
  98035. */
  98036. type: number;
  98037. /**
  98038. * Gets the format of the texture (RGB, RGBA...)
  98039. */
  98040. format: number;
  98041. /**
  98042. * Observable called when the texture is loaded
  98043. */
  98044. onLoadedObservable: Observable<InternalTexture>;
  98045. /**
  98046. * Gets the width of the texture
  98047. */
  98048. width: number;
  98049. /**
  98050. * Gets the height of the texture
  98051. */
  98052. height: number;
  98053. /**
  98054. * Gets the depth of the texture
  98055. */
  98056. depth: number;
  98057. /**
  98058. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  98059. */
  98060. baseWidth: number;
  98061. /**
  98062. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  98063. */
  98064. baseHeight: number;
  98065. /**
  98066. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  98067. */
  98068. baseDepth: number;
  98069. /**
  98070. * Gets a boolean indicating if the texture is inverted on Y axis
  98071. */
  98072. invertY: boolean;
  98073. /** @hidden */
  98074. _invertVScale: boolean;
  98075. /** @hidden */
  98076. _associatedChannel: number;
  98077. /** @hidden */
  98078. _source: InternalTextureSource;
  98079. /** @hidden */
  98080. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  98081. /** @hidden */
  98082. _bufferView: Nullable<ArrayBufferView>;
  98083. /** @hidden */
  98084. _bufferViewArray: Nullable<ArrayBufferView[]>;
  98085. /** @hidden */
  98086. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  98087. /** @hidden */
  98088. _size: number;
  98089. /** @hidden */
  98090. _extension: string;
  98091. /** @hidden */
  98092. _files: Nullable<string[]>;
  98093. /** @hidden */
  98094. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  98095. /** @hidden */
  98096. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  98097. /** @hidden */
  98098. _framebuffer: Nullable<WebGLFramebuffer>;
  98099. /** @hidden */
  98100. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  98101. /** @hidden */
  98102. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  98103. /** @hidden */
  98104. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  98105. /** @hidden */
  98106. _attachments: Nullable<number[]>;
  98107. /** @hidden */
  98108. _cachedCoordinatesMode: Nullable<number>;
  98109. /** @hidden */
  98110. _cachedWrapU: Nullable<number>;
  98111. /** @hidden */
  98112. _cachedWrapV: Nullable<number>;
  98113. /** @hidden */
  98114. _cachedWrapR: Nullable<number>;
  98115. /** @hidden */
  98116. _cachedAnisotropicFilteringLevel: Nullable<number>;
  98117. /** @hidden */
  98118. _isDisabled: boolean;
  98119. /** @hidden */
  98120. _compression: Nullable<string>;
  98121. /** @hidden */
  98122. _generateStencilBuffer: boolean;
  98123. /** @hidden */
  98124. _generateDepthBuffer: boolean;
  98125. /** @hidden */
  98126. _comparisonFunction: number;
  98127. /** @hidden */
  98128. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  98129. /** @hidden */
  98130. _lodGenerationScale: number;
  98131. /** @hidden */
  98132. _lodGenerationOffset: number;
  98133. /** @hidden */
  98134. _colorTextureArray: Nullable<WebGLTexture>;
  98135. /** @hidden */
  98136. _depthStencilTextureArray: Nullable<WebGLTexture>;
  98137. /** @hidden */
  98138. _lodTextureHigh: Nullable<BaseTexture>;
  98139. /** @hidden */
  98140. _lodTextureMid: Nullable<BaseTexture>;
  98141. /** @hidden */
  98142. _lodTextureLow: Nullable<BaseTexture>;
  98143. /** @hidden */
  98144. _isRGBD: boolean;
  98145. /** @hidden */
  98146. _linearSpecularLOD: boolean;
  98147. /** @hidden */
  98148. _irradianceTexture: Nullable<BaseTexture>;
  98149. /** @hidden */
  98150. _webGLTexture: Nullable<WebGLTexture>;
  98151. /** @hidden */
  98152. _references: number;
  98153. private _engine;
  98154. /**
  98155. * Gets the Engine the texture belongs to.
  98156. * @returns The babylon engine
  98157. */
  98158. getEngine(): ThinEngine;
  98159. /**
  98160. * Gets the data source type of the texture
  98161. */
  98162. readonly source: InternalTextureSource;
  98163. /**
  98164. * Creates a new InternalTexture
  98165. * @param engine defines the engine to use
  98166. * @param source defines the type of data that will be used
  98167. * @param delayAllocation if the texture allocation should be delayed (default: false)
  98168. */
  98169. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  98170. /**
  98171. * Increments the number of references (ie. the number of Texture that point to it)
  98172. */
  98173. incrementReferences(): void;
  98174. /**
  98175. * Change the size of the texture (not the size of the content)
  98176. * @param width defines the new width
  98177. * @param height defines the new height
  98178. * @param depth defines the new depth (1 by default)
  98179. */
  98180. updateSize(width: int, height: int, depth?: int): void;
  98181. /** @hidden */
  98182. _rebuild(): void;
  98183. /** @hidden */
  98184. _swapAndDie(target: InternalTexture): void;
  98185. /**
  98186. * Dispose the current allocated resources
  98187. */
  98188. dispose(): void;
  98189. }
  98190. }
  98191. declare module BABYLON {
  98192. /**
  98193. * Class used to work with sound analyzer using fast fourier transform (FFT)
  98194. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  98195. */
  98196. export class Analyser {
  98197. /**
  98198. * Gets or sets the smoothing
  98199. * @ignorenaming
  98200. */
  98201. SMOOTHING: number;
  98202. /**
  98203. * Gets or sets the FFT table size
  98204. * @ignorenaming
  98205. */
  98206. FFT_SIZE: number;
  98207. /**
  98208. * Gets or sets the bar graph amplitude
  98209. * @ignorenaming
  98210. */
  98211. BARGRAPHAMPLITUDE: number;
  98212. /**
  98213. * Gets or sets the position of the debug canvas
  98214. * @ignorenaming
  98215. */
  98216. DEBUGCANVASPOS: {
  98217. x: number;
  98218. y: number;
  98219. };
  98220. /**
  98221. * Gets or sets the debug canvas size
  98222. * @ignorenaming
  98223. */
  98224. DEBUGCANVASSIZE: {
  98225. width: number;
  98226. height: number;
  98227. };
  98228. private _byteFreqs;
  98229. private _byteTime;
  98230. private _floatFreqs;
  98231. private _webAudioAnalyser;
  98232. private _debugCanvas;
  98233. private _debugCanvasContext;
  98234. private _scene;
  98235. private _registerFunc;
  98236. private _audioEngine;
  98237. /**
  98238. * Creates a new analyser
  98239. * @param scene defines hosting scene
  98240. */
  98241. constructor(scene: Scene);
  98242. /**
  98243. * Get the number of data values you will have to play with for the visualization
  98244. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  98245. * @returns a number
  98246. */
  98247. getFrequencyBinCount(): number;
  98248. /**
  98249. * Gets the current frequency data as a byte array
  98250. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  98251. * @returns a Uint8Array
  98252. */
  98253. getByteFrequencyData(): Uint8Array;
  98254. /**
  98255. * Gets the current waveform as a byte array
  98256. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  98257. * @returns a Uint8Array
  98258. */
  98259. getByteTimeDomainData(): Uint8Array;
  98260. /**
  98261. * Gets the current frequency data as a float array
  98262. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  98263. * @returns a Float32Array
  98264. */
  98265. getFloatFrequencyData(): Float32Array;
  98266. /**
  98267. * Renders the debug canvas
  98268. */
  98269. drawDebugCanvas(): void;
  98270. /**
  98271. * Stops rendering the debug canvas and removes it
  98272. */
  98273. stopDebugCanvas(): void;
  98274. /**
  98275. * Connects two audio nodes
  98276. * @param inputAudioNode defines first node to connect
  98277. * @param outputAudioNode defines second node to connect
  98278. */
  98279. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  98280. /**
  98281. * Releases all associated resources
  98282. */
  98283. dispose(): void;
  98284. }
  98285. }
  98286. declare module BABYLON {
  98287. /**
  98288. * This represents an audio engine and it is responsible
  98289. * to play, synchronize and analyse sounds throughout the application.
  98290. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  98291. */
  98292. export interface IAudioEngine extends IDisposable {
  98293. /**
  98294. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  98295. */
  98296. readonly canUseWebAudio: boolean;
  98297. /**
  98298. * Gets the current AudioContext if available.
  98299. */
  98300. readonly audioContext: Nullable<AudioContext>;
  98301. /**
  98302. * The master gain node defines the global audio volume of your audio engine.
  98303. */
  98304. readonly masterGain: GainNode;
  98305. /**
  98306. * Gets whether or not mp3 are supported by your browser.
  98307. */
  98308. readonly isMP3supported: boolean;
  98309. /**
  98310. * Gets whether or not ogg are supported by your browser.
  98311. */
  98312. readonly isOGGsupported: boolean;
  98313. /**
  98314. * Defines if Babylon should emit a warning if WebAudio is not supported.
  98315. * @ignoreNaming
  98316. */
  98317. WarnedWebAudioUnsupported: boolean;
  98318. /**
  98319. * Defines if the audio engine relies on a custom unlocked button.
  98320. * In this case, the embedded button will not be displayed.
  98321. */
  98322. useCustomUnlockedButton: boolean;
  98323. /**
  98324. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  98325. */
  98326. readonly unlocked: boolean;
  98327. /**
  98328. * Event raised when audio has been unlocked on the browser.
  98329. */
  98330. onAudioUnlockedObservable: Observable<AudioEngine>;
  98331. /**
  98332. * Event raised when audio has been locked on the browser.
  98333. */
  98334. onAudioLockedObservable: Observable<AudioEngine>;
  98335. /**
  98336. * Flags the audio engine in Locked state.
  98337. * This happens due to new browser policies preventing audio to autoplay.
  98338. */
  98339. lock(): void;
  98340. /**
  98341. * Unlocks the audio engine once a user action has been done on the dom.
  98342. * This is helpful to resume play once browser policies have been satisfied.
  98343. */
  98344. unlock(): void;
  98345. }
  98346. /**
  98347. * This represents the default audio engine used in babylon.
  98348. * It is responsible to play, synchronize and analyse sounds throughout the application.
  98349. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  98350. */
  98351. export class AudioEngine implements IAudioEngine {
  98352. private _audioContext;
  98353. private _audioContextInitialized;
  98354. private _muteButton;
  98355. private _hostElement;
  98356. /**
  98357. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  98358. */
  98359. canUseWebAudio: boolean;
  98360. /**
  98361. * The master gain node defines the global audio volume of your audio engine.
  98362. */
  98363. masterGain: GainNode;
  98364. /**
  98365. * Defines if Babylon should emit a warning if WebAudio is not supported.
  98366. * @ignoreNaming
  98367. */
  98368. WarnedWebAudioUnsupported: boolean;
  98369. /**
  98370. * Gets whether or not mp3 are supported by your browser.
  98371. */
  98372. isMP3supported: boolean;
  98373. /**
  98374. * Gets whether or not ogg are supported by your browser.
  98375. */
  98376. isOGGsupported: boolean;
  98377. /**
  98378. * Gets whether audio has been unlocked on the device.
  98379. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  98380. * a user interaction has happened.
  98381. */
  98382. unlocked: boolean;
  98383. /**
  98384. * Defines if the audio engine relies on a custom unlocked button.
  98385. * In this case, the embedded button will not be displayed.
  98386. */
  98387. useCustomUnlockedButton: boolean;
  98388. /**
  98389. * Event raised when audio has been unlocked on the browser.
  98390. */
  98391. onAudioUnlockedObservable: Observable<AudioEngine>;
  98392. /**
  98393. * Event raised when audio has been locked on the browser.
  98394. */
  98395. onAudioLockedObservable: Observable<AudioEngine>;
  98396. /**
  98397. * Gets the current AudioContext if available.
  98398. */
  98399. readonly audioContext: Nullable<AudioContext>;
  98400. private _connectedAnalyser;
  98401. /**
  98402. * Instantiates a new audio engine.
  98403. *
  98404. * There should be only one per page as some browsers restrict the number
  98405. * of audio contexts you can create.
  98406. * @param hostElement defines the host element where to display the mute icon if necessary
  98407. */
  98408. constructor(hostElement?: Nullable<HTMLElement>);
  98409. /**
  98410. * Flags the audio engine in Locked state.
  98411. * This happens due to new browser policies preventing audio to autoplay.
  98412. */
  98413. lock(): void;
  98414. /**
  98415. * Unlocks the audio engine once a user action has been done on the dom.
  98416. * This is helpful to resume play once browser policies have been satisfied.
  98417. */
  98418. unlock(): void;
  98419. private _resumeAudioContext;
  98420. private _initializeAudioContext;
  98421. private _tryToRun;
  98422. private _triggerRunningState;
  98423. private _triggerSuspendedState;
  98424. private _displayMuteButton;
  98425. private _moveButtonToTopLeft;
  98426. private _onResize;
  98427. private _hideMuteButton;
  98428. /**
  98429. * Destroy and release the resources associated with the audio ccontext.
  98430. */
  98431. dispose(): void;
  98432. /**
  98433. * Gets the global volume sets on the master gain.
  98434. * @returns the global volume if set or -1 otherwise
  98435. */
  98436. getGlobalVolume(): number;
  98437. /**
  98438. * Sets the global volume of your experience (sets on the master gain).
  98439. * @param newVolume Defines the new global volume of the application
  98440. */
  98441. setGlobalVolume(newVolume: number): void;
  98442. /**
  98443. * Connect the audio engine to an audio analyser allowing some amazing
  98444. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  98445. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  98446. * @param analyser The analyser to connect to the engine
  98447. */
  98448. connectToAnalyser(analyser: Analyser): void;
  98449. }
  98450. }
  98451. declare module BABYLON {
  98452. /**
  98453. * Interface used to present a loading screen while loading a scene
  98454. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  98455. */
  98456. export interface ILoadingScreen {
  98457. /**
  98458. * Function called to display the loading screen
  98459. */
  98460. displayLoadingUI: () => void;
  98461. /**
  98462. * Function called to hide the loading screen
  98463. */
  98464. hideLoadingUI: () => void;
  98465. /**
  98466. * Gets or sets the color to use for the background
  98467. */
  98468. loadingUIBackgroundColor: string;
  98469. /**
  98470. * Gets or sets the text to display while loading
  98471. */
  98472. loadingUIText: string;
  98473. }
  98474. /**
  98475. * Class used for the default loading screen
  98476. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  98477. */
  98478. export class DefaultLoadingScreen implements ILoadingScreen {
  98479. private _renderingCanvas;
  98480. private _loadingText;
  98481. private _loadingDivBackgroundColor;
  98482. private _loadingDiv;
  98483. private _loadingTextDiv;
  98484. /** Gets or sets the logo url to use for the default loading screen */
  98485. static DefaultLogoUrl: string;
  98486. /** Gets or sets the spinner url to use for the default loading screen */
  98487. static DefaultSpinnerUrl: string;
  98488. /**
  98489. * Creates a new default loading screen
  98490. * @param _renderingCanvas defines the canvas used to render the scene
  98491. * @param _loadingText defines the default text to display
  98492. * @param _loadingDivBackgroundColor defines the default background color
  98493. */
  98494. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  98495. /**
  98496. * Function called to display the loading screen
  98497. */
  98498. displayLoadingUI(): void;
  98499. /**
  98500. * Function called to hide the loading screen
  98501. */
  98502. hideLoadingUI(): void;
  98503. /**
  98504. * Gets or sets the text to display while loading
  98505. */
  98506. loadingUIText: string;
  98507. /**
  98508. * Gets or sets the color to use for the background
  98509. */
  98510. loadingUIBackgroundColor: string;
  98511. private _resizeLoadingUI;
  98512. }
  98513. }
  98514. declare module BABYLON {
  98515. /**
  98516. * Interface for any object that can request an animation frame
  98517. */
  98518. export interface ICustomAnimationFrameRequester {
  98519. /**
  98520. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  98521. */
  98522. renderFunction?: Function;
  98523. /**
  98524. * Called to request the next frame to render to
  98525. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  98526. */
  98527. requestAnimationFrame: Function;
  98528. /**
  98529. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  98530. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  98531. */
  98532. requestID?: number;
  98533. }
  98534. }
  98535. declare module BABYLON {
  98536. /**
  98537. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  98538. */
  98539. export class PerformanceMonitor {
  98540. private _enabled;
  98541. private _rollingFrameTime;
  98542. private _lastFrameTimeMs;
  98543. /**
  98544. * constructor
  98545. * @param frameSampleSize The number of samples required to saturate the sliding window
  98546. */
  98547. constructor(frameSampleSize?: number);
  98548. /**
  98549. * Samples current frame
  98550. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  98551. */
  98552. sampleFrame(timeMs?: number): void;
  98553. /**
  98554. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  98555. */
  98556. readonly averageFrameTime: number;
  98557. /**
  98558. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  98559. */
  98560. readonly averageFrameTimeVariance: number;
  98561. /**
  98562. * Returns the frame time of the most recent frame
  98563. */
  98564. readonly instantaneousFrameTime: number;
  98565. /**
  98566. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  98567. */
  98568. readonly averageFPS: number;
  98569. /**
  98570. * Returns the average framerate in frames per second using the most recent frame time
  98571. */
  98572. readonly instantaneousFPS: number;
  98573. /**
  98574. * Returns true if enough samples have been taken to completely fill the sliding window
  98575. */
  98576. readonly isSaturated: boolean;
  98577. /**
  98578. * Enables contributions to the sliding window sample set
  98579. */
  98580. enable(): void;
  98581. /**
  98582. * Disables contributions to the sliding window sample set
  98583. * Samples will not be interpolated over the disabled period
  98584. */
  98585. disable(): void;
  98586. /**
  98587. * Returns true if sampling is enabled
  98588. */
  98589. readonly isEnabled: boolean;
  98590. /**
  98591. * Resets performance monitor
  98592. */
  98593. reset(): void;
  98594. }
  98595. /**
  98596. * RollingAverage
  98597. *
  98598. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  98599. */
  98600. export class RollingAverage {
  98601. /**
  98602. * Current average
  98603. */
  98604. average: number;
  98605. /**
  98606. * Current variance
  98607. */
  98608. variance: number;
  98609. protected _samples: Array<number>;
  98610. protected _sampleCount: number;
  98611. protected _pos: number;
  98612. protected _m2: number;
  98613. /**
  98614. * constructor
  98615. * @param length The number of samples required to saturate the sliding window
  98616. */
  98617. constructor(length: number);
  98618. /**
  98619. * Adds a sample to the sample set
  98620. * @param v The sample value
  98621. */
  98622. add(v: number): void;
  98623. /**
  98624. * Returns previously added values or null if outside of history or outside the sliding window domain
  98625. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  98626. * @return Value previously recorded with add() or null if outside of range
  98627. */
  98628. history(i: number): number;
  98629. /**
  98630. * Returns true if enough samples have been taken to completely fill the sliding window
  98631. * @return true if sample-set saturated
  98632. */
  98633. isSaturated(): boolean;
  98634. /**
  98635. * Resets the rolling average (equivalent to 0 samples taken so far)
  98636. */
  98637. reset(): void;
  98638. /**
  98639. * Wraps a value around the sample range boundaries
  98640. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  98641. * @return Wrapped position in sample range
  98642. */
  98643. protected _wrapPosition(i: number): number;
  98644. }
  98645. }
  98646. declare module BABYLON {
  98647. /**
  98648. * This class is used to track a performance counter which is number based.
  98649. * The user has access to many properties which give statistics of different nature.
  98650. *
  98651. * The implementer can track two kinds of Performance Counter: time and count.
  98652. * 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.
  98653. * 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.
  98654. */
  98655. export class PerfCounter {
  98656. /**
  98657. * Gets or sets a global boolean to turn on and off all the counters
  98658. */
  98659. static Enabled: boolean;
  98660. /**
  98661. * Returns the smallest value ever
  98662. */
  98663. readonly min: number;
  98664. /**
  98665. * Returns the biggest value ever
  98666. */
  98667. readonly max: number;
  98668. /**
  98669. * Returns the average value since the performance counter is running
  98670. */
  98671. readonly average: number;
  98672. /**
  98673. * Returns the average value of the last second the counter was monitored
  98674. */
  98675. readonly lastSecAverage: number;
  98676. /**
  98677. * Returns the current value
  98678. */
  98679. readonly current: number;
  98680. /**
  98681. * Gets the accumulated total
  98682. */
  98683. readonly total: number;
  98684. /**
  98685. * Gets the total value count
  98686. */
  98687. readonly count: number;
  98688. /**
  98689. * Creates a new counter
  98690. */
  98691. constructor();
  98692. /**
  98693. * Call this method to start monitoring a new frame.
  98694. * 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.
  98695. */
  98696. fetchNewFrame(): void;
  98697. /**
  98698. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  98699. * @param newCount the count value to add to the monitored count
  98700. * @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.
  98701. */
  98702. addCount(newCount: number, fetchResult: boolean): void;
  98703. /**
  98704. * Start monitoring this performance counter
  98705. */
  98706. beginMonitoring(): void;
  98707. /**
  98708. * Compute the time lapsed since the previous beginMonitoring() call.
  98709. * @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
  98710. */
  98711. endMonitoring(newFrame?: boolean): void;
  98712. private _fetchResult;
  98713. private _startMonitoringTime;
  98714. private _min;
  98715. private _max;
  98716. private _average;
  98717. private _current;
  98718. private _totalValueCount;
  98719. private _totalAccumulated;
  98720. private _lastSecAverage;
  98721. private _lastSecAccumulated;
  98722. private _lastSecTime;
  98723. private _lastSecValueCount;
  98724. }
  98725. }
  98726. declare module BABYLON {
  98727. /**
  98728. * Defines the interface used by display changed events
  98729. */
  98730. export interface IDisplayChangedEventArgs {
  98731. /** Gets the vrDisplay object (if any) */
  98732. vrDisplay: Nullable<any>;
  98733. /** Gets a boolean indicating if webVR is supported */
  98734. vrSupported: boolean;
  98735. }
  98736. /**
  98737. * Defines the interface used by objects containing a viewport (like a camera)
  98738. */
  98739. interface IViewportOwnerLike {
  98740. /**
  98741. * Gets or sets the viewport
  98742. */
  98743. viewport: IViewportLike;
  98744. }
  98745. /**
  98746. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  98747. */
  98748. export class Engine extends ThinEngine {
  98749. /** Defines that alpha blending is disabled */
  98750. static readonly ALPHA_DISABLE: number;
  98751. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  98752. static readonly ALPHA_ADD: number;
  98753. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  98754. static readonly ALPHA_COMBINE: number;
  98755. /** Defines that alpha blending to DEST - SRC * DEST */
  98756. static readonly ALPHA_SUBTRACT: number;
  98757. /** Defines that alpha blending to SRC * DEST */
  98758. static readonly ALPHA_MULTIPLY: number;
  98759. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  98760. static readonly ALPHA_MAXIMIZED: number;
  98761. /** Defines that alpha blending to SRC + DEST */
  98762. static readonly ALPHA_ONEONE: number;
  98763. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  98764. static readonly ALPHA_PREMULTIPLIED: number;
  98765. /**
  98766. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  98767. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  98768. */
  98769. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  98770. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  98771. static readonly ALPHA_INTERPOLATE: number;
  98772. /**
  98773. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  98774. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  98775. */
  98776. static readonly ALPHA_SCREENMODE: number;
  98777. /** Defines that the ressource is not delayed*/
  98778. static readonly DELAYLOADSTATE_NONE: number;
  98779. /** Defines that the ressource was successfully delay loaded */
  98780. static readonly DELAYLOADSTATE_LOADED: number;
  98781. /** Defines that the ressource is currently delay loading */
  98782. static readonly DELAYLOADSTATE_LOADING: number;
  98783. /** Defines that the ressource is delayed and has not started loading */
  98784. static readonly DELAYLOADSTATE_NOTLOADED: number;
  98785. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  98786. static readonly NEVER: number;
  98787. /** 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 */
  98788. static readonly ALWAYS: number;
  98789. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  98790. static readonly LESS: number;
  98791. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  98792. static readonly EQUAL: number;
  98793. /** 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 */
  98794. static readonly LEQUAL: number;
  98795. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  98796. static readonly GREATER: number;
  98797. /** 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 */
  98798. static readonly GEQUAL: number;
  98799. /** 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 */
  98800. static readonly NOTEQUAL: number;
  98801. /** Passed to stencilOperation to specify that stencil value must be kept */
  98802. static readonly KEEP: number;
  98803. /** Passed to stencilOperation to specify that stencil value must be replaced */
  98804. static readonly REPLACE: number;
  98805. /** Passed to stencilOperation to specify that stencil value must be incremented */
  98806. static readonly INCR: number;
  98807. /** Passed to stencilOperation to specify that stencil value must be decremented */
  98808. static readonly DECR: number;
  98809. /** Passed to stencilOperation to specify that stencil value must be inverted */
  98810. static readonly INVERT: number;
  98811. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  98812. static readonly INCR_WRAP: number;
  98813. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  98814. static readonly DECR_WRAP: number;
  98815. /** Texture is not repeating outside of 0..1 UVs */
  98816. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  98817. /** Texture is repeating outside of 0..1 UVs */
  98818. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  98819. /** Texture is repeating and mirrored */
  98820. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  98821. /** ALPHA */
  98822. static readonly TEXTUREFORMAT_ALPHA: number;
  98823. /** LUMINANCE */
  98824. static readonly TEXTUREFORMAT_LUMINANCE: number;
  98825. /** LUMINANCE_ALPHA */
  98826. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  98827. /** RGB */
  98828. static readonly TEXTUREFORMAT_RGB: number;
  98829. /** RGBA */
  98830. static readonly TEXTUREFORMAT_RGBA: number;
  98831. /** RED */
  98832. static readonly TEXTUREFORMAT_RED: number;
  98833. /** RED (2nd reference) */
  98834. static readonly TEXTUREFORMAT_R: number;
  98835. /** RG */
  98836. static readonly TEXTUREFORMAT_RG: number;
  98837. /** RED_INTEGER */
  98838. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  98839. /** RED_INTEGER (2nd reference) */
  98840. static readonly TEXTUREFORMAT_R_INTEGER: number;
  98841. /** RG_INTEGER */
  98842. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  98843. /** RGB_INTEGER */
  98844. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  98845. /** RGBA_INTEGER */
  98846. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  98847. /** UNSIGNED_BYTE */
  98848. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  98849. /** UNSIGNED_BYTE (2nd reference) */
  98850. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  98851. /** FLOAT */
  98852. static readonly TEXTURETYPE_FLOAT: number;
  98853. /** HALF_FLOAT */
  98854. static readonly TEXTURETYPE_HALF_FLOAT: number;
  98855. /** BYTE */
  98856. static readonly TEXTURETYPE_BYTE: number;
  98857. /** SHORT */
  98858. static readonly TEXTURETYPE_SHORT: number;
  98859. /** UNSIGNED_SHORT */
  98860. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  98861. /** INT */
  98862. static readonly TEXTURETYPE_INT: number;
  98863. /** UNSIGNED_INT */
  98864. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  98865. /** UNSIGNED_SHORT_4_4_4_4 */
  98866. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  98867. /** UNSIGNED_SHORT_5_5_5_1 */
  98868. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  98869. /** UNSIGNED_SHORT_5_6_5 */
  98870. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  98871. /** UNSIGNED_INT_2_10_10_10_REV */
  98872. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  98873. /** UNSIGNED_INT_24_8 */
  98874. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  98875. /** UNSIGNED_INT_10F_11F_11F_REV */
  98876. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  98877. /** UNSIGNED_INT_5_9_9_9_REV */
  98878. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  98879. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  98880. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  98881. /** nearest is mag = nearest and min = nearest and mip = linear */
  98882. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  98883. /** Bilinear is mag = linear and min = linear and mip = nearest */
  98884. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  98885. /** Trilinear is mag = linear and min = linear and mip = linear */
  98886. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  98887. /** nearest is mag = nearest and min = nearest and mip = linear */
  98888. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  98889. /** Bilinear is mag = linear and min = linear and mip = nearest */
  98890. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  98891. /** Trilinear is mag = linear and min = linear and mip = linear */
  98892. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  98893. /** mag = nearest and min = nearest and mip = nearest */
  98894. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  98895. /** mag = nearest and min = linear and mip = nearest */
  98896. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  98897. /** mag = nearest and min = linear and mip = linear */
  98898. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  98899. /** mag = nearest and min = linear and mip = none */
  98900. static readonly TEXTURE_NEAREST_LINEAR: number;
  98901. /** mag = nearest and min = nearest and mip = none */
  98902. static readonly TEXTURE_NEAREST_NEAREST: number;
  98903. /** mag = linear and min = nearest and mip = nearest */
  98904. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  98905. /** mag = linear and min = nearest and mip = linear */
  98906. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  98907. /** mag = linear and min = linear and mip = none */
  98908. static readonly TEXTURE_LINEAR_LINEAR: number;
  98909. /** mag = linear and min = nearest and mip = none */
  98910. static readonly TEXTURE_LINEAR_NEAREST: number;
  98911. /** Explicit coordinates mode */
  98912. static readonly TEXTURE_EXPLICIT_MODE: number;
  98913. /** Spherical coordinates mode */
  98914. static readonly TEXTURE_SPHERICAL_MODE: number;
  98915. /** Planar coordinates mode */
  98916. static readonly TEXTURE_PLANAR_MODE: number;
  98917. /** Cubic coordinates mode */
  98918. static readonly TEXTURE_CUBIC_MODE: number;
  98919. /** Projection coordinates mode */
  98920. static readonly TEXTURE_PROJECTION_MODE: number;
  98921. /** Skybox coordinates mode */
  98922. static readonly TEXTURE_SKYBOX_MODE: number;
  98923. /** Inverse Cubic coordinates mode */
  98924. static readonly TEXTURE_INVCUBIC_MODE: number;
  98925. /** Equirectangular coordinates mode */
  98926. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  98927. /** Equirectangular Fixed coordinates mode */
  98928. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  98929. /** Equirectangular Fixed Mirrored coordinates mode */
  98930. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  98931. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  98932. static readonly SCALEMODE_FLOOR: number;
  98933. /** Defines that texture rescaling will look for the nearest power of 2 size */
  98934. static readonly SCALEMODE_NEAREST: number;
  98935. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  98936. static readonly SCALEMODE_CEILING: number;
  98937. /**
  98938. * Returns the current npm package of the sdk
  98939. */
  98940. static readonly NpmPackage: string;
  98941. /**
  98942. * Returns the current version of the framework
  98943. */
  98944. static readonly Version: string;
  98945. /** Gets the list of created engines */
  98946. static readonly Instances: Engine[];
  98947. /**
  98948. * Gets the latest created engine
  98949. */
  98950. static readonly LastCreatedEngine: Nullable<Engine>;
  98951. /**
  98952. * Gets the latest created scene
  98953. */
  98954. static readonly LastCreatedScene: Nullable<Scene>;
  98955. /**
  98956. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  98957. * @param flag defines which part of the materials must be marked as dirty
  98958. * @param predicate defines a predicate used to filter which materials should be affected
  98959. */
  98960. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  98961. /**
  98962. * Method called to create the default loading screen.
  98963. * This can be overriden in your own app.
  98964. * @param canvas The rendering canvas element
  98965. * @returns The loading screen
  98966. */
  98967. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  98968. /**
  98969. * Method called to create the default rescale post process on each engine.
  98970. */
  98971. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  98972. /**
  98973. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  98974. **/
  98975. enableOfflineSupport: boolean;
  98976. /**
  98977. * 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)
  98978. **/
  98979. disableManifestCheck: boolean;
  98980. /**
  98981. * Gets the list of created scenes
  98982. */
  98983. scenes: Scene[];
  98984. /**
  98985. * Event raised when a new scene is created
  98986. */
  98987. onNewSceneAddedObservable: Observable<Scene>;
  98988. /**
  98989. * Gets the list of created postprocesses
  98990. */
  98991. postProcesses: PostProcess[];
  98992. /**
  98993. * Gets a boolean indicating if the pointer is currently locked
  98994. */
  98995. isPointerLock: boolean;
  98996. /**
  98997. * Observable event triggered each time the rendering canvas is resized
  98998. */
  98999. onResizeObservable: Observable<Engine>;
  99000. /**
  99001. * Observable event triggered each time the canvas loses focus
  99002. */
  99003. onCanvasBlurObservable: Observable<Engine>;
  99004. /**
  99005. * Observable event triggered each time the canvas gains focus
  99006. */
  99007. onCanvasFocusObservable: Observable<Engine>;
  99008. /**
  99009. * Observable event triggered each time the canvas receives pointerout event
  99010. */
  99011. onCanvasPointerOutObservable: Observable<PointerEvent>;
  99012. /**
  99013. * Observable raised when the engine begins a new frame
  99014. */
  99015. onBeginFrameObservable: Observable<Engine>;
  99016. /**
  99017. * If set, will be used to request the next animation frame for the render loop
  99018. */
  99019. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  99020. /**
  99021. * Observable raised when the engine ends the current frame
  99022. */
  99023. onEndFrameObservable: Observable<Engine>;
  99024. /**
  99025. * Observable raised when the engine is about to compile a shader
  99026. */
  99027. onBeforeShaderCompilationObservable: Observable<Engine>;
  99028. /**
  99029. * Observable raised when the engine has jsut compiled a shader
  99030. */
  99031. onAfterShaderCompilationObservable: Observable<Engine>;
  99032. /**
  99033. * Gets the audio engine
  99034. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  99035. * @ignorenaming
  99036. */
  99037. static audioEngine: IAudioEngine;
  99038. /**
  99039. * Default AudioEngine factory responsible of creating the Audio Engine.
  99040. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  99041. */
  99042. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  99043. /**
  99044. * Default offline support factory responsible of creating a tool used to store data locally.
  99045. * By default, this will create a Database object if the workload has been embedded.
  99046. */
  99047. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  99048. private _loadingScreen;
  99049. private _pointerLockRequested;
  99050. private _dummyFramebuffer;
  99051. private _rescalePostProcess;
  99052. /** @hidden */
  99053. protected _alphaMode: number;
  99054. /** @hidden */
  99055. protected _alphaEquation: number;
  99056. private _deterministicLockstep;
  99057. private _lockstepMaxSteps;
  99058. protected readonly _supportsHardwareTextureRescaling: boolean;
  99059. private _fps;
  99060. private _deltaTime;
  99061. /** @hidden */
  99062. _drawCalls: PerfCounter;
  99063. /**
  99064. * Turn this value on if you want to pause FPS computation when in background
  99065. */
  99066. disablePerformanceMonitorInBackground: boolean;
  99067. private _performanceMonitor;
  99068. /**
  99069. * Gets the performance monitor attached to this engine
  99070. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  99071. */
  99072. readonly performanceMonitor: PerformanceMonitor;
  99073. private _onFocus;
  99074. private _onBlur;
  99075. private _onCanvasPointerOut;
  99076. private _onCanvasBlur;
  99077. private _onCanvasFocus;
  99078. private _onFullscreenChange;
  99079. private _onPointerLockChange;
  99080. /**
  99081. * Creates a new engine
  99082. * @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
  99083. * @param antialias defines enable antialiasing (default: false)
  99084. * @param options defines further options to be sent to the getContext() function
  99085. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  99086. */
  99087. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  99088. /**
  99089. * Gets current aspect ratio
  99090. * @param viewportOwner defines the camera to use to get the aspect ratio
  99091. * @param useScreen defines if screen size must be used (or the current render target if any)
  99092. * @returns a number defining the aspect ratio
  99093. */
  99094. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  99095. /**
  99096. * Gets current screen aspect ratio
  99097. * @returns a number defining the aspect ratio
  99098. */
  99099. getScreenAspectRatio(): number;
  99100. /**
  99101. * Gets host document
  99102. * @returns the host document object
  99103. */
  99104. getHostDocument(): Document;
  99105. /**
  99106. * Gets the client rect of the HTML canvas attached with the current webGL context
  99107. * @returns a client rectanglee
  99108. */
  99109. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  99110. /**
  99111. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  99112. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  99113. * @returns true if engine is in deterministic lock step mode
  99114. */
  99115. isDeterministicLockStep(): boolean;
  99116. /**
  99117. * Gets the max steps when engine is running in deterministic lock step
  99118. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  99119. * @returns the max steps
  99120. */
  99121. getLockstepMaxSteps(): number;
  99122. /**
  99123. * Force the mipmap generation for the given render target texture
  99124. * @param texture defines the render target texture to use
  99125. */
  99126. generateMipMapsForCubemap(texture: InternalTexture): void;
  99127. /** States */
  99128. /**
  99129. * Set various states to the webGL context
  99130. * @param culling defines backface culling state
  99131. * @param zOffset defines the value to apply to zOffset (0 by default)
  99132. * @param force defines if states must be applied even if cache is up to date
  99133. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  99134. */
  99135. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  99136. /**
  99137. * Set the z offset to apply to current rendering
  99138. * @param value defines the offset to apply
  99139. */
  99140. setZOffset(value: number): void;
  99141. /**
  99142. * Gets the current value of the zOffset
  99143. * @returns the current zOffset state
  99144. */
  99145. getZOffset(): number;
  99146. /**
  99147. * Enable or disable depth buffering
  99148. * @param enable defines the state to set
  99149. */
  99150. setDepthBuffer(enable: boolean): void;
  99151. /**
  99152. * Gets a boolean indicating if depth writing is enabled
  99153. * @returns the current depth writing state
  99154. */
  99155. getDepthWrite(): boolean;
  99156. /**
  99157. * Enable or disable depth writing
  99158. * @param enable defines the state to set
  99159. */
  99160. setDepthWrite(enable: boolean): void;
  99161. /**
  99162. * Enable or disable color writing
  99163. * @param enable defines the state to set
  99164. */
  99165. setColorWrite(enable: boolean): void;
  99166. /**
  99167. * Gets a boolean indicating if color writing is enabled
  99168. * @returns the current color writing state
  99169. */
  99170. getColorWrite(): boolean;
  99171. /**
  99172. * Sets alpha constants used by some alpha blending modes
  99173. * @param r defines the red component
  99174. * @param g defines the green component
  99175. * @param b defines the blue component
  99176. * @param a defines the alpha component
  99177. */
  99178. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  99179. /**
  99180. * Sets the current alpha mode
  99181. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  99182. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  99183. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  99184. */
  99185. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  99186. /**
  99187. * Gets the current alpha mode
  99188. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  99189. * @returns the current alpha mode
  99190. */
  99191. getAlphaMode(): number;
  99192. /**
  99193. * Sets the current alpha equation
  99194. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  99195. */
  99196. setAlphaEquation(equation: number): void;
  99197. /**
  99198. * Gets the current alpha equation.
  99199. * @returns the current alpha equation
  99200. */
  99201. getAlphaEquation(): number;
  99202. /**
  99203. * Gets a boolean indicating if stencil buffer is enabled
  99204. * @returns the current stencil buffer state
  99205. */
  99206. getStencilBuffer(): boolean;
  99207. /**
  99208. * Enable or disable the stencil buffer
  99209. * @param enable defines if the stencil buffer must be enabled or disabled
  99210. */
  99211. setStencilBuffer(enable: boolean): void;
  99212. /**
  99213. * Gets the current stencil mask
  99214. * @returns a number defining the new stencil mask to use
  99215. */
  99216. getStencilMask(): number;
  99217. /**
  99218. * Sets the current stencil mask
  99219. * @param mask defines the new stencil mask to use
  99220. */
  99221. setStencilMask(mask: number): void;
  99222. /**
  99223. * Gets the current stencil function
  99224. * @returns a number defining the stencil function to use
  99225. */
  99226. getStencilFunction(): number;
  99227. /**
  99228. * Gets the current stencil reference value
  99229. * @returns a number defining the stencil reference value to use
  99230. */
  99231. getStencilFunctionReference(): number;
  99232. /**
  99233. * Gets the current stencil mask
  99234. * @returns a number defining the stencil mask to use
  99235. */
  99236. getStencilFunctionMask(): number;
  99237. /**
  99238. * Sets the current stencil function
  99239. * @param stencilFunc defines the new stencil function to use
  99240. */
  99241. setStencilFunction(stencilFunc: number): void;
  99242. /**
  99243. * Sets the current stencil reference
  99244. * @param reference defines the new stencil reference to use
  99245. */
  99246. setStencilFunctionReference(reference: number): void;
  99247. /**
  99248. * Sets the current stencil mask
  99249. * @param mask defines the new stencil mask to use
  99250. */
  99251. setStencilFunctionMask(mask: number): void;
  99252. /**
  99253. * Gets the current stencil operation when stencil fails
  99254. * @returns a number defining stencil operation to use when stencil fails
  99255. */
  99256. getStencilOperationFail(): number;
  99257. /**
  99258. * Gets the current stencil operation when depth fails
  99259. * @returns a number defining stencil operation to use when depth fails
  99260. */
  99261. getStencilOperationDepthFail(): number;
  99262. /**
  99263. * Gets the current stencil operation when stencil passes
  99264. * @returns a number defining stencil operation to use when stencil passes
  99265. */
  99266. getStencilOperationPass(): number;
  99267. /**
  99268. * Sets the stencil operation to use when stencil fails
  99269. * @param operation defines the stencil operation to use when stencil fails
  99270. */
  99271. setStencilOperationFail(operation: number): void;
  99272. /**
  99273. * Sets the stencil operation to use when depth fails
  99274. * @param operation defines the stencil operation to use when depth fails
  99275. */
  99276. setStencilOperationDepthFail(operation: number): void;
  99277. /**
  99278. * Sets the stencil operation to use when stencil passes
  99279. * @param operation defines the stencil operation to use when stencil passes
  99280. */
  99281. setStencilOperationPass(operation: number): void;
  99282. /**
  99283. * Sets a boolean indicating if the dithering state is enabled or disabled
  99284. * @param value defines the dithering state
  99285. */
  99286. setDitheringState(value: boolean): void;
  99287. /**
  99288. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  99289. * @param value defines the rasterizer state
  99290. */
  99291. setRasterizerState(value: boolean): void;
  99292. /**
  99293. * Gets the current depth function
  99294. * @returns a number defining the depth function
  99295. */
  99296. getDepthFunction(): Nullable<number>;
  99297. /**
  99298. * Sets the current depth function
  99299. * @param depthFunc defines the function to use
  99300. */
  99301. setDepthFunction(depthFunc: number): void;
  99302. /**
  99303. * Sets the current depth function to GREATER
  99304. */
  99305. setDepthFunctionToGreater(): void;
  99306. /**
  99307. * Sets the current depth function to GEQUAL
  99308. */
  99309. setDepthFunctionToGreaterOrEqual(): void;
  99310. /**
  99311. * Sets the current depth function to LESS
  99312. */
  99313. setDepthFunctionToLess(): void;
  99314. /**
  99315. * Sets the current depth function to LEQUAL
  99316. */
  99317. setDepthFunctionToLessOrEqual(): void;
  99318. private _cachedStencilBuffer;
  99319. private _cachedStencilFunction;
  99320. private _cachedStencilMask;
  99321. private _cachedStencilOperationPass;
  99322. private _cachedStencilOperationFail;
  99323. private _cachedStencilOperationDepthFail;
  99324. private _cachedStencilReference;
  99325. /**
  99326. * Caches the the state of the stencil buffer
  99327. */
  99328. cacheStencilState(): void;
  99329. /**
  99330. * Restores the state of the stencil buffer
  99331. */
  99332. restoreStencilState(): void;
  99333. /**
  99334. * Directly set the WebGL Viewport
  99335. * @param x defines the x coordinate of the viewport (in screen space)
  99336. * @param y defines the y coordinate of the viewport (in screen space)
  99337. * @param width defines the width of the viewport (in screen space)
  99338. * @param height defines the height of the viewport (in screen space)
  99339. * @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
  99340. */
  99341. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  99342. /**
  99343. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  99344. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  99345. * @param y defines the y-coordinate of the corner of the clear rectangle
  99346. * @param width defines the width of the clear rectangle
  99347. * @param height defines the height of the clear rectangle
  99348. * @param clearColor defines the clear color
  99349. */
  99350. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  99351. /**
  99352. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  99353. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  99354. * @param y defines the y-coordinate of the corner of the clear rectangle
  99355. * @param width defines the width of the clear rectangle
  99356. * @param height defines the height of the clear rectangle
  99357. */
  99358. enableScissor(x: number, y: number, width: number, height: number): void;
  99359. /**
  99360. * Disable previously set scissor test rectangle
  99361. */
  99362. disableScissor(): void;
  99363. protected _reportDrawCall(): void;
  99364. /**
  99365. * Initializes a webVR display and starts listening to display change events
  99366. * The onVRDisplayChangedObservable will be notified upon these changes
  99367. * @returns The onVRDisplayChangedObservable
  99368. */
  99369. initWebVR(): Observable<IDisplayChangedEventArgs>;
  99370. /** @hidden */
  99371. _prepareVRComponent(): void;
  99372. /** @hidden */
  99373. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  99374. /** @hidden */
  99375. _submitVRFrame(): void;
  99376. /**
  99377. * Call this function to leave webVR mode
  99378. * Will do nothing if webVR is not supported or if there is no webVR device
  99379. * @see http://doc.babylonjs.com/how_to/webvr_camera
  99380. */
  99381. disableVR(): void;
  99382. /**
  99383. * Gets a boolean indicating that the system is in VR mode and is presenting
  99384. * @returns true if VR mode is engaged
  99385. */
  99386. isVRPresenting(): boolean;
  99387. /** @hidden */
  99388. _requestVRFrame(): void;
  99389. /** @hidden */
  99390. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  99391. /**
  99392. * Gets the source code of the vertex shader associated with a specific webGL program
  99393. * @param program defines the program to use
  99394. * @returns a string containing the source code of the vertex shader associated with the program
  99395. */
  99396. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  99397. /**
  99398. * Gets the source code of the fragment shader associated with a specific webGL program
  99399. * @param program defines the program to use
  99400. * @returns a string containing the source code of the fragment shader associated with the program
  99401. */
  99402. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  99403. /**
  99404. * Reads pixels from the current frame buffer. Please note that this function can be slow
  99405. * @param x defines the x coordinate of the rectangle where pixels must be read
  99406. * @param y defines the y coordinate of the rectangle where pixels must be read
  99407. * @param width defines the width of the rectangle where pixels must be read
  99408. * @param height defines the height of the rectangle where pixels must be read
  99409. * @returns a Uint8Array containing RGBA colors
  99410. */
  99411. readPixels(x: number, y: number, width: number, height: number): Uint8Array;
  99412. /**
  99413. * Sets a depth stencil texture from a render target to the according uniform.
  99414. * @param channel The texture channel
  99415. * @param uniform The uniform to set
  99416. * @param texture The render target texture containing the depth stencil texture to apply
  99417. */
  99418. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  99419. /**
  99420. * Sets a texture to the webGL context from a postprocess
  99421. * @param channel defines the channel to use
  99422. * @param postProcess defines the source postprocess
  99423. */
  99424. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  99425. /**
  99426. * Binds the output of the passed in post process to the texture channel specified
  99427. * @param channel The channel the texture should be bound to
  99428. * @param postProcess The post process which's output should be bound
  99429. */
  99430. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  99431. /** @hidden */
  99432. _convertRGBtoRGBATextureData(rgbData: any, width: number, height: number, textureType: number): ArrayBufferView;
  99433. protected _rebuildBuffers(): void;
  99434. _renderLoop(): void;
  99435. /**
  99436. * Toggle full screen mode
  99437. * @param requestPointerLock defines if a pointer lock should be requested from the user
  99438. */
  99439. switchFullscreen(requestPointerLock: boolean): void;
  99440. /**
  99441. * Enters full screen mode
  99442. * @param requestPointerLock defines if a pointer lock should be requested from the user
  99443. */
  99444. enterFullscreen(requestPointerLock: boolean): void;
  99445. /**
  99446. * Exits full screen mode
  99447. */
  99448. exitFullscreen(): void;
  99449. /**
  99450. * Enters Pointerlock mode
  99451. */
  99452. enterPointerlock(): void;
  99453. /**
  99454. * Exits Pointerlock mode
  99455. */
  99456. exitPointerlock(): void;
  99457. /**
  99458. * Begin a new frame
  99459. */
  99460. beginFrame(): void;
  99461. /**
  99462. * Enf the current frame
  99463. */
  99464. endFrame(): void;
  99465. resize(): void;
  99466. /**
  99467. * Set the compressed texture format to use, based on the formats you have, and the formats
  99468. * supported by the hardware / browser.
  99469. *
  99470. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  99471. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  99472. * to API arguments needed to compressed textures. This puts the burden on the container
  99473. * generator to house the arcane code for determining these for current & future formats.
  99474. *
  99475. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  99476. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  99477. *
  99478. * Note: The result of this call is not taken into account when a texture is base64.
  99479. *
  99480. * @param formatsAvailable defines the list of those format families you have created
  99481. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  99482. *
  99483. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  99484. * @returns The extension selected.
  99485. */
  99486. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  99487. /**
  99488. * Force a specific size of the canvas
  99489. * @param width defines the new canvas' width
  99490. * @param height defines the new canvas' height
  99491. */
  99492. setSize(width: number, height: number): void;
  99493. /**
  99494. * Updates a dynamic vertex buffer.
  99495. * @param vertexBuffer the vertex buffer to update
  99496. * @param data the data used to update the vertex buffer
  99497. * @param byteOffset the byte offset of the data
  99498. * @param byteLength the byte length of the data
  99499. */
  99500. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  99501. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  99502. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  99503. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  99504. _releaseTexture(texture: InternalTexture): void;
  99505. /**
  99506. * @hidden
  99507. * Rescales a texture
  99508. * @param source input texutre
  99509. * @param destination destination texture
  99510. * @param scene scene to use to render the resize
  99511. * @param internalFormat format to use when resizing
  99512. * @param onComplete callback to be called when resize has completed
  99513. */
  99514. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  99515. /**
  99516. * Gets the current framerate
  99517. * @returns a number representing the framerate
  99518. */
  99519. getFps(): number;
  99520. /**
  99521. * Gets the time spent between current and previous frame
  99522. * @returns a number representing the delta time in ms
  99523. */
  99524. getDeltaTime(): number;
  99525. private _measureFps;
  99526. /** @hidden */
  99527. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  99528. /**
  99529. * Sets the frame buffer Depth / Stencil attachement of the render target to the defined depth stencil texture.
  99530. * @param renderTarget The render target to set the frame buffer for
  99531. */
  99532. setFrameBufferDepthStencilTexture(renderTarget: RenderTargetTexture): void;
  99533. /**
  99534. * Update a dynamic index buffer
  99535. * @param indexBuffer defines the target index buffer
  99536. * @param indices defines the data to update
  99537. * @param offset defines the offset in the target index buffer where update should start
  99538. */
  99539. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  99540. /**
  99541. * Updates the sample count of a render target texture
  99542. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  99543. * @param texture defines the texture to update
  99544. * @param samples defines the sample count to set
  99545. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  99546. */
  99547. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  99548. /**
  99549. * Updates a depth texture Comparison Mode and Function.
  99550. * If the comparison Function is equal to 0, the mode will be set to none.
  99551. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  99552. * @param texture The texture to set the comparison function for
  99553. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  99554. */
  99555. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  99556. /**
  99557. * Creates a webGL buffer to use with instanciation
  99558. * @param capacity defines the size of the buffer
  99559. * @returns the webGL buffer
  99560. */
  99561. createInstancesBuffer(capacity: number): DataBuffer;
  99562. /**
  99563. * Delete a webGL buffer used with instanciation
  99564. * @param buffer defines the webGL buffer to delete
  99565. */
  99566. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  99567. /** @hidden */
  99568. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  99569. dispose(): void;
  99570. private _disableTouchAction;
  99571. /**
  99572. * Display the loading screen
  99573. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99574. */
  99575. displayLoadingUI(): void;
  99576. /**
  99577. * Hide the loading screen
  99578. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99579. */
  99580. hideLoadingUI(): void;
  99581. /**
  99582. * Gets the current loading screen object
  99583. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99584. */
  99585. /**
  99586. * Sets the current loading screen object
  99587. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99588. */
  99589. loadingScreen: ILoadingScreen;
  99590. /**
  99591. * Sets the current loading screen text
  99592. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99593. */
  99594. loadingUIText: string;
  99595. /**
  99596. * Sets the current loading screen background color
  99597. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99598. */
  99599. loadingUIBackgroundColor: string;
  99600. /** Pointerlock and fullscreen */
  99601. /**
  99602. * Ask the browser to promote the current element to pointerlock mode
  99603. * @param element defines the DOM element to promote
  99604. */
  99605. static _RequestPointerlock(element: HTMLElement): void;
  99606. /**
  99607. * Asks the browser to exit pointerlock mode
  99608. */
  99609. static _ExitPointerlock(): void;
  99610. /**
  99611. * Ask the browser to promote the current element to fullscreen rendering mode
  99612. * @param element defines the DOM element to promote
  99613. */
  99614. static _RequestFullscreen(element: HTMLElement): void;
  99615. /**
  99616. * Asks the browser to exit fullscreen mode
  99617. */
  99618. static _ExitFullscreen(): void;
  99619. }
  99620. }
  99621. declare module BABYLON {
  99622. /**
  99623. * The engine store class is responsible to hold all the instances of Engine and Scene created
  99624. * during the life time of the application.
  99625. */
  99626. export class EngineStore {
  99627. /** Gets the list of created engines */
  99628. static Instances: Engine[];
  99629. /** @hidden */
  99630. static _LastCreatedScene: Nullable<Scene>;
  99631. /**
  99632. * Gets the latest created engine
  99633. */
  99634. static readonly LastCreatedEngine: Nullable<Engine>;
  99635. /**
  99636. * Gets the latest created scene
  99637. */
  99638. static readonly LastCreatedScene: Nullable<Scene>;
  99639. /**
  99640. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  99641. * @ignorenaming
  99642. */
  99643. static UseFallbackTexture: boolean;
  99644. /**
  99645. * Texture content used if a texture cannot loaded
  99646. * @ignorenaming
  99647. */
  99648. static FallbackTexture: string;
  99649. }
  99650. }
  99651. declare module BABYLON {
  99652. /**
  99653. * Helper class that provides a small promise polyfill
  99654. */
  99655. export class PromisePolyfill {
  99656. /**
  99657. * Static function used to check if the polyfill is required
  99658. * If this is the case then the function will inject the polyfill to window.Promise
  99659. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  99660. */
  99661. static Apply(force?: boolean): void;
  99662. }
  99663. }
  99664. declare module BABYLON {
  99665. /**
  99666. * Interface for screenshot methods with describe argument called `size` as object with options
  99667. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  99668. */
  99669. export interface IScreenshotSize {
  99670. /**
  99671. * number in pixels for canvas height
  99672. */
  99673. height?: number;
  99674. /**
  99675. * multiplier allowing render at a higher or lower resolution
  99676. * If value is defined then height and width will be ignored and taken from camera
  99677. */
  99678. precision?: number;
  99679. /**
  99680. * number in pixels for canvas width
  99681. */
  99682. width?: number;
  99683. }
  99684. }
  99685. declare module BABYLON {
  99686. interface IColor4Like {
  99687. r: float;
  99688. g: float;
  99689. b: float;
  99690. a: float;
  99691. }
  99692. /**
  99693. * Class containing a set of static utilities functions
  99694. */
  99695. export class Tools {
  99696. /**
  99697. * Gets or sets the base URL to use to load assets
  99698. */
  99699. static BaseUrl: string;
  99700. /**
  99701. * Enable/Disable Custom HTTP Request Headers globally.
  99702. * default = false
  99703. * @see CustomRequestHeaders
  99704. */
  99705. static UseCustomRequestHeaders: boolean;
  99706. /**
  99707. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  99708. * i.e. when loading files, where the server/service expects an Authorization header
  99709. */
  99710. static CustomRequestHeaders: {
  99711. [key: string]: string;
  99712. };
  99713. /**
  99714. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  99715. */
  99716. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  99717. /**
  99718. * Default behaviour for cors in the application.
  99719. * It can be a string if the expected behavior is identical in the entire app.
  99720. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  99721. */
  99722. static CorsBehavior: string | ((url: string | string[]) => string);
  99723. /**
  99724. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  99725. * @ignorenaming
  99726. */
  99727. static UseFallbackTexture: boolean;
  99728. /**
  99729. * Use this object to register external classes like custom textures or material
  99730. * to allow the laoders to instantiate them
  99731. */
  99732. static RegisteredExternalClasses: {
  99733. [key: string]: Object;
  99734. };
  99735. /**
  99736. * Texture content used if a texture cannot loaded
  99737. * @ignorenaming
  99738. */
  99739. static fallbackTexture: string;
  99740. /**
  99741. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  99742. * @param u defines the coordinate on X axis
  99743. * @param v defines the coordinate on Y axis
  99744. * @param width defines the width of the source data
  99745. * @param height defines the height of the source data
  99746. * @param pixels defines the source byte array
  99747. * @param color defines the output color
  99748. */
  99749. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  99750. /**
  99751. * Interpolates between a and b via alpha
  99752. * @param a The lower value (returned when alpha = 0)
  99753. * @param b The upper value (returned when alpha = 1)
  99754. * @param alpha The interpolation-factor
  99755. * @return The mixed value
  99756. */
  99757. static Mix(a: number, b: number, alpha: number): number;
  99758. /**
  99759. * Tries to instantiate a new object from a given class name
  99760. * @param className defines the class name to instantiate
  99761. * @returns the new object or null if the system was not able to do the instantiation
  99762. */
  99763. static Instantiate(className: string): any;
  99764. /**
  99765. * Provides a slice function that will work even on IE
  99766. * @param data defines the array to slice
  99767. * @param start defines the start of the data (optional)
  99768. * @param end defines the end of the data (optional)
  99769. * @returns the new sliced array
  99770. */
  99771. static Slice<T>(data: T, start?: number, end?: number): T;
  99772. /**
  99773. * Polyfill for setImmediate
  99774. * @param action defines the action to execute after the current execution block
  99775. */
  99776. static SetImmediate(action: () => void): void;
  99777. /**
  99778. * Function indicating if a number is an exponent of 2
  99779. * @param value defines the value to test
  99780. * @returns true if the value is an exponent of 2
  99781. */
  99782. static IsExponentOfTwo(value: number): boolean;
  99783. private static _tmpFloatArray;
  99784. /**
  99785. * Returns the nearest 32-bit single precision float representation of a Number
  99786. * @param value A Number. If the parameter is of a different type, it will get converted
  99787. * to a number or to NaN if it cannot be converted
  99788. * @returns number
  99789. */
  99790. static FloatRound(value: number): number;
  99791. /**
  99792. * Extracts the filename from a path
  99793. * @param path defines the path to use
  99794. * @returns the filename
  99795. */
  99796. static GetFilename(path: string): string;
  99797. /**
  99798. * Extracts the "folder" part of a path (everything before the filename).
  99799. * @param uri The URI to extract the info from
  99800. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  99801. * @returns The "folder" part of the path
  99802. */
  99803. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  99804. /**
  99805. * Extracts text content from a DOM element hierarchy
  99806. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  99807. */
  99808. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  99809. /**
  99810. * Convert an angle in radians to degrees
  99811. * @param angle defines the angle to convert
  99812. * @returns the angle in degrees
  99813. */
  99814. static ToDegrees(angle: number): number;
  99815. /**
  99816. * Convert an angle in degrees to radians
  99817. * @param angle defines the angle to convert
  99818. * @returns the angle in radians
  99819. */
  99820. static ToRadians(angle: number): number;
  99821. /**
  99822. * Returns an array if obj is not an array
  99823. * @param obj defines the object to evaluate as an array
  99824. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  99825. * @returns either obj directly if obj is an array or a new array containing obj
  99826. */
  99827. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  99828. /**
  99829. * Gets the pointer prefix to use
  99830. * @returns "pointer" if touch is enabled. Else returns "mouse"
  99831. */
  99832. static GetPointerPrefix(): string;
  99833. /**
  99834. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  99835. * @param url define the url we are trying
  99836. * @param element define the dom element where to configure the cors policy
  99837. */
  99838. static SetCorsBehavior(url: string | string[], element: {
  99839. crossOrigin: string | null;
  99840. }): void;
  99841. /**
  99842. * Removes unwanted characters from an url
  99843. * @param url defines the url to clean
  99844. * @returns the cleaned url
  99845. */
  99846. static CleanUrl(url: string): string;
  99847. /**
  99848. * Gets or sets a function used to pre-process url before using them to load assets
  99849. */
  99850. static PreprocessUrl: (url: string) => string;
  99851. /**
  99852. * Loads an image as an HTMLImageElement.
  99853. * @param input url string, ArrayBuffer, or Blob to load
  99854. * @param onLoad callback called when the image successfully loads
  99855. * @param onError callback called when the image fails to load
  99856. * @param offlineProvider offline provider for caching
  99857. * @param mimeType optional mime type
  99858. * @returns the HTMLImageElement of the loaded image
  99859. */
  99860. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  99861. /**
  99862. * Loads a file from a url
  99863. * @param url url string, ArrayBuffer, or Blob to load
  99864. * @param onSuccess callback called when the file successfully loads
  99865. * @param onProgress callback called while file is loading (if the server supports this mode)
  99866. * @param offlineProvider defines the offline provider for caching
  99867. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  99868. * @param onError callback called when the file fails to load
  99869. * @returns a file request object
  99870. */
  99871. 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;
  99872. /**
  99873. * Loads a file from a url
  99874. * @param url the file url to load
  99875. * @returns a promise containing an ArrayBuffer corrisponding to the loaded file
  99876. */
  99877. static LoadFileAsync(url: string): Promise<ArrayBuffer>;
  99878. /**
  99879. * Load a script (identified by an url). When the url returns, the
  99880. * content of this file is added into a new script element, attached to the DOM (body element)
  99881. * @param scriptUrl defines the url of the script to laod
  99882. * @param onSuccess defines the callback called when the script is loaded
  99883. * @param onError defines the callback to call if an error occurs
  99884. * @param scriptId defines the id of the script element
  99885. */
  99886. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  99887. /**
  99888. * Load an asynchronous script (identified by an url). When the url returns, the
  99889. * content of this file is added into a new script element, attached to the DOM (body element)
  99890. * @param scriptUrl defines the url of the script to laod
  99891. * @param scriptId defines the id of the script element
  99892. * @returns a promise request object
  99893. */
  99894. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<boolean>;
  99895. /**
  99896. * Loads a file from a blob
  99897. * @param fileToLoad defines the blob to use
  99898. * @param callback defines the callback to call when data is loaded
  99899. * @param progressCallback defines the callback to call during loading process
  99900. * @returns a file request object
  99901. */
  99902. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  99903. /**
  99904. * Reads a file from a File object
  99905. * @param file defines the file to load
  99906. * @param onSuccess defines the callback to call when data is loaded
  99907. * @param onProgress defines the callback to call during loading process
  99908. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  99909. * @param onError defines the callback to call when an error occurs
  99910. * @returns a file request object
  99911. */
  99912. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  99913. /**
  99914. * Creates a data url from a given string content
  99915. * @param content defines the content to convert
  99916. * @returns the new data url link
  99917. */
  99918. static FileAsURL(content: string): string;
  99919. /**
  99920. * Format the given number to a specific decimal format
  99921. * @param value defines the number to format
  99922. * @param decimals defines the number of decimals to use
  99923. * @returns the formatted string
  99924. */
  99925. static Format(value: number, decimals?: number): string;
  99926. /**
  99927. * Tries to copy an object by duplicating every property
  99928. * @param source defines the source object
  99929. * @param destination defines the target object
  99930. * @param doNotCopyList defines a list of properties to avoid
  99931. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  99932. */
  99933. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  99934. /**
  99935. * Gets a boolean indicating if the given object has no own property
  99936. * @param obj defines the object to test
  99937. * @returns true if object has no own property
  99938. */
  99939. static IsEmpty(obj: any): boolean;
  99940. /**
  99941. * Function used to register events at window level
  99942. * @param windowElement defines the Window object to use
  99943. * @param events defines the events to register
  99944. */
  99945. static RegisterTopRootEvents(windowElement: Window, events: {
  99946. name: string;
  99947. handler: Nullable<(e: FocusEvent) => any>;
  99948. }[]): void;
  99949. /**
  99950. * Function used to unregister events from window level
  99951. * @param windowElement defines the Window object to use
  99952. * @param events defines the events to unregister
  99953. */
  99954. static UnregisterTopRootEvents(windowElement: Window, events: {
  99955. name: string;
  99956. handler: Nullable<(e: FocusEvent) => any>;
  99957. }[]): void;
  99958. /**
  99959. * @ignore
  99960. */
  99961. static _ScreenshotCanvas: HTMLCanvasElement;
  99962. /**
  99963. * Dumps the current bound framebuffer
  99964. * @param width defines the rendering width
  99965. * @param height defines the rendering height
  99966. * @param engine defines the hosting engine
  99967. * @param successCallback defines the callback triggered once the data are available
  99968. * @param mimeType defines the mime type of the result
  99969. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  99970. */
  99971. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  99972. /**
  99973. * Converts the canvas data to blob.
  99974. * This acts as a polyfill for browsers not supporting the to blob function.
  99975. * @param canvas Defines the canvas to extract the data from
  99976. * @param successCallback Defines the callback triggered once the data are available
  99977. * @param mimeType Defines the mime type of the result
  99978. */
  99979. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  99980. /**
  99981. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  99982. * @param successCallback defines the callback triggered once the data are available
  99983. * @param mimeType defines the mime type of the result
  99984. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  99985. */
  99986. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  99987. /**
  99988. * Downloads a blob in the browser
  99989. * @param blob defines the blob to download
  99990. * @param fileName defines the name of the downloaded file
  99991. */
  99992. static Download(blob: Blob, fileName: string): void;
  99993. /**
  99994. * Captures a screenshot of the current rendering
  99995. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  99996. * @param engine defines the rendering engine
  99997. * @param camera defines the source camera
  99998. * @param size This parameter can be set to a single number or to an object with the
  99999. * following (optional) properties: precision, width, height. If a single number is passed,
  100000. * it will be used for both width and height. If an object is passed, the screenshot size
  100001. * will be derived from the parameters. The precision property is a multiplier allowing
  100002. * rendering at a higher or lower resolution
  100003. * @param successCallback defines the callback receives a single parameter which contains the
  100004. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  100005. * src parameter of an <img> to display it
  100006. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  100007. * Check your browser for supported MIME types
  100008. */
  100009. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  100010. /**
  100011. * Captures a screenshot of the current rendering
  100012. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100013. * @param engine defines the rendering engine
  100014. * @param camera defines the source camera
  100015. * @param size This parameter can be set to a single number or to an object with the
  100016. * following (optional) properties: precision, width, height. If a single number is passed,
  100017. * it will be used for both width and height. If an object is passed, the screenshot size
  100018. * will be derived from the parameters. The precision property is a multiplier allowing
  100019. * rendering at a higher or lower resolution
  100020. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  100021. * Check your browser for supported MIME types
  100022. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  100023. * to the src parameter of an <img> to display it
  100024. */
  100025. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  100026. /**
  100027. * Generates an image screenshot from the specified camera.
  100028. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100029. * @param engine The engine to use for rendering
  100030. * @param camera The camera to use for rendering
  100031. * @param size This parameter can be set to a single number or to an object with the
  100032. * following (optional) properties: precision, width, height. If a single number is passed,
  100033. * it will be used for both width and height. If an object is passed, the screenshot size
  100034. * will be derived from the parameters. The precision property is a multiplier allowing
  100035. * rendering at a higher or lower resolution
  100036. * @param successCallback The callback receives a single parameter which contains the
  100037. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  100038. * src parameter of an <img> to display it
  100039. * @param mimeType The MIME type of the screenshot image (default: image/png).
  100040. * Check your browser for supported MIME types
  100041. * @param samples Texture samples (default: 1)
  100042. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  100043. * @param fileName A name for for the downloaded file.
  100044. */
  100045. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  100046. /**
  100047. * Generates an image screenshot from the specified camera.
  100048. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100049. * @param engine The engine to use for rendering
  100050. * @param camera The camera to use for rendering
  100051. * @param size This parameter can be set to a single number or to an object with the
  100052. * following (optional) properties: precision, width, height. If a single number is passed,
  100053. * it will be used for both width and height. If an object is passed, the screenshot size
  100054. * will be derived from the parameters. The precision property is a multiplier allowing
  100055. * rendering at a higher or lower resolution
  100056. * @param mimeType The MIME type of the screenshot image (default: image/png).
  100057. * Check your browser for supported MIME types
  100058. * @param samples Texture samples (default: 1)
  100059. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  100060. * @param fileName A name for for the downloaded file.
  100061. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  100062. * to the src parameter of an <img> to display it
  100063. */
  100064. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  100065. /**
  100066. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  100067. * Be aware Math.random() could cause collisions, but:
  100068. * "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"
  100069. * @returns a pseudo random id
  100070. */
  100071. static RandomId(): string;
  100072. /**
  100073. * Test if the given uri is a base64 string
  100074. * @param uri The uri to test
  100075. * @return True if the uri is a base64 string or false otherwise
  100076. */
  100077. static IsBase64(uri: string): boolean;
  100078. /**
  100079. * Decode the given base64 uri.
  100080. * @param uri The uri to decode
  100081. * @return The decoded base64 data.
  100082. */
  100083. static DecodeBase64(uri: string): ArrayBuffer;
  100084. /**
  100085. * Gets the absolute url.
  100086. * @param url the input url
  100087. * @return the absolute url
  100088. */
  100089. static GetAbsoluteUrl(url: string): string;
  100090. /**
  100091. * No log
  100092. */
  100093. static readonly NoneLogLevel: number;
  100094. /**
  100095. * Only message logs
  100096. */
  100097. static readonly MessageLogLevel: number;
  100098. /**
  100099. * Only warning logs
  100100. */
  100101. static readonly WarningLogLevel: number;
  100102. /**
  100103. * Only error logs
  100104. */
  100105. static readonly ErrorLogLevel: number;
  100106. /**
  100107. * All logs
  100108. */
  100109. static readonly AllLogLevel: number;
  100110. /**
  100111. * Gets a value indicating the number of loading errors
  100112. * @ignorenaming
  100113. */
  100114. static readonly errorsCount: number;
  100115. /**
  100116. * Callback called when a new log is added
  100117. */
  100118. static OnNewCacheEntry: (entry: string) => void;
  100119. /**
  100120. * Log a message to the console
  100121. * @param message defines the message to log
  100122. */
  100123. static Log(message: string): void;
  100124. /**
  100125. * Write a warning message to the console
  100126. * @param message defines the message to log
  100127. */
  100128. static Warn(message: string): void;
  100129. /**
  100130. * Write an error message to the console
  100131. * @param message defines the message to log
  100132. */
  100133. static Error(message: string): void;
  100134. /**
  100135. * Gets current log cache (list of logs)
  100136. */
  100137. static readonly LogCache: string;
  100138. /**
  100139. * Clears the log cache
  100140. */
  100141. static ClearLogCache(): void;
  100142. /**
  100143. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  100144. */
  100145. static LogLevels: number;
  100146. /**
  100147. * Checks if the window object exists
  100148. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  100149. */
  100150. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  100151. /**
  100152. * No performance log
  100153. */
  100154. static readonly PerformanceNoneLogLevel: number;
  100155. /**
  100156. * Use user marks to log performance
  100157. */
  100158. static readonly PerformanceUserMarkLogLevel: number;
  100159. /**
  100160. * Log performance to the console
  100161. */
  100162. static readonly PerformanceConsoleLogLevel: number;
  100163. private static _performance;
  100164. /**
  100165. * Sets the current performance log level
  100166. */
  100167. static PerformanceLogLevel: number;
  100168. private static _StartPerformanceCounterDisabled;
  100169. private static _EndPerformanceCounterDisabled;
  100170. private static _StartUserMark;
  100171. private static _EndUserMark;
  100172. private static _StartPerformanceConsole;
  100173. private static _EndPerformanceConsole;
  100174. /**
  100175. * Starts a performance counter
  100176. */
  100177. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  100178. /**
  100179. * Ends a specific performance coutner
  100180. */
  100181. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  100182. /**
  100183. * Gets either window.performance.now() if supported or Date.now() else
  100184. */
  100185. static readonly Now: number;
  100186. /**
  100187. * This method will return the name of the class used to create the instance of the given object.
  100188. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  100189. * @param object the object to get the class name from
  100190. * @param isType defines if the object is actually a type
  100191. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  100192. */
  100193. static GetClassName(object: any, isType?: boolean): string;
  100194. /**
  100195. * Gets the first element of an array satisfying a given predicate
  100196. * @param array defines the array to browse
  100197. * @param predicate defines the predicate to use
  100198. * @returns null if not found or the element
  100199. */
  100200. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  100201. /**
  100202. * This method will return the name of the full name of the class, including its owning module (if any).
  100203. * 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).
  100204. * @param object the object to get the class name from
  100205. * @param isType defines if the object is actually a type
  100206. * @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.
  100207. * @ignorenaming
  100208. */
  100209. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  100210. /**
  100211. * Returns a promise that resolves after the given amount of time.
  100212. * @param delay Number of milliseconds to delay
  100213. * @returns Promise that resolves after the given amount of time
  100214. */
  100215. static DelayAsync(delay: number): Promise<void>;
  100216. }
  100217. /**
  100218. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  100219. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  100220. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  100221. * @param name The name of the class, case should be preserved
  100222. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  100223. */
  100224. export function className(name: string, module?: string): (target: Object) => void;
  100225. /**
  100226. * An implementation of a loop for asynchronous functions.
  100227. */
  100228. export class AsyncLoop {
  100229. /**
  100230. * Defines the number of iterations for the loop
  100231. */
  100232. iterations: number;
  100233. /**
  100234. * Defines the current index of the loop.
  100235. */
  100236. index: number;
  100237. private _done;
  100238. private _fn;
  100239. private _successCallback;
  100240. /**
  100241. * Constructor.
  100242. * @param iterations the number of iterations.
  100243. * @param func the function to run each iteration
  100244. * @param successCallback the callback that will be called upon succesful execution
  100245. * @param offset starting offset.
  100246. */
  100247. constructor(
  100248. /**
  100249. * Defines the number of iterations for the loop
  100250. */
  100251. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  100252. /**
  100253. * Execute the next iteration. Must be called after the last iteration was finished.
  100254. */
  100255. executeNext(): void;
  100256. /**
  100257. * Break the loop and run the success callback.
  100258. */
  100259. breakLoop(): void;
  100260. /**
  100261. * Create and run an async loop.
  100262. * @param iterations the number of iterations.
  100263. * @param fn the function to run each iteration
  100264. * @param successCallback the callback that will be called upon succesful execution
  100265. * @param offset starting offset.
  100266. * @returns the created async loop object
  100267. */
  100268. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  100269. /**
  100270. * A for-loop that will run a given number of iterations synchronous and the rest async.
  100271. * @param iterations total number of iterations
  100272. * @param syncedIterations number of synchronous iterations in each async iteration.
  100273. * @param fn the function to call each iteration.
  100274. * @param callback a success call back that will be called when iterating stops.
  100275. * @param breakFunction a break condition (optional)
  100276. * @param timeout timeout settings for the setTimeout function. default - 0.
  100277. * @returns the created async loop object
  100278. */
  100279. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  100280. }
  100281. }
  100282. declare module BABYLON {
  100283. /**
  100284. * This class implement a typical dictionary using a string as key and the generic type T as value.
  100285. * The underlying implementation relies on an associative array to ensure the best performances.
  100286. * The value can be anything including 'null' but except 'undefined'
  100287. */
  100288. export class StringDictionary<T> {
  100289. /**
  100290. * This will clear this dictionary and copy the content from the 'source' one.
  100291. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  100292. * @param source the dictionary to take the content from and copy to this dictionary
  100293. */
  100294. copyFrom(source: StringDictionary<T>): void;
  100295. /**
  100296. * Get a value based from its key
  100297. * @param key the given key to get the matching value from
  100298. * @return the value if found, otherwise undefined is returned
  100299. */
  100300. get(key: string): T | undefined;
  100301. /**
  100302. * Get a value from its key or add it if it doesn't exist.
  100303. * This method will ensure you that a given key/data will be present in the dictionary.
  100304. * @param key the given key to get the matching value from
  100305. * @param factory the factory that will create the value if the key is not present in the dictionary.
  100306. * The factory will only be invoked if there's no data for the given key.
  100307. * @return the value corresponding to the key.
  100308. */
  100309. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  100310. /**
  100311. * Get a value from its key if present in the dictionary otherwise add it
  100312. * @param key the key to get the value from
  100313. * @param val if there's no such key/value pair in the dictionary add it with this value
  100314. * @return the value corresponding to the key
  100315. */
  100316. getOrAdd(key: string, val: T): T;
  100317. /**
  100318. * Check if there's a given key in the dictionary
  100319. * @param key the key to check for
  100320. * @return true if the key is present, false otherwise
  100321. */
  100322. contains(key: string): boolean;
  100323. /**
  100324. * Add a new key and its corresponding value
  100325. * @param key the key to add
  100326. * @param value the value corresponding to the key
  100327. * @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
  100328. */
  100329. add(key: string, value: T): boolean;
  100330. /**
  100331. * Update a specific value associated to a key
  100332. * @param key defines the key to use
  100333. * @param value defines the value to store
  100334. * @returns true if the value was updated (or false if the key was not found)
  100335. */
  100336. set(key: string, value: T): boolean;
  100337. /**
  100338. * Get the element of the given key and remove it from the dictionary
  100339. * @param key defines the key to search
  100340. * @returns the value associated with the key or null if not found
  100341. */
  100342. getAndRemove(key: string): Nullable<T>;
  100343. /**
  100344. * Remove a key/value from the dictionary.
  100345. * @param key the key to remove
  100346. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  100347. */
  100348. remove(key: string): boolean;
  100349. /**
  100350. * Clear the whole content of the dictionary
  100351. */
  100352. clear(): void;
  100353. /**
  100354. * Gets the current count
  100355. */
  100356. readonly count: number;
  100357. /**
  100358. * Execute a callback on each key/val of the dictionary.
  100359. * Note that you can remove any element in this dictionary in the callback implementation
  100360. * @param callback the callback to execute on a given key/value pair
  100361. */
  100362. forEach(callback: (key: string, val: T) => void): void;
  100363. /**
  100364. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  100365. * If the callback returns null or undefined the method will iterate to the next key/value pair
  100366. * Note that you can remove any element in this dictionary in the callback implementation
  100367. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  100368. * @returns the first item
  100369. */
  100370. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  100371. private _count;
  100372. private _data;
  100373. }
  100374. }
  100375. declare module BABYLON {
  100376. /** @hidden */
  100377. export interface ICollisionCoordinator {
  100378. createCollider(): Collider;
  100379. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  100380. init(scene: Scene): void;
  100381. }
  100382. /** @hidden */
  100383. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  100384. private _scene;
  100385. private _scaledPosition;
  100386. private _scaledVelocity;
  100387. private _finalPosition;
  100388. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  100389. createCollider(): Collider;
  100390. init(scene: Scene): void;
  100391. private _collideWithWorld;
  100392. }
  100393. }
  100394. declare module BABYLON {
  100395. /**
  100396. * Class used to manage all inputs for the scene.
  100397. */
  100398. export class InputManager {
  100399. /** The distance in pixel that you have to move to prevent some events */
  100400. static DragMovementThreshold: number;
  100401. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  100402. static LongPressDelay: number;
  100403. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  100404. static DoubleClickDelay: number;
  100405. /** If you need to check double click without raising a single click at first click, enable this flag */
  100406. static ExclusiveDoubleClickMode: boolean;
  100407. private _wheelEventName;
  100408. private _onPointerMove;
  100409. private _onPointerDown;
  100410. private _onPointerUp;
  100411. private _initClickEvent;
  100412. private _initActionManager;
  100413. private _delayedSimpleClick;
  100414. private _delayedSimpleClickTimeout;
  100415. private _previousDelayedSimpleClickTimeout;
  100416. private _meshPickProceed;
  100417. private _previousButtonPressed;
  100418. private _currentPickResult;
  100419. private _previousPickResult;
  100420. private _totalPointersPressed;
  100421. private _doubleClickOccured;
  100422. private _pointerOverMesh;
  100423. private _pickedDownMesh;
  100424. private _pickedUpMesh;
  100425. private _pointerX;
  100426. private _pointerY;
  100427. private _unTranslatedPointerX;
  100428. private _unTranslatedPointerY;
  100429. private _startingPointerPosition;
  100430. private _previousStartingPointerPosition;
  100431. private _startingPointerTime;
  100432. private _previousStartingPointerTime;
  100433. private _pointerCaptures;
  100434. private _onKeyDown;
  100435. private _onKeyUp;
  100436. private _onCanvasFocusObserver;
  100437. private _onCanvasBlurObserver;
  100438. private _scene;
  100439. /**
  100440. * Creates a new InputManager
  100441. * @param scene defines the hosting scene
  100442. */
  100443. constructor(scene: Scene);
  100444. /**
  100445. * Gets the mesh that is currently under the pointer
  100446. */
  100447. readonly meshUnderPointer: Nullable<AbstractMesh>;
  100448. /**
  100449. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  100450. */
  100451. readonly unTranslatedPointer: Vector2;
  100452. /**
  100453. * Gets or sets the current on-screen X position of the pointer
  100454. */
  100455. pointerX: number;
  100456. /**
  100457. * Gets or sets the current on-screen Y position of the pointer
  100458. */
  100459. pointerY: number;
  100460. private _updatePointerPosition;
  100461. private _processPointerMove;
  100462. private _setRayOnPointerInfo;
  100463. private _checkPrePointerObservable;
  100464. /**
  100465. * Use this method to simulate a pointer move on a mesh
  100466. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  100467. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  100468. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  100469. */
  100470. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  100471. /**
  100472. * Use this method to simulate a pointer down on a mesh
  100473. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  100474. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  100475. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  100476. */
  100477. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  100478. private _processPointerDown;
  100479. /** @hidden */
  100480. _isPointerSwiping(): boolean;
  100481. /**
  100482. * Use this method to simulate a pointer up on a mesh
  100483. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  100484. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  100485. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  100486. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  100487. */
  100488. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  100489. private _processPointerUp;
  100490. /**
  100491. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  100492. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  100493. * @returns true if the pointer was captured
  100494. */
  100495. isPointerCaptured(pointerId?: number): boolean;
  100496. /**
  100497. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  100498. * @param attachUp defines if you want to attach events to pointerup
  100499. * @param attachDown defines if you want to attach events to pointerdown
  100500. * @param attachMove defines if you want to attach events to pointermove
  100501. */
  100502. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  100503. /**
  100504. * Detaches all event handlers
  100505. */
  100506. detachControl(): void;
  100507. /**
  100508. * Force the value of meshUnderPointer
  100509. * @param mesh defines the mesh to use
  100510. */
  100511. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  100512. /**
  100513. * Gets the mesh under the pointer
  100514. * @returns a Mesh or null if no mesh is under the pointer
  100515. */
  100516. getPointerOverMesh(): Nullable<AbstractMesh>;
  100517. }
  100518. }
  100519. declare module BABYLON {
  100520. /**
  100521. * Helper class used to generate session unique ID
  100522. */
  100523. export class UniqueIdGenerator {
  100524. private static _UniqueIdCounter;
  100525. /**
  100526. * Gets an unique (relatively to the current scene) Id
  100527. */
  100528. static readonly UniqueId: number;
  100529. }
  100530. }
  100531. declare module BABYLON {
  100532. /**
  100533. * This class defines the direct association between an animation and a target
  100534. */
  100535. export class TargetedAnimation {
  100536. /**
  100537. * Animation to perform
  100538. */
  100539. animation: Animation;
  100540. /**
  100541. * Target to animate
  100542. */
  100543. target: any;
  100544. /**
  100545. * Serialize the object
  100546. * @returns the JSON object representing the current entity
  100547. */
  100548. serialize(): any;
  100549. }
  100550. /**
  100551. * Use this class to create coordinated animations on multiple targets
  100552. */
  100553. export class AnimationGroup implements IDisposable {
  100554. /** The name of the animation group */
  100555. name: string;
  100556. private _scene;
  100557. private _targetedAnimations;
  100558. private _animatables;
  100559. private _from;
  100560. private _to;
  100561. private _isStarted;
  100562. private _isPaused;
  100563. private _speedRatio;
  100564. private _loopAnimation;
  100565. /**
  100566. * Gets or sets the unique id of the node
  100567. */
  100568. uniqueId: number;
  100569. /**
  100570. * This observable will notify when one animation have ended
  100571. */
  100572. onAnimationEndObservable: Observable<TargetedAnimation>;
  100573. /**
  100574. * Observer raised when one animation loops
  100575. */
  100576. onAnimationLoopObservable: Observable<TargetedAnimation>;
  100577. /**
  100578. * Observer raised when all animations have looped
  100579. */
  100580. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  100581. /**
  100582. * This observable will notify when all animations have ended.
  100583. */
  100584. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  100585. /**
  100586. * This observable will notify when all animations have paused.
  100587. */
  100588. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  100589. /**
  100590. * This observable will notify when all animations are playing.
  100591. */
  100592. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  100593. /**
  100594. * Gets the first frame
  100595. */
  100596. readonly from: number;
  100597. /**
  100598. * Gets the last frame
  100599. */
  100600. readonly to: number;
  100601. /**
  100602. * Define if the animations are started
  100603. */
  100604. readonly isStarted: boolean;
  100605. /**
  100606. * Gets a value indicating that the current group is playing
  100607. */
  100608. readonly isPlaying: boolean;
  100609. /**
  100610. * Gets or sets the speed ratio to use for all animations
  100611. */
  100612. /**
  100613. * Gets or sets the speed ratio to use for all animations
  100614. */
  100615. speedRatio: number;
  100616. /**
  100617. * Gets or sets if all animations should loop or not
  100618. */
  100619. loopAnimation: boolean;
  100620. /**
  100621. * Gets the targeted animations for this animation group
  100622. */
  100623. readonly targetedAnimations: Array<TargetedAnimation>;
  100624. /**
  100625. * returning the list of animatables controlled by this animation group.
  100626. */
  100627. readonly animatables: Array<Animatable>;
  100628. /**
  100629. * Instantiates a new Animation Group.
  100630. * This helps managing several animations at once.
  100631. * @see http://doc.babylonjs.com/how_to/group
  100632. * @param name Defines the name of the group
  100633. * @param scene Defines the scene the group belongs to
  100634. */
  100635. constructor(
  100636. /** The name of the animation group */
  100637. name: string, scene?: Nullable<Scene>);
  100638. /**
  100639. * Add an animation (with its target) in the group
  100640. * @param animation defines the animation we want to add
  100641. * @param target defines the target of the animation
  100642. * @returns the TargetedAnimation object
  100643. */
  100644. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  100645. /**
  100646. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  100647. * It can add constant keys at begin or end
  100648. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  100649. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  100650. * @returns the animation group
  100651. */
  100652. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  100653. private _animationLoopCount;
  100654. private _animationLoopFlags;
  100655. private _processLoop;
  100656. /**
  100657. * Start all animations on given targets
  100658. * @param loop defines if animations must loop
  100659. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  100660. * @param from defines the from key (optional)
  100661. * @param to defines the to key (optional)
  100662. * @returns the current animation group
  100663. */
  100664. start(loop?: boolean, speedRatio?: number, from?: number, to?: number): AnimationGroup;
  100665. /**
  100666. * Pause all animations
  100667. * @returns the animation group
  100668. */
  100669. pause(): AnimationGroup;
  100670. /**
  100671. * Play all animations to initial state
  100672. * This function will start() the animations if they were not started or will restart() them if they were paused
  100673. * @param loop defines if animations must loop
  100674. * @returns the animation group
  100675. */
  100676. play(loop?: boolean): AnimationGroup;
  100677. /**
  100678. * Reset all animations to initial state
  100679. * @returns the animation group
  100680. */
  100681. reset(): AnimationGroup;
  100682. /**
  100683. * Restart animations from key 0
  100684. * @returns the animation group
  100685. */
  100686. restart(): AnimationGroup;
  100687. /**
  100688. * Stop all animations
  100689. * @returns the animation group
  100690. */
  100691. stop(): AnimationGroup;
  100692. /**
  100693. * Set animation weight for all animatables
  100694. * @param weight defines the weight to use
  100695. * @return the animationGroup
  100696. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  100697. */
  100698. setWeightForAllAnimatables(weight: number): AnimationGroup;
  100699. /**
  100700. * Synchronize and normalize all animatables with a source animatable
  100701. * @param root defines the root animatable to synchronize with
  100702. * @return the animationGroup
  100703. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  100704. */
  100705. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  100706. /**
  100707. * Goes to a specific frame in this animation group
  100708. * @param frame the frame number to go to
  100709. * @return the animationGroup
  100710. */
  100711. goToFrame(frame: number): AnimationGroup;
  100712. /**
  100713. * Dispose all associated resources
  100714. */
  100715. dispose(): void;
  100716. private _checkAnimationGroupEnded;
  100717. /**
  100718. * Clone the current animation group and returns a copy
  100719. * @param newName defines the name of the new group
  100720. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  100721. * @returns the new aniamtion group
  100722. */
  100723. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  100724. /**
  100725. * Serializes the animationGroup to an object
  100726. * @returns Serialized object
  100727. */
  100728. serialize(): any;
  100729. /**
  100730. * Returns a new AnimationGroup object parsed from the source provided.
  100731. * @param parsedAnimationGroup defines the source
  100732. * @param scene defines the scene that will receive the animationGroup
  100733. * @returns a new AnimationGroup
  100734. */
  100735. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  100736. /**
  100737. * Returns the string "AnimationGroup"
  100738. * @returns "AnimationGroup"
  100739. */
  100740. getClassName(): string;
  100741. /**
  100742. * Creates a detailled string about the object
  100743. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  100744. * @returns a string representing the object
  100745. */
  100746. toString(fullDetails?: boolean): string;
  100747. }
  100748. }
  100749. declare module BABYLON {
  100750. /**
  100751. * Define an interface for all classes that will hold resources
  100752. */
  100753. export interface IDisposable {
  100754. /**
  100755. * Releases all held resources
  100756. */
  100757. dispose(): void;
  100758. }
  100759. /** Interface defining initialization parameters for Scene class */
  100760. export interface SceneOptions {
  100761. /**
  100762. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  100763. * It will improve performance when the number of geometries becomes important.
  100764. */
  100765. useGeometryUniqueIdsMap?: boolean;
  100766. /**
  100767. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  100768. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  100769. */
  100770. useMaterialMeshMap?: boolean;
  100771. /**
  100772. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  100773. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  100774. */
  100775. useClonedMeshhMap?: boolean;
  100776. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  100777. virtual?: boolean;
  100778. }
  100779. /**
  100780. * Represents a scene to be rendered by the engine.
  100781. * @see http://doc.babylonjs.com/features/scene
  100782. */
  100783. export class Scene extends AbstractScene implements IAnimatable {
  100784. /** The fog is deactivated */
  100785. static readonly FOGMODE_NONE: number;
  100786. /** The fog density is following an exponential function */
  100787. static readonly FOGMODE_EXP: number;
  100788. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  100789. static readonly FOGMODE_EXP2: number;
  100790. /** The fog density is following a linear function. */
  100791. static readonly FOGMODE_LINEAR: number;
  100792. /**
  100793. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  100794. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  100795. */
  100796. static MinDeltaTime: number;
  100797. /**
  100798. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  100799. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  100800. */
  100801. static MaxDeltaTime: number;
  100802. /**
  100803. * Factory used to create the default material.
  100804. * @param name The name of the material to create
  100805. * @param scene The scene to create the material for
  100806. * @returns The default material
  100807. */
  100808. static DefaultMaterialFactory(scene: Scene): Material;
  100809. /**
  100810. * Factory used to create the a collision coordinator.
  100811. * @returns The collision coordinator
  100812. */
  100813. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  100814. /** @hidden */
  100815. _inputManager: InputManager;
  100816. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  100817. cameraToUseForPointers: Nullable<Camera>;
  100818. /** @hidden */
  100819. readonly _isScene: boolean;
  100820. /**
  100821. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  100822. */
  100823. autoClear: boolean;
  100824. /**
  100825. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  100826. */
  100827. autoClearDepthAndStencil: boolean;
  100828. /**
  100829. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  100830. */
  100831. clearColor: Color4;
  100832. /**
  100833. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  100834. */
  100835. ambientColor: Color3;
  100836. /**
  100837. * This is use to store the default BRDF lookup for PBR materials in your scene.
  100838. * It should only be one of the following (if not the default embedded one):
  100839. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  100840. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  100841. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  100842. * The material properties need to be setup according to the type of texture in use.
  100843. */
  100844. environmentBRDFTexture: BaseTexture;
  100845. /** @hidden */
  100846. protected _environmentTexture: Nullable<BaseTexture>;
  100847. /**
  100848. * Texture used in all pbr material as the reflection texture.
  100849. * As in the majority of the scene they are the same (exception for multi room and so on),
  100850. * this is easier to reference from here than from all the materials.
  100851. */
  100852. /**
  100853. * Texture used in all pbr material as the reflection texture.
  100854. * As in the majority of the scene they are the same (exception for multi room and so on),
  100855. * this is easier to set here than in all the materials.
  100856. */
  100857. environmentTexture: Nullable<BaseTexture>;
  100858. /** @hidden */
  100859. protected _environmentIntensity: number;
  100860. /**
  100861. * Intensity of the environment in all pbr material.
  100862. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  100863. * As in the majority of the scene they are the same (exception for multi room and so on),
  100864. * this is easier to reference from here than from all the materials.
  100865. */
  100866. /**
  100867. * Intensity of the environment in all pbr material.
  100868. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  100869. * As in the majority of the scene they are the same (exception for multi room and so on),
  100870. * this is easier to set here than in all the materials.
  100871. */
  100872. environmentIntensity: number;
  100873. /** @hidden */
  100874. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  100875. /**
  100876. * Default image processing configuration used either in the rendering
  100877. * Forward main pass or through the imageProcessingPostProcess if present.
  100878. * As in the majority of the scene they are the same (exception for multi camera),
  100879. * this is easier to reference from here than from all the materials and post process.
  100880. *
  100881. * No setter as we it is a shared configuration, you can set the values instead.
  100882. */
  100883. readonly imageProcessingConfiguration: ImageProcessingConfiguration;
  100884. private _forceWireframe;
  100885. /**
  100886. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  100887. */
  100888. forceWireframe: boolean;
  100889. private _forcePointsCloud;
  100890. /**
  100891. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  100892. */
  100893. forcePointsCloud: boolean;
  100894. /**
  100895. * Gets or sets the active clipplane 1
  100896. */
  100897. clipPlane: Nullable<Plane>;
  100898. /**
  100899. * Gets or sets the active clipplane 2
  100900. */
  100901. clipPlane2: Nullable<Plane>;
  100902. /**
  100903. * Gets or sets the active clipplane 3
  100904. */
  100905. clipPlane3: Nullable<Plane>;
  100906. /**
  100907. * Gets or sets the active clipplane 4
  100908. */
  100909. clipPlane4: Nullable<Plane>;
  100910. /**
  100911. * Gets or sets a boolean indicating if animations are enabled
  100912. */
  100913. animationsEnabled: boolean;
  100914. private _animationPropertiesOverride;
  100915. /**
  100916. * Gets or sets the animation properties override
  100917. */
  100918. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  100919. /**
  100920. * Gets or sets a boolean indicating if a constant deltatime has to be used
  100921. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  100922. */
  100923. useConstantAnimationDeltaTime: boolean;
  100924. /**
  100925. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  100926. * Please note that it requires to run a ray cast through the scene on every frame
  100927. */
  100928. constantlyUpdateMeshUnderPointer: boolean;
  100929. /**
  100930. * Defines the HTML cursor to use when hovering over interactive elements
  100931. */
  100932. hoverCursor: string;
  100933. /**
  100934. * Defines the HTML default cursor to use (empty by default)
  100935. */
  100936. defaultCursor: string;
  100937. /**
  100938. * Defines wether cursors are handled by the scene.
  100939. */
  100940. doNotHandleCursors: boolean;
  100941. /**
  100942. * This is used to call preventDefault() on pointer down
  100943. * in order to block unwanted artifacts like system double clicks
  100944. */
  100945. preventDefaultOnPointerDown: boolean;
  100946. /**
  100947. * This is used to call preventDefault() on pointer up
  100948. * in order to block unwanted artifacts like system double clicks
  100949. */
  100950. preventDefaultOnPointerUp: boolean;
  100951. /**
  100952. * Gets or sets user defined metadata
  100953. */
  100954. metadata: any;
  100955. /**
  100956. * For internal use only. Please do not use.
  100957. */
  100958. reservedDataStore: any;
  100959. /**
  100960. * Gets the name of the plugin used to load this scene (null by default)
  100961. */
  100962. loadingPluginName: string;
  100963. /**
  100964. * Use this array to add regular expressions used to disable offline support for specific urls
  100965. */
  100966. disableOfflineSupportExceptionRules: RegExp[];
  100967. /**
  100968. * An event triggered when the scene is disposed.
  100969. */
  100970. onDisposeObservable: Observable<Scene>;
  100971. private _onDisposeObserver;
  100972. /** Sets a function to be executed when this scene is disposed. */
  100973. onDispose: () => void;
  100974. /**
  100975. * An event triggered before rendering the scene (right after animations and physics)
  100976. */
  100977. onBeforeRenderObservable: Observable<Scene>;
  100978. private _onBeforeRenderObserver;
  100979. /** Sets a function to be executed before rendering this scene */
  100980. beforeRender: Nullable<() => void>;
  100981. /**
  100982. * An event triggered after rendering the scene
  100983. */
  100984. onAfterRenderObservable: Observable<Scene>;
  100985. /**
  100986. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  100987. */
  100988. onAfterRenderCameraObservable: Observable<Camera>;
  100989. private _onAfterRenderObserver;
  100990. /** Sets a function to be executed after rendering this scene */
  100991. afterRender: Nullable<() => void>;
  100992. /**
  100993. * An event triggered before animating the scene
  100994. */
  100995. onBeforeAnimationsObservable: Observable<Scene>;
  100996. /**
  100997. * An event triggered after animations processing
  100998. */
  100999. onAfterAnimationsObservable: Observable<Scene>;
  101000. /**
  101001. * An event triggered before draw calls are ready to be sent
  101002. */
  101003. onBeforeDrawPhaseObservable: Observable<Scene>;
  101004. /**
  101005. * An event triggered after draw calls have been sent
  101006. */
  101007. onAfterDrawPhaseObservable: Observable<Scene>;
  101008. /**
  101009. * An event triggered when the scene is ready
  101010. */
  101011. onReadyObservable: Observable<Scene>;
  101012. /**
  101013. * An event triggered before rendering a camera
  101014. */
  101015. onBeforeCameraRenderObservable: Observable<Camera>;
  101016. private _onBeforeCameraRenderObserver;
  101017. /** Sets a function to be executed before rendering a camera*/
  101018. beforeCameraRender: () => void;
  101019. /**
  101020. * An event triggered after rendering a camera
  101021. */
  101022. onAfterCameraRenderObservable: Observable<Camera>;
  101023. private _onAfterCameraRenderObserver;
  101024. /** Sets a function to be executed after rendering a camera*/
  101025. afterCameraRender: () => void;
  101026. /**
  101027. * An event triggered when active meshes evaluation is about to start
  101028. */
  101029. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  101030. /**
  101031. * An event triggered when active meshes evaluation is done
  101032. */
  101033. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  101034. /**
  101035. * An event triggered when particles rendering is about to start
  101036. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  101037. */
  101038. onBeforeParticlesRenderingObservable: Observable<Scene>;
  101039. /**
  101040. * An event triggered when particles rendering is done
  101041. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  101042. */
  101043. onAfterParticlesRenderingObservable: Observable<Scene>;
  101044. /**
  101045. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  101046. */
  101047. onDataLoadedObservable: Observable<Scene>;
  101048. /**
  101049. * An event triggered when a camera is created
  101050. */
  101051. onNewCameraAddedObservable: Observable<Camera>;
  101052. /**
  101053. * An event triggered when a camera is removed
  101054. */
  101055. onCameraRemovedObservable: Observable<Camera>;
  101056. /**
  101057. * An event triggered when a light is created
  101058. */
  101059. onNewLightAddedObservable: Observable<Light>;
  101060. /**
  101061. * An event triggered when a light is removed
  101062. */
  101063. onLightRemovedObservable: Observable<Light>;
  101064. /**
  101065. * An event triggered when a geometry is created
  101066. */
  101067. onNewGeometryAddedObservable: Observable<Geometry>;
  101068. /**
  101069. * An event triggered when a geometry is removed
  101070. */
  101071. onGeometryRemovedObservable: Observable<Geometry>;
  101072. /**
  101073. * An event triggered when a transform node is created
  101074. */
  101075. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  101076. /**
  101077. * An event triggered when a transform node is removed
  101078. */
  101079. onTransformNodeRemovedObservable: Observable<TransformNode>;
  101080. /**
  101081. * An event triggered when a mesh is created
  101082. */
  101083. onNewMeshAddedObservable: Observable<AbstractMesh>;
  101084. /**
  101085. * An event triggered when a mesh is removed
  101086. */
  101087. onMeshRemovedObservable: Observable<AbstractMesh>;
  101088. /**
  101089. * An event triggered when a skeleton is created
  101090. */
  101091. onNewSkeletonAddedObservable: Observable<Skeleton>;
  101092. /**
  101093. * An event triggered when a skeleton is removed
  101094. */
  101095. onSkeletonRemovedObservable: Observable<Skeleton>;
  101096. /**
  101097. * An event triggered when a material is created
  101098. */
  101099. onNewMaterialAddedObservable: Observable<Material>;
  101100. /**
  101101. * An event triggered when a material is removed
  101102. */
  101103. onMaterialRemovedObservable: Observable<Material>;
  101104. /**
  101105. * An event triggered when a texture is created
  101106. */
  101107. onNewTextureAddedObservable: Observable<BaseTexture>;
  101108. /**
  101109. * An event triggered when a texture is removed
  101110. */
  101111. onTextureRemovedObservable: Observable<BaseTexture>;
  101112. /**
  101113. * An event triggered when render targets are about to be rendered
  101114. * Can happen multiple times per frame.
  101115. */
  101116. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  101117. /**
  101118. * An event triggered when render targets were rendered.
  101119. * Can happen multiple times per frame.
  101120. */
  101121. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  101122. /**
  101123. * An event triggered before calculating deterministic simulation step
  101124. */
  101125. onBeforeStepObservable: Observable<Scene>;
  101126. /**
  101127. * An event triggered after calculating deterministic simulation step
  101128. */
  101129. onAfterStepObservable: Observable<Scene>;
  101130. /**
  101131. * An event triggered when the activeCamera property is updated
  101132. */
  101133. onActiveCameraChanged: Observable<Scene>;
  101134. /**
  101135. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  101136. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  101137. * 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)
  101138. */
  101139. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  101140. /**
  101141. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  101142. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  101143. * 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)
  101144. */
  101145. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  101146. /**
  101147. * This Observable will when a mesh has been imported into the scene.
  101148. */
  101149. onMeshImportedObservable: Observable<AbstractMesh>;
  101150. /**
  101151. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  101152. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  101153. */
  101154. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  101155. /** @hidden */
  101156. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  101157. /**
  101158. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  101159. */
  101160. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  101161. /**
  101162. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  101163. */
  101164. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  101165. /**
  101166. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  101167. */
  101168. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  101169. /** Callback called when a pointer move is detected */
  101170. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  101171. /** Callback called when a pointer down is detected */
  101172. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  101173. /** Callback called when a pointer up is detected */
  101174. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  101175. /** Callback called when a pointer pick is detected */
  101176. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  101177. /**
  101178. * 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).
  101179. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  101180. */
  101181. onPrePointerObservable: Observable<PointerInfoPre>;
  101182. /**
  101183. * Observable event triggered each time an input event is received from the rendering canvas
  101184. */
  101185. onPointerObservable: Observable<PointerInfo>;
  101186. /**
  101187. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  101188. */
  101189. readonly unTranslatedPointer: Vector2;
  101190. /**
  101191. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  101192. */
  101193. static DragMovementThreshold: number;
  101194. /**
  101195. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  101196. */
  101197. static LongPressDelay: number;
  101198. /**
  101199. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  101200. */
  101201. static DoubleClickDelay: number;
  101202. /** If you need to check double click without raising a single click at first click, enable this flag */
  101203. static ExclusiveDoubleClickMode: boolean;
  101204. /** @hidden */
  101205. _mirroredCameraPosition: Nullable<Vector3>;
  101206. /**
  101207. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  101208. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  101209. */
  101210. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  101211. /**
  101212. * Observable event triggered each time an keyboard event is received from the hosting window
  101213. */
  101214. onKeyboardObservable: Observable<KeyboardInfo>;
  101215. private _useRightHandedSystem;
  101216. /**
  101217. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  101218. */
  101219. useRightHandedSystem: boolean;
  101220. private _timeAccumulator;
  101221. private _currentStepId;
  101222. private _currentInternalStep;
  101223. /**
  101224. * Sets the step Id used by deterministic lock step
  101225. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101226. * @param newStepId defines the step Id
  101227. */
  101228. setStepId(newStepId: number): void;
  101229. /**
  101230. * Gets the step Id used by deterministic lock step
  101231. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101232. * @returns the step Id
  101233. */
  101234. getStepId(): number;
  101235. /**
  101236. * Gets the internal step used by deterministic lock step
  101237. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101238. * @returns the internal step
  101239. */
  101240. getInternalStep(): number;
  101241. private _fogEnabled;
  101242. /**
  101243. * Gets or sets a boolean indicating if fog is enabled on this scene
  101244. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101245. * (Default is true)
  101246. */
  101247. fogEnabled: boolean;
  101248. private _fogMode;
  101249. /**
  101250. * Gets or sets the fog mode to use
  101251. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101252. * | mode | value |
  101253. * | --- | --- |
  101254. * | FOGMODE_NONE | 0 |
  101255. * | FOGMODE_EXP | 1 |
  101256. * | FOGMODE_EXP2 | 2 |
  101257. * | FOGMODE_LINEAR | 3 |
  101258. */
  101259. fogMode: number;
  101260. /**
  101261. * Gets or sets the fog color to use
  101262. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101263. * (Default is Color3(0.2, 0.2, 0.3))
  101264. */
  101265. fogColor: Color3;
  101266. /**
  101267. * Gets or sets the fog density to use
  101268. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101269. * (Default is 0.1)
  101270. */
  101271. fogDensity: number;
  101272. /**
  101273. * Gets or sets the fog start distance to use
  101274. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101275. * (Default is 0)
  101276. */
  101277. fogStart: number;
  101278. /**
  101279. * Gets or sets the fog end distance to use
  101280. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101281. * (Default is 1000)
  101282. */
  101283. fogEnd: number;
  101284. private _shadowsEnabled;
  101285. /**
  101286. * Gets or sets a boolean indicating if shadows are enabled on this scene
  101287. */
  101288. shadowsEnabled: boolean;
  101289. private _lightsEnabled;
  101290. /**
  101291. * Gets or sets a boolean indicating if lights are enabled on this scene
  101292. */
  101293. lightsEnabled: boolean;
  101294. /** All of the active cameras added to this scene. */
  101295. activeCameras: Camera[];
  101296. /** @hidden */
  101297. _activeCamera: Nullable<Camera>;
  101298. /** Gets or sets the current active camera */
  101299. activeCamera: Nullable<Camera>;
  101300. private _defaultMaterial;
  101301. /** The default material used on meshes when no material is affected */
  101302. /** The default material used on meshes when no material is affected */
  101303. defaultMaterial: Material;
  101304. private _texturesEnabled;
  101305. /**
  101306. * Gets or sets a boolean indicating if textures are enabled on this scene
  101307. */
  101308. texturesEnabled: boolean;
  101309. /**
  101310. * Gets or sets a boolean indicating if particles are enabled on this scene
  101311. */
  101312. particlesEnabled: boolean;
  101313. /**
  101314. * Gets or sets a boolean indicating if sprites are enabled on this scene
  101315. */
  101316. spritesEnabled: boolean;
  101317. private _skeletonsEnabled;
  101318. /**
  101319. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  101320. */
  101321. skeletonsEnabled: boolean;
  101322. /**
  101323. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  101324. */
  101325. lensFlaresEnabled: boolean;
  101326. /**
  101327. * Gets or sets a boolean indicating if collisions are enabled on this scene
  101328. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  101329. */
  101330. collisionsEnabled: boolean;
  101331. private _collisionCoordinator;
  101332. /** @hidden */
  101333. readonly collisionCoordinator: ICollisionCoordinator;
  101334. /**
  101335. * Defines the gravity applied to this scene (used only for collisions)
  101336. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  101337. */
  101338. gravity: Vector3;
  101339. /**
  101340. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  101341. */
  101342. postProcessesEnabled: boolean;
  101343. /**
  101344. * The list of postprocesses added to the scene
  101345. */
  101346. postProcesses: PostProcess[];
  101347. /**
  101348. * Gets the current postprocess manager
  101349. */
  101350. postProcessManager: PostProcessManager;
  101351. /**
  101352. * Gets or sets a boolean indicating if render targets are enabled on this scene
  101353. */
  101354. renderTargetsEnabled: boolean;
  101355. /**
  101356. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  101357. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  101358. */
  101359. dumpNextRenderTargets: boolean;
  101360. /**
  101361. * The list of user defined render targets added to the scene
  101362. */
  101363. customRenderTargets: RenderTargetTexture[];
  101364. /**
  101365. * Defines if texture loading must be delayed
  101366. * If true, textures will only be loaded when they need to be rendered
  101367. */
  101368. useDelayedTextureLoading: boolean;
  101369. /**
  101370. * Gets the list of meshes imported to the scene through SceneLoader
  101371. */
  101372. importedMeshesFiles: String[];
  101373. /**
  101374. * Gets or sets a boolean indicating if probes are enabled on this scene
  101375. */
  101376. probesEnabled: boolean;
  101377. /**
  101378. * Gets or sets the current offline provider to use to store scene data
  101379. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  101380. */
  101381. offlineProvider: IOfflineProvider;
  101382. /**
  101383. * Gets or sets the action manager associated with the scene
  101384. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  101385. */
  101386. actionManager: AbstractActionManager;
  101387. private _meshesForIntersections;
  101388. /**
  101389. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  101390. */
  101391. proceduralTexturesEnabled: boolean;
  101392. private _engine;
  101393. private _totalVertices;
  101394. /** @hidden */
  101395. _activeIndices: PerfCounter;
  101396. /** @hidden */
  101397. _activeParticles: PerfCounter;
  101398. /** @hidden */
  101399. _activeBones: PerfCounter;
  101400. private _animationRatio;
  101401. /** @hidden */
  101402. _animationTimeLast: number;
  101403. /** @hidden */
  101404. _animationTime: number;
  101405. /**
  101406. * Gets or sets a general scale for animation speed
  101407. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  101408. */
  101409. animationTimeScale: number;
  101410. /** @hidden */
  101411. _cachedMaterial: Nullable<Material>;
  101412. /** @hidden */
  101413. _cachedEffect: Nullable<Effect>;
  101414. /** @hidden */
  101415. _cachedVisibility: Nullable<number>;
  101416. private _renderId;
  101417. private _frameId;
  101418. private _executeWhenReadyTimeoutId;
  101419. private _intermediateRendering;
  101420. private _viewUpdateFlag;
  101421. private _projectionUpdateFlag;
  101422. /** @hidden */
  101423. _toBeDisposed: Nullable<IDisposable>[];
  101424. private _activeRequests;
  101425. /** @hidden */
  101426. _pendingData: any[];
  101427. private _isDisposed;
  101428. /**
  101429. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  101430. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  101431. */
  101432. dispatchAllSubMeshesOfActiveMeshes: boolean;
  101433. private _activeMeshes;
  101434. private _processedMaterials;
  101435. private _renderTargets;
  101436. /** @hidden */
  101437. _activeParticleSystems: SmartArray<IParticleSystem>;
  101438. private _activeSkeletons;
  101439. private _softwareSkinnedMeshes;
  101440. private _renderingManager;
  101441. /** @hidden */
  101442. _activeAnimatables: Animatable[];
  101443. private _transformMatrix;
  101444. private _sceneUbo;
  101445. /** @hidden */
  101446. _viewMatrix: Matrix;
  101447. private _projectionMatrix;
  101448. /** @hidden */
  101449. _forcedViewPosition: Nullable<Vector3>;
  101450. /** @hidden */
  101451. _frustumPlanes: Plane[];
  101452. /**
  101453. * Gets the list of frustum planes (built from the active camera)
  101454. */
  101455. readonly frustumPlanes: Plane[];
  101456. /**
  101457. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  101458. * This is useful if there are more lights that the maximum simulteanous authorized
  101459. */
  101460. requireLightSorting: boolean;
  101461. /** @hidden */
  101462. readonly useMaterialMeshMap: boolean;
  101463. /** @hidden */
  101464. readonly useClonedMeshhMap: boolean;
  101465. private _externalData;
  101466. private _uid;
  101467. /**
  101468. * @hidden
  101469. * Backing store of defined scene components.
  101470. */
  101471. _components: ISceneComponent[];
  101472. /**
  101473. * @hidden
  101474. * Backing store of defined scene components.
  101475. */
  101476. _serializableComponents: ISceneSerializableComponent[];
  101477. /**
  101478. * List of components to register on the next registration step.
  101479. */
  101480. private _transientComponents;
  101481. /**
  101482. * Registers the transient components if needed.
  101483. */
  101484. private _registerTransientComponents;
  101485. /**
  101486. * @hidden
  101487. * Add a component to the scene.
  101488. * Note that the ccomponent could be registered on th next frame if this is called after
  101489. * the register component stage.
  101490. * @param component Defines the component to add to the scene
  101491. */
  101492. _addComponent(component: ISceneComponent): void;
  101493. /**
  101494. * @hidden
  101495. * Gets a component from the scene.
  101496. * @param name defines the name of the component to retrieve
  101497. * @returns the component or null if not present
  101498. */
  101499. _getComponent(name: string): Nullable<ISceneComponent>;
  101500. /**
  101501. * @hidden
  101502. * Defines the actions happening before camera updates.
  101503. */
  101504. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  101505. /**
  101506. * @hidden
  101507. * Defines the actions happening before clear the canvas.
  101508. */
  101509. _beforeClearStage: Stage<SimpleStageAction>;
  101510. /**
  101511. * @hidden
  101512. * Defines the actions when collecting render targets for the frame.
  101513. */
  101514. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  101515. /**
  101516. * @hidden
  101517. * Defines the actions happening for one camera in the frame.
  101518. */
  101519. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  101520. /**
  101521. * @hidden
  101522. * Defines the actions happening during the per mesh ready checks.
  101523. */
  101524. _isReadyForMeshStage: Stage<MeshStageAction>;
  101525. /**
  101526. * @hidden
  101527. * Defines the actions happening before evaluate active mesh checks.
  101528. */
  101529. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  101530. /**
  101531. * @hidden
  101532. * Defines the actions happening during the evaluate sub mesh checks.
  101533. */
  101534. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  101535. /**
  101536. * @hidden
  101537. * Defines the actions happening during the active mesh stage.
  101538. */
  101539. _activeMeshStage: Stage<ActiveMeshStageAction>;
  101540. /**
  101541. * @hidden
  101542. * Defines the actions happening during the per camera render target step.
  101543. */
  101544. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  101545. /**
  101546. * @hidden
  101547. * Defines the actions happening just before the active camera is drawing.
  101548. */
  101549. _beforeCameraDrawStage: Stage<CameraStageAction>;
  101550. /**
  101551. * @hidden
  101552. * Defines the actions happening just before a render target is drawing.
  101553. */
  101554. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  101555. /**
  101556. * @hidden
  101557. * Defines the actions happening just before a rendering group is drawing.
  101558. */
  101559. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  101560. /**
  101561. * @hidden
  101562. * Defines the actions happening just before a mesh is drawing.
  101563. */
  101564. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  101565. /**
  101566. * @hidden
  101567. * Defines the actions happening just after a mesh has been drawn.
  101568. */
  101569. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  101570. /**
  101571. * @hidden
  101572. * Defines the actions happening just after a rendering group has been drawn.
  101573. */
  101574. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  101575. /**
  101576. * @hidden
  101577. * Defines the actions happening just after the active camera has been drawn.
  101578. */
  101579. _afterCameraDrawStage: Stage<CameraStageAction>;
  101580. /**
  101581. * @hidden
  101582. * Defines the actions happening just after a render target has been drawn.
  101583. */
  101584. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  101585. /**
  101586. * @hidden
  101587. * Defines the actions happening just after rendering all cameras and computing intersections.
  101588. */
  101589. _afterRenderStage: Stage<SimpleStageAction>;
  101590. /**
  101591. * @hidden
  101592. * Defines the actions happening when a pointer move event happens.
  101593. */
  101594. _pointerMoveStage: Stage<PointerMoveStageAction>;
  101595. /**
  101596. * @hidden
  101597. * Defines the actions happening when a pointer down event happens.
  101598. */
  101599. _pointerDownStage: Stage<PointerUpDownStageAction>;
  101600. /**
  101601. * @hidden
  101602. * Defines the actions happening when a pointer up event happens.
  101603. */
  101604. _pointerUpStage: Stage<PointerUpDownStageAction>;
  101605. /**
  101606. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  101607. */
  101608. private geometriesByUniqueId;
  101609. /**
  101610. * Creates a new Scene
  101611. * @param engine defines the engine to use to render this scene
  101612. * @param options defines the scene options
  101613. */
  101614. constructor(engine: Engine, options?: SceneOptions);
  101615. /**
  101616. * Gets a string idenfifying the name of the class
  101617. * @returns "Scene" string
  101618. */
  101619. getClassName(): string;
  101620. private _defaultMeshCandidates;
  101621. /**
  101622. * @hidden
  101623. */
  101624. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  101625. private _defaultSubMeshCandidates;
  101626. /**
  101627. * @hidden
  101628. */
  101629. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  101630. /**
  101631. * Sets the default candidate providers for the scene.
  101632. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  101633. * and getCollidingSubMeshCandidates to their default function
  101634. */
  101635. setDefaultCandidateProviders(): void;
  101636. /**
  101637. * Gets the mesh that is currently under the pointer
  101638. */
  101639. readonly meshUnderPointer: Nullable<AbstractMesh>;
  101640. /**
  101641. * Gets or sets the current on-screen X position of the pointer
  101642. */
  101643. pointerX: number;
  101644. /**
  101645. * Gets or sets the current on-screen Y position of the pointer
  101646. */
  101647. pointerY: number;
  101648. /**
  101649. * Gets the cached material (ie. the latest rendered one)
  101650. * @returns the cached material
  101651. */
  101652. getCachedMaterial(): Nullable<Material>;
  101653. /**
  101654. * Gets the cached effect (ie. the latest rendered one)
  101655. * @returns the cached effect
  101656. */
  101657. getCachedEffect(): Nullable<Effect>;
  101658. /**
  101659. * Gets the cached visibility state (ie. the latest rendered one)
  101660. * @returns the cached visibility state
  101661. */
  101662. getCachedVisibility(): Nullable<number>;
  101663. /**
  101664. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  101665. * @param material defines the current material
  101666. * @param effect defines the current effect
  101667. * @param visibility defines the current visibility state
  101668. * @returns true if one parameter is not cached
  101669. */
  101670. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  101671. /**
  101672. * Gets the engine associated with the scene
  101673. * @returns an Engine
  101674. */
  101675. getEngine(): Engine;
  101676. /**
  101677. * Gets the total number of vertices rendered per frame
  101678. * @returns the total number of vertices rendered per frame
  101679. */
  101680. getTotalVertices(): number;
  101681. /**
  101682. * Gets the performance counter for total vertices
  101683. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  101684. */
  101685. readonly totalVerticesPerfCounter: PerfCounter;
  101686. /**
  101687. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  101688. * @returns the total number of active indices rendered per frame
  101689. */
  101690. getActiveIndices(): number;
  101691. /**
  101692. * Gets the performance counter for active indices
  101693. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  101694. */
  101695. readonly totalActiveIndicesPerfCounter: PerfCounter;
  101696. /**
  101697. * Gets the total number of active particles rendered per frame
  101698. * @returns the total number of active particles rendered per frame
  101699. */
  101700. getActiveParticles(): number;
  101701. /**
  101702. * Gets the performance counter for active particles
  101703. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  101704. */
  101705. readonly activeParticlesPerfCounter: PerfCounter;
  101706. /**
  101707. * Gets the total number of active bones rendered per frame
  101708. * @returns the total number of active bones rendered per frame
  101709. */
  101710. getActiveBones(): number;
  101711. /**
  101712. * Gets the performance counter for active bones
  101713. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  101714. */
  101715. readonly activeBonesPerfCounter: PerfCounter;
  101716. /**
  101717. * Gets the array of active meshes
  101718. * @returns an array of AbstractMesh
  101719. */
  101720. getActiveMeshes(): SmartArray<AbstractMesh>;
  101721. /**
  101722. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  101723. * @returns a number
  101724. */
  101725. getAnimationRatio(): number;
  101726. /**
  101727. * Gets an unique Id for the current render phase
  101728. * @returns a number
  101729. */
  101730. getRenderId(): number;
  101731. /**
  101732. * Gets an unique Id for the current frame
  101733. * @returns a number
  101734. */
  101735. getFrameId(): number;
  101736. /** Call this function if you want to manually increment the render Id*/
  101737. incrementRenderId(): void;
  101738. private _createUbo;
  101739. /**
  101740. * Use this method to simulate a pointer move on a mesh
  101741. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101742. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101743. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101744. * @returns the current scene
  101745. */
  101746. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  101747. /**
  101748. * Use this method to simulate a pointer down on a mesh
  101749. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101750. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101751. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101752. * @returns the current scene
  101753. */
  101754. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  101755. /**
  101756. * Use this method to simulate a pointer up on a mesh
  101757. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101758. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101759. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101760. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  101761. * @returns the current scene
  101762. */
  101763. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  101764. /**
  101765. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  101766. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  101767. * @returns true if the pointer was captured
  101768. */
  101769. isPointerCaptured(pointerId?: number): boolean;
  101770. /**
  101771. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  101772. * @param attachUp defines if you want to attach events to pointerup
  101773. * @param attachDown defines if you want to attach events to pointerdown
  101774. * @param attachMove defines if you want to attach events to pointermove
  101775. */
  101776. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  101777. /** Detaches all event handlers*/
  101778. detachControl(): void;
  101779. /**
  101780. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  101781. * Delay loaded resources are not taking in account
  101782. * @return true if all required resources are ready
  101783. */
  101784. isReady(): boolean;
  101785. /** Resets all cached information relative to material (including effect and visibility) */
  101786. resetCachedMaterial(): void;
  101787. /**
  101788. * Registers a function to be called before every frame render
  101789. * @param func defines the function to register
  101790. */
  101791. registerBeforeRender(func: () => void): void;
  101792. /**
  101793. * Unregisters a function called before every frame render
  101794. * @param func defines the function to unregister
  101795. */
  101796. unregisterBeforeRender(func: () => void): void;
  101797. /**
  101798. * Registers a function to be called after every frame render
  101799. * @param func defines the function to register
  101800. */
  101801. registerAfterRender(func: () => void): void;
  101802. /**
  101803. * Unregisters a function called after every frame render
  101804. * @param func defines the function to unregister
  101805. */
  101806. unregisterAfterRender(func: () => void): void;
  101807. private _executeOnceBeforeRender;
  101808. /**
  101809. * The provided function will run before render once and will be disposed afterwards.
  101810. * A timeout delay can be provided so that the function will be executed in N ms.
  101811. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  101812. * @param func The function to be executed.
  101813. * @param timeout optional delay in ms
  101814. */
  101815. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  101816. /** @hidden */
  101817. _addPendingData(data: any): void;
  101818. /** @hidden */
  101819. _removePendingData(data: any): void;
  101820. /**
  101821. * Returns the number of items waiting to be loaded
  101822. * @returns the number of items waiting to be loaded
  101823. */
  101824. getWaitingItemsCount(): number;
  101825. /**
  101826. * Returns a boolean indicating if the scene is still loading data
  101827. */
  101828. readonly isLoading: boolean;
  101829. /**
  101830. * Registers a function to be executed when the scene is ready
  101831. * @param {Function} func - the function to be executed
  101832. */
  101833. executeWhenReady(func: () => void): void;
  101834. /**
  101835. * Returns a promise that resolves when the scene is ready
  101836. * @returns A promise that resolves when the scene is ready
  101837. */
  101838. whenReadyAsync(): Promise<void>;
  101839. /** @hidden */
  101840. _checkIsReady(): void;
  101841. /**
  101842. * Gets all animatable attached to the scene
  101843. */
  101844. readonly animatables: Animatable[];
  101845. /**
  101846. * Resets the last animation time frame.
  101847. * Useful to override when animations start running when loading a scene for the first time.
  101848. */
  101849. resetLastAnimationTimeFrame(): void;
  101850. /**
  101851. * Gets the current view matrix
  101852. * @returns a Matrix
  101853. */
  101854. getViewMatrix(): Matrix;
  101855. /**
  101856. * Gets the current projection matrix
  101857. * @returns a Matrix
  101858. */
  101859. getProjectionMatrix(): Matrix;
  101860. /**
  101861. * Gets the current transform matrix
  101862. * @returns a Matrix made of View * Projection
  101863. */
  101864. getTransformMatrix(): Matrix;
  101865. /**
  101866. * Sets the current transform matrix
  101867. * @param viewL defines the View matrix to use
  101868. * @param projectionL defines the Projection matrix to use
  101869. * @param viewR defines the right View matrix to use (if provided)
  101870. * @param projectionR defines the right Projection matrix to use (if provided)
  101871. */
  101872. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  101873. /**
  101874. * Gets the uniform buffer used to store scene data
  101875. * @returns a UniformBuffer
  101876. */
  101877. getSceneUniformBuffer(): UniformBuffer;
  101878. /**
  101879. * Gets an unique (relatively to the current scene) Id
  101880. * @returns an unique number for the scene
  101881. */
  101882. getUniqueId(): number;
  101883. /**
  101884. * Add a mesh to the list of scene's meshes
  101885. * @param newMesh defines the mesh to add
  101886. * @param recursive if all child meshes should also be added to the scene
  101887. */
  101888. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  101889. /**
  101890. * Remove a mesh for the list of scene's meshes
  101891. * @param toRemove defines the mesh to remove
  101892. * @param recursive if all child meshes should also be removed from the scene
  101893. * @returns the index where the mesh was in the mesh list
  101894. */
  101895. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  101896. /**
  101897. * Add a transform node to the list of scene's transform nodes
  101898. * @param newTransformNode defines the transform node to add
  101899. */
  101900. addTransformNode(newTransformNode: TransformNode): void;
  101901. /**
  101902. * Remove a transform node for the list of scene's transform nodes
  101903. * @param toRemove defines the transform node to remove
  101904. * @returns the index where the transform node was in the transform node list
  101905. */
  101906. removeTransformNode(toRemove: TransformNode): number;
  101907. /**
  101908. * Remove a skeleton for the list of scene's skeletons
  101909. * @param toRemove defines the skeleton to remove
  101910. * @returns the index where the skeleton was in the skeleton list
  101911. */
  101912. removeSkeleton(toRemove: Skeleton): number;
  101913. /**
  101914. * Remove a morph target for the list of scene's morph targets
  101915. * @param toRemove defines the morph target to remove
  101916. * @returns the index where the morph target was in the morph target list
  101917. */
  101918. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  101919. /**
  101920. * Remove a light for the list of scene's lights
  101921. * @param toRemove defines the light to remove
  101922. * @returns the index where the light was in the light list
  101923. */
  101924. removeLight(toRemove: Light): number;
  101925. /**
  101926. * Remove a camera for the list of scene's cameras
  101927. * @param toRemove defines the camera to remove
  101928. * @returns the index where the camera was in the camera list
  101929. */
  101930. removeCamera(toRemove: Camera): number;
  101931. /**
  101932. * Remove a particle system for the list of scene's particle systems
  101933. * @param toRemove defines the particle system to remove
  101934. * @returns the index where the particle system was in the particle system list
  101935. */
  101936. removeParticleSystem(toRemove: IParticleSystem): number;
  101937. /**
  101938. * Remove a animation for the list of scene's animations
  101939. * @param toRemove defines the animation to remove
  101940. * @returns the index where the animation was in the animation list
  101941. */
  101942. removeAnimation(toRemove: Animation): number;
  101943. /**
  101944. * Will stop the animation of the given target
  101945. * @param target - the target
  101946. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  101947. * @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)
  101948. */
  101949. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  101950. /**
  101951. * Removes the given animation group from this scene.
  101952. * @param toRemove The animation group to remove
  101953. * @returns The index of the removed animation group
  101954. */
  101955. removeAnimationGroup(toRemove: AnimationGroup): number;
  101956. /**
  101957. * Removes the given multi-material from this scene.
  101958. * @param toRemove The multi-material to remove
  101959. * @returns The index of the removed multi-material
  101960. */
  101961. removeMultiMaterial(toRemove: MultiMaterial): number;
  101962. /**
  101963. * Removes the given material from this scene.
  101964. * @param toRemove The material to remove
  101965. * @returns The index of the removed material
  101966. */
  101967. removeMaterial(toRemove: Material): number;
  101968. /**
  101969. * Removes the given action manager from this scene.
  101970. * @param toRemove The action manager to remove
  101971. * @returns The index of the removed action manager
  101972. */
  101973. removeActionManager(toRemove: AbstractActionManager): number;
  101974. /**
  101975. * Removes the given texture from this scene.
  101976. * @param toRemove The texture to remove
  101977. * @returns The index of the removed texture
  101978. */
  101979. removeTexture(toRemove: BaseTexture): number;
  101980. /**
  101981. * Adds the given light to this scene
  101982. * @param newLight The light to add
  101983. */
  101984. addLight(newLight: Light): void;
  101985. /**
  101986. * Sorts the list list based on light priorities
  101987. */
  101988. sortLightsByPriority(): void;
  101989. /**
  101990. * Adds the given camera to this scene
  101991. * @param newCamera The camera to add
  101992. */
  101993. addCamera(newCamera: Camera): void;
  101994. /**
  101995. * Adds the given skeleton to this scene
  101996. * @param newSkeleton The skeleton to add
  101997. */
  101998. addSkeleton(newSkeleton: Skeleton): void;
  101999. /**
  102000. * Adds the given particle system to this scene
  102001. * @param newParticleSystem The particle system to add
  102002. */
  102003. addParticleSystem(newParticleSystem: IParticleSystem): void;
  102004. /**
  102005. * Adds the given animation to this scene
  102006. * @param newAnimation The animation to add
  102007. */
  102008. addAnimation(newAnimation: Animation): void;
  102009. /**
  102010. * Adds the given animation group to this scene.
  102011. * @param newAnimationGroup The animation group to add
  102012. */
  102013. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  102014. /**
  102015. * Adds the given multi-material to this scene
  102016. * @param newMultiMaterial The multi-material to add
  102017. */
  102018. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  102019. /**
  102020. * Adds the given material to this scene
  102021. * @param newMaterial The material to add
  102022. */
  102023. addMaterial(newMaterial: Material): void;
  102024. /**
  102025. * Adds the given morph target to this scene
  102026. * @param newMorphTargetManager The morph target to add
  102027. */
  102028. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  102029. /**
  102030. * Adds the given geometry to this scene
  102031. * @param newGeometry The geometry to add
  102032. */
  102033. addGeometry(newGeometry: Geometry): void;
  102034. /**
  102035. * Adds the given action manager to this scene
  102036. * @param newActionManager The action manager to add
  102037. */
  102038. addActionManager(newActionManager: AbstractActionManager): void;
  102039. /**
  102040. * Adds the given texture to this scene.
  102041. * @param newTexture The texture to add
  102042. */
  102043. addTexture(newTexture: BaseTexture): void;
  102044. /**
  102045. * Switch active camera
  102046. * @param newCamera defines the new active camera
  102047. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  102048. */
  102049. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  102050. /**
  102051. * sets the active camera of the scene using its ID
  102052. * @param id defines the camera's ID
  102053. * @return the new active camera or null if none found.
  102054. */
  102055. setActiveCameraByID(id: string): Nullable<Camera>;
  102056. /**
  102057. * sets the active camera of the scene using its name
  102058. * @param name defines the camera's name
  102059. * @returns the new active camera or null if none found.
  102060. */
  102061. setActiveCameraByName(name: string): Nullable<Camera>;
  102062. /**
  102063. * get an animation group using its name
  102064. * @param name defines the material's name
  102065. * @return the animation group or null if none found.
  102066. */
  102067. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  102068. /**
  102069. * Get a material using its unique id
  102070. * @param uniqueId defines the material's unique id
  102071. * @return the material or null if none found.
  102072. */
  102073. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  102074. /**
  102075. * get a material using its id
  102076. * @param id defines the material's ID
  102077. * @return the material or null if none found.
  102078. */
  102079. getMaterialByID(id: string): Nullable<Material>;
  102080. /**
  102081. * Gets a the last added material using a given id
  102082. * @param id defines the material's ID
  102083. * @return the last material with the given id or null if none found.
  102084. */
  102085. getLastMaterialByID(id: string): Nullable<Material>;
  102086. /**
  102087. * Gets a material using its name
  102088. * @param name defines the material's name
  102089. * @return the material or null if none found.
  102090. */
  102091. getMaterialByName(name: string): Nullable<Material>;
  102092. /**
  102093. * Get a texture using its unique id
  102094. * @param uniqueId defines the texture's unique id
  102095. * @return the texture or null if none found.
  102096. */
  102097. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  102098. /**
  102099. * Gets a camera using its id
  102100. * @param id defines the id to look for
  102101. * @returns the camera or null if not found
  102102. */
  102103. getCameraByID(id: string): Nullable<Camera>;
  102104. /**
  102105. * Gets a camera using its unique id
  102106. * @param uniqueId defines the unique id to look for
  102107. * @returns the camera or null if not found
  102108. */
  102109. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  102110. /**
  102111. * Gets a camera using its name
  102112. * @param name defines the camera's name
  102113. * @return the camera or null if none found.
  102114. */
  102115. getCameraByName(name: string): Nullable<Camera>;
  102116. /**
  102117. * Gets a bone using its id
  102118. * @param id defines the bone's id
  102119. * @return the bone or null if not found
  102120. */
  102121. getBoneByID(id: string): Nullable<Bone>;
  102122. /**
  102123. * Gets a bone using its id
  102124. * @param name defines the bone's name
  102125. * @return the bone or null if not found
  102126. */
  102127. getBoneByName(name: string): Nullable<Bone>;
  102128. /**
  102129. * Gets a light node using its name
  102130. * @param name defines the the light's name
  102131. * @return the light or null if none found.
  102132. */
  102133. getLightByName(name: string): Nullable<Light>;
  102134. /**
  102135. * Gets a light node using its id
  102136. * @param id defines the light's id
  102137. * @return the light or null if none found.
  102138. */
  102139. getLightByID(id: string): Nullable<Light>;
  102140. /**
  102141. * Gets a light node using its scene-generated unique ID
  102142. * @param uniqueId defines the light's unique id
  102143. * @return the light or null if none found.
  102144. */
  102145. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  102146. /**
  102147. * Gets a particle system by id
  102148. * @param id defines the particle system id
  102149. * @return the corresponding system or null if none found
  102150. */
  102151. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  102152. /**
  102153. * Gets a geometry using its ID
  102154. * @param id defines the geometry's id
  102155. * @return the geometry or null if none found.
  102156. */
  102157. getGeometryByID(id: string): Nullable<Geometry>;
  102158. private _getGeometryByUniqueID;
  102159. /**
  102160. * Add a new geometry to this scene
  102161. * @param geometry defines the geometry to be added to the scene.
  102162. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  102163. * @return a boolean defining if the geometry was added or not
  102164. */
  102165. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  102166. /**
  102167. * Removes an existing geometry
  102168. * @param geometry defines the geometry to be removed from the scene
  102169. * @return a boolean defining if the geometry was removed or not
  102170. */
  102171. removeGeometry(geometry: Geometry): boolean;
  102172. /**
  102173. * Gets the list of geometries attached to the scene
  102174. * @returns an array of Geometry
  102175. */
  102176. getGeometries(): Geometry[];
  102177. /**
  102178. * Gets the first added mesh found of a given ID
  102179. * @param id defines the id to search for
  102180. * @return the mesh found or null if not found at all
  102181. */
  102182. getMeshByID(id: string): Nullable<AbstractMesh>;
  102183. /**
  102184. * Gets a list of meshes using their id
  102185. * @param id defines the id to search for
  102186. * @returns a list of meshes
  102187. */
  102188. getMeshesByID(id: string): Array<AbstractMesh>;
  102189. /**
  102190. * Gets the first added transform node found of a given ID
  102191. * @param id defines the id to search for
  102192. * @return the found transform node or null if not found at all.
  102193. */
  102194. getTransformNodeByID(id: string): Nullable<TransformNode>;
  102195. /**
  102196. * Gets a transform node with its auto-generated unique id
  102197. * @param uniqueId efines the unique id to search for
  102198. * @return the found transform node or null if not found at all.
  102199. */
  102200. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  102201. /**
  102202. * Gets a list of transform nodes using their id
  102203. * @param id defines the id to search for
  102204. * @returns a list of transform nodes
  102205. */
  102206. getTransformNodesByID(id: string): Array<TransformNode>;
  102207. /**
  102208. * Gets a mesh with its auto-generated unique id
  102209. * @param uniqueId defines the unique id to search for
  102210. * @return the found mesh or null if not found at all.
  102211. */
  102212. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  102213. /**
  102214. * Gets a the last added mesh using a given id
  102215. * @param id defines the id to search for
  102216. * @return the found mesh or null if not found at all.
  102217. */
  102218. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  102219. /**
  102220. * Gets a the last added node (Mesh, Camera, Light) using a given id
  102221. * @param id defines the id to search for
  102222. * @return the found node or null if not found at all
  102223. */
  102224. getLastEntryByID(id: string): Nullable<Node>;
  102225. /**
  102226. * Gets a node (Mesh, Camera, Light) using a given id
  102227. * @param id defines the id to search for
  102228. * @return the found node or null if not found at all
  102229. */
  102230. getNodeByID(id: string): Nullable<Node>;
  102231. /**
  102232. * Gets a node (Mesh, Camera, Light) using a given name
  102233. * @param name defines the name to search for
  102234. * @return the found node or null if not found at all.
  102235. */
  102236. getNodeByName(name: string): Nullable<Node>;
  102237. /**
  102238. * Gets a mesh using a given name
  102239. * @param name defines the name to search for
  102240. * @return the found mesh or null if not found at all.
  102241. */
  102242. getMeshByName(name: string): Nullable<AbstractMesh>;
  102243. /**
  102244. * Gets a transform node using a given name
  102245. * @param name defines the name to search for
  102246. * @return the found transform node or null if not found at all.
  102247. */
  102248. getTransformNodeByName(name: string): Nullable<TransformNode>;
  102249. /**
  102250. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  102251. * @param id defines the id to search for
  102252. * @return the found skeleton or null if not found at all.
  102253. */
  102254. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  102255. /**
  102256. * Gets a skeleton using a given auto generated unique id
  102257. * @param uniqueId defines the unique id to search for
  102258. * @return the found skeleton or null if not found at all.
  102259. */
  102260. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  102261. /**
  102262. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  102263. * @param id defines the id to search for
  102264. * @return the found skeleton or null if not found at all.
  102265. */
  102266. getSkeletonById(id: string): Nullable<Skeleton>;
  102267. /**
  102268. * Gets a skeleton using a given name
  102269. * @param name defines the name to search for
  102270. * @return the found skeleton or null if not found at all.
  102271. */
  102272. getSkeletonByName(name: string): Nullable<Skeleton>;
  102273. /**
  102274. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  102275. * @param id defines the id to search for
  102276. * @return the found morph target manager or null if not found at all.
  102277. */
  102278. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  102279. /**
  102280. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  102281. * @param id defines the id to search for
  102282. * @return the found morph target or null if not found at all.
  102283. */
  102284. getMorphTargetById(id: string): Nullable<MorphTarget>;
  102285. /**
  102286. * Gets a boolean indicating if the given mesh is active
  102287. * @param mesh defines the mesh to look for
  102288. * @returns true if the mesh is in the active list
  102289. */
  102290. isActiveMesh(mesh: AbstractMesh): boolean;
  102291. /**
  102292. * Return a unique id as a string which can serve as an identifier for the scene
  102293. */
  102294. readonly uid: string;
  102295. /**
  102296. * Add an externaly attached data from its key.
  102297. * This method call will fail and return false, if such key already exists.
  102298. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  102299. * @param key the unique key that identifies the data
  102300. * @param data the data object to associate to the key for this Engine instance
  102301. * @return true if no such key were already present and the data was added successfully, false otherwise
  102302. */
  102303. addExternalData<T>(key: string, data: T): boolean;
  102304. /**
  102305. * Get an externaly attached data from its key
  102306. * @param key the unique key that identifies the data
  102307. * @return the associated data, if present (can be null), or undefined if not present
  102308. */
  102309. getExternalData<T>(key: string): Nullable<T>;
  102310. /**
  102311. * Get an externaly attached data from its key, create it using a factory if it's not already present
  102312. * @param key the unique key that identifies the data
  102313. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  102314. * @return the associated data, can be null if the factory returned null.
  102315. */
  102316. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  102317. /**
  102318. * Remove an externaly attached data from the Engine instance
  102319. * @param key the unique key that identifies the data
  102320. * @return true if the data was successfully removed, false if it doesn't exist
  102321. */
  102322. removeExternalData(key: string): boolean;
  102323. private _evaluateSubMesh;
  102324. /**
  102325. * Clear the processed materials smart array preventing retention point in material dispose.
  102326. */
  102327. freeProcessedMaterials(): void;
  102328. private _preventFreeActiveMeshesAndRenderingGroups;
  102329. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  102330. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  102331. * when disposing several meshes in a row or a hierarchy of meshes.
  102332. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  102333. */
  102334. blockfreeActiveMeshesAndRenderingGroups: boolean;
  102335. /**
  102336. * Clear the active meshes smart array preventing retention point in mesh dispose.
  102337. */
  102338. freeActiveMeshes(): void;
  102339. /**
  102340. * Clear the info related to rendering groups preventing retention points during dispose.
  102341. */
  102342. freeRenderingGroups(): void;
  102343. /** @hidden */
  102344. _isInIntermediateRendering(): boolean;
  102345. /**
  102346. * Lambda returning the list of potentially active meshes.
  102347. */
  102348. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  102349. /**
  102350. * Lambda returning the list of potentially active sub meshes.
  102351. */
  102352. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  102353. /**
  102354. * Lambda returning the list of potentially intersecting sub meshes.
  102355. */
  102356. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  102357. /**
  102358. * Lambda returning the list of potentially colliding sub meshes.
  102359. */
  102360. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  102361. private _activeMeshesFrozen;
  102362. /**
  102363. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  102364. * @returns the current scene
  102365. */
  102366. freezeActiveMeshes(): Scene;
  102367. /**
  102368. * Use this function to restart evaluating active meshes on every frame
  102369. * @returns the current scene
  102370. */
  102371. unfreezeActiveMeshes(): Scene;
  102372. private _evaluateActiveMeshes;
  102373. private _activeMesh;
  102374. /**
  102375. * Update the transform matrix to update from the current active camera
  102376. * @param force defines a boolean used to force the update even if cache is up to date
  102377. */
  102378. updateTransformMatrix(force?: boolean): void;
  102379. private _bindFrameBuffer;
  102380. /** @hidden */
  102381. _allowPostProcessClearColor: boolean;
  102382. /** @hidden */
  102383. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  102384. private _processSubCameras;
  102385. private _checkIntersections;
  102386. /** @hidden */
  102387. _advancePhysicsEngineStep(step: number): void;
  102388. /**
  102389. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  102390. */
  102391. getDeterministicFrameTime: () => number;
  102392. /** @hidden */
  102393. _animate(): void;
  102394. /** Execute all animations (for a frame) */
  102395. animate(): void;
  102396. /**
  102397. * Render the scene
  102398. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  102399. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  102400. */
  102401. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  102402. /**
  102403. * Freeze all materials
  102404. * A frozen material will not be updatable but should be faster to render
  102405. */
  102406. freezeMaterials(): void;
  102407. /**
  102408. * Unfreeze all materials
  102409. * A frozen material will not be updatable but should be faster to render
  102410. */
  102411. unfreezeMaterials(): void;
  102412. /**
  102413. * Releases all held ressources
  102414. */
  102415. dispose(): void;
  102416. /**
  102417. * Gets if the scene is already disposed
  102418. */
  102419. readonly isDisposed: boolean;
  102420. /**
  102421. * Call this function to reduce memory footprint of the scene.
  102422. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  102423. */
  102424. clearCachedVertexData(): void;
  102425. /**
  102426. * This function will remove the local cached buffer data from texture.
  102427. * It will save memory but will prevent the texture from being rebuilt
  102428. */
  102429. cleanCachedTextureBuffer(): void;
  102430. /**
  102431. * Get the world extend vectors with an optional filter
  102432. *
  102433. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  102434. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  102435. */
  102436. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  102437. min: Vector3;
  102438. max: Vector3;
  102439. };
  102440. /**
  102441. * Creates a ray that can be used to pick in the scene
  102442. * @param x defines the x coordinate of the origin (on-screen)
  102443. * @param y defines the y coordinate of the origin (on-screen)
  102444. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  102445. * @param camera defines the camera to use for the picking
  102446. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  102447. * @returns a Ray
  102448. */
  102449. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  102450. /**
  102451. * Creates a ray that can be used to pick in the scene
  102452. * @param x defines the x coordinate of the origin (on-screen)
  102453. * @param y defines the y coordinate of the origin (on-screen)
  102454. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  102455. * @param result defines the ray where to store the picking ray
  102456. * @param camera defines the camera to use for the picking
  102457. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  102458. * @returns the current scene
  102459. */
  102460. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  102461. /**
  102462. * Creates a ray that can be used to pick in the scene
  102463. * @param x defines the x coordinate of the origin (on-screen)
  102464. * @param y defines the y coordinate of the origin (on-screen)
  102465. * @param camera defines the camera to use for the picking
  102466. * @returns a Ray
  102467. */
  102468. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  102469. /**
  102470. * Creates a ray that can be used to pick in the scene
  102471. * @param x defines the x coordinate of the origin (on-screen)
  102472. * @param y defines the y coordinate of the origin (on-screen)
  102473. * @param result defines the ray where to store the picking ray
  102474. * @param camera defines the camera to use for the picking
  102475. * @returns the current scene
  102476. */
  102477. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  102478. /** Launch a ray to try to pick a mesh in the scene
  102479. * @param x position on screen
  102480. * @param y position on screen
  102481. * @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
  102482. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  102483. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  102484. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  102485. * @returns a PickingInfo
  102486. */
  102487. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  102488. /** Use the given ray to pick a mesh in the scene
  102489. * @param ray The ray to use to pick meshes
  102490. * @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
  102491. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null
  102492. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  102493. * @returns a PickingInfo
  102494. */
  102495. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  102496. /**
  102497. * Launch a ray to try to pick a mesh in the scene
  102498. * @param x X position on screen
  102499. * @param y Y position on screen
  102500. * @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
  102501. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  102502. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  102503. * @returns an array of PickingInfo
  102504. */
  102505. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  102506. /**
  102507. * Launch a ray to try to pick a mesh in the scene
  102508. * @param ray Ray to use
  102509. * @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
  102510. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  102511. * @returns an array of PickingInfo
  102512. */
  102513. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  102514. /**
  102515. * Force the value of meshUnderPointer
  102516. * @param mesh defines the mesh to use
  102517. */
  102518. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  102519. /**
  102520. * Gets the mesh under the pointer
  102521. * @returns a Mesh or null if no mesh is under the pointer
  102522. */
  102523. getPointerOverMesh(): Nullable<AbstractMesh>;
  102524. /** @hidden */
  102525. _rebuildGeometries(): void;
  102526. /** @hidden */
  102527. _rebuildTextures(): void;
  102528. private _getByTags;
  102529. /**
  102530. * Get a list of meshes by tags
  102531. * @param tagsQuery defines the tags query to use
  102532. * @param forEach defines a predicate used to filter results
  102533. * @returns an array of Mesh
  102534. */
  102535. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  102536. /**
  102537. * Get a list of cameras by tags
  102538. * @param tagsQuery defines the tags query to use
  102539. * @param forEach defines a predicate used to filter results
  102540. * @returns an array of Camera
  102541. */
  102542. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  102543. /**
  102544. * Get a list of lights by tags
  102545. * @param tagsQuery defines the tags query to use
  102546. * @param forEach defines a predicate used to filter results
  102547. * @returns an array of Light
  102548. */
  102549. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  102550. /**
  102551. * Get a list of materials by tags
  102552. * @param tagsQuery defines the tags query to use
  102553. * @param forEach defines a predicate used to filter results
  102554. * @returns an array of Material
  102555. */
  102556. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  102557. /**
  102558. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  102559. * This allowed control for front to back rendering or reversly depending of the special needs.
  102560. *
  102561. * @param renderingGroupId The rendering group id corresponding to its index
  102562. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  102563. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  102564. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  102565. */
  102566. 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;
  102567. /**
  102568. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  102569. *
  102570. * @param renderingGroupId The rendering group id corresponding to its index
  102571. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  102572. * @param depth Automatically clears depth between groups if true and autoClear is true.
  102573. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  102574. */
  102575. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  102576. /**
  102577. * Gets the current auto clear configuration for one rendering group of the rendering
  102578. * manager.
  102579. * @param index the rendering group index to get the information for
  102580. * @returns The auto clear setup for the requested rendering group
  102581. */
  102582. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  102583. private _blockMaterialDirtyMechanism;
  102584. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  102585. blockMaterialDirtyMechanism: boolean;
  102586. /**
  102587. * Will flag all materials as dirty to trigger new shader compilation
  102588. * @param flag defines the flag used to specify which material part must be marked as dirty
  102589. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  102590. */
  102591. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  102592. /** @hidden */
  102593. _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;
  102594. /** @hidden */
  102595. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  102596. /** @hidden */
  102597. _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;
  102598. /** @hidden */
  102599. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  102600. /** @hidden */
  102601. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  102602. /** @hidden */
  102603. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  102604. }
  102605. }
  102606. declare module BABYLON {
  102607. /**
  102608. * Set of assets to keep when moving a scene into an asset container.
  102609. */
  102610. export class KeepAssets extends AbstractScene {
  102611. }
  102612. /**
  102613. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  102614. */
  102615. export class InstantiatedEntries {
  102616. /**
  102617. * List of new root nodes (eg. nodes with no parent)
  102618. */
  102619. rootNodes: TransformNode[];
  102620. /**
  102621. * List of new skeletons
  102622. */
  102623. skeletons: Skeleton[];
  102624. /**
  102625. * List of new animation groups
  102626. */
  102627. animationGroups: AnimationGroup[];
  102628. }
  102629. /**
  102630. * Container with a set of assets that can be added or removed from a scene.
  102631. */
  102632. export class AssetContainer extends AbstractScene {
  102633. /**
  102634. * The scene the AssetContainer belongs to.
  102635. */
  102636. scene: Scene;
  102637. /**
  102638. * Instantiates an AssetContainer.
  102639. * @param scene The scene the AssetContainer belongs to.
  102640. */
  102641. constructor(scene: Scene);
  102642. /**
  102643. * Instantiate or clone all meshes and add the new ones to the scene.
  102644. * Skeletons and animation groups will all be cloned
  102645. * @param nameFunction defines an optional function used to get new names for clones
  102646. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  102647. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  102648. */
  102649. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  102650. /**
  102651. * Adds all the assets from the container to the scene.
  102652. */
  102653. addAllToScene(): void;
  102654. /**
  102655. * Removes all the assets in the container from the scene
  102656. */
  102657. removeAllFromScene(): void;
  102658. /**
  102659. * Disposes all the assets in the container
  102660. */
  102661. dispose(): void;
  102662. private _moveAssets;
  102663. /**
  102664. * Removes all the assets contained in the scene and adds them to the container.
  102665. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  102666. */
  102667. moveAllFromScene(keepAssets?: KeepAssets): void;
  102668. /**
  102669. * 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.
  102670. * @returns the root mesh
  102671. */
  102672. createRootMesh(): Mesh;
  102673. }
  102674. }
  102675. declare module BABYLON {
  102676. /**
  102677. * Defines how the parser contract is defined.
  102678. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  102679. */
  102680. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  102681. /**
  102682. * Defines how the individual parser contract is defined.
  102683. * These parser can parse an individual asset
  102684. */
  102685. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  102686. /**
  102687. * Base class of the scene acting as a container for the different elements composing a scene.
  102688. * This class is dynamically extended by the different components of the scene increasing
  102689. * flexibility and reducing coupling
  102690. */
  102691. export abstract class AbstractScene {
  102692. /**
  102693. * Stores the list of available parsers in the application.
  102694. */
  102695. private static _BabylonFileParsers;
  102696. /**
  102697. * Stores the list of available individual parsers in the application.
  102698. */
  102699. private static _IndividualBabylonFileParsers;
  102700. /**
  102701. * Adds a parser in the list of available ones
  102702. * @param name Defines the name of the parser
  102703. * @param parser Defines the parser to add
  102704. */
  102705. static AddParser(name: string, parser: BabylonFileParser): void;
  102706. /**
  102707. * Gets a general parser from the list of avaialble ones
  102708. * @param name Defines the name of the parser
  102709. * @returns the requested parser or null
  102710. */
  102711. static GetParser(name: string): Nullable<BabylonFileParser>;
  102712. /**
  102713. * Adds n individual parser in the list of available ones
  102714. * @param name Defines the name of the parser
  102715. * @param parser Defines the parser to add
  102716. */
  102717. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  102718. /**
  102719. * Gets an individual parser from the list of avaialble ones
  102720. * @param name Defines the name of the parser
  102721. * @returns the requested parser or null
  102722. */
  102723. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  102724. /**
  102725. * Parser json data and populate both a scene and its associated container object
  102726. * @param jsonData Defines the data to parse
  102727. * @param scene Defines the scene to parse the data for
  102728. * @param container Defines the container attached to the parsing sequence
  102729. * @param rootUrl Defines the root url of the data
  102730. */
  102731. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  102732. /**
  102733. * Gets the list of root nodes (ie. nodes with no parent)
  102734. */
  102735. rootNodes: Node[];
  102736. /** All of the cameras added to this scene
  102737. * @see http://doc.babylonjs.com/babylon101/cameras
  102738. */
  102739. cameras: Camera[];
  102740. /**
  102741. * All of the lights added to this scene
  102742. * @see http://doc.babylonjs.com/babylon101/lights
  102743. */
  102744. lights: Light[];
  102745. /**
  102746. * All of the (abstract) meshes added to this scene
  102747. */
  102748. meshes: AbstractMesh[];
  102749. /**
  102750. * The list of skeletons added to the scene
  102751. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  102752. */
  102753. skeletons: Skeleton[];
  102754. /**
  102755. * All of the particle systems added to this scene
  102756. * @see http://doc.babylonjs.com/babylon101/particles
  102757. */
  102758. particleSystems: IParticleSystem[];
  102759. /**
  102760. * Gets a list of Animations associated with the scene
  102761. */
  102762. animations: Animation[];
  102763. /**
  102764. * All of the animation groups added to this scene
  102765. * @see http://doc.babylonjs.com/how_to/group
  102766. */
  102767. animationGroups: AnimationGroup[];
  102768. /**
  102769. * All of the multi-materials added to this scene
  102770. * @see http://doc.babylonjs.com/how_to/multi_materials
  102771. */
  102772. multiMaterials: MultiMaterial[];
  102773. /**
  102774. * All of the materials added to this scene
  102775. * In the context of a Scene, it is not supposed to be modified manually.
  102776. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  102777. * Note also that the order of the Material within the array is not significant and might change.
  102778. * @see http://doc.babylonjs.com/babylon101/materials
  102779. */
  102780. materials: Material[];
  102781. /**
  102782. * The list of morph target managers added to the scene
  102783. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  102784. */
  102785. morphTargetManagers: MorphTargetManager[];
  102786. /**
  102787. * The list of geometries used in the scene.
  102788. */
  102789. geometries: Geometry[];
  102790. /**
  102791. * All of the tranform nodes added to this scene
  102792. * In the context of a Scene, it is not supposed to be modified manually.
  102793. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  102794. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  102795. * @see http://doc.babylonjs.com/how_to/transformnode
  102796. */
  102797. transformNodes: TransformNode[];
  102798. /**
  102799. * ActionManagers available on the scene.
  102800. */
  102801. actionManagers: AbstractActionManager[];
  102802. /**
  102803. * Textures to keep.
  102804. */
  102805. textures: BaseTexture[];
  102806. /**
  102807. * Environment texture for the scene
  102808. */
  102809. environmentTexture: Nullable<BaseTexture>;
  102810. }
  102811. }
  102812. declare module BABYLON {
  102813. /**
  102814. * Interface used to define options for Sound class
  102815. */
  102816. export interface ISoundOptions {
  102817. /**
  102818. * Does the sound autoplay once loaded.
  102819. */
  102820. autoplay?: boolean;
  102821. /**
  102822. * Does the sound loop after it finishes playing once.
  102823. */
  102824. loop?: boolean;
  102825. /**
  102826. * Sound's volume
  102827. */
  102828. volume?: number;
  102829. /**
  102830. * Is it a spatial sound?
  102831. */
  102832. spatialSound?: boolean;
  102833. /**
  102834. * Maximum distance to hear that sound
  102835. */
  102836. maxDistance?: number;
  102837. /**
  102838. * Uses user defined attenuation function
  102839. */
  102840. useCustomAttenuation?: boolean;
  102841. /**
  102842. * Define the roll off factor of spatial sounds.
  102843. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102844. */
  102845. rolloffFactor?: number;
  102846. /**
  102847. * Define the reference distance the sound should be heard perfectly.
  102848. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102849. */
  102850. refDistance?: number;
  102851. /**
  102852. * Define the distance attenuation model the sound will follow.
  102853. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102854. */
  102855. distanceModel?: string;
  102856. /**
  102857. * Defines the playback speed (1 by default)
  102858. */
  102859. playbackRate?: number;
  102860. /**
  102861. * Defines if the sound is from a streaming source
  102862. */
  102863. streaming?: boolean;
  102864. /**
  102865. * Defines an optional length (in seconds) inside the sound file
  102866. */
  102867. length?: number;
  102868. /**
  102869. * Defines an optional offset (in seconds) inside the sound file
  102870. */
  102871. offset?: number;
  102872. /**
  102873. * If true, URLs will not be required to state the audio file codec to use.
  102874. */
  102875. skipCodecCheck?: boolean;
  102876. }
  102877. /**
  102878. * Defines a sound that can be played in the application.
  102879. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  102880. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  102881. */
  102882. export class Sound {
  102883. /**
  102884. * The name of the sound in the scene.
  102885. */
  102886. name: string;
  102887. /**
  102888. * Does the sound autoplay once loaded.
  102889. */
  102890. autoplay: boolean;
  102891. /**
  102892. * Does the sound loop after it finishes playing once.
  102893. */
  102894. loop: boolean;
  102895. /**
  102896. * Does the sound use a custom attenuation curve to simulate the falloff
  102897. * happening when the source gets further away from the camera.
  102898. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  102899. */
  102900. useCustomAttenuation: boolean;
  102901. /**
  102902. * The sound track id this sound belongs to.
  102903. */
  102904. soundTrackId: number;
  102905. /**
  102906. * Is this sound currently played.
  102907. */
  102908. isPlaying: boolean;
  102909. /**
  102910. * Is this sound currently paused.
  102911. */
  102912. isPaused: boolean;
  102913. /**
  102914. * Does this sound enables spatial sound.
  102915. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102916. */
  102917. spatialSound: boolean;
  102918. /**
  102919. * Define the reference distance the sound should be heard perfectly.
  102920. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102921. */
  102922. refDistance: number;
  102923. /**
  102924. * Define the roll off factor of spatial sounds.
  102925. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102926. */
  102927. rolloffFactor: number;
  102928. /**
  102929. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  102930. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102931. */
  102932. maxDistance: number;
  102933. /**
  102934. * Define the distance attenuation model the sound will follow.
  102935. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  102936. */
  102937. distanceModel: string;
  102938. /**
  102939. * @hidden
  102940. * Back Compat
  102941. **/
  102942. onended: () => any;
  102943. /**
  102944. * Observable event when the current playing sound finishes.
  102945. */
  102946. onEndedObservable: Observable<Sound>;
  102947. private _panningModel;
  102948. private _playbackRate;
  102949. private _streaming;
  102950. private _startTime;
  102951. private _startOffset;
  102952. private _position;
  102953. /** @hidden */
  102954. _positionInEmitterSpace: boolean;
  102955. private _localDirection;
  102956. private _volume;
  102957. private _isReadyToPlay;
  102958. private _isDirectional;
  102959. private _readyToPlayCallback;
  102960. private _audioBuffer;
  102961. private _soundSource;
  102962. private _streamingSource;
  102963. private _soundPanner;
  102964. private _soundGain;
  102965. private _inputAudioNode;
  102966. private _outputAudioNode;
  102967. private _coneInnerAngle;
  102968. private _coneOuterAngle;
  102969. private _coneOuterGain;
  102970. private _scene;
  102971. private _connectedTransformNode;
  102972. private _customAttenuationFunction;
  102973. private _registerFunc;
  102974. private _isOutputConnected;
  102975. private _htmlAudioElement;
  102976. private _urlType;
  102977. private _length?;
  102978. private _offset?;
  102979. /** @hidden */
  102980. static _SceneComponentInitialization: (scene: Scene) => void;
  102981. /**
  102982. * Create a sound and attach it to a scene
  102983. * @param name Name of your sound
  102984. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  102985. * @param scene defines the scene the sound belongs to
  102986. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  102987. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  102988. */
  102989. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  102990. /**
  102991. * Release the sound and its associated resources
  102992. */
  102993. dispose(): void;
  102994. /**
  102995. * Gets if the sounds is ready to be played or not.
  102996. * @returns true if ready, otherwise false
  102997. */
  102998. isReady(): boolean;
  102999. private _soundLoaded;
  103000. /**
  103001. * Sets the data of the sound from an audiobuffer
  103002. * @param audioBuffer The audioBuffer containing the data
  103003. */
  103004. setAudioBuffer(audioBuffer: AudioBuffer): void;
  103005. /**
  103006. * Updates the current sounds options such as maxdistance, loop...
  103007. * @param options A JSON object containing values named as the object properties
  103008. */
  103009. updateOptions(options: ISoundOptions): void;
  103010. private _createSpatialParameters;
  103011. private _updateSpatialParameters;
  103012. /**
  103013. * Switch the panning model to HRTF:
  103014. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  103015. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103016. */
  103017. switchPanningModelToHRTF(): void;
  103018. /**
  103019. * Switch the panning model to Equal Power:
  103020. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  103021. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103022. */
  103023. switchPanningModelToEqualPower(): void;
  103024. private _switchPanningModel;
  103025. /**
  103026. * Connect this sound to a sound track audio node like gain...
  103027. * @param soundTrackAudioNode the sound track audio node to connect to
  103028. */
  103029. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  103030. /**
  103031. * Transform this sound into a directional source
  103032. * @param coneInnerAngle Size of the inner cone in degree
  103033. * @param coneOuterAngle Size of the outer cone in degree
  103034. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  103035. */
  103036. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  103037. /**
  103038. * Gets or sets the inner angle for the directional cone.
  103039. */
  103040. /**
  103041. * Gets or sets the inner angle for the directional cone.
  103042. */
  103043. directionalConeInnerAngle: number;
  103044. /**
  103045. * Gets or sets the outer angle for the directional cone.
  103046. */
  103047. /**
  103048. * Gets or sets the outer angle for the directional cone.
  103049. */
  103050. directionalConeOuterAngle: number;
  103051. /**
  103052. * Sets the position of the emitter if spatial sound is enabled
  103053. * @param newPosition Defines the new posisiton
  103054. */
  103055. setPosition(newPosition: Vector3): void;
  103056. /**
  103057. * Sets the local direction of the emitter if spatial sound is enabled
  103058. * @param newLocalDirection Defines the new local direction
  103059. */
  103060. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  103061. private _updateDirection;
  103062. /** @hidden */
  103063. updateDistanceFromListener(): void;
  103064. /**
  103065. * Sets a new custom attenuation function for the sound.
  103066. * @param callback Defines the function used for the attenuation
  103067. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  103068. */
  103069. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  103070. /**
  103071. * Play the sound
  103072. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  103073. * @param offset (optional) Start the sound at a specific time in seconds
  103074. * @param length (optional) Sound duration (in seconds)
  103075. */
  103076. play(time?: number, offset?: number, length?: number): void;
  103077. private _onended;
  103078. /**
  103079. * Stop the sound
  103080. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  103081. */
  103082. stop(time?: number): void;
  103083. /**
  103084. * Put the sound in pause
  103085. */
  103086. pause(): void;
  103087. /**
  103088. * Sets a dedicated volume for this sounds
  103089. * @param newVolume Define the new volume of the sound
  103090. * @param time Define time for gradual change to new volume
  103091. */
  103092. setVolume(newVolume: number, time?: number): void;
  103093. /**
  103094. * Set the sound play back rate
  103095. * @param newPlaybackRate Define the playback rate the sound should be played at
  103096. */
  103097. setPlaybackRate(newPlaybackRate: number): void;
  103098. /**
  103099. * Gets the volume of the sound.
  103100. * @returns the volume of the sound
  103101. */
  103102. getVolume(): number;
  103103. /**
  103104. * Attach the sound to a dedicated mesh
  103105. * @param transformNode The transform node to connect the sound with
  103106. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  103107. */
  103108. attachToMesh(transformNode: TransformNode): void;
  103109. /**
  103110. * Detach the sound from the previously attached mesh
  103111. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  103112. */
  103113. detachFromMesh(): void;
  103114. private _onRegisterAfterWorldMatrixUpdate;
  103115. /**
  103116. * Clone the current sound in the scene.
  103117. * @returns the new sound clone
  103118. */
  103119. clone(): Nullable<Sound>;
  103120. /**
  103121. * Gets the current underlying audio buffer containing the data
  103122. * @returns the audio buffer
  103123. */
  103124. getAudioBuffer(): Nullable<AudioBuffer>;
  103125. /**
  103126. * Serializes the Sound in a JSON representation
  103127. * @returns the JSON representation of the sound
  103128. */
  103129. serialize(): any;
  103130. /**
  103131. * Parse a JSON representation of a sound to innstantiate in a given scene
  103132. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  103133. * @param scene Define the scene the new parsed sound should be created in
  103134. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  103135. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  103136. * @returns the newly parsed sound
  103137. */
  103138. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  103139. }
  103140. }
  103141. declare module BABYLON {
  103142. /**
  103143. * This defines an action helpful to play a defined sound on a triggered action.
  103144. */
  103145. export class PlaySoundAction extends Action {
  103146. private _sound;
  103147. /**
  103148. * Instantiate the action
  103149. * @param triggerOptions defines the trigger options
  103150. * @param sound defines the sound to play
  103151. * @param condition defines the trigger related conditions
  103152. */
  103153. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  103154. /** @hidden */
  103155. _prepare(): void;
  103156. /**
  103157. * Execute the action and play the sound.
  103158. */
  103159. execute(): void;
  103160. /**
  103161. * Serializes the actions and its related information.
  103162. * @param parent defines the object to serialize in
  103163. * @returns the serialized object
  103164. */
  103165. serialize(parent: any): any;
  103166. }
  103167. /**
  103168. * This defines an action helpful to stop a defined sound on a triggered action.
  103169. */
  103170. export class StopSoundAction extends Action {
  103171. private _sound;
  103172. /**
  103173. * Instantiate the action
  103174. * @param triggerOptions defines the trigger options
  103175. * @param sound defines the sound to stop
  103176. * @param condition defines the trigger related conditions
  103177. */
  103178. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  103179. /** @hidden */
  103180. _prepare(): void;
  103181. /**
  103182. * Execute the action and stop the sound.
  103183. */
  103184. execute(): void;
  103185. /**
  103186. * Serializes the actions and its related information.
  103187. * @param parent defines the object to serialize in
  103188. * @returns the serialized object
  103189. */
  103190. serialize(parent: any): any;
  103191. }
  103192. }
  103193. declare module BABYLON {
  103194. /**
  103195. * This defines an action responsible to change the value of a property
  103196. * by interpolating between its current value and the newly set one once triggered.
  103197. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  103198. */
  103199. export class InterpolateValueAction extends Action {
  103200. /**
  103201. * Defines the path of the property where the value should be interpolated
  103202. */
  103203. propertyPath: string;
  103204. /**
  103205. * Defines the target value at the end of the interpolation.
  103206. */
  103207. value: any;
  103208. /**
  103209. * Defines the time it will take for the property to interpolate to the value.
  103210. */
  103211. duration: number;
  103212. /**
  103213. * Defines if the other scene animations should be stopped when the action has been triggered
  103214. */
  103215. stopOtherAnimations?: boolean;
  103216. /**
  103217. * Defines a callback raised once the interpolation animation has been done.
  103218. */
  103219. onInterpolationDone?: () => void;
  103220. /**
  103221. * Observable triggered once the interpolation animation has been done.
  103222. */
  103223. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  103224. private _target;
  103225. private _effectiveTarget;
  103226. private _property;
  103227. /**
  103228. * Instantiate the action
  103229. * @param triggerOptions defines the trigger options
  103230. * @param target defines the object containing the value to interpolate
  103231. * @param propertyPath defines the path to the property in the target object
  103232. * @param value defines the target value at the end of the interpolation
  103233. * @param duration deines the time it will take for the property to interpolate to the value.
  103234. * @param condition defines the trigger related conditions
  103235. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  103236. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  103237. */
  103238. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  103239. /** @hidden */
  103240. _prepare(): void;
  103241. /**
  103242. * Execute the action starts the value interpolation.
  103243. */
  103244. execute(): void;
  103245. /**
  103246. * Serializes the actions and its related information.
  103247. * @param parent defines the object to serialize in
  103248. * @returns the serialized object
  103249. */
  103250. serialize(parent: any): any;
  103251. }
  103252. }
  103253. declare module BABYLON {
  103254. /**
  103255. * Options allowed during the creation of a sound track.
  103256. */
  103257. export interface ISoundTrackOptions {
  103258. /**
  103259. * The volume the sound track should take during creation
  103260. */
  103261. volume?: number;
  103262. /**
  103263. * Define if the sound track is the main sound track of the scene
  103264. */
  103265. mainTrack?: boolean;
  103266. }
  103267. /**
  103268. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  103269. * It will be also used in a future release to apply effects on a specific track.
  103270. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  103271. */
  103272. export class SoundTrack {
  103273. /**
  103274. * The unique identifier of the sound track in the scene.
  103275. */
  103276. id: number;
  103277. /**
  103278. * The list of sounds included in the sound track.
  103279. */
  103280. soundCollection: Array<Sound>;
  103281. private _outputAudioNode;
  103282. private _scene;
  103283. private _isMainTrack;
  103284. private _connectedAnalyser;
  103285. private _options;
  103286. private _isInitialized;
  103287. /**
  103288. * Creates a new sound track.
  103289. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  103290. * @param scene Define the scene the sound track belongs to
  103291. * @param options
  103292. */
  103293. constructor(scene: Scene, options?: ISoundTrackOptions);
  103294. private _initializeSoundTrackAudioGraph;
  103295. /**
  103296. * Release the sound track and its associated resources
  103297. */
  103298. dispose(): void;
  103299. /**
  103300. * Adds a sound to this sound track
  103301. * @param sound define the cound to add
  103302. * @ignoreNaming
  103303. */
  103304. AddSound(sound: Sound): void;
  103305. /**
  103306. * Removes a sound to this sound track
  103307. * @param sound define the cound to remove
  103308. * @ignoreNaming
  103309. */
  103310. RemoveSound(sound: Sound): void;
  103311. /**
  103312. * Set a global volume for the full sound track.
  103313. * @param newVolume Define the new volume of the sound track
  103314. */
  103315. setVolume(newVolume: number): void;
  103316. /**
  103317. * Switch the panning model to HRTF:
  103318. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  103319. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103320. */
  103321. switchPanningModelToHRTF(): void;
  103322. /**
  103323. * Switch the panning model to Equal Power:
  103324. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  103325. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103326. */
  103327. switchPanningModelToEqualPower(): void;
  103328. /**
  103329. * Connect the sound track to an audio analyser allowing some amazing
  103330. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  103331. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  103332. * @param analyser The analyser to connect to the engine
  103333. */
  103334. connectToAnalyser(analyser: Analyser): void;
  103335. }
  103336. }
  103337. declare module BABYLON {
  103338. interface AbstractScene {
  103339. /**
  103340. * The list of sounds used in the scene.
  103341. */
  103342. sounds: Nullable<Array<Sound>>;
  103343. }
  103344. interface Scene {
  103345. /**
  103346. * @hidden
  103347. * Backing field
  103348. */
  103349. _mainSoundTrack: SoundTrack;
  103350. /**
  103351. * The main sound track played by the scene.
  103352. * It cotains your primary collection of sounds.
  103353. */
  103354. mainSoundTrack: SoundTrack;
  103355. /**
  103356. * The list of sound tracks added to the scene
  103357. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103358. */
  103359. soundTracks: Nullable<Array<SoundTrack>>;
  103360. /**
  103361. * Gets a sound using a given name
  103362. * @param name defines the name to search for
  103363. * @return the found sound or null if not found at all.
  103364. */
  103365. getSoundByName(name: string): Nullable<Sound>;
  103366. /**
  103367. * Gets or sets if audio support is enabled
  103368. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103369. */
  103370. audioEnabled: boolean;
  103371. /**
  103372. * Gets or sets if audio will be output to headphones
  103373. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103374. */
  103375. headphone: boolean;
  103376. /**
  103377. * Gets or sets custom audio listener position provider
  103378. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103379. */
  103380. audioListenerPositionProvider: Nullable<() => Vector3>;
  103381. /**
  103382. * Gets or sets a refresh rate when using 3D audio positioning
  103383. */
  103384. audioPositioningRefreshRate: number;
  103385. }
  103386. /**
  103387. * Defines the sound scene component responsible to manage any sounds
  103388. * in a given scene.
  103389. */
  103390. export class AudioSceneComponent implements ISceneSerializableComponent {
  103391. /**
  103392. * The component name helpfull to identify the component in the list of scene components.
  103393. */
  103394. readonly name: string;
  103395. /**
  103396. * The scene the component belongs to.
  103397. */
  103398. scene: Scene;
  103399. private _audioEnabled;
  103400. /**
  103401. * Gets whether audio is enabled or not.
  103402. * Please use related enable/disable method to switch state.
  103403. */
  103404. readonly audioEnabled: boolean;
  103405. private _headphone;
  103406. /**
  103407. * Gets whether audio is outputing to headphone or not.
  103408. * Please use the according Switch methods to change output.
  103409. */
  103410. readonly headphone: boolean;
  103411. /**
  103412. * Gets or sets a refresh rate when using 3D audio positioning
  103413. */
  103414. audioPositioningRefreshRate: number;
  103415. private _audioListenerPositionProvider;
  103416. /**
  103417. * Gets the current audio listener position provider
  103418. */
  103419. /**
  103420. * Sets a custom listener position for all sounds in the scene
  103421. * By default, this is the position of the first active camera
  103422. */
  103423. audioListenerPositionProvider: Nullable<() => Vector3>;
  103424. /**
  103425. * Creates a new instance of the component for the given scene
  103426. * @param scene Defines the scene to register the component in
  103427. */
  103428. constructor(scene: Scene);
  103429. /**
  103430. * Registers the component in a given scene
  103431. */
  103432. register(): void;
  103433. /**
  103434. * Rebuilds the elements related to this component in case of
  103435. * context lost for instance.
  103436. */
  103437. rebuild(): void;
  103438. /**
  103439. * Serializes the component data to the specified json object
  103440. * @param serializationObject The object to serialize to
  103441. */
  103442. serialize(serializationObject: any): void;
  103443. /**
  103444. * Adds all the elements from the container to the scene
  103445. * @param container the container holding the elements
  103446. */
  103447. addFromContainer(container: AbstractScene): void;
  103448. /**
  103449. * Removes all the elements in the container from the scene
  103450. * @param container contains the elements to remove
  103451. * @param dispose if the removed element should be disposed (default: false)
  103452. */
  103453. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  103454. /**
  103455. * Disposes the component and the associated ressources.
  103456. */
  103457. dispose(): void;
  103458. /**
  103459. * Disables audio in the associated scene.
  103460. */
  103461. disableAudio(): void;
  103462. /**
  103463. * Enables audio in the associated scene.
  103464. */
  103465. enableAudio(): void;
  103466. /**
  103467. * Switch audio to headphone output.
  103468. */
  103469. switchAudioModeForHeadphones(): void;
  103470. /**
  103471. * Switch audio to normal speakers.
  103472. */
  103473. switchAudioModeForNormalSpeakers(): void;
  103474. private _cachedCameraDirection;
  103475. private _cachedCameraPosition;
  103476. private _lastCheck;
  103477. private _afterRender;
  103478. }
  103479. }
  103480. declare module BABYLON {
  103481. /**
  103482. * Wraps one or more Sound objects and selects one with random weight for playback.
  103483. */
  103484. export class WeightedSound {
  103485. /** When true a Sound will be selected and played when the current playing Sound completes. */
  103486. loop: boolean;
  103487. private _coneInnerAngle;
  103488. private _coneOuterAngle;
  103489. private _volume;
  103490. /** A Sound is currently playing. */
  103491. isPlaying: boolean;
  103492. /** A Sound is currently paused. */
  103493. isPaused: boolean;
  103494. private _sounds;
  103495. private _weights;
  103496. private _currentIndex?;
  103497. /**
  103498. * Creates a new WeightedSound from the list of sounds given.
  103499. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  103500. * @param sounds Array of Sounds that will be selected from.
  103501. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  103502. */
  103503. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  103504. /**
  103505. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  103506. */
  103507. /**
  103508. * The size of cone in degress for a directional sound in which there will be no attenuation.
  103509. */
  103510. directionalConeInnerAngle: number;
  103511. /**
  103512. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  103513. * Listener angles between innerAngle and outerAngle will falloff linearly.
  103514. */
  103515. /**
  103516. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  103517. * Listener angles between innerAngle and outerAngle will falloff linearly.
  103518. */
  103519. directionalConeOuterAngle: number;
  103520. /**
  103521. * Playback volume.
  103522. */
  103523. /**
  103524. * Playback volume.
  103525. */
  103526. volume: number;
  103527. private _onended;
  103528. /**
  103529. * Suspend playback
  103530. */
  103531. pause(): void;
  103532. /**
  103533. * Stop playback
  103534. */
  103535. stop(): void;
  103536. /**
  103537. * Start playback.
  103538. * @param startOffset Position the clip head at a specific time in seconds.
  103539. */
  103540. play(startOffset?: number): void;
  103541. }
  103542. }
  103543. declare module BABYLON {
  103544. /**
  103545. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  103546. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  103547. */
  103548. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  103549. /**
  103550. * Gets the name of the behavior.
  103551. */
  103552. readonly name: string;
  103553. /**
  103554. * The easing function used by animations
  103555. */
  103556. static EasingFunction: BackEase;
  103557. /**
  103558. * The easing mode used by animations
  103559. */
  103560. static EasingMode: number;
  103561. /**
  103562. * The duration of the animation, in milliseconds
  103563. */
  103564. transitionDuration: number;
  103565. /**
  103566. * Length of the distance animated by the transition when lower radius is reached
  103567. */
  103568. lowerRadiusTransitionRange: number;
  103569. /**
  103570. * Length of the distance animated by the transition when upper radius is reached
  103571. */
  103572. upperRadiusTransitionRange: number;
  103573. private _autoTransitionRange;
  103574. /**
  103575. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  103576. */
  103577. /**
  103578. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  103579. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  103580. */
  103581. autoTransitionRange: boolean;
  103582. private _attachedCamera;
  103583. private _onAfterCheckInputsObserver;
  103584. private _onMeshTargetChangedObserver;
  103585. /**
  103586. * Initializes the behavior.
  103587. */
  103588. init(): void;
  103589. /**
  103590. * Attaches the behavior to its arc rotate camera.
  103591. * @param camera Defines the camera to attach the behavior to
  103592. */
  103593. attach(camera: ArcRotateCamera): void;
  103594. /**
  103595. * Detaches the behavior from its current arc rotate camera.
  103596. */
  103597. detach(): void;
  103598. private _radiusIsAnimating;
  103599. private _radiusBounceTransition;
  103600. private _animatables;
  103601. private _cachedWheelPrecision;
  103602. /**
  103603. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  103604. * @param radiusLimit The limit to check against.
  103605. * @return Bool to indicate if at limit.
  103606. */
  103607. private _isRadiusAtLimit;
  103608. /**
  103609. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  103610. * @param radiusDelta The delta by which to animate to. Can be negative.
  103611. */
  103612. private _applyBoundRadiusAnimation;
  103613. /**
  103614. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  103615. */
  103616. protected _clearAnimationLocks(): void;
  103617. /**
  103618. * Stops and removes all animations that have been applied to the camera
  103619. */
  103620. stopAllAnimations(): void;
  103621. }
  103622. }
  103623. declare module BABYLON {
  103624. /**
  103625. * 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.
  103626. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  103627. */
  103628. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  103629. /**
  103630. * Gets the name of the behavior.
  103631. */
  103632. readonly name: string;
  103633. private _mode;
  103634. private _radiusScale;
  103635. private _positionScale;
  103636. private _defaultElevation;
  103637. private _elevationReturnTime;
  103638. private _elevationReturnWaitTime;
  103639. private _zoomStopsAnimation;
  103640. private _framingTime;
  103641. /**
  103642. * The easing function used by animations
  103643. */
  103644. static EasingFunction: ExponentialEase;
  103645. /**
  103646. * The easing mode used by animations
  103647. */
  103648. static EasingMode: number;
  103649. /**
  103650. * Sets the current mode used by the behavior
  103651. */
  103652. /**
  103653. * Gets current mode used by the behavior.
  103654. */
  103655. mode: number;
  103656. /**
  103657. * Sets the scale applied to the radius (1 by default)
  103658. */
  103659. /**
  103660. * Gets the scale applied to the radius
  103661. */
  103662. radiusScale: number;
  103663. /**
  103664. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  103665. */
  103666. /**
  103667. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  103668. */
  103669. positionScale: number;
  103670. /**
  103671. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  103672. * behaviour is triggered, in radians.
  103673. */
  103674. /**
  103675. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  103676. * behaviour is triggered, in radians.
  103677. */
  103678. defaultElevation: number;
  103679. /**
  103680. * Sets the time (in milliseconds) taken to return to the default beta position.
  103681. * Negative value indicates camera should not return to default.
  103682. */
  103683. /**
  103684. * Gets the time (in milliseconds) taken to return to the default beta position.
  103685. * Negative value indicates camera should not return to default.
  103686. */
  103687. elevationReturnTime: number;
  103688. /**
  103689. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  103690. */
  103691. /**
  103692. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  103693. */
  103694. elevationReturnWaitTime: number;
  103695. /**
  103696. * Sets the flag that indicates if user zooming should stop animation.
  103697. */
  103698. /**
  103699. * Gets the flag that indicates if user zooming should stop animation.
  103700. */
  103701. zoomStopsAnimation: boolean;
  103702. /**
  103703. * Sets the transition time when framing the mesh, in milliseconds
  103704. */
  103705. /**
  103706. * Gets the transition time when framing the mesh, in milliseconds
  103707. */
  103708. framingTime: number;
  103709. /**
  103710. * Define if the behavior should automatically change the configured
  103711. * camera limits and sensibilities.
  103712. */
  103713. autoCorrectCameraLimitsAndSensibility: boolean;
  103714. private _onPrePointerObservableObserver;
  103715. private _onAfterCheckInputsObserver;
  103716. private _onMeshTargetChangedObserver;
  103717. private _attachedCamera;
  103718. private _isPointerDown;
  103719. private _lastInteractionTime;
  103720. /**
  103721. * Initializes the behavior.
  103722. */
  103723. init(): void;
  103724. /**
  103725. * Attaches the behavior to its arc rotate camera.
  103726. * @param camera Defines the camera to attach the behavior to
  103727. */
  103728. attach(camera: ArcRotateCamera): void;
  103729. /**
  103730. * Detaches the behavior from its current arc rotate camera.
  103731. */
  103732. detach(): void;
  103733. private _animatables;
  103734. private _betaIsAnimating;
  103735. private _betaTransition;
  103736. private _radiusTransition;
  103737. private _vectorTransition;
  103738. /**
  103739. * Targets the given mesh and updates zoom level accordingly.
  103740. * @param mesh The mesh to target.
  103741. * @param radius Optional. If a cached radius position already exists, overrides default.
  103742. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  103743. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  103744. * @param onAnimationEnd Callback triggered at the end of the framing animation
  103745. */
  103746. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  103747. /**
  103748. * Targets the given mesh with its children and updates zoom level accordingly.
  103749. * @param mesh The mesh to target.
  103750. * @param radius Optional. If a cached radius position already exists, overrides default.
  103751. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  103752. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  103753. * @param onAnimationEnd Callback triggered at the end of the framing animation
  103754. */
  103755. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  103756. /**
  103757. * Targets the given meshes with their children and updates zoom level accordingly.
  103758. * @param meshes The mesh to target.
  103759. * @param radius Optional. If a cached radius position already exists, overrides default.
  103760. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  103761. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  103762. * @param onAnimationEnd Callback triggered at the end of the framing animation
  103763. */
  103764. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  103765. /**
  103766. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  103767. * @param minimumWorld Determines the smaller position of the bounding box extend
  103768. * @param maximumWorld Determines the bigger position of the bounding box extend
  103769. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  103770. * @param onAnimationEnd Callback triggered at the end of the framing animation
  103771. */
  103772. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  103773. /**
  103774. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  103775. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  103776. * frustum width.
  103777. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  103778. * to fully enclose the mesh in the viewing frustum.
  103779. */
  103780. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  103781. /**
  103782. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  103783. * is automatically returned to its default position (expected to be above ground plane).
  103784. */
  103785. private _maintainCameraAboveGround;
  103786. /**
  103787. * Returns the frustum slope based on the canvas ratio and camera FOV
  103788. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  103789. */
  103790. private _getFrustumSlope;
  103791. /**
  103792. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  103793. */
  103794. private _clearAnimationLocks;
  103795. /**
  103796. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  103797. */
  103798. private _applyUserInteraction;
  103799. /**
  103800. * Stops and removes all animations that have been applied to the camera
  103801. */
  103802. stopAllAnimations(): void;
  103803. /**
  103804. * Gets a value indicating if the user is moving the camera
  103805. */
  103806. readonly isUserIsMoving: boolean;
  103807. /**
  103808. * The camera can move all the way towards the mesh.
  103809. */
  103810. static IgnoreBoundsSizeMode: number;
  103811. /**
  103812. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  103813. */
  103814. static FitFrustumSidesMode: number;
  103815. }
  103816. }
  103817. declare module BABYLON {
  103818. /**
  103819. * Base class for Camera Pointer Inputs.
  103820. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  103821. * for example usage.
  103822. */
  103823. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  103824. /**
  103825. * Defines the camera the input is attached to.
  103826. */
  103827. abstract camera: Camera;
  103828. /**
  103829. * Whether keyboard modifier keys are pressed at time of last mouse event.
  103830. */
  103831. protected _altKey: boolean;
  103832. protected _ctrlKey: boolean;
  103833. protected _metaKey: boolean;
  103834. protected _shiftKey: boolean;
  103835. /**
  103836. * Which mouse buttons were pressed at time of last mouse event.
  103837. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  103838. */
  103839. protected _buttonsPressed: number;
  103840. /**
  103841. * Defines the buttons associated with the input to handle camera move.
  103842. */
  103843. buttons: number[];
  103844. /**
  103845. * Attach the input controls to a specific dom element to get the input from.
  103846. * @param element Defines the element the controls should be listened from
  103847. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  103848. */
  103849. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  103850. /**
  103851. * Detach the current controls from the specified dom element.
  103852. * @param element Defines the element to stop listening the inputs from
  103853. */
  103854. detachControl(element: Nullable<HTMLElement>): void;
  103855. /**
  103856. * Gets the class name of the current input.
  103857. * @returns the class name
  103858. */
  103859. getClassName(): string;
  103860. /**
  103861. * Get the friendly name associated with the input class.
  103862. * @returns the input friendly name
  103863. */
  103864. getSimpleName(): string;
  103865. /**
  103866. * Called on pointer POINTERDOUBLETAP event.
  103867. * Override this method to provide functionality on POINTERDOUBLETAP event.
  103868. */
  103869. protected onDoubleTap(type: string): void;
  103870. /**
  103871. * Called on pointer POINTERMOVE event if only a single touch is active.
  103872. * Override this method to provide functionality.
  103873. */
  103874. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  103875. /**
  103876. * Called on pointer POINTERMOVE event if multiple touches are active.
  103877. * Override this method to provide functionality.
  103878. */
  103879. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  103880. /**
  103881. * Called on JS contextmenu event.
  103882. * Override this method to provide functionality.
  103883. */
  103884. protected onContextMenu(evt: PointerEvent): void;
  103885. /**
  103886. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  103887. * press.
  103888. * Override this method to provide functionality.
  103889. */
  103890. protected onButtonDown(evt: PointerEvent): void;
  103891. /**
  103892. * Called each time a new POINTERUP event occurs. Ie, for each button
  103893. * release.
  103894. * Override this method to provide functionality.
  103895. */
  103896. protected onButtonUp(evt: PointerEvent): void;
  103897. /**
  103898. * Called when window becomes inactive.
  103899. * Override this method to provide functionality.
  103900. */
  103901. protected onLostFocus(): void;
  103902. private _pointerInput;
  103903. private _observer;
  103904. private _onLostFocus;
  103905. private pointA;
  103906. private pointB;
  103907. }
  103908. }
  103909. declare module BABYLON {
  103910. /**
  103911. * Manage the pointers inputs to control an arc rotate camera.
  103912. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  103913. */
  103914. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  103915. /**
  103916. * Defines the camera the input is attached to.
  103917. */
  103918. camera: ArcRotateCamera;
  103919. /**
  103920. * Gets the class name of the current input.
  103921. * @returns the class name
  103922. */
  103923. getClassName(): string;
  103924. /**
  103925. * Defines the buttons associated with the input to handle camera move.
  103926. */
  103927. buttons: number[];
  103928. /**
  103929. * Defines the pointer angular sensibility along the X axis or how fast is
  103930. * the camera rotating.
  103931. */
  103932. angularSensibilityX: number;
  103933. /**
  103934. * Defines the pointer angular sensibility along the Y axis or how fast is
  103935. * the camera rotating.
  103936. */
  103937. angularSensibilityY: number;
  103938. /**
  103939. * Defines the pointer pinch precision or how fast is the camera zooming.
  103940. */
  103941. pinchPrecision: number;
  103942. /**
  103943. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  103944. * from 0.
  103945. * It defines the percentage of current camera.radius to use as delta when
  103946. * pinch zoom is used.
  103947. */
  103948. pinchDeltaPercentage: number;
  103949. /**
  103950. * Defines the pointer panning sensibility or how fast is the camera moving.
  103951. */
  103952. panningSensibility: number;
  103953. /**
  103954. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  103955. */
  103956. multiTouchPanning: boolean;
  103957. /**
  103958. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  103959. * zoom (pinch) through multitouch.
  103960. */
  103961. multiTouchPanAndZoom: boolean;
  103962. /**
  103963. * Revers pinch action direction.
  103964. */
  103965. pinchInwards: boolean;
  103966. private _isPanClick;
  103967. private _twoFingerActivityCount;
  103968. private _isPinching;
  103969. /**
  103970. * Called on pointer POINTERMOVE event if only a single touch is active.
  103971. */
  103972. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  103973. /**
  103974. * Called on pointer POINTERDOUBLETAP event.
  103975. */
  103976. protected onDoubleTap(type: string): void;
  103977. /**
  103978. * Called on pointer POINTERMOVE event if multiple touches are active.
  103979. */
  103980. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  103981. /**
  103982. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  103983. * press.
  103984. */
  103985. protected onButtonDown(evt: PointerEvent): void;
  103986. /**
  103987. * Called each time a new POINTERUP event occurs. Ie, for each button
  103988. * release.
  103989. */
  103990. protected onButtonUp(evt: PointerEvent): void;
  103991. /**
  103992. * Called when window becomes inactive.
  103993. */
  103994. protected onLostFocus(): void;
  103995. }
  103996. }
  103997. declare module BABYLON {
  103998. /**
  103999. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  104000. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  104001. */
  104002. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  104003. /**
  104004. * Defines the camera the input is attached to.
  104005. */
  104006. camera: ArcRotateCamera;
  104007. /**
  104008. * Defines the list of key codes associated with the up action (increase alpha)
  104009. */
  104010. keysUp: number[];
  104011. /**
  104012. * Defines the list of key codes associated with the down action (decrease alpha)
  104013. */
  104014. keysDown: number[];
  104015. /**
  104016. * Defines the list of key codes associated with the left action (increase beta)
  104017. */
  104018. keysLeft: number[];
  104019. /**
  104020. * Defines the list of key codes associated with the right action (decrease beta)
  104021. */
  104022. keysRight: number[];
  104023. /**
  104024. * Defines the list of key codes associated with the reset action.
  104025. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  104026. */
  104027. keysReset: number[];
  104028. /**
  104029. * Defines the panning sensibility of the inputs.
  104030. * (How fast is the camera paning)
  104031. */
  104032. panningSensibility: number;
  104033. /**
  104034. * Defines the zooming sensibility of the inputs.
  104035. * (How fast is the camera zooming)
  104036. */
  104037. zoomingSensibility: number;
  104038. /**
  104039. * Defines wether maintaining the alt key down switch the movement mode from
  104040. * orientation to zoom.
  104041. */
  104042. useAltToZoom: boolean;
  104043. /**
  104044. * Rotation speed of the camera
  104045. */
  104046. angularSpeed: number;
  104047. private _keys;
  104048. private _ctrlPressed;
  104049. private _altPressed;
  104050. private _onCanvasBlurObserver;
  104051. private _onKeyboardObserver;
  104052. private _engine;
  104053. private _scene;
  104054. /**
  104055. * Attach the input controls to a specific dom element to get the input from.
  104056. * @param element Defines the element the controls should be listened from
  104057. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  104058. */
  104059. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  104060. /**
  104061. * Detach the current controls from the specified dom element.
  104062. * @param element Defines the element to stop listening the inputs from
  104063. */
  104064. detachControl(element: Nullable<HTMLElement>): void;
  104065. /**
  104066. * Update the current camera state depending on the inputs that have been used this frame.
  104067. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  104068. */
  104069. checkInputs(): void;
  104070. /**
  104071. * Gets the class name of the current intput.
  104072. * @returns the class name
  104073. */
  104074. getClassName(): string;
  104075. /**
  104076. * Get the friendly name associated with the input class.
  104077. * @returns the input friendly name
  104078. */
  104079. getSimpleName(): string;
  104080. }
  104081. }
  104082. declare module BABYLON {
  104083. /**
  104084. * Manage the mouse wheel inputs to control an arc rotate camera.
  104085. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  104086. */
  104087. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  104088. /**
  104089. * Defines the camera the input is attached to.
  104090. */
  104091. camera: ArcRotateCamera;
  104092. /**
  104093. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  104094. */
  104095. wheelPrecision: number;
  104096. /**
  104097. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  104098. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  104099. */
  104100. wheelDeltaPercentage: number;
  104101. private _wheel;
  104102. private _observer;
  104103. private computeDeltaFromMouseWheelLegacyEvent;
  104104. /**
  104105. * Attach the input controls to a specific dom element to get the input from.
  104106. * @param element Defines the element the controls should be listened from
  104107. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  104108. */
  104109. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  104110. /**
  104111. * Detach the current controls from the specified dom element.
  104112. * @param element Defines the element to stop listening the inputs from
  104113. */
  104114. detachControl(element: Nullable<HTMLElement>): void;
  104115. /**
  104116. * Gets the class name of the current intput.
  104117. * @returns the class name
  104118. */
  104119. getClassName(): string;
  104120. /**
  104121. * Get the friendly name associated with the input class.
  104122. * @returns the input friendly name
  104123. */
  104124. getSimpleName(): string;
  104125. }
  104126. }
  104127. declare module BABYLON {
  104128. /**
  104129. * Default Inputs manager for the ArcRotateCamera.
  104130. * It groups all the default supported inputs for ease of use.
  104131. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  104132. */
  104133. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  104134. /**
  104135. * Instantiates a new ArcRotateCameraInputsManager.
  104136. * @param camera Defines the camera the inputs belong to
  104137. */
  104138. constructor(camera: ArcRotateCamera);
  104139. /**
  104140. * Add mouse wheel input support to the input manager.
  104141. * @returns the current input manager
  104142. */
  104143. addMouseWheel(): ArcRotateCameraInputsManager;
  104144. /**
  104145. * Add pointers input support to the input manager.
  104146. * @returns the current input manager
  104147. */
  104148. addPointers(): ArcRotateCameraInputsManager;
  104149. /**
  104150. * Add keyboard input support to the input manager.
  104151. * @returns the current input manager
  104152. */
  104153. addKeyboard(): ArcRotateCameraInputsManager;
  104154. }
  104155. }
  104156. declare module BABYLON {
  104157. /**
  104158. * This represents an orbital type of camera.
  104159. *
  104160. * 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.
  104161. * 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.
  104162. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  104163. */
  104164. export class ArcRotateCamera extends TargetCamera {
  104165. /**
  104166. * Defines the rotation angle of the camera along the longitudinal axis.
  104167. */
  104168. alpha: number;
  104169. /**
  104170. * Defines the rotation angle of the camera along the latitudinal axis.
  104171. */
  104172. beta: number;
  104173. /**
  104174. * Defines the radius of the camera from it s target point.
  104175. */
  104176. radius: number;
  104177. protected _target: Vector3;
  104178. protected _targetHost: Nullable<AbstractMesh>;
  104179. /**
  104180. * Defines the target point of the camera.
  104181. * The camera looks towards it form the radius distance.
  104182. */
  104183. target: Vector3;
  104184. /**
  104185. * Define the current local position of the camera in the scene
  104186. */
  104187. position: Vector3;
  104188. protected _upVector: Vector3;
  104189. protected _upToYMatrix: Matrix;
  104190. protected _YToUpMatrix: Matrix;
  104191. /**
  104192. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  104193. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  104194. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  104195. */
  104196. upVector: Vector3;
  104197. /**
  104198. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  104199. */
  104200. setMatUp(): void;
  104201. /**
  104202. * Current inertia value on the longitudinal axis.
  104203. * The bigger this number the longer it will take for the camera to stop.
  104204. */
  104205. inertialAlphaOffset: number;
  104206. /**
  104207. * Current inertia value on the latitudinal axis.
  104208. * The bigger this number the longer it will take for the camera to stop.
  104209. */
  104210. inertialBetaOffset: number;
  104211. /**
  104212. * Current inertia value on the radius axis.
  104213. * The bigger this number the longer it will take for the camera to stop.
  104214. */
  104215. inertialRadiusOffset: number;
  104216. /**
  104217. * Minimum allowed angle on the longitudinal axis.
  104218. * This can help limiting how the Camera is able to move in the scene.
  104219. */
  104220. lowerAlphaLimit: Nullable<number>;
  104221. /**
  104222. * Maximum allowed angle on the longitudinal axis.
  104223. * This can help limiting how the Camera is able to move in the scene.
  104224. */
  104225. upperAlphaLimit: Nullable<number>;
  104226. /**
  104227. * Minimum allowed angle on the latitudinal axis.
  104228. * This can help limiting how the Camera is able to move in the scene.
  104229. */
  104230. lowerBetaLimit: number;
  104231. /**
  104232. * Maximum allowed angle on the latitudinal axis.
  104233. * This can help limiting how the Camera is able to move in the scene.
  104234. */
  104235. upperBetaLimit: number;
  104236. /**
  104237. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  104238. * This can help limiting how the Camera is able to move in the scene.
  104239. */
  104240. lowerRadiusLimit: Nullable<number>;
  104241. /**
  104242. * Maximum allowed distance of the camera to the target (The camera can not get further).
  104243. * This can help limiting how the Camera is able to move in the scene.
  104244. */
  104245. upperRadiusLimit: Nullable<number>;
  104246. /**
  104247. * Defines the current inertia value used during panning of the camera along the X axis.
  104248. */
  104249. inertialPanningX: number;
  104250. /**
  104251. * Defines the current inertia value used during panning of the camera along the Y axis.
  104252. */
  104253. inertialPanningY: number;
  104254. /**
  104255. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  104256. * Basically if your fingers moves away from more than this distance you will be considered
  104257. * in pinch mode.
  104258. */
  104259. pinchToPanMaxDistance: number;
  104260. /**
  104261. * Defines the maximum distance the camera can pan.
  104262. * This could help keeping the cammera always in your scene.
  104263. */
  104264. panningDistanceLimit: Nullable<number>;
  104265. /**
  104266. * Defines the target of the camera before paning.
  104267. */
  104268. panningOriginTarget: Vector3;
  104269. /**
  104270. * Defines the value of the inertia used during panning.
  104271. * 0 would mean stop inertia and one would mean no decelleration at all.
  104272. */
  104273. panningInertia: number;
  104274. /**
  104275. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  104276. */
  104277. angularSensibilityX: number;
  104278. /**
  104279. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  104280. */
  104281. angularSensibilityY: number;
  104282. /**
  104283. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  104284. */
  104285. pinchPrecision: number;
  104286. /**
  104287. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  104288. * It will be used instead of pinchDeltaPrecision if different from 0.
  104289. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  104290. */
  104291. pinchDeltaPercentage: number;
  104292. /**
  104293. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  104294. */
  104295. panningSensibility: number;
  104296. /**
  104297. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  104298. */
  104299. keysUp: number[];
  104300. /**
  104301. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  104302. */
  104303. keysDown: number[];
  104304. /**
  104305. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  104306. */
  104307. keysLeft: number[];
  104308. /**
  104309. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  104310. */
  104311. keysRight: number[];
  104312. /**
  104313. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  104314. */
  104315. wheelPrecision: number;
  104316. /**
  104317. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  104318. * It will be used instead of pinchDeltaPrecision if different from 0.
  104319. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  104320. */
  104321. wheelDeltaPercentage: number;
  104322. /**
  104323. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  104324. */
  104325. zoomOnFactor: number;
  104326. /**
  104327. * Defines a screen offset for the camera position.
  104328. */
  104329. targetScreenOffset: Vector2;
  104330. /**
  104331. * Allows the camera to be completely reversed.
  104332. * If false the camera can not arrive upside down.
  104333. */
  104334. allowUpsideDown: boolean;
  104335. /**
  104336. * Define if double tap/click is used to restore the previously saved state of the camera.
  104337. */
  104338. useInputToRestoreState: boolean;
  104339. /** @hidden */
  104340. _viewMatrix: Matrix;
  104341. /** @hidden */
  104342. _useCtrlForPanning: boolean;
  104343. /** @hidden */
  104344. _panningMouseButton: number;
  104345. /**
  104346. * Defines the input associated to the camera.
  104347. */
  104348. inputs: ArcRotateCameraInputsManager;
  104349. /** @hidden */
  104350. _reset: () => void;
  104351. /**
  104352. * Defines the allowed panning axis.
  104353. */
  104354. panningAxis: Vector3;
  104355. protected _localDirection: Vector3;
  104356. protected _transformedDirection: Vector3;
  104357. private _bouncingBehavior;
  104358. /**
  104359. * Gets the bouncing behavior of the camera if it has been enabled.
  104360. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  104361. */
  104362. readonly bouncingBehavior: Nullable<BouncingBehavior>;
  104363. /**
  104364. * Defines if the bouncing behavior of the camera is enabled on the camera.
  104365. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  104366. */
  104367. useBouncingBehavior: boolean;
  104368. private _framingBehavior;
  104369. /**
  104370. * Gets the framing behavior of the camera if it has been enabled.
  104371. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  104372. */
  104373. readonly framingBehavior: Nullable<FramingBehavior>;
  104374. /**
  104375. * Defines if the framing behavior of the camera is enabled on the camera.
  104376. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  104377. */
  104378. useFramingBehavior: boolean;
  104379. private _autoRotationBehavior;
  104380. /**
  104381. * Gets the auto rotation behavior of the camera if it has been enabled.
  104382. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  104383. */
  104384. readonly autoRotationBehavior: Nullable<AutoRotationBehavior>;
  104385. /**
  104386. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  104387. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  104388. */
  104389. useAutoRotationBehavior: boolean;
  104390. /**
  104391. * Observable triggered when the mesh target has been changed on the camera.
  104392. */
  104393. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  104394. /**
  104395. * Event raised when the camera is colliding with a mesh.
  104396. */
  104397. onCollide: (collidedMesh: AbstractMesh) => void;
  104398. /**
  104399. * Defines whether the camera should check collision with the objects oh the scene.
  104400. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  104401. */
  104402. checkCollisions: boolean;
  104403. /**
  104404. * Defines the collision radius of the camera.
  104405. * This simulates a sphere around the camera.
  104406. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  104407. */
  104408. collisionRadius: Vector3;
  104409. protected _collider: Collider;
  104410. protected _previousPosition: Vector3;
  104411. protected _collisionVelocity: Vector3;
  104412. protected _newPosition: Vector3;
  104413. protected _previousAlpha: number;
  104414. protected _previousBeta: number;
  104415. protected _previousRadius: number;
  104416. protected _collisionTriggered: boolean;
  104417. protected _targetBoundingCenter: Nullable<Vector3>;
  104418. private _computationVector;
  104419. /**
  104420. * Instantiates a new ArcRotateCamera in a given scene
  104421. * @param name Defines the name of the camera
  104422. * @param alpha Defines the camera rotation along the logitudinal axis
  104423. * @param beta Defines the camera rotation along the latitudinal axis
  104424. * @param radius Defines the camera distance from its target
  104425. * @param target Defines the camera target
  104426. * @param scene Defines the scene the camera belongs to
  104427. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  104428. */
  104429. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  104430. /** @hidden */
  104431. _initCache(): void;
  104432. /** @hidden */
  104433. _updateCache(ignoreParentClass?: boolean): void;
  104434. protected _getTargetPosition(): Vector3;
  104435. private _storedAlpha;
  104436. private _storedBeta;
  104437. private _storedRadius;
  104438. private _storedTarget;
  104439. private _storedTargetScreenOffset;
  104440. /**
  104441. * Stores the current state of the camera (alpha, beta, radius and target)
  104442. * @returns the camera itself
  104443. */
  104444. storeState(): Camera;
  104445. /**
  104446. * @hidden
  104447. * Restored camera state. You must call storeState() first
  104448. */
  104449. _restoreStateValues(): boolean;
  104450. /** @hidden */
  104451. _isSynchronizedViewMatrix(): boolean;
  104452. /**
  104453. * Attached controls to the current camera.
  104454. * @param element Defines the element the controls should be listened from
  104455. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  104456. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  104457. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  104458. */
  104459. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  104460. /**
  104461. * Detach the current controls from the camera.
  104462. * The camera will stop reacting to inputs.
  104463. * @param element Defines the element to stop listening the inputs from
  104464. */
  104465. detachControl(element: HTMLElement): void;
  104466. /** @hidden */
  104467. _checkInputs(): void;
  104468. protected _checkLimits(): void;
  104469. /**
  104470. * Rebuilds angles (alpha, beta) and radius from the give position and target
  104471. */
  104472. rebuildAnglesAndRadius(): void;
  104473. /**
  104474. * Use a position to define the current camera related information like alpha, beta and radius
  104475. * @param position Defines the position to set the camera at
  104476. */
  104477. setPosition(position: Vector3): void;
  104478. /**
  104479. * Defines the target the camera should look at.
  104480. * This will automatically adapt alpha beta and radius to fit within the new target.
  104481. * @param target Defines the new target as a Vector or a mesh
  104482. * @param toBoundingCenter In case of a mesh target, defines wether to target the mesh position or its bounding information center
  104483. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  104484. */
  104485. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  104486. /** @hidden */
  104487. _getViewMatrix(): Matrix;
  104488. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  104489. /**
  104490. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  104491. * @param meshes Defines the mesh to zoom on
  104492. * @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)
  104493. */
  104494. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  104495. /**
  104496. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  104497. * The target will be changed but the radius
  104498. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  104499. * @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)
  104500. */
  104501. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  104502. min: Vector3;
  104503. max: Vector3;
  104504. distance: number;
  104505. }, doNotUpdateMaxZ?: boolean): void;
  104506. /**
  104507. * @override
  104508. * Override Camera.createRigCamera
  104509. */
  104510. createRigCamera(name: string, cameraIndex: number): Camera;
  104511. /**
  104512. * @hidden
  104513. * @override
  104514. * Override Camera._updateRigCameras
  104515. */
  104516. _updateRigCameras(): void;
  104517. /**
  104518. * Destroy the camera and release the current resources hold by it.
  104519. */
  104520. dispose(): void;
  104521. /**
  104522. * Gets the current object class name.
  104523. * @return the class name
  104524. */
  104525. getClassName(): string;
  104526. }
  104527. }
  104528. declare module BABYLON {
  104529. /**
  104530. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  104531. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  104532. */
  104533. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  104534. /**
  104535. * Gets the name of the behavior.
  104536. */
  104537. readonly name: string;
  104538. private _zoomStopsAnimation;
  104539. private _idleRotationSpeed;
  104540. private _idleRotationWaitTime;
  104541. private _idleRotationSpinupTime;
  104542. /**
  104543. * Sets the flag that indicates if user zooming should stop animation.
  104544. */
  104545. /**
  104546. * Gets the flag that indicates if user zooming should stop animation.
  104547. */
  104548. zoomStopsAnimation: boolean;
  104549. /**
  104550. * Sets the default speed at which the camera rotates around the model.
  104551. */
  104552. /**
  104553. * Gets the default speed at which the camera rotates around the model.
  104554. */
  104555. idleRotationSpeed: number;
  104556. /**
  104557. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  104558. */
  104559. /**
  104560. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  104561. */
  104562. idleRotationWaitTime: number;
  104563. /**
  104564. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  104565. */
  104566. /**
  104567. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  104568. */
  104569. idleRotationSpinupTime: number;
  104570. /**
  104571. * Gets a value indicating if the camera is currently rotating because of this behavior
  104572. */
  104573. readonly rotationInProgress: boolean;
  104574. private _onPrePointerObservableObserver;
  104575. private _onAfterCheckInputsObserver;
  104576. private _attachedCamera;
  104577. private _isPointerDown;
  104578. private _lastFrameTime;
  104579. private _lastInteractionTime;
  104580. private _cameraRotationSpeed;
  104581. /**
  104582. * Initializes the behavior.
  104583. */
  104584. init(): void;
  104585. /**
  104586. * Attaches the behavior to its arc rotate camera.
  104587. * @param camera Defines the camera to attach the behavior to
  104588. */
  104589. attach(camera: ArcRotateCamera): void;
  104590. /**
  104591. * Detaches the behavior from its current arc rotate camera.
  104592. */
  104593. detach(): void;
  104594. /**
  104595. * Returns true if user is scrolling.
  104596. * @return true if user is scrolling.
  104597. */
  104598. private _userIsZooming;
  104599. private _lastFrameRadius;
  104600. private _shouldAnimationStopForInteraction;
  104601. /**
  104602. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  104603. */
  104604. private _applyUserInteraction;
  104605. private _userIsMoving;
  104606. }
  104607. }
  104608. declare module BABYLON {
  104609. /**
  104610. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  104611. */
  104612. export class AttachToBoxBehavior implements Behavior<Mesh> {
  104613. private ui;
  104614. /**
  104615. * The name of the behavior
  104616. */
  104617. name: string;
  104618. /**
  104619. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  104620. */
  104621. distanceAwayFromFace: number;
  104622. /**
  104623. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  104624. */
  104625. distanceAwayFromBottomOfFace: number;
  104626. private _faceVectors;
  104627. private _target;
  104628. private _scene;
  104629. private _onRenderObserver;
  104630. private _tmpMatrix;
  104631. private _tmpVector;
  104632. /**
  104633. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  104634. * @param ui The transform node that should be attched to the mesh
  104635. */
  104636. constructor(ui: TransformNode);
  104637. /**
  104638. * Initializes the behavior
  104639. */
  104640. init(): void;
  104641. private _closestFace;
  104642. private _zeroVector;
  104643. private _lookAtTmpMatrix;
  104644. private _lookAtToRef;
  104645. /**
  104646. * Attaches the AttachToBoxBehavior to the passed in mesh
  104647. * @param target The mesh that the specified node will be attached to
  104648. */
  104649. attach(target: Mesh): void;
  104650. /**
  104651. * Detaches the behavior from the mesh
  104652. */
  104653. detach(): void;
  104654. }
  104655. }
  104656. declare module BABYLON {
  104657. /**
  104658. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  104659. */
  104660. export class FadeInOutBehavior implements Behavior<Mesh> {
  104661. /**
  104662. * Time in milliseconds to delay before fading in (Default: 0)
  104663. */
  104664. delay: number;
  104665. /**
  104666. * Time in milliseconds for the mesh to fade in (Default: 300)
  104667. */
  104668. fadeInTime: number;
  104669. private _millisecondsPerFrame;
  104670. private _hovered;
  104671. private _hoverValue;
  104672. private _ownerNode;
  104673. /**
  104674. * Instatiates the FadeInOutBehavior
  104675. */
  104676. constructor();
  104677. /**
  104678. * The name of the behavior
  104679. */
  104680. readonly name: string;
  104681. /**
  104682. * Initializes the behavior
  104683. */
  104684. init(): void;
  104685. /**
  104686. * Attaches the fade behavior on the passed in mesh
  104687. * @param ownerNode The mesh that will be faded in/out once attached
  104688. */
  104689. attach(ownerNode: Mesh): void;
  104690. /**
  104691. * Detaches the behavior from the mesh
  104692. */
  104693. detach(): void;
  104694. /**
  104695. * Triggers the mesh to begin fading in or out
  104696. * @param value if the object should fade in or out (true to fade in)
  104697. */
  104698. fadeIn(value: boolean): void;
  104699. private _update;
  104700. private _setAllVisibility;
  104701. }
  104702. }
  104703. declare module BABYLON {
  104704. /**
  104705. * Class containing a set of static utilities functions for managing Pivots
  104706. * @hidden
  104707. */
  104708. export class PivotTools {
  104709. private static _PivotCached;
  104710. private static _OldPivotPoint;
  104711. private static _PivotTranslation;
  104712. private static _PivotTmpVector;
  104713. /** @hidden */
  104714. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  104715. /** @hidden */
  104716. static _RestorePivotPoint(mesh: AbstractMesh): void;
  104717. }
  104718. }
  104719. declare module BABYLON {
  104720. /**
  104721. * Class containing static functions to help procedurally build meshes
  104722. */
  104723. export class PlaneBuilder {
  104724. /**
  104725. * Creates a plane mesh
  104726. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  104727. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  104728. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  104729. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  104730. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  104731. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  104732. * @param name defines the name of the mesh
  104733. * @param options defines the options used to create the mesh
  104734. * @param scene defines the hosting scene
  104735. * @returns the plane mesh
  104736. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  104737. */
  104738. static CreatePlane(name: string, options: {
  104739. size?: number;
  104740. width?: number;
  104741. height?: number;
  104742. sideOrientation?: number;
  104743. frontUVs?: Vector4;
  104744. backUVs?: Vector4;
  104745. updatable?: boolean;
  104746. sourcePlane?: Plane;
  104747. }, scene?: Nullable<Scene>): Mesh;
  104748. }
  104749. }
  104750. declare module BABYLON {
  104751. /**
  104752. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  104753. */
  104754. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  104755. private static _AnyMouseID;
  104756. /**
  104757. * Abstract mesh the behavior is set on
  104758. */
  104759. attachedNode: AbstractMesh;
  104760. private _dragPlane;
  104761. private _scene;
  104762. private _pointerObserver;
  104763. private _beforeRenderObserver;
  104764. private static _planeScene;
  104765. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  104766. /**
  104767. * 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)
  104768. */
  104769. maxDragAngle: number;
  104770. /**
  104771. * @hidden
  104772. */
  104773. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  104774. /**
  104775. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  104776. */
  104777. currentDraggingPointerID: number;
  104778. /**
  104779. * The last position where the pointer hit the drag plane in world space
  104780. */
  104781. lastDragPosition: Vector3;
  104782. /**
  104783. * If the behavior is currently in a dragging state
  104784. */
  104785. dragging: boolean;
  104786. /**
  104787. * 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)
  104788. */
  104789. dragDeltaRatio: number;
  104790. /**
  104791. * If the drag plane orientation should be updated during the dragging (Default: true)
  104792. */
  104793. updateDragPlane: boolean;
  104794. private _debugMode;
  104795. private _moving;
  104796. /**
  104797. * Fires each time the attached mesh is dragged with the pointer
  104798. * * delta between last drag position and current drag position in world space
  104799. * * dragDistance along the drag axis
  104800. * * dragPlaneNormal normal of the current drag plane used during the drag
  104801. * * dragPlanePoint in world space where the drag intersects the drag plane
  104802. */
  104803. onDragObservable: Observable<{
  104804. delta: Vector3;
  104805. dragPlanePoint: Vector3;
  104806. dragPlaneNormal: Vector3;
  104807. dragDistance: number;
  104808. pointerId: number;
  104809. }>;
  104810. /**
  104811. * Fires each time a drag begins (eg. mouse down on mesh)
  104812. */
  104813. onDragStartObservable: Observable<{
  104814. dragPlanePoint: Vector3;
  104815. pointerId: number;
  104816. }>;
  104817. /**
  104818. * Fires each time a drag ends (eg. mouse release after drag)
  104819. */
  104820. onDragEndObservable: Observable<{
  104821. dragPlanePoint: Vector3;
  104822. pointerId: number;
  104823. }>;
  104824. /**
  104825. * If the attached mesh should be moved when dragged
  104826. */
  104827. moveAttached: boolean;
  104828. /**
  104829. * If the drag behavior will react to drag events (Default: true)
  104830. */
  104831. enabled: boolean;
  104832. /**
  104833. * If pointer events should start and release the drag (Default: true)
  104834. */
  104835. startAndReleaseDragOnPointerEvents: boolean;
  104836. /**
  104837. * If camera controls should be detached during the drag
  104838. */
  104839. detachCameraControls: boolean;
  104840. /**
  104841. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  104842. */
  104843. useObjectOrienationForDragging: boolean;
  104844. private _options;
  104845. /**
  104846. * Creates a pointer drag behavior that can be attached to a mesh
  104847. * @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)
  104848. */
  104849. constructor(options?: {
  104850. dragAxis?: Vector3;
  104851. dragPlaneNormal?: Vector3;
  104852. });
  104853. /**
  104854. * Predicate to determine if it is valid to move the object to a new position when it is moved
  104855. */
  104856. validateDrag: (targetPosition: Vector3) => boolean;
  104857. /**
  104858. * The name of the behavior
  104859. */
  104860. readonly name: string;
  104861. /**
  104862. * Initializes the behavior
  104863. */
  104864. init(): void;
  104865. private _tmpVector;
  104866. private _alternatePickedPoint;
  104867. private _worldDragAxis;
  104868. private _targetPosition;
  104869. private _attachedElement;
  104870. /**
  104871. * Attaches the drag behavior the passed in mesh
  104872. * @param ownerNode The mesh that will be dragged around once attached
  104873. * @param predicate Predicate to use for pick filtering
  104874. */
  104875. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  104876. /**
  104877. * Force relase the drag action by code.
  104878. */
  104879. releaseDrag(): void;
  104880. private _startDragRay;
  104881. private _lastPointerRay;
  104882. /**
  104883. * Simulates the start of a pointer drag event on the behavior
  104884. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  104885. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  104886. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  104887. */
  104888. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  104889. private _startDrag;
  104890. private _dragDelta;
  104891. private _moveDrag;
  104892. private _pickWithRayOnDragPlane;
  104893. private _pointA;
  104894. private _pointB;
  104895. private _pointC;
  104896. private _lineA;
  104897. private _lineB;
  104898. private _localAxis;
  104899. private _lookAt;
  104900. private _updateDragPlanePosition;
  104901. /**
  104902. * Detaches the behavior from the mesh
  104903. */
  104904. detach(): void;
  104905. }
  104906. }
  104907. declare module BABYLON {
  104908. /**
  104909. * A behavior that when attached to a mesh will allow the mesh to be scaled
  104910. */
  104911. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  104912. private _dragBehaviorA;
  104913. private _dragBehaviorB;
  104914. private _startDistance;
  104915. private _initialScale;
  104916. private _targetScale;
  104917. private _ownerNode;
  104918. private _sceneRenderObserver;
  104919. /**
  104920. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  104921. */
  104922. constructor();
  104923. /**
  104924. * The name of the behavior
  104925. */
  104926. readonly name: string;
  104927. /**
  104928. * Initializes the behavior
  104929. */
  104930. init(): void;
  104931. private _getCurrentDistance;
  104932. /**
  104933. * Attaches the scale behavior the passed in mesh
  104934. * @param ownerNode The mesh that will be scaled around once attached
  104935. */
  104936. attach(ownerNode: Mesh): void;
  104937. /**
  104938. * Detaches the behavior from the mesh
  104939. */
  104940. detach(): void;
  104941. }
  104942. }
  104943. declare module BABYLON {
  104944. /**
  104945. * 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
  104946. */
  104947. export class SixDofDragBehavior implements Behavior<Mesh> {
  104948. private static _virtualScene;
  104949. private _ownerNode;
  104950. private _sceneRenderObserver;
  104951. private _scene;
  104952. private _targetPosition;
  104953. private _virtualOriginMesh;
  104954. private _virtualDragMesh;
  104955. private _pointerObserver;
  104956. private _moving;
  104957. private _startingOrientation;
  104958. /**
  104959. * 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)
  104960. */
  104961. private zDragFactor;
  104962. /**
  104963. * If the object should rotate to face the drag origin
  104964. */
  104965. rotateDraggedObject: boolean;
  104966. /**
  104967. * If the behavior is currently in a dragging state
  104968. */
  104969. dragging: boolean;
  104970. /**
  104971. * 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)
  104972. */
  104973. dragDeltaRatio: number;
  104974. /**
  104975. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  104976. */
  104977. currentDraggingPointerID: number;
  104978. /**
  104979. * If camera controls should be detached during the drag
  104980. */
  104981. detachCameraControls: boolean;
  104982. /**
  104983. * Fires each time a drag starts
  104984. */
  104985. onDragStartObservable: Observable<{}>;
  104986. /**
  104987. * Fires each time a drag ends (eg. mouse release after drag)
  104988. */
  104989. onDragEndObservable: Observable<{}>;
  104990. /**
  104991. * 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
  104992. */
  104993. constructor();
  104994. /**
  104995. * The name of the behavior
  104996. */
  104997. readonly name: string;
  104998. /**
  104999. * Initializes the behavior
  105000. */
  105001. init(): void;
  105002. /**
  105003. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  105004. */
  105005. private readonly _pointerCamera;
  105006. /**
  105007. * Attaches the scale behavior the passed in mesh
  105008. * @param ownerNode The mesh that will be scaled around once attached
  105009. */
  105010. attach(ownerNode: Mesh): void;
  105011. /**
  105012. * Detaches the behavior from the mesh
  105013. */
  105014. detach(): void;
  105015. }
  105016. }
  105017. declare module BABYLON {
  105018. /**
  105019. * Class used to apply inverse kinematics to bones
  105020. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  105021. */
  105022. export class BoneIKController {
  105023. private static _tmpVecs;
  105024. private static _tmpQuat;
  105025. private static _tmpMats;
  105026. /**
  105027. * Gets or sets the target mesh
  105028. */
  105029. targetMesh: AbstractMesh;
  105030. /** Gets or sets the mesh used as pole */
  105031. poleTargetMesh: AbstractMesh;
  105032. /**
  105033. * Gets or sets the bone used as pole
  105034. */
  105035. poleTargetBone: Nullable<Bone>;
  105036. /**
  105037. * Gets or sets the target position
  105038. */
  105039. targetPosition: Vector3;
  105040. /**
  105041. * Gets or sets the pole target position
  105042. */
  105043. poleTargetPosition: Vector3;
  105044. /**
  105045. * Gets or sets the pole target local offset
  105046. */
  105047. poleTargetLocalOffset: Vector3;
  105048. /**
  105049. * Gets or sets the pole angle
  105050. */
  105051. poleAngle: number;
  105052. /**
  105053. * Gets or sets the mesh associated with the controller
  105054. */
  105055. mesh: AbstractMesh;
  105056. /**
  105057. * 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)
  105058. */
  105059. slerpAmount: number;
  105060. private _bone1Quat;
  105061. private _bone1Mat;
  105062. private _bone2Ang;
  105063. private _bone1;
  105064. private _bone2;
  105065. private _bone1Length;
  105066. private _bone2Length;
  105067. private _maxAngle;
  105068. private _maxReach;
  105069. private _rightHandedSystem;
  105070. private _bendAxis;
  105071. private _slerping;
  105072. private _adjustRoll;
  105073. /**
  105074. * Gets or sets maximum allowed angle
  105075. */
  105076. maxAngle: number;
  105077. /**
  105078. * Creates a new BoneIKController
  105079. * @param mesh defines the mesh to control
  105080. * @param bone defines the bone to control
  105081. * @param options defines options to set up the controller
  105082. */
  105083. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  105084. targetMesh?: AbstractMesh;
  105085. poleTargetMesh?: AbstractMesh;
  105086. poleTargetBone?: Bone;
  105087. poleTargetLocalOffset?: Vector3;
  105088. poleAngle?: number;
  105089. bendAxis?: Vector3;
  105090. maxAngle?: number;
  105091. slerpAmount?: number;
  105092. });
  105093. private _setMaxAngle;
  105094. /**
  105095. * Force the controller to update the bones
  105096. */
  105097. update(): void;
  105098. }
  105099. }
  105100. declare module BABYLON {
  105101. /**
  105102. * Class used to make a bone look toward a point in space
  105103. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  105104. */
  105105. export class BoneLookController {
  105106. private static _tmpVecs;
  105107. private static _tmpQuat;
  105108. private static _tmpMats;
  105109. /**
  105110. * The target Vector3 that the bone will look at
  105111. */
  105112. target: Vector3;
  105113. /**
  105114. * The mesh that the bone is attached to
  105115. */
  105116. mesh: AbstractMesh;
  105117. /**
  105118. * The bone that will be looking to the target
  105119. */
  105120. bone: Bone;
  105121. /**
  105122. * The up axis of the coordinate system that is used when the bone is rotated
  105123. */
  105124. upAxis: Vector3;
  105125. /**
  105126. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  105127. */
  105128. upAxisSpace: Space;
  105129. /**
  105130. * Used to make an adjustment to the yaw of the bone
  105131. */
  105132. adjustYaw: number;
  105133. /**
  105134. * Used to make an adjustment to the pitch of the bone
  105135. */
  105136. adjustPitch: number;
  105137. /**
  105138. * Used to make an adjustment to the roll of the bone
  105139. */
  105140. adjustRoll: number;
  105141. /**
  105142. * 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)
  105143. */
  105144. slerpAmount: number;
  105145. private _minYaw;
  105146. private _maxYaw;
  105147. private _minPitch;
  105148. private _maxPitch;
  105149. private _minYawSin;
  105150. private _minYawCos;
  105151. private _maxYawSin;
  105152. private _maxYawCos;
  105153. private _midYawConstraint;
  105154. private _minPitchTan;
  105155. private _maxPitchTan;
  105156. private _boneQuat;
  105157. private _slerping;
  105158. private _transformYawPitch;
  105159. private _transformYawPitchInv;
  105160. private _firstFrameSkipped;
  105161. private _yawRange;
  105162. private _fowardAxis;
  105163. /**
  105164. * Gets or sets the minimum yaw angle that the bone can look to
  105165. */
  105166. minYaw: number;
  105167. /**
  105168. * Gets or sets the maximum yaw angle that the bone can look to
  105169. */
  105170. maxYaw: number;
  105171. /**
  105172. * Gets or sets the minimum pitch angle that the bone can look to
  105173. */
  105174. minPitch: number;
  105175. /**
  105176. * Gets or sets the maximum pitch angle that the bone can look to
  105177. */
  105178. maxPitch: number;
  105179. /**
  105180. * Create a BoneLookController
  105181. * @param mesh the mesh that the bone belongs to
  105182. * @param bone the bone that will be looking to the target
  105183. * @param target the target Vector3 to look at
  105184. * @param options optional settings:
  105185. * * maxYaw: the maximum angle the bone will yaw to
  105186. * * minYaw: the minimum angle the bone will yaw to
  105187. * * maxPitch: the maximum angle the bone will pitch to
  105188. * * minPitch: the minimum angle the bone will yaw to
  105189. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  105190. * * upAxis: the up axis of the coordinate system
  105191. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  105192. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  105193. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  105194. * * adjustYaw: used to make an adjustment to the yaw of the bone
  105195. * * adjustPitch: used to make an adjustment to the pitch of the bone
  105196. * * adjustRoll: used to make an adjustment to the roll of the bone
  105197. **/
  105198. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  105199. maxYaw?: number;
  105200. minYaw?: number;
  105201. maxPitch?: number;
  105202. minPitch?: number;
  105203. slerpAmount?: number;
  105204. upAxis?: Vector3;
  105205. upAxisSpace?: Space;
  105206. yawAxis?: Vector3;
  105207. pitchAxis?: Vector3;
  105208. adjustYaw?: number;
  105209. adjustPitch?: number;
  105210. adjustRoll?: number;
  105211. });
  105212. /**
  105213. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  105214. */
  105215. update(): void;
  105216. private _getAngleDiff;
  105217. private _getAngleBetween;
  105218. private _isAngleBetween;
  105219. }
  105220. }
  105221. declare module BABYLON {
  105222. /**
  105223. * Manage the gamepad inputs to control an arc rotate camera.
  105224. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105225. */
  105226. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  105227. /**
  105228. * Defines the camera the input is attached to.
  105229. */
  105230. camera: ArcRotateCamera;
  105231. /**
  105232. * Defines the gamepad the input is gathering event from.
  105233. */
  105234. gamepad: Nullable<Gamepad>;
  105235. /**
  105236. * Defines the gamepad rotation sensiblity.
  105237. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  105238. */
  105239. gamepadRotationSensibility: number;
  105240. /**
  105241. * Defines the gamepad move sensiblity.
  105242. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  105243. */
  105244. gamepadMoveSensibility: number;
  105245. private _yAxisScale;
  105246. /**
  105247. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  105248. */
  105249. invertYAxis: boolean;
  105250. private _onGamepadConnectedObserver;
  105251. private _onGamepadDisconnectedObserver;
  105252. /**
  105253. * Attach the input controls to a specific dom element to get the input from.
  105254. * @param element Defines the element the controls should be listened from
  105255. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105256. */
  105257. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105258. /**
  105259. * Detach the current controls from the specified dom element.
  105260. * @param element Defines the element to stop listening the inputs from
  105261. */
  105262. detachControl(element: Nullable<HTMLElement>): void;
  105263. /**
  105264. * Update the current camera state depending on the inputs that have been used this frame.
  105265. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  105266. */
  105267. checkInputs(): void;
  105268. /**
  105269. * Gets the class name of the current intput.
  105270. * @returns the class name
  105271. */
  105272. getClassName(): string;
  105273. /**
  105274. * Get the friendly name associated with the input class.
  105275. * @returns the input friendly name
  105276. */
  105277. getSimpleName(): string;
  105278. }
  105279. }
  105280. declare module BABYLON {
  105281. interface ArcRotateCameraInputsManager {
  105282. /**
  105283. * Add orientation input support to the input manager.
  105284. * @returns the current input manager
  105285. */
  105286. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  105287. }
  105288. /**
  105289. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  105290. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105291. */
  105292. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  105293. /**
  105294. * Defines the camera the input is attached to.
  105295. */
  105296. camera: ArcRotateCamera;
  105297. /**
  105298. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  105299. */
  105300. alphaCorrection: number;
  105301. /**
  105302. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  105303. */
  105304. gammaCorrection: number;
  105305. private _alpha;
  105306. private _gamma;
  105307. private _dirty;
  105308. private _deviceOrientationHandler;
  105309. /**
  105310. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  105311. */
  105312. constructor();
  105313. /**
  105314. * Attach the input controls to a specific dom element to get the input from.
  105315. * @param element Defines the element the controls should be listened from
  105316. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105317. */
  105318. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105319. /** @hidden */
  105320. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  105321. /**
  105322. * Update the current camera state depending on the inputs that have been used this frame.
  105323. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  105324. */
  105325. checkInputs(): void;
  105326. /**
  105327. * Detach the current controls from the specified dom element.
  105328. * @param element Defines the element to stop listening the inputs from
  105329. */
  105330. detachControl(element: Nullable<HTMLElement>): void;
  105331. /**
  105332. * Gets the class name of the current intput.
  105333. * @returns the class name
  105334. */
  105335. getClassName(): string;
  105336. /**
  105337. * Get the friendly name associated with the input class.
  105338. * @returns the input friendly name
  105339. */
  105340. getSimpleName(): string;
  105341. }
  105342. }
  105343. declare module BABYLON {
  105344. /**
  105345. * Listen to mouse events to control the camera.
  105346. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105347. */
  105348. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  105349. /**
  105350. * Defines the camera the input is attached to.
  105351. */
  105352. camera: FlyCamera;
  105353. /**
  105354. * Defines if touch is enabled. (Default is true.)
  105355. */
  105356. touchEnabled: boolean;
  105357. /**
  105358. * Defines the buttons associated with the input to handle camera rotation.
  105359. */
  105360. buttons: number[];
  105361. /**
  105362. * Assign buttons for Yaw control.
  105363. */
  105364. buttonsYaw: number[];
  105365. /**
  105366. * Assign buttons for Pitch control.
  105367. */
  105368. buttonsPitch: number[];
  105369. /**
  105370. * Assign buttons for Roll control.
  105371. */
  105372. buttonsRoll: number[];
  105373. /**
  105374. * Detect if any button is being pressed while mouse is moved.
  105375. * -1 = Mouse locked.
  105376. * 0 = Left button.
  105377. * 1 = Middle Button.
  105378. * 2 = Right Button.
  105379. */
  105380. activeButton: number;
  105381. /**
  105382. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  105383. * Higher values reduce its sensitivity.
  105384. */
  105385. angularSensibility: number;
  105386. private _mousemoveCallback;
  105387. private _observer;
  105388. private _rollObserver;
  105389. private previousPosition;
  105390. private noPreventDefault;
  105391. private element;
  105392. /**
  105393. * Listen to mouse events to control the camera.
  105394. * @param touchEnabled Define if touch is enabled. (Default is true.)
  105395. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105396. */
  105397. constructor(touchEnabled?: boolean);
  105398. /**
  105399. * Attach the mouse control to the HTML DOM element.
  105400. * @param element Defines the element that listens to the input events.
  105401. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  105402. */
  105403. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105404. /**
  105405. * Detach the current controls from the specified dom element.
  105406. * @param element Defines the element to stop listening the inputs from
  105407. */
  105408. detachControl(element: Nullable<HTMLElement>): void;
  105409. /**
  105410. * Gets the class name of the current input.
  105411. * @returns the class name.
  105412. */
  105413. getClassName(): string;
  105414. /**
  105415. * Get the friendly name associated with the input class.
  105416. * @returns the input's friendly name.
  105417. */
  105418. getSimpleName(): string;
  105419. private _pointerInput;
  105420. private _onMouseMove;
  105421. /**
  105422. * Rotate camera by mouse offset.
  105423. */
  105424. private rotateCamera;
  105425. }
  105426. }
  105427. declare module BABYLON {
  105428. /**
  105429. * Default Inputs manager for the FlyCamera.
  105430. * It groups all the default supported inputs for ease of use.
  105431. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105432. */
  105433. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  105434. /**
  105435. * Instantiates a new FlyCameraInputsManager.
  105436. * @param camera Defines the camera the inputs belong to.
  105437. */
  105438. constructor(camera: FlyCamera);
  105439. /**
  105440. * Add keyboard input support to the input manager.
  105441. * @returns the new FlyCameraKeyboardMoveInput().
  105442. */
  105443. addKeyboard(): FlyCameraInputsManager;
  105444. /**
  105445. * Add mouse input support to the input manager.
  105446. * @param touchEnabled Enable touch screen support.
  105447. * @returns the new FlyCameraMouseInput().
  105448. */
  105449. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  105450. }
  105451. }
  105452. declare module BABYLON {
  105453. /**
  105454. * This is a flying camera, designed for 3D movement and rotation in all directions,
  105455. * such as in a 3D Space Shooter or a Flight Simulator.
  105456. */
  105457. export class FlyCamera extends TargetCamera {
  105458. /**
  105459. * Define the collision ellipsoid of the camera.
  105460. * This is helpful for simulating a camera body, like a player's body.
  105461. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  105462. */
  105463. ellipsoid: Vector3;
  105464. /**
  105465. * Define an offset for the position of the ellipsoid around the camera.
  105466. * This can be helpful if the camera is attached away from the player's body center,
  105467. * such as at its head.
  105468. */
  105469. ellipsoidOffset: Vector3;
  105470. /**
  105471. * Enable or disable collisions of the camera with the rest of the scene objects.
  105472. */
  105473. checkCollisions: boolean;
  105474. /**
  105475. * Enable or disable gravity on the camera.
  105476. */
  105477. applyGravity: boolean;
  105478. /**
  105479. * Define the current direction the camera is moving to.
  105480. */
  105481. cameraDirection: Vector3;
  105482. /**
  105483. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  105484. * This overrides and empties cameraRotation.
  105485. */
  105486. rotationQuaternion: Quaternion;
  105487. /**
  105488. * Track Roll to maintain the wanted Rolling when looking around.
  105489. */
  105490. _trackRoll: number;
  105491. /**
  105492. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  105493. */
  105494. rollCorrect: number;
  105495. /**
  105496. * Mimic a banked turn, Rolling the camera when Yawing.
  105497. * It's recommended to use rollCorrect = 10 for faster banking correction.
  105498. */
  105499. bankedTurn: boolean;
  105500. /**
  105501. * Limit in radians for how much Roll banking will add. (Default: 90°)
  105502. */
  105503. bankedTurnLimit: number;
  105504. /**
  105505. * Value of 0 disables the banked Roll.
  105506. * Value of 1 is equal to the Yaw angle in radians.
  105507. */
  105508. bankedTurnMultiplier: number;
  105509. /**
  105510. * The inputs manager loads all the input sources, such as keyboard and mouse.
  105511. */
  105512. inputs: FlyCameraInputsManager;
  105513. /**
  105514. * Gets the input sensibility for mouse input.
  105515. * Higher values reduce sensitivity.
  105516. */
  105517. /**
  105518. * Sets the input sensibility for a mouse input.
  105519. * Higher values reduce sensitivity.
  105520. */
  105521. angularSensibility: number;
  105522. /**
  105523. * Get the keys for camera movement forward.
  105524. */
  105525. /**
  105526. * Set the keys for camera movement forward.
  105527. */
  105528. keysForward: number[];
  105529. /**
  105530. * Get the keys for camera movement backward.
  105531. */
  105532. keysBackward: number[];
  105533. /**
  105534. * Get the keys for camera movement up.
  105535. */
  105536. /**
  105537. * Set the keys for camera movement up.
  105538. */
  105539. keysUp: number[];
  105540. /**
  105541. * Get the keys for camera movement down.
  105542. */
  105543. /**
  105544. * Set the keys for camera movement down.
  105545. */
  105546. keysDown: number[];
  105547. /**
  105548. * Get the keys for camera movement left.
  105549. */
  105550. /**
  105551. * Set the keys for camera movement left.
  105552. */
  105553. keysLeft: number[];
  105554. /**
  105555. * Set the keys for camera movement right.
  105556. */
  105557. /**
  105558. * Set the keys for camera movement right.
  105559. */
  105560. keysRight: number[];
  105561. /**
  105562. * Event raised when the camera collides with a mesh in the scene.
  105563. */
  105564. onCollide: (collidedMesh: AbstractMesh) => void;
  105565. private _collider;
  105566. private _needMoveForGravity;
  105567. private _oldPosition;
  105568. private _diffPosition;
  105569. private _newPosition;
  105570. /** @hidden */
  105571. _localDirection: Vector3;
  105572. /** @hidden */
  105573. _transformedDirection: Vector3;
  105574. /**
  105575. * Instantiates a FlyCamera.
  105576. * This is a flying camera, designed for 3D movement and rotation in all directions,
  105577. * such as in a 3D Space Shooter or a Flight Simulator.
  105578. * @param name Define the name of the camera in the scene.
  105579. * @param position Define the starting position of the camera in the scene.
  105580. * @param scene Define the scene the camera belongs to.
  105581. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  105582. */
  105583. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  105584. /**
  105585. * Attach a control to the HTML DOM element.
  105586. * @param element Defines the element that listens to the input events.
  105587. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  105588. */
  105589. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105590. /**
  105591. * Detach a control from the HTML DOM element.
  105592. * The camera will stop reacting to that input.
  105593. * @param element Defines the element that listens to the input events.
  105594. */
  105595. detachControl(element: HTMLElement): void;
  105596. private _collisionMask;
  105597. /**
  105598. * Get the mask that the camera ignores in collision events.
  105599. */
  105600. /**
  105601. * Set the mask that the camera ignores in collision events.
  105602. */
  105603. collisionMask: number;
  105604. /** @hidden */
  105605. _collideWithWorld(displacement: Vector3): void;
  105606. /** @hidden */
  105607. private _onCollisionPositionChange;
  105608. /** @hidden */
  105609. _checkInputs(): void;
  105610. /** @hidden */
  105611. _decideIfNeedsToMove(): boolean;
  105612. /** @hidden */
  105613. _updatePosition(): void;
  105614. /**
  105615. * Restore the Roll to its target value at the rate specified.
  105616. * @param rate - Higher means slower restoring.
  105617. * @hidden
  105618. */
  105619. restoreRoll(rate: number): void;
  105620. /**
  105621. * Destroy the camera and release the current resources held by it.
  105622. */
  105623. dispose(): void;
  105624. /**
  105625. * Get the current object class name.
  105626. * @returns the class name.
  105627. */
  105628. getClassName(): string;
  105629. }
  105630. }
  105631. declare module BABYLON {
  105632. /**
  105633. * Listen to keyboard events to control the camera.
  105634. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105635. */
  105636. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  105637. /**
  105638. * Defines the camera the input is attached to.
  105639. */
  105640. camera: FlyCamera;
  105641. /**
  105642. * The list of keyboard keys used to control the forward move of the camera.
  105643. */
  105644. keysForward: number[];
  105645. /**
  105646. * The list of keyboard keys used to control the backward move of the camera.
  105647. */
  105648. keysBackward: number[];
  105649. /**
  105650. * The list of keyboard keys used to control the forward move of the camera.
  105651. */
  105652. keysUp: number[];
  105653. /**
  105654. * The list of keyboard keys used to control the backward move of the camera.
  105655. */
  105656. keysDown: number[];
  105657. /**
  105658. * The list of keyboard keys used to control the right strafe move of the camera.
  105659. */
  105660. keysRight: number[];
  105661. /**
  105662. * The list of keyboard keys used to control the left strafe move of the camera.
  105663. */
  105664. keysLeft: number[];
  105665. private _keys;
  105666. private _onCanvasBlurObserver;
  105667. private _onKeyboardObserver;
  105668. private _engine;
  105669. private _scene;
  105670. /**
  105671. * Attach the input controls to a specific dom element to get the input from.
  105672. * @param element Defines the element the controls should be listened from
  105673. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105674. */
  105675. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105676. /**
  105677. * Detach the current controls from the specified dom element.
  105678. * @param element Defines the element to stop listening the inputs from
  105679. */
  105680. detachControl(element: Nullable<HTMLElement>): void;
  105681. /**
  105682. * Gets the class name of the current intput.
  105683. * @returns the class name
  105684. */
  105685. getClassName(): string;
  105686. /** @hidden */
  105687. _onLostFocus(e: FocusEvent): void;
  105688. /**
  105689. * Get the friendly name associated with the input class.
  105690. * @returns the input friendly name
  105691. */
  105692. getSimpleName(): string;
  105693. /**
  105694. * Update the current camera state depending on the inputs that have been used this frame.
  105695. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  105696. */
  105697. checkInputs(): void;
  105698. }
  105699. }
  105700. declare module BABYLON {
  105701. /**
  105702. * Manage the mouse wheel inputs to control a follow camera.
  105703. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105704. */
  105705. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  105706. /**
  105707. * Defines the camera the input is attached to.
  105708. */
  105709. camera: FollowCamera;
  105710. /**
  105711. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  105712. */
  105713. axisControlRadius: boolean;
  105714. /**
  105715. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  105716. */
  105717. axisControlHeight: boolean;
  105718. /**
  105719. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  105720. */
  105721. axisControlRotation: boolean;
  105722. /**
  105723. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  105724. * relation to mouseWheel events.
  105725. */
  105726. wheelPrecision: number;
  105727. /**
  105728. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  105729. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  105730. */
  105731. wheelDeltaPercentage: number;
  105732. private _wheel;
  105733. private _observer;
  105734. /**
  105735. * Attach the input controls to a specific dom element to get the input from.
  105736. * @param element Defines the element the controls should be listened from
  105737. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105738. */
  105739. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105740. /**
  105741. * Detach the current controls from the specified dom element.
  105742. * @param element Defines the element to stop listening the inputs from
  105743. */
  105744. detachControl(element: Nullable<HTMLElement>): void;
  105745. /**
  105746. * Gets the class name of the current intput.
  105747. * @returns the class name
  105748. */
  105749. getClassName(): string;
  105750. /**
  105751. * Get the friendly name associated with the input class.
  105752. * @returns the input friendly name
  105753. */
  105754. getSimpleName(): string;
  105755. }
  105756. }
  105757. declare module BABYLON {
  105758. /**
  105759. * Manage the pointers inputs to control an follow camera.
  105760. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105761. */
  105762. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  105763. /**
  105764. * Defines the camera the input is attached to.
  105765. */
  105766. camera: FollowCamera;
  105767. /**
  105768. * Gets the class name of the current input.
  105769. * @returns the class name
  105770. */
  105771. getClassName(): string;
  105772. /**
  105773. * Defines the pointer angular sensibility along the X axis or how fast is
  105774. * the camera rotating.
  105775. * A negative number will reverse the axis direction.
  105776. */
  105777. angularSensibilityX: number;
  105778. /**
  105779. * Defines the pointer angular sensibility along the Y axis or how fast is
  105780. * the camera rotating.
  105781. * A negative number will reverse the axis direction.
  105782. */
  105783. angularSensibilityY: number;
  105784. /**
  105785. * Defines the pointer pinch precision or how fast is the camera zooming.
  105786. * A negative number will reverse the axis direction.
  105787. */
  105788. pinchPrecision: number;
  105789. /**
  105790. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  105791. * from 0.
  105792. * It defines the percentage of current camera.radius to use as delta when
  105793. * pinch zoom is used.
  105794. */
  105795. pinchDeltaPercentage: number;
  105796. /**
  105797. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  105798. */
  105799. axisXControlRadius: boolean;
  105800. /**
  105801. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  105802. */
  105803. axisXControlHeight: boolean;
  105804. /**
  105805. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  105806. */
  105807. axisXControlRotation: boolean;
  105808. /**
  105809. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  105810. */
  105811. axisYControlRadius: boolean;
  105812. /**
  105813. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  105814. */
  105815. axisYControlHeight: boolean;
  105816. /**
  105817. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  105818. */
  105819. axisYControlRotation: boolean;
  105820. /**
  105821. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  105822. */
  105823. axisPinchControlRadius: boolean;
  105824. /**
  105825. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  105826. */
  105827. axisPinchControlHeight: boolean;
  105828. /**
  105829. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  105830. */
  105831. axisPinchControlRotation: boolean;
  105832. /**
  105833. * Log error messages if basic misconfiguration has occurred.
  105834. */
  105835. warningEnable: boolean;
  105836. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  105837. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  105838. private _warningCounter;
  105839. private _warning;
  105840. }
  105841. }
  105842. declare module BABYLON {
  105843. /**
  105844. * Default Inputs manager for the FollowCamera.
  105845. * It groups all the default supported inputs for ease of use.
  105846. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105847. */
  105848. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  105849. /**
  105850. * Instantiates a new FollowCameraInputsManager.
  105851. * @param camera Defines the camera the inputs belong to
  105852. */
  105853. constructor(camera: FollowCamera);
  105854. /**
  105855. * Add keyboard input support to the input manager.
  105856. * @returns the current input manager
  105857. */
  105858. addKeyboard(): FollowCameraInputsManager;
  105859. /**
  105860. * Add mouse wheel input support to the input manager.
  105861. * @returns the current input manager
  105862. */
  105863. addMouseWheel(): FollowCameraInputsManager;
  105864. /**
  105865. * Add pointers input support to the input manager.
  105866. * @returns the current input manager
  105867. */
  105868. addPointers(): FollowCameraInputsManager;
  105869. /**
  105870. * Add orientation input support to the input manager.
  105871. * @returns the current input manager
  105872. */
  105873. addVRDeviceOrientation(): FollowCameraInputsManager;
  105874. }
  105875. }
  105876. declare module BABYLON {
  105877. /**
  105878. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  105879. * an arc rotate version arcFollowCamera are available.
  105880. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  105881. */
  105882. export class FollowCamera extends TargetCamera {
  105883. /**
  105884. * Distance the follow camera should follow an object at
  105885. */
  105886. radius: number;
  105887. /**
  105888. * Minimum allowed distance of the camera to the axis of rotation
  105889. * (The camera can not get closer).
  105890. * This can help limiting how the Camera is able to move in the scene.
  105891. */
  105892. lowerRadiusLimit: Nullable<number>;
  105893. /**
  105894. * Maximum allowed distance of the camera to the axis of rotation
  105895. * (The camera can not get further).
  105896. * This can help limiting how the Camera is able to move in the scene.
  105897. */
  105898. upperRadiusLimit: Nullable<number>;
  105899. /**
  105900. * Define a rotation offset between the camera and the object it follows
  105901. */
  105902. rotationOffset: number;
  105903. /**
  105904. * Minimum allowed angle to camera position relative to target object.
  105905. * This can help limiting how the Camera is able to move in the scene.
  105906. */
  105907. lowerRotationOffsetLimit: Nullable<number>;
  105908. /**
  105909. * Maximum allowed angle to camera position relative to target object.
  105910. * This can help limiting how the Camera is able to move in the scene.
  105911. */
  105912. upperRotationOffsetLimit: Nullable<number>;
  105913. /**
  105914. * Define a height offset between the camera and the object it follows.
  105915. * It can help following an object from the top (like a car chaing a plane)
  105916. */
  105917. heightOffset: number;
  105918. /**
  105919. * Minimum allowed height of camera position relative to target object.
  105920. * This can help limiting how the Camera is able to move in the scene.
  105921. */
  105922. lowerHeightOffsetLimit: Nullable<number>;
  105923. /**
  105924. * Maximum allowed height of camera position relative to target object.
  105925. * This can help limiting how the Camera is able to move in the scene.
  105926. */
  105927. upperHeightOffsetLimit: Nullable<number>;
  105928. /**
  105929. * Define how fast the camera can accelerate to follow it s target.
  105930. */
  105931. cameraAcceleration: number;
  105932. /**
  105933. * Define the speed limit of the camera following an object.
  105934. */
  105935. maxCameraSpeed: number;
  105936. /**
  105937. * Define the target of the camera.
  105938. */
  105939. lockedTarget: Nullable<AbstractMesh>;
  105940. /**
  105941. * Defines the input associated with the camera.
  105942. */
  105943. inputs: FollowCameraInputsManager;
  105944. /**
  105945. * Instantiates the follow camera.
  105946. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  105947. * @param name Define the name of the camera in the scene
  105948. * @param position Define the position of the camera
  105949. * @param scene Define the scene the camera belong to
  105950. * @param lockedTarget Define the target of the camera
  105951. */
  105952. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  105953. private _follow;
  105954. /**
  105955. * Attached controls to the current camera.
  105956. * @param element Defines the element the controls should be listened from
  105957. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105958. */
  105959. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105960. /**
  105961. * Detach the current controls from the camera.
  105962. * The camera will stop reacting to inputs.
  105963. * @param element Defines the element to stop listening the inputs from
  105964. */
  105965. detachControl(element: HTMLElement): void;
  105966. /** @hidden */
  105967. _checkInputs(): void;
  105968. private _checkLimits;
  105969. /**
  105970. * Gets the camera class name.
  105971. * @returns the class name
  105972. */
  105973. getClassName(): string;
  105974. }
  105975. /**
  105976. * Arc Rotate version of the follow camera.
  105977. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  105978. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  105979. */
  105980. export class ArcFollowCamera extends TargetCamera {
  105981. /** The longitudinal angle of the camera */
  105982. alpha: number;
  105983. /** The latitudinal angle of the camera */
  105984. beta: number;
  105985. /** The radius of the camera from its target */
  105986. radius: number;
  105987. /** Define the camera target (the messh it should follow) */
  105988. target: Nullable<AbstractMesh>;
  105989. private _cartesianCoordinates;
  105990. /**
  105991. * Instantiates a new ArcFollowCamera
  105992. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  105993. * @param name Define the name of the camera
  105994. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  105995. * @param beta Define the rotation angle of the camera around the elevation axis
  105996. * @param radius Define the radius of the camera from its target point
  105997. * @param target Define the target of the camera
  105998. * @param scene Define the scene the camera belongs to
  105999. */
  106000. constructor(name: string,
  106001. /** The longitudinal angle of the camera */
  106002. alpha: number,
  106003. /** The latitudinal angle of the camera */
  106004. beta: number,
  106005. /** The radius of the camera from its target */
  106006. radius: number,
  106007. /** Define the camera target (the messh it should follow) */
  106008. target: Nullable<AbstractMesh>, scene: Scene);
  106009. private _follow;
  106010. /** @hidden */
  106011. _checkInputs(): void;
  106012. /**
  106013. * Returns the class name of the object.
  106014. * It is mostly used internally for serialization purposes.
  106015. */
  106016. getClassName(): string;
  106017. }
  106018. }
  106019. declare module BABYLON {
  106020. /**
  106021. * Manage the keyboard inputs to control the movement of a follow camera.
  106022. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106023. */
  106024. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  106025. /**
  106026. * Defines the camera the input is attached to.
  106027. */
  106028. camera: FollowCamera;
  106029. /**
  106030. * Defines the list of key codes associated with the up action (increase heightOffset)
  106031. */
  106032. keysHeightOffsetIncr: number[];
  106033. /**
  106034. * Defines the list of key codes associated with the down action (decrease heightOffset)
  106035. */
  106036. keysHeightOffsetDecr: number[];
  106037. /**
  106038. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  106039. */
  106040. keysHeightOffsetModifierAlt: boolean;
  106041. /**
  106042. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  106043. */
  106044. keysHeightOffsetModifierCtrl: boolean;
  106045. /**
  106046. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  106047. */
  106048. keysHeightOffsetModifierShift: boolean;
  106049. /**
  106050. * Defines the list of key codes associated with the left action (increase rotationOffset)
  106051. */
  106052. keysRotationOffsetIncr: number[];
  106053. /**
  106054. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  106055. */
  106056. keysRotationOffsetDecr: number[];
  106057. /**
  106058. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  106059. */
  106060. keysRotationOffsetModifierAlt: boolean;
  106061. /**
  106062. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  106063. */
  106064. keysRotationOffsetModifierCtrl: boolean;
  106065. /**
  106066. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  106067. */
  106068. keysRotationOffsetModifierShift: boolean;
  106069. /**
  106070. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  106071. */
  106072. keysRadiusIncr: number[];
  106073. /**
  106074. * Defines the list of key codes associated with the zoom-out action (increase radius)
  106075. */
  106076. keysRadiusDecr: number[];
  106077. /**
  106078. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  106079. */
  106080. keysRadiusModifierAlt: boolean;
  106081. /**
  106082. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  106083. */
  106084. keysRadiusModifierCtrl: boolean;
  106085. /**
  106086. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  106087. */
  106088. keysRadiusModifierShift: boolean;
  106089. /**
  106090. * Defines the rate of change of heightOffset.
  106091. */
  106092. heightSensibility: number;
  106093. /**
  106094. * Defines the rate of change of rotationOffset.
  106095. */
  106096. rotationSensibility: number;
  106097. /**
  106098. * Defines the rate of change of radius.
  106099. */
  106100. radiusSensibility: number;
  106101. private _keys;
  106102. private _ctrlPressed;
  106103. private _altPressed;
  106104. private _shiftPressed;
  106105. private _onCanvasBlurObserver;
  106106. private _onKeyboardObserver;
  106107. private _engine;
  106108. private _scene;
  106109. /**
  106110. * Attach the input controls to a specific dom element to get the input from.
  106111. * @param element Defines the element the controls should be listened from
  106112. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106113. */
  106114. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106115. /**
  106116. * Detach the current controls from the specified dom element.
  106117. * @param element Defines the element to stop listening the inputs from
  106118. */
  106119. detachControl(element: Nullable<HTMLElement>): void;
  106120. /**
  106121. * Update the current camera state depending on the inputs that have been used this frame.
  106122. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106123. */
  106124. checkInputs(): void;
  106125. /**
  106126. * Gets the class name of the current input.
  106127. * @returns the class name
  106128. */
  106129. getClassName(): string;
  106130. /**
  106131. * Get the friendly name associated with the input class.
  106132. * @returns the input friendly name
  106133. */
  106134. getSimpleName(): string;
  106135. /**
  106136. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  106137. * allow modification of the heightOffset value.
  106138. */
  106139. private _modifierHeightOffset;
  106140. /**
  106141. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  106142. * allow modification of the rotationOffset value.
  106143. */
  106144. private _modifierRotationOffset;
  106145. /**
  106146. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  106147. * allow modification of the radius value.
  106148. */
  106149. private _modifierRadius;
  106150. }
  106151. }
  106152. declare module BABYLON {
  106153. interface FreeCameraInputsManager {
  106154. /**
  106155. * @hidden
  106156. */
  106157. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  106158. /**
  106159. * Add orientation input support to the input manager.
  106160. * @returns the current input manager
  106161. */
  106162. addDeviceOrientation(): FreeCameraInputsManager;
  106163. }
  106164. /**
  106165. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  106166. * Screen rotation is taken into account.
  106167. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106168. */
  106169. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  106170. private _camera;
  106171. private _screenOrientationAngle;
  106172. private _constantTranform;
  106173. private _screenQuaternion;
  106174. private _alpha;
  106175. private _beta;
  106176. private _gamma;
  106177. /**
  106178. * Can be used to detect if a device orientation sensor is availible on a device
  106179. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  106180. * @returns a promise that will resolve on orientation change
  106181. */
  106182. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  106183. /**
  106184. * @hidden
  106185. */
  106186. _onDeviceOrientationChangedObservable: Observable<void>;
  106187. /**
  106188. * Instantiates a new input
  106189. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106190. */
  106191. constructor();
  106192. /**
  106193. * Define the camera controlled by the input.
  106194. */
  106195. camera: FreeCamera;
  106196. /**
  106197. * Attach the input controls to a specific dom element to get the input from.
  106198. * @param element Defines the element the controls should be listened from
  106199. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106200. */
  106201. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106202. private _orientationChanged;
  106203. private _deviceOrientation;
  106204. /**
  106205. * Detach the current controls from the specified dom element.
  106206. * @param element Defines the element to stop listening the inputs from
  106207. */
  106208. detachControl(element: Nullable<HTMLElement>): void;
  106209. /**
  106210. * Update the current camera state depending on the inputs that have been used this frame.
  106211. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106212. */
  106213. checkInputs(): void;
  106214. /**
  106215. * Gets the class name of the current intput.
  106216. * @returns the class name
  106217. */
  106218. getClassName(): string;
  106219. /**
  106220. * Get the friendly name associated with the input class.
  106221. * @returns the input friendly name
  106222. */
  106223. getSimpleName(): string;
  106224. }
  106225. }
  106226. declare module BABYLON {
  106227. /**
  106228. * Manage the gamepad inputs to control a free camera.
  106229. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106230. */
  106231. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  106232. /**
  106233. * Define the camera the input is attached to.
  106234. */
  106235. camera: FreeCamera;
  106236. /**
  106237. * Define the Gamepad controlling the input
  106238. */
  106239. gamepad: Nullable<Gamepad>;
  106240. /**
  106241. * Defines the gamepad rotation sensiblity.
  106242. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  106243. */
  106244. gamepadAngularSensibility: number;
  106245. /**
  106246. * Defines the gamepad move sensiblity.
  106247. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  106248. */
  106249. gamepadMoveSensibility: number;
  106250. private _yAxisScale;
  106251. /**
  106252. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  106253. */
  106254. invertYAxis: boolean;
  106255. private _onGamepadConnectedObserver;
  106256. private _onGamepadDisconnectedObserver;
  106257. private _cameraTransform;
  106258. private _deltaTransform;
  106259. private _vector3;
  106260. private _vector2;
  106261. /**
  106262. * Attach the input controls to a specific dom element to get the input from.
  106263. * @param element Defines the element the controls should be listened from
  106264. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106265. */
  106266. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106267. /**
  106268. * Detach the current controls from the specified dom element.
  106269. * @param element Defines the element to stop listening the inputs from
  106270. */
  106271. detachControl(element: Nullable<HTMLElement>): void;
  106272. /**
  106273. * Update the current camera state depending on the inputs that have been used this frame.
  106274. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106275. */
  106276. checkInputs(): void;
  106277. /**
  106278. * Gets the class name of the current intput.
  106279. * @returns the class name
  106280. */
  106281. getClassName(): string;
  106282. /**
  106283. * Get the friendly name associated with the input class.
  106284. * @returns the input friendly name
  106285. */
  106286. getSimpleName(): string;
  106287. }
  106288. }
  106289. declare module BABYLON {
  106290. /**
  106291. * Defines the potential axis of a Joystick
  106292. */
  106293. export enum JoystickAxis {
  106294. /** X axis */
  106295. X = 0,
  106296. /** Y axis */
  106297. Y = 1,
  106298. /** Z axis */
  106299. Z = 2
  106300. }
  106301. /**
  106302. * Class used to define virtual joystick (used in touch mode)
  106303. */
  106304. export class VirtualJoystick {
  106305. /**
  106306. * Gets or sets a boolean indicating that left and right values must be inverted
  106307. */
  106308. reverseLeftRight: boolean;
  106309. /**
  106310. * Gets or sets a boolean indicating that up and down values must be inverted
  106311. */
  106312. reverseUpDown: boolean;
  106313. /**
  106314. * Gets the offset value for the position (ie. the change of the position value)
  106315. */
  106316. deltaPosition: Vector3;
  106317. /**
  106318. * Gets a boolean indicating if the virtual joystick was pressed
  106319. */
  106320. pressed: boolean;
  106321. /**
  106322. * Canvas the virtual joystick will render onto, default z-index of this is 5
  106323. */
  106324. static Canvas: Nullable<HTMLCanvasElement>;
  106325. private static _globalJoystickIndex;
  106326. private static vjCanvasContext;
  106327. private static vjCanvasWidth;
  106328. private static vjCanvasHeight;
  106329. private static halfWidth;
  106330. private _action;
  106331. private _axisTargetedByLeftAndRight;
  106332. private _axisTargetedByUpAndDown;
  106333. private _joystickSensibility;
  106334. private _inversedSensibility;
  106335. private _joystickPointerID;
  106336. private _joystickColor;
  106337. private _joystickPointerPos;
  106338. private _joystickPreviousPointerPos;
  106339. private _joystickPointerStartPos;
  106340. private _deltaJoystickVector;
  106341. private _leftJoystick;
  106342. private _touches;
  106343. private _onPointerDownHandlerRef;
  106344. private _onPointerMoveHandlerRef;
  106345. private _onPointerUpHandlerRef;
  106346. private _onResize;
  106347. /**
  106348. * Creates a new virtual joystick
  106349. * @param leftJoystick defines that the joystick is for left hand (false by default)
  106350. */
  106351. constructor(leftJoystick?: boolean);
  106352. /**
  106353. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  106354. * @param newJoystickSensibility defines the new sensibility
  106355. */
  106356. setJoystickSensibility(newJoystickSensibility: number): void;
  106357. private _onPointerDown;
  106358. private _onPointerMove;
  106359. private _onPointerUp;
  106360. /**
  106361. * Change the color of the virtual joystick
  106362. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  106363. */
  106364. setJoystickColor(newColor: string): void;
  106365. /**
  106366. * Defines a callback to call when the joystick is touched
  106367. * @param action defines the callback
  106368. */
  106369. setActionOnTouch(action: () => any): void;
  106370. /**
  106371. * Defines which axis you'd like to control for left & right
  106372. * @param axis defines the axis to use
  106373. */
  106374. setAxisForLeftRight(axis: JoystickAxis): void;
  106375. /**
  106376. * Defines which axis you'd like to control for up & down
  106377. * @param axis defines the axis to use
  106378. */
  106379. setAxisForUpDown(axis: JoystickAxis): void;
  106380. private _drawVirtualJoystick;
  106381. /**
  106382. * Release internal HTML canvas
  106383. */
  106384. releaseCanvas(): void;
  106385. }
  106386. }
  106387. declare module BABYLON {
  106388. interface FreeCameraInputsManager {
  106389. /**
  106390. * Add virtual joystick input support to the input manager.
  106391. * @returns the current input manager
  106392. */
  106393. addVirtualJoystick(): FreeCameraInputsManager;
  106394. }
  106395. /**
  106396. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  106397. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106398. */
  106399. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  106400. /**
  106401. * Defines the camera the input is attached to.
  106402. */
  106403. camera: FreeCamera;
  106404. private _leftjoystick;
  106405. private _rightjoystick;
  106406. /**
  106407. * Gets the left stick of the virtual joystick.
  106408. * @returns The virtual Joystick
  106409. */
  106410. getLeftJoystick(): VirtualJoystick;
  106411. /**
  106412. * Gets the right stick of the virtual joystick.
  106413. * @returns The virtual Joystick
  106414. */
  106415. getRightJoystick(): VirtualJoystick;
  106416. /**
  106417. * Update the current camera state depending on the inputs that have been used this frame.
  106418. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106419. */
  106420. checkInputs(): void;
  106421. /**
  106422. * Attach the input controls to a specific dom element to get the input from.
  106423. * @param element Defines the element the controls should be listened from
  106424. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106425. */
  106426. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106427. /**
  106428. * Detach the current controls from the specified dom element.
  106429. * @param element Defines the element to stop listening the inputs from
  106430. */
  106431. detachControl(element: Nullable<HTMLElement>): void;
  106432. /**
  106433. * Gets the class name of the current intput.
  106434. * @returns the class name
  106435. */
  106436. getClassName(): string;
  106437. /**
  106438. * Get the friendly name associated with the input class.
  106439. * @returns the input friendly name
  106440. */
  106441. getSimpleName(): string;
  106442. }
  106443. }
  106444. declare module BABYLON {
  106445. /**
  106446. * This represents a FPS type of camera controlled by touch.
  106447. * This is like a universal camera minus the Gamepad controls.
  106448. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  106449. */
  106450. export class TouchCamera extends FreeCamera {
  106451. /**
  106452. * Defines the touch sensibility for rotation.
  106453. * The higher the faster.
  106454. */
  106455. touchAngularSensibility: number;
  106456. /**
  106457. * Defines the touch sensibility for move.
  106458. * The higher the faster.
  106459. */
  106460. touchMoveSensibility: number;
  106461. /**
  106462. * Instantiates a new touch camera.
  106463. * This represents a FPS type of camera controlled by touch.
  106464. * This is like a universal camera minus the Gamepad controls.
  106465. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  106466. * @param name Define the name of the camera in the scene
  106467. * @param position Define the start position of the camera in the scene
  106468. * @param scene Define the scene the camera belongs to
  106469. */
  106470. constructor(name: string, position: Vector3, scene: Scene);
  106471. /**
  106472. * Gets the current object class name.
  106473. * @return the class name
  106474. */
  106475. getClassName(): string;
  106476. /** @hidden */
  106477. _setupInputs(): void;
  106478. }
  106479. }
  106480. declare module BABYLON {
  106481. /**
  106482. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  106483. * being tilted forward or back and left or right.
  106484. */
  106485. export class DeviceOrientationCamera extends FreeCamera {
  106486. private _initialQuaternion;
  106487. private _quaternionCache;
  106488. private _tmpDragQuaternion;
  106489. private _disablePointerInputWhenUsingDeviceOrientation;
  106490. /**
  106491. * Creates a new device orientation camera
  106492. * @param name The name of the camera
  106493. * @param position The start position camera
  106494. * @param scene The scene the camera belongs to
  106495. */
  106496. constructor(name: string, position: Vector3, scene: Scene);
  106497. /**
  106498. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  106499. */
  106500. disablePointerInputWhenUsingDeviceOrientation: boolean;
  106501. private _dragFactor;
  106502. /**
  106503. * Enabled turning on the y axis when the orientation sensor is active
  106504. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  106505. */
  106506. enableHorizontalDragging(dragFactor?: number): void;
  106507. /**
  106508. * Gets the current instance class name ("DeviceOrientationCamera").
  106509. * This helps avoiding instanceof at run time.
  106510. * @returns the class name
  106511. */
  106512. getClassName(): string;
  106513. /**
  106514. * @hidden
  106515. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  106516. */
  106517. _checkInputs(): void;
  106518. /**
  106519. * Reset the camera to its default orientation on the specified axis only.
  106520. * @param axis The axis to reset
  106521. */
  106522. resetToCurrentRotation(axis?: Axis): void;
  106523. }
  106524. }
  106525. declare module BABYLON {
  106526. /**
  106527. * Defines supported buttons for XBox360 compatible gamepads
  106528. */
  106529. export enum Xbox360Button {
  106530. /** A */
  106531. A = 0,
  106532. /** B */
  106533. B = 1,
  106534. /** X */
  106535. X = 2,
  106536. /** Y */
  106537. Y = 3,
  106538. /** Start */
  106539. Start = 4,
  106540. /** Back */
  106541. Back = 5,
  106542. /** Left button */
  106543. LB = 6,
  106544. /** Right button */
  106545. RB = 7,
  106546. /** Left stick */
  106547. LeftStick = 8,
  106548. /** Right stick */
  106549. RightStick = 9
  106550. }
  106551. /** Defines values for XBox360 DPad */
  106552. export enum Xbox360Dpad {
  106553. /** Up */
  106554. Up = 0,
  106555. /** Down */
  106556. Down = 1,
  106557. /** Left */
  106558. Left = 2,
  106559. /** Right */
  106560. Right = 3
  106561. }
  106562. /**
  106563. * Defines a XBox360 gamepad
  106564. */
  106565. export class Xbox360Pad extends Gamepad {
  106566. private _leftTrigger;
  106567. private _rightTrigger;
  106568. private _onlefttriggerchanged;
  106569. private _onrighttriggerchanged;
  106570. private _onbuttondown;
  106571. private _onbuttonup;
  106572. private _ondpaddown;
  106573. private _ondpadup;
  106574. /** Observable raised when a button is pressed */
  106575. onButtonDownObservable: Observable<Xbox360Button>;
  106576. /** Observable raised when a button is released */
  106577. onButtonUpObservable: Observable<Xbox360Button>;
  106578. /** Observable raised when a pad is pressed */
  106579. onPadDownObservable: Observable<Xbox360Dpad>;
  106580. /** Observable raised when a pad is released */
  106581. onPadUpObservable: Observable<Xbox360Dpad>;
  106582. private _buttonA;
  106583. private _buttonB;
  106584. private _buttonX;
  106585. private _buttonY;
  106586. private _buttonBack;
  106587. private _buttonStart;
  106588. private _buttonLB;
  106589. private _buttonRB;
  106590. private _buttonLeftStick;
  106591. private _buttonRightStick;
  106592. private _dPadUp;
  106593. private _dPadDown;
  106594. private _dPadLeft;
  106595. private _dPadRight;
  106596. private _isXboxOnePad;
  106597. /**
  106598. * Creates a new XBox360 gamepad object
  106599. * @param id defines the id of this gamepad
  106600. * @param index defines its index
  106601. * @param gamepad defines the internal HTML gamepad object
  106602. * @param xboxOne defines if it is a XBox One gamepad
  106603. */
  106604. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  106605. /**
  106606. * Defines the callback to call when left trigger is pressed
  106607. * @param callback defines the callback to use
  106608. */
  106609. onlefttriggerchanged(callback: (value: number) => void): void;
  106610. /**
  106611. * Defines the callback to call when right trigger is pressed
  106612. * @param callback defines the callback to use
  106613. */
  106614. onrighttriggerchanged(callback: (value: number) => void): void;
  106615. /**
  106616. * Gets the left trigger value
  106617. */
  106618. /**
  106619. * Sets the left trigger value
  106620. */
  106621. leftTrigger: number;
  106622. /**
  106623. * Gets the right trigger value
  106624. */
  106625. /**
  106626. * Sets the right trigger value
  106627. */
  106628. rightTrigger: number;
  106629. /**
  106630. * Defines the callback to call when a button is pressed
  106631. * @param callback defines the callback to use
  106632. */
  106633. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  106634. /**
  106635. * Defines the callback to call when a button is released
  106636. * @param callback defines the callback to use
  106637. */
  106638. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  106639. /**
  106640. * Defines the callback to call when a pad is pressed
  106641. * @param callback defines the callback to use
  106642. */
  106643. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  106644. /**
  106645. * Defines the callback to call when a pad is released
  106646. * @param callback defines the callback to use
  106647. */
  106648. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  106649. private _setButtonValue;
  106650. private _setDPadValue;
  106651. /**
  106652. * Gets the value of the `A` button
  106653. */
  106654. /**
  106655. * Sets the value of the `A` button
  106656. */
  106657. buttonA: number;
  106658. /**
  106659. * Gets the value of the `B` button
  106660. */
  106661. /**
  106662. * Sets the value of the `B` button
  106663. */
  106664. buttonB: number;
  106665. /**
  106666. * Gets the value of the `X` button
  106667. */
  106668. /**
  106669. * Sets the value of the `X` button
  106670. */
  106671. buttonX: number;
  106672. /**
  106673. * Gets the value of the `Y` button
  106674. */
  106675. /**
  106676. * Sets the value of the `Y` button
  106677. */
  106678. buttonY: number;
  106679. /**
  106680. * Gets the value of the `Start` button
  106681. */
  106682. /**
  106683. * Sets the value of the `Start` button
  106684. */
  106685. buttonStart: number;
  106686. /**
  106687. * Gets the value of the `Back` button
  106688. */
  106689. /**
  106690. * Sets the value of the `Back` button
  106691. */
  106692. buttonBack: number;
  106693. /**
  106694. * Gets the value of the `Left` button
  106695. */
  106696. /**
  106697. * Sets the value of the `Left` button
  106698. */
  106699. buttonLB: number;
  106700. /**
  106701. * Gets the value of the `Right` button
  106702. */
  106703. /**
  106704. * Sets the value of the `Right` button
  106705. */
  106706. buttonRB: number;
  106707. /**
  106708. * Gets the value of the Left joystick
  106709. */
  106710. /**
  106711. * Sets the value of the Left joystick
  106712. */
  106713. buttonLeftStick: number;
  106714. /**
  106715. * Gets the value of the Right joystick
  106716. */
  106717. /**
  106718. * Sets the value of the Right joystick
  106719. */
  106720. buttonRightStick: number;
  106721. /**
  106722. * Gets the value of D-pad up
  106723. */
  106724. /**
  106725. * Sets the value of D-pad up
  106726. */
  106727. dPadUp: number;
  106728. /**
  106729. * Gets the value of D-pad down
  106730. */
  106731. /**
  106732. * Sets the value of D-pad down
  106733. */
  106734. dPadDown: number;
  106735. /**
  106736. * Gets the value of D-pad left
  106737. */
  106738. /**
  106739. * Sets the value of D-pad left
  106740. */
  106741. dPadLeft: number;
  106742. /**
  106743. * Gets the value of D-pad right
  106744. */
  106745. /**
  106746. * Sets the value of D-pad right
  106747. */
  106748. dPadRight: number;
  106749. /**
  106750. * Force the gamepad to synchronize with device values
  106751. */
  106752. update(): void;
  106753. /**
  106754. * Disposes the gamepad
  106755. */
  106756. dispose(): void;
  106757. }
  106758. }
  106759. declare module BABYLON {
  106760. /**
  106761. * Defines supported buttons for DualShock compatible gamepads
  106762. */
  106763. export enum DualShockButton {
  106764. /** Cross */
  106765. Cross = 0,
  106766. /** Circle */
  106767. Circle = 1,
  106768. /** Square */
  106769. Square = 2,
  106770. /** Triangle */
  106771. Triangle = 3,
  106772. /** Options */
  106773. Options = 4,
  106774. /** Share */
  106775. Share = 5,
  106776. /** L1 */
  106777. L1 = 6,
  106778. /** R1 */
  106779. R1 = 7,
  106780. /** Left stick */
  106781. LeftStick = 8,
  106782. /** Right stick */
  106783. RightStick = 9
  106784. }
  106785. /** Defines values for DualShock DPad */
  106786. export enum DualShockDpad {
  106787. /** Up */
  106788. Up = 0,
  106789. /** Down */
  106790. Down = 1,
  106791. /** Left */
  106792. Left = 2,
  106793. /** Right */
  106794. Right = 3
  106795. }
  106796. /**
  106797. * Defines a DualShock gamepad
  106798. */
  106799. export class DualShockPad extends Gamepad {
  106800. private _leftTrigger;
  106801. private _rightTrigger;
  106802. private _onlefttriggerchanged;
  106803. private _onrighttriggerchanged;
  106804. private _onbuttondown;
  106805. private _onbuttonup;
  106806. private _ondpaddown;
  106807. private _ondpadup;
  106808. /** Observable raised when a button is pressed */
  106809. onButtonDownObservable: Observable<DualShockButton>;
  106810. /** Observable raised when a button is released */
  106811. onButtonUpObservable: Observable<DualShockButton>;
  106812. /** Observable raised when a pad is pressed */
  106813. onPadDownObservable: Observable<DualShockDpad>;
  106814. /** Observable raised when a pad is released */
  106815. onPadUpObservable: Observable<DualShockDpad>;
  106816. private _buttonCross;
  106817. private _buttonCircle;
  106818. private _buttonSquare;
  106819. private _buttonTriangle;
  106820. private _buttonShare;
  106821. private _buttonOptions;
  106822. private _buttonL1;
  106823. private _buttonR1;
  106824. private _buttonLeftStick;
  106825. private _buttonRightStick;
  106826. private _dPadUp;
  106827. private _dPadDown;
  106828. private _dPadLeft;
  106829. private _dPadRight;
  106830. /**
  106831. * Creates a new DualShock gamepad object
  106832. * @param id defines the id of this gamepad
  106833. * @param index defines its index
  106834. * @param gamepad defines the internal HTML gamepad object
  106835. */
  106836. constructor(id: string, index: number, gamepad: any);
  106837. /**
  106838. * Defines the callback to call when left trigger is pressed
  106839. * @param callback defines the callback to use
  106840. */
  106841. onlefttriggerchanged(callback: (value: number) => void): void;
  106842. /**
  106843. * Defines the callback to call when right trigger is pressed
  106844. * @param callback defines the callback to use
  106845. */
  106846. onrighttriggerchanged(callback: (value: number) => void): void;
  106847. /**
  106848. * Gets the left trigger value
  106849. */
  106850. /**
  106851. * Sets the left trigger value
  106852. */
  106853. leftTrigger: number;
  106854. /**
  106855. * Gets the right trigger value
  106856. */
  106857. /**
  106858. * Sets the right trigger value
  106859. */
  106860. rightTrigger: number;
  106861. /**
  106862. * Defines the callback to call when a button is pressed
  106863. * @param callback defines the callback to use
  106864. */
  106865. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  106866. /**
  106867. * Defines the callback to call when a button is released
  106868. * @param callback defines the callback to use
  106869. */
  106870. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  106871. /**
  106872. * Defines the callback to call when a pad is pressed
  106873. * @param callback defines the callback to use
  106874. */
  106875. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  106876. /**
  106877. * Defines the callback to call when a pad is released
  106878. * @param callback defines the callback to use
  106879. */
  106880. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  106881. private _setButtonValue;
  106882. private _setDPadValue;
  106883. /**
  106884. * Gets the value of the `Cross` button
  106885. */
  106886. /**
  106887. * Sets the value of the `Cross` button
  106888. */
  106889. buttonCross: number;
  106890. /**
  106891. * Gets the value of the `Circle` button
  106892. */
  106893. /**
  106894. * Sets the value of the `Circle` button
  106895. */
  106896. buttonCircle: number;
  106897. /**
  106898. * Gets the value of the `Square` button
  106899. */
  106900. /**
  106901. * Sets the value of the `Square` button
  106902. */
  106903. buttonSquare: number;
  106904. /**
  106905. * Gets the value of the `Triangle` button
  106906. */
  106907. /**
  106908. * Sets the value of the `Triangle` button
  106909. */
  106910. buttonTriangle: number;
  106911. /**
  106912. * Gets the value of the `Options` button
  106913. */
  106914. /**
  106915. * Sets the value of the `Options` button
  106916. */
  106917. buttonOptions: number;
  106918. /**
  106919. * Gets the value of the `Share` button
  106920. */
  106921. /**
  106922. * Sets the value of the `Share` button
  106923. */
  106924. buttonShare: number;
  106925. /**
  106926. * Gets the value of the `L1` button
  106927. */
  106928. /**
  106929. * Sets the value of the `L1` button
  106930. */
  106931. buttonL1: number;
  106932. /**
  106933. * Gets the value of the `R1` button
  106934. */
  106935. /**
  106936. * Sets the value of the `R1` button
  106937. */
  106938. buttonR1: number;
  106939. /**
  106940. * Gets the value of the Left joystick
  106941. */
  106942. /**
  106943. * Sets the value of the Left joystick
  106944. */
  106945. buttonLeftStick: number;
  106946. /**
  106947. * Gets the value of the Right joystick
  106948. */
  106949. /**
  106950. * Sets the value of the Right joystick
  106951. */
  106952. buttonRightStick: number;
  106953. /**
  106954. * Gets the value of D-pad up
  106955. */
  106956. /**
  106957. * Sets the value of D-pad up
  106958. */
  106959. dPadUp: number;
  106960. /**
  106961. * Gets the value of D-pad down
  106962. */
  106963. /**
  106964. * Sets the value of D-pad down
  106965. */
  106966. dPadDown: number;
  106967. /**
  106968. * Gets the value of D-pad left
  106969. */
  106970. /**
  106971. * Sets the value of D-pad left
  106972. */
  106973. dPadLeft: number;
  106974. /**
  106975. * Gets the value of D-pad right
  106976. */
  106977. /**
  106978. * Sets the value of D-pad right
  106979. */
  106980. dPadRight: number;
  106981. /**
  106982. * Force the gamepad to synchronize with device values
  106983. */
  106984. update(): void;
  106985. /**
  106986. * Disposes the gamepad
  106987. */
  106988. dispose(): void;
  106989. }
  106990. }
  106991. declare module BABYLON {
  106992. /**
  106993. * Manager for handling gamepads
  106994. */
  106995. export class GamepadManager {
  106996. private _scene?;
  106997. private _babylonGamepads;
  106998. private _oneGamepadConnected;
  106999. /** @hidden */
  107000. _isMonitoring: boolean;
  107001. private _gamepadEventSupported;
  107002. private _gamepadSupport;
  107003. /**
  107004. * observable to be triggered when the gamepad controller has been connected
  107005. */
  107006. onGamepadConnectedObservable: Observable<Gamepad>;
  107007. /**
  107008. * observable to be triggered when the gamepad controller has been disconnected
  107009. */
  107010. onGamepadDisconnectedObservable: Observable<Gamepad>;
  107011. private _onGamepadConnectedEvent;
  107012. private _onGamepadDisconnectedEvent;
  107013. /**
  107014. * Initializes the gamepad manager
  107015. * @param _scene BabylonJS scene
  107016. */
  107017. constructor(_scene?: Scene | undefined);
  107018. /**
  107019. * The gamepads in the game pad manager
  107020. */
  107021. readonly gamepads: Gamepad[];
  107022. /**
  107023. * Get the gamepad controllers based on type
  107024. * @param type The type of gamepad controller
  107025. * @returns Nullable gamepad
  107026. */
  107027. getGamepadByType(type?: number): Nullable<Gamepad>;
  107028. /**
  107029. * Disposes the gamepad manager
  107030. */
  107031. dispose(): void;
  107032. private _addNewGamepad;
  107033. private _startMonitoringGamepads;
  107034. private _stopMonitoringGamepads;
  107035. /** @hidden */
  107036. _checkGamepadsStatus(): void;
  107037. private _updateGamepadObjects;
  107038. }
  107039. }
  107040. declare module BABYLON {
  107041. interface Scene {
  107042. /** @hidden */
  107043. _gamepadManager: Nullable<GamepadManager>;
  107044. /**
  107045. * Gets the gamepad manager associated with the scene
  107046. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  107047. */
  107048. gamepadManager: GamepadManager;
  107049. }
  107050. /**
  107051. * Interface representing a free camera inputs manager
  107052. */
  107053. interface FreeCameraInputsManager {
  107054. /**
  107055. * Adds gamepad input support to the FreeCameraInputsManager.
  107056. * @returns the FreeCameraInputsManager
  107057. */
  107058. addGamepad(): FreeCameraInputsManager;
  107059. }
  107060. /**
  107061. * Interface representing an arc rotate camera inputs manager
  107062. */
  107063. interface ArcRotateCameraInputsManager {
  107064. /**
  107065. * Adds gamepad input support to the ArcRotateCamera InputManager.
  107066. * @returns the camera inputs manager
  107067. */
  107068. addGamepad(): ArcRotateCameraInputsManager;
  107069. }
  107070. /**
  107071. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  107072. */
  107073. export class GamepadSystemSceneComponent implements ISceneComponent {
  107074. /**
  107075. * The component name helpfull to identify the component in the list of scene components.
  107076. */
  107077. readonly name: string;
  107078. /**
  107079. * The scene the component belongs to.
  107080. */
  107081. scene: Scene;
  107082. /**
  107083. * Creates a new instance of the component for the given scene
  107084. * @param scene Defines the scene to register the component in
  107085. */
  107086. constructor(scene: Scene);
  107087. /**
  107088. * Registers the component in a given scene
  107089. */
  107090. register(): void;
  107091. /**
  107092. * Rebuilds the elements related to this component in case of
  107093. * context lost for instance.
  107094. */
  107095. rebuild(): void;
  107096. /**
  107097. * Disposes the component and the associated ressources
  107098. */
  107099. dispose(): void;
  107100. private _beforeCameraUpdate;
  107101. }
  107102. }
  107103. declare module BABYLON {
  107104. /**
  107105. * 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,
  107106. * which still works and will still be found in many Playgrounds.
  107107. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107108. */
  107109. export class UniversalCamera extends TouchCamera {
  107110. /**
  107111. * Defines the gamepad rotation sensiblity.
  107112. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  107113. */
  107114. gamepadAngularSensibility: number;
  107115. /**
  107116. * Defines the gamepad move sensiblity.
  107117. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  107118. */
  107119. gamepadMoveSensibility: number;
  107120. /**
  107121. * 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,
  107122. * which still works and will still be found in many Playgrounds.
  107123. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107124. * @param name Define the name of the camera in the scene
  107125. * @param position Define the start position of the camera in the scene
  107126. * @param scene Define the scene the camera belongs to
  107127. */
  107128. constructor(name: string, position: Vector3, scene: Scene);
  107129. /**
  107130. * Gets the current object class name.
  107131. * @return the class name
  107132. */
  107133. getClassName(): string;
  107134. }
  107135. }
  107136. declare module BABYLON {
  107137. /**
  107138. * This represents a FPS type of camera. This is only here for back compat purpose.
  107139. * Please use the UniversalCamera instead as both are identical.
  107140. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107141. */
  107142. export class GamepadCamera extends UniversalCamera {
  107143. /**
  107144. * Instantiates a new Gamepad Camera
  107145. * This represents a FPS type of camera. This is only here for back compat purpose.
  107146. * Please use the UniversalCamera instead as both are identical.
  107147. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107148. * @param name Define the name of the camera in the scene
  107149. * @param position Define the start position of the camera in the scene
  107150. * @param scene Define the scene the camera belongs to
  107151. */
  107152. constructor(name: string, position: Vector3, scene: Scene);
  107153. /**
  107154. * Gets the current object class name.
  107155. * @return the class name
  107156. */
  107157. getClassName(): string;
  107158. }
  107159. }
  107160. declare module BABYLON {
  107161. /** @hidden */
  107162. export var passPixelShader: {
  107163. name: string;
  107164. shader: string;
  107165. };
  107166. }
  107167. declare module BABYLON {
  107168. /** @hidden */
  107169. export var passCubePixelShader: {
  107170. name: string;
  107171. shader: string;
  107172. };
  107173. }
  107174. declare module BABYLON {
  107175. /**
  107176. * PassPostProcess which produces an output the same as it's input
  107177. */
  107178. export class PassPostProcess extends PostProcess {
  107179. /**
  107180. * Creates the PassPostProcess
  107181. * @param name The name of the effect.
  107182. * @param options The required width/height ratio to downsize to before computing the render pass.
  107183. * @param camera The camera to apply the render pass to.
  107184. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  107185. * @param engine The engine which the post process will be applied. (default: current engine)
  107186. * @param reusable If the post process can be reused on the same frame. (default: false)
  107187. * @param textureType The type of texture to be used when performing the post processing.
  107188. * @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)
  107189. */
  107190. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  107191. }
  107192. /**
  107193. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  107194. */
  107195. export class PassCubePostProcess extends PostProcess {
  107196. private _face;
  107197. /**
  107198. * Gets or sets the cube face to display.
  107199. * * 0 is +X
  107200. * * 1 is -X
  107201. * * 2 is +Y
  107202. * * 3 is -Y
  107203. * * 4 is +Z
  107204. * * 5 is -Z
  107205. */
  107206. face: number;
  107207. /**
  107208. * Creates the PassCubePostProcess
  107209. * @param name The name of the effect.
  107210. * @param options The required width/height ratio to downsize to before computing the render pass.
  107211. * @param camera The camera to apply the render pass to.
  107212. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  107213. * @param engine The engine which the post process will be applied. (default: current engine)
  107214. * @param reusable If the post process can be reused on the same frame. (default: false)
  107215. * @param textureType The type of texture to be used when performing the post processing.
  107216. * @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)
  107217. */
  107218. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  107219. }
  107220. }
  107221. declare module BABYLON {
  107222. /** @hidden */
  107223. export var anaglyphPixelShader: {
  107224. name: string;
  107225. shader: string;
  107226. };
  107227. }
  107228. declare module BABYLON {
  107229. /**
  107230. * Postprocess used to generate anaglyphic rendering
  107231. */
  107232. export class AnaglyphPostProcess extends PostProcess {
  107233. private _passedProcess;
  107234. /**
  107235. * Creates a new AnaglyphPostProcess
  107236. * @param name defines postprocess name
  107237. * @param options defines creation options or target ratio scale
  107238. * @param rigCameras defines cameras using this postprocess
  107239. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  107240. * @param engine defines hosting engine
  107241. * @param reusable defines if the postprocess will be reused multiple times per frame
  107242. */
  107243. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  107244. }
  107245. }
  107246. declare module BABYLON {
  107247. /**
  107248. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  107249. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  107250. */
  107251. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  107252. /**
  107253. * Creates a new AnaglyphArcRotateCamera
  107254. * @param name defines camera name
  107255. * @param alpha defines alpha angle (in radians)
  107256. * @param beta defines beta angle (in radians)
  107257. * @param radius defines radius
  107258. * @param target defines camera target
  107259. * @param interaxialDistance defines distance between each color axis
  107260. * @param scene defines the hosting scene
  107261. */
  107262. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  107263. /**
  107264. * Gets camera class name
  107265. * @returns AnaglyphArcRotateCamera
  107266. */
  107267. getClassName(): string;
  107268. }
  107269. }
  107270. declare module BABYLON {
  107271. /**
  107272. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  107273. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  107274. */
  107275. export class AnaglyphFreeCamera extends FreeCamera {
  107276. /**
  107277. * Creates a new AnaglyphFreeCamera
  107278. * @param name defines camera name
  107279. * @param position defines initial position
  107280. * @param interaxialDistance defines distance between each color axis
  107281. * @param scene defines the hosting scene
  107282. */
  107283. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  107284. /**
  107285. * Gets camera class name
  107286. * @returns AnaglyphFreeCamera
  107287. */
  107288. getClassName(): string;
  107289. }
  107290. }
  107291. declare module BABYLON {
  107292. /**
  107293. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  107294. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  107295. */
  107296. export class AnaglyphGamepadCamera extends GamepadCamera {
  107297. /**
  107298. * Creates a new AnaglyphGamepadCamera
  107299. * @param name defines camera name
  107300. * @param position defines initial position
  107301. * @param interaxialDistance defines distance between each color axis
  107302. * @param scene defines the hosting scene
  107303. */
  107304. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  107305. /**
  107306. * Gets camera class name
  107307. * @returns AnaglyphGamepadCamera
  107308. */
  107309. getClassName(): string;
  107310. }
  107311. }
  107312. declare module BABYLON {
  107313. /**
  107314. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  107315. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  107316. */
  107317. export class AnaglyphUniversalCamera extends UniversalCamera {
  107318. /**
  107319. * Creates a new AnaglyphUniversalCamera
  107320. * @param name defines camera name
  107321. * @param position defines initial position
  107322. * @param interaxialDistance defines distance between each color axis
  107323. * @param scene defines the hosting scene
  107324. */
  107325. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  107326. /**
  107327. * Gets camera class name
  107328. * @returns AnaglyphUniversalCamera
  107329. */
  107330. getClassName(): string;
  107331. }
  107332. }
  107333. declare module BABYLON {
  107334. /** @hidden */
  107335. export var stereoscopicInterlacePixelShader: {
  107336. name: string;
  107337. shader: string;
  107338. };
  107339. }
  107340. declare module BABYLON {
  107341. /**
  107342. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  107343. */
  107344. export class StereoscopicInterlacePostProcess extends PostProcess {
  107345. private _stepSize;
  107346. private _passedProcess;
  107347. /**
  107348. * Initializes a StereoscopicInterlacePostProcess
  107349. * @param name The name of the effect.
  107350. * @param rigCameras The rig cameras to be appled to the post process
  107351. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  107352. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  107353. * @param engine The engine which the post process will be applied. (default: current engine)
  107354. * @param reusable If the post process can be reused on the same frame. (default: false)
  107355. */
  107356. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  107357. }
  107358. }
  107359. declare module BABYLON {
  107360. /**
  107361. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  107362. * @see http://doc.babylonjs.com/features/cameras
  107363. */
  107364. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  107365. /**
  107366. * Creates a new StereoscopicArcRotateCamera
  107367. * @param name defines camera name
  107368. * @param alpha defines alpha angle (in radians)
  107369. * @param beta defines beta angle (in radians)
  107370. * @param radius defines radius
  107371. * @param target defines camera target
  107372. * @param interaxialDistance defines distance between each color axis
  107373. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  107374. * @param scene defines the hosting scene
  107375. */
  107376. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  107377. /**
  107378. * Gets camera class name
  107379. * @returns StereoscopicArcRotateCamera
  107380. */
  107381. getClassName(): string;
  107382. }
  107383. }
  107384. declare module BABYLON {
  107385. /**
  107386. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  107387. * @see http://doc.babylonjs.com/features/cameras
  107388. */
  107389. export class StereoscopicFreeCamera extends FreeCamera {
  107390. /**
  107391. * Creates a new StereoscopicFreeCamera
  107392. * @param name defines camera name
  107393. * @param position defines initial position
  107394. * @param interaxialDistance defines distance between each color axis
  107395. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  107396. * @param scene defines the hosting scene
  107397. */
  107398. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  107399. /**
  107400. * Gets camera class name
  107401. * @returns StereoscopicFreeCamera
  107402. */
  107403. getClassName(): string;
  107404. }
  107405. }
  107406. declare module BABYLON {
  107407. /**
  107408. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  107409. * @see http://doc.babylonjs.com/features/cameras
  107410. */
  107411. export class StereoscopicGamepadCamera extends GamepadCamera {
  107412. /**
  107413. * Creates a new StereoscopicGamepadCamera
  107414. * @param name defines camera name
  107415. * @param position defines initial position
  107416. * @param interaxialDistance defines distance between each color axis
  107417. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  107418. * @param scene defines the hosting scene
  107419. */
  107420. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  107421. /**
  107422. * Gets camera class name
  107423. * @returns StereoscopicGamepadCamera
  107424. */
  107425. getClassName(): string;
  107426. }
  107427. }
  107428. declare module BABYLON {
  107429. /**
  107430. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  107431. * @see http://doc.babylonjs.com/features/cameras
  107432. */
  107433. export class StereoscopicUniversalCamera extends UniversalCamera {
  107434. /**
  107435. * Creates a new StereoscopicUniversalCamera
  107436. * @param name defines camera name
  107437. * @param position defines initial position
  107438. * @param interaxialDistance defines distance between each color axis
  107439. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  107440. * @param scene defines the hosting scene
  107441. */
  107442. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  107443. /**
  107444. * Gets camera class name
  107445. * @returns StereoscopicUniversalCamera
  107446. */
  107447. getClassName(): string;
  107448. }
  107449. }
  107450. declare module BABYLON {
  107451. /**
  107452. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  107453. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  107454. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  107455. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  107456. */
  107457. export class VirtualJoysticksCamera extends FreeCamera {
  107458. /**
  107459. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  107460. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  107461. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  107462. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  107463. * @param name Define the name of the camera in the scene
  107464. * @param position Define the start position of the camera in the scene
  107465. * @param scene Define the scene the camera belongs to
  107466. */
  107467. constructor(name: string, position: Vector3, scene: Scene);
  107468. /**
  107469. * Gets the current object class name.
  107470. * @return the class name
  107471. */
  107472. getClassName(): string;
  107473. }
  107474. }
  107475. declare module BABYLON {
  107476. /**
  107477. * This represents all the required metrics to create a VR camera.
  107478. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  107479. */
  107480. export class VRCameraMetrics {
  107481. /**
  107482. * Define the horizontal resolution off the screen.
  107483. */
  107484. hResolution: number;
  107485. /**
  107486. * Define the vertical resolution off the screen.
  107487. */
  107488. vResolution: number;
  107489. /**
  107490. * Define the horizontal screen size.
  107491. */
  107492. hScreenSize: number;
  107493. /**
  107494. * Define the vertical screen size.
  107495. */
  107496. vScreenSize: number;
  107497. /**
  107498. * Define the vertical screen center position.
  107499. */
  107500. vScreenCenter: number;
  107501. /**
  107502. * Define the distance of the eyes to the screen.
  107503. */
  107504. eyeToScreenDistance: number;
  107505. /**
  107506. * Define the distance between both lenses
  107507. */
  107508. lensSeparationDistance: number;
  107509. /**
  107510. * Define the distance between both viewer's eyes.
  107511. */
  107512. interpupillaryDistance: number;
  107513. /**
  107514. * Define the distortion factor of the VR postprocess.
  107515. * Please, touch with care.
  107516. */
  107517. distortionK: number[];
  107518. /**
  107519. * Define the chromatic aberration correction factors for the VR post process.
  107520. */
  107521. chromaAbCorrection: number[];
  107522. /**
  107523. * Define the scale factor of the post process.
  107524. * The smaller the better but the slower.
  107525. */
  107526. postProcessScaleFactor: number;
  107527. /**
  107528. * Define an offset for the lens center.
  107529. */
  107530. lensCenterOffset: number;
  107531. /**
  107532. * Define if the current vr camera should compensate the distortion of the lense or not.
  107533. */
  107534. compensateDistortion: boolean;
  107535. /**
  107536. * Defines if multiview should be enabled when rendering (Default: false)
  107537. */
  107538. multiviewEnabled: boolean;
  107539. /**
  107540. * Gets the rendering aspect ratio based on the provided resolutions.
  107541. */
  107542. readonly aspectRatio: number;
  107543. /**
  107544. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  107545. */
  107546. readonly aspectRatioFov: number;
  107547. /**
  107548. * @hidden
  107549. */
  107550. readonly leftHMatrix: Matrix;
  107551. /**
  107552. * @hidden
  107553. */
  107554. readonly rightHMatrix: Matrix;
  107555. /**
  107556. * @hidden
  107557. */
  107558. readonly leftPreViewMatrix: Matrix;
  107559. /**
  107560. * @hidden
  107561. */
  107562. readonly rightPreViewMatrix: Matrix;
  107563. /**
  107564. * Get the default VRMetrics based on the most generic setup.
  107565. * @returns the default vr metrics
  107566. */
  107567. static GetDefault(): VRCameraMetrics;
  107568. }
  107569. }
  107570. declare module BABYLON {
  107571. /** @hidden */
  107572. export var vrDistortionCorrectionPixelShader: {
  107573. name: string;
  107574. shader: string;
  107575. };
  107576. }
  107577. declare module BABYLON {
  107578. /**
  107579. * VRDistortionCorrectionPostProcess used for mobile VR
  107580. */
  107581. export class VRDistortionCorrectionPostProcess extends PostProcess {
  107582. private _isRightEye;
  107583. private _distortionFactors;
  107584. private _postProcessScaleFactor;
  107585. private _lensCenterOffset;
  107586. private _scaleIn;
  107587. private _scaleFactor;
  107588. private _lensCenter;
  107589. /**
  107590. * Initializes the VRDistortionCorrectionPostProcess
  107591. * @param name The name of the effect.
  107592. * @param camera The camera to apply the render pass to.
  107593. * @param isRightEye If this is for the right eye distortion
  107594. * @param vrMetrics All the required metrics for the VR camera
  107595. */
  107596. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  107597. }
  107598. }
  107599. declare module BABYLON {
  107600. /**
  107601. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  107602. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  107603. */
  107604. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  107605. /**
  107606. * Creates a new VRDeviceOrientationArcRotateCamera
  107607. * @param name defines camera name
  107608. * @param alpha defines the camera rotation along the logitudinal axis
  107609. * @param beta defines the camera rotation along the latitudinal axis
  107610. * @param radius defines the camera distance from its target
  107611. * @param target defines the camera target
  107612. * @param scene defines the scene the camera belongs to
  107613. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  107614. * @param vrCameraMetrics defines the vr metrics associated to the camera
  107615. */
  107616. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  107617. /**
  107618. * Gets camera class name
  107619. * @returns VRDeviceOrientationArcRotateCamera
  107620. */
  107621. getClassName(): string;
  107622. }
  107623. }
  107624. declare module BABYLON {
  107625. /**
  107626. * Camera used to simulate VR rendering (based on FreeCamera)
  107627. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  107628. */
  107629. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  107630. /**
  107631. * Creates a new VRDeviceOrientationFreeCamera
  107632. * @param name defines camera name
  107633. * @param position defines the start position of the camera
  107634. * @param scene defines the scene the camera belongs to
  107635. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  107636. * @param vrCameraMetrics defines the vr metrics associated to the camera
  107637. */
  107638. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  107639. /**
  107640. * Gets camera class name
  107641. * @returns VRDeviceOrientationFreeCamera
  107642. */
  107643. getClassName(): string;
  107644. }
  107645. }
  107646. declare module BABYLON {
  107647. /**
  107648. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  107649. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  107650. */
  107651. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  107652. /**
  107653. * Creates a new VRDeviceOrientationGamepadCamera
  107654. * @param name defines camera name
  107655. * @param position defines the start position of the camera
  107656. * @param scene defines the scene the camera belongs to
  107657. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  107658. * @param vrCameraMetrics defines the vr metrics associated to the camera
  107659. */
  107660. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  107661. /**
  107662. * Gets camera class name
  107663. * @returns VRDeviceOrientationGamepadCamera
  107664. */
  107665. getClassName(): string;
  107666. }
  107667. }
  107668. declare module BABYLON {
  107669. /**
  107670. * Base class of materials working in push mode in babylon JS
  107671. * @hidden
  107672. */
  107673. export class PushMaterial extends Material {
  107674. protected _activeEffect: Effect;
  107675. protected _normalMatrix: Matrix;
  107676. /**
  107677. * Gets or sets a boolean indicating that the material is allowed to do shader hot swapping.
  107678. * This means that the material can keep using a previous shader while a new one is being compiled.
  107679. * This is mostly used when shader parallel compilation is supported (true by default)
  107680. */
  107681. allowShaderHotSwapping: boolean;
  107682. constructor(name: string, scene: Scene);
  107683. getEffect(): Effect;
  107684. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  107685. /**
  107686. * Binds the given world matrix to the active effect
  107687. *
  107688. * @param world the matrix to bind
  107689. */
  107690. bindOnlyWorldMatrix(world: Matrix): void;
  107691. /**
  107692. * Binds the given normal matrix to the active effect
  107693. *
  107694. * @param normalMatrix the matrix to bind
  107695. */
  107696. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  107697. bind(world: Matrix, mesh?: Mesh): void;
  107698. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  107699. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  107700. }
  107701. }
  107702. declare module BABYLON {
  107703. /**
  107704. * This groups all the flags used to control the materials channel.
  107705. */
  107706. export class MaterialFlags {
  107707. private static _DiffuseTextureEnabled;
  107708. /**
  107709. * Are diffuse textures enabled in the application.
  107710. */
  107711. static DiffuseTextureEnabled: boolean;
  107712. private static _AmbientTextureEnabled;
  107713. /**
  107714. * Are ambient textures enabled in the application.
  107715. */
  107716. static AmbientTextureEnabled: boolean;
  107717. private static _OpacityTextureEnabled;
  107718. /**
  107719. * Are opacity textures enabled in the application.
  107720. */
  107721. static OpacityTextureEnabled: boolean;
  107722. private static _ReflectionTextureEnabled;
  107723. /**
  107724. * Are reflection textures enabled in the application.
  107725. */
  107726. static ReflectionTextureEnabled: boolean;
  107727. private static _EmissiveTextureEnabled;
  107728. /**
  107729. * Are emissive textures enabled in the application.
  107730. */
  107731. static EmissiveTextureEnabled: boolean;
  107732. private static _SpecularTextureEnabled;
  107733. /**
  107734. * Are specular textures enabled in the application.
  107735. */
  107736. static SpecularTextureEnabled: boolean;
  107737. private static _BumpTextureEnabled;
  107738. /**
  107739. * Are bump textures enabled in the application.
  107740. */
  107741. static BumpTextureEnabled: boolean;
  107742. private static _LightmapTextureEnabled;
  107743. /**
  107744. * Are lightmap textures enabled in the application.
  107745. */
  107746. static LightmapTextureEnabled: boolean;
  107747. private static _RefractionTextureEnabled;
  107748. /**
  107749. * Are refraction textures enabled in the application.
  107750. */
  107751. static RefractionTextureEnabled: boolean;
  107752. private static _ColorGradingTextureEnabled;
  107753. /**
  107754. * Are color grading textures enabled in the application.
  107755. */
  107756. static ColorGradingTextureEnabled: boolean;
  107757. private static _FresnelEnabled;
  107758. /**
  107759. * Are fresnels enabled in the application.
  107760. */
  107761. static FresnelEnabled: boolean;
  107762. private static _ClearCoatTextureEnabled;
  107763. /**
  107764. * Are clear coat textures enabled in the application.
  107765. */
  107766. static ClearCoatTextureEnabled: boolean;
  107767. private static _ClearCoatBumpTextureEnabled;
  107768. /**
  107769. * Are clear coat bump textures enabled in the application.
  107770. */
  107771. static ClearCoatBumpTextureEnabled: boolean;
  107772. private static _ClearCoatTintTextureEnabled;
  107773. /**
  107774. * Are clear coat tint textures enabled in the application.
  107775. */
  107776. static ClearCoatTintTextureEnabled: boolean;
  107777. private static _SheenTextureEnabled;
  107778. /**
  107779. * Are sheen textures enabled in the application.
  107780. */
  107781. static SheenTextureEnabled: boolean;
  107782. private static _AnisotropicTextureEnabled;
  107783. /**
  107784. * Are anisotropic textures enabled in the application.
  107785. */
  107786. static AnisotropicTextureEnabled: boolean;
  107787. private static _ThicknessTextureEnabled;
  107788. /**
  107789. * Are thickness textures enabled in the application.
  107790. */
  107791. static ThicknessTextureEnabled: boolean;
  107792. }
  107793. }
  107794. declare module BABYLON {
  107795. /** @hidden */
  107796. export var defaultFragmentDeclaration: {
  107797. name: string;
  107798. shader: string;
  107799. };
  107800. }
  107801. declare module BABYLON {
  107802. /** @hidden */
  107803. export var defaultUboDeclaration: {
  107804. name: string;
  107805. shader: string;
  107806. };
  107807. }
  107808. declare module BABYLON {
  107809. /** @hidden */
  107810. export var lightFragmentDeclaration: {
  107811. name: string;
  107812. shader: string;
  107813. };
  107814. }
  107815. declare module BABYLON {
  107816. /** @hidden */
  107817. export var lightUboDeclaration: {
  107818. name: string;
  107819. shader: string;
  107820. };
  107821. }
  107822. declare module BABYLON {
  107823. /** @hidden */
  107824. export var lightsFragmentFunctions: {
  107825. name: string;
  107826. shader: string;
  107827. };
  107828. }
  107829. declare module BABYLON {
  107830. /** @hidden */
  107831. export var shadowsFragmentFunctions: {
  107832. name: string;
  107833. shader: string;
  107834. };
  107835. }
  107836. declare module BABYLON {
  107837. /** @hidden */
  107838. export var fresnelFunction: {
  107839. name: string;
  107840. shader: string;
  107841. };
  107842. }
  107843. declare module BABYLON {
  107844. /** @hidden */
  107845. export var reflectionFunction: {
  107846. name: string;
  107847. shader: string;
  107848. };
  107849. }
  107850. declare module BABYLON {
  107851. /** @hidden */
  107852. export var bumpFragmentFunctions: {
  107853. name: string;
  107854. shader: string;
  107855. };
  107856. }
  107857. declare module BABYLON {
  107858. /** @hidden */
  107859. export var logDepthDeclaration: {
  107860. name: string;
  107861. shader: string;
  107862. };
  107863. }
  107864. declare module BABYLON {
  107865. /** @hidden */
  107866. export var bumpFragment: {
  107867. name: string;
  107868. shader: string;
  107869. };
  107870. }
  107871. declare module BABYLON {
  107872. /** @hidden */
  107873. export var depthPrePass: {
  107874. name: string;
  107875. shader: string;
  107876. };
  107877. }
  107878. declare module BABYLON {
  107879. /** @hidden */
  107880. export var lightFragment: {
  107881. name: string;
  107882. shader: string;
  107883. };
  107884. }
  107885. declare module BABYLON {
  107886. /** @hidden */
  107887. export var logDepthFragment: {
  107888. name: string;
  107889. shader: string;
  107890. };
  107891. }
  107892. declare module BABYLON {
  107893. /** @hidden */
  107894. export var defaultPixelShader: {
  107895. name: string;
  107896. shader: string;
  107897. };
  107898. }
  107899. declare module BABYLON {
  107900. /** @hidden */
  107901. export var defaultVertexDeclaration: {
  107902. name: string;
  107903. shader: string;
  107904. };
  107905. }
  107906. declare module BABYLON {
  107907. /** @hidden */
  107908. export var bumpVertexDeclaration: {
  107909. name: string;
  107910. shader: string;
  107911. };
  107912. }
  107913. declare module BABYLON {
  107914. /** @hidden */
  107915. export var bumpVertex: {
  107916. name: string;
  107917. shader: string;
  107918. };
  107919. }
  107920. declare module BABYLON {
  107921. /** @hidden */
  107922. export var fogVertex: {
  107923. name: string;
  107924. shader: string;
  107925. };
  107926. }
  107927. declare module BABYLON {
  107928. /** @hidden */
  107929. export var shadowsVertex: {
  107930. name: string;
  107931. shader: string;
  107932. };
  107933. }
  107934. declare module BABYLON {
  107935. /** @hidden */
  107936. export var pointCloudVertex: {
  107937. name: string;
  107938. shader: string;
  107939. };
  107940. }
  107941. declare module BABYLON {
  107942. /** @hidden */
  107943. export var logDepthVertex: {
  107944. name: string;
  107945. shader: string;
  107946. };
  107947. }
  107948. declare module BABYLON {
  107949. /** @hidden */
  107950. export var defaultVertexShader: {
  107951. name: string;
  107952. shader: string;
  107953. };
  107954. }
  107955. declare module BABYLON {
  107956. /** @hidden */
  107957. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  107958. MAINUV1: boolean;
  107959. MAINUV2: boolean;
  107960. DIFFUSE: boolean;
  107961. DIFFUSEDIRECTUV: number;
  107962. AMBIENT: boolean;
  107963. AMBIENTDIRECTUV: number;
  107964. OPACITY: boolean;
  107965. OPACITYDIRECTUV: number;
  107966. OPACITYRGB: boolean;
  107967. REFLECTION: boolean;
  107968. EMISSIVE: boolean;
  107969. EMISSIVEDIRECTUV: number;
  107970. SPECULAR: boolean;
  107971. SPECULARDIRECTUV: number;
  107972. BUMP: boolean;
  107973. BUMPDIRECTUV: number;
  107974. PARALLAX: boolean;
  107975. PARALLAXOCCLUSION: boolean;
  107976. SPECULAROVERALPHA: boolean;
  107977. CLIPPLANE: boolean;
  107978. CLIPPLANE2: boolean;
  107979. CLIPPLANE3: boolean;
  107980. CLIPPLANE4: boolean;
  107981. ALPHATEST: boolean;
  107982. DEPTHPREPASS: boolean;
  107983. ALPHAFROMDIFFUSE: boolean;
  107984. POINTSIZE: boolean;
  107985. FOG: boolean;
  107986. SPECULARTERM: boolean;
  107987. DIFFUSEFRESNEL: boolean;
  107988. OPACITYFRESNEL: boolean;
  107989. REFLECTIONFRESNEL: boolean;
  107990. REFRACTIONFRESNEL: boolean;
  107991. EMISSIVEFRESNEL: boolean;
  107992. FRESNEL: boolean;
  107993. NORMAL: boolean;
  107994. UV1: boolean;
  107995. UV2: boolean;
  107996. VERTEXCOLOR: boolean;
  107997. VERTEXALPHA: boolean;
  107998. NUM_BONE_INFLUENCERS: number;
  107999. BonesPerMesh: number;
  108000. BONETEXTURE: boolean;
  108001. INSTANCES: boolean;
  108002. GLOSSINESS: boolean;
  108003. ROUGHNESS: boolean;
  108004. EMISSIVEASILLUMINATION: boolean;
  108005. LINKEMISSIVEWITHDIFFUSE: boolean;
  108006. REFLECTIONFRESNELFROMSPECULAR: boolean;
  108007. LIGHTMAP: boolean;
  108008. LIGHTMAPDIRECTUV: number;
  108009. OBJECTSPACE_NORMALMAP: boolean;
  108010. USELIGHTMAPASSHADOWMAP: boolean;
  108011. REFLECTIONMAP_3D: boolean;
  108012. REFLECTIONMAP_SPHERICAL: boolean;
  108013. REFLECTIONMAP_PLANAR: boolean;
  108014. REFLECTIONMAP_CUBIC: boolean;
  108015. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  108016. REFLECTIONMAP_PROJECTION: boolean;
  108017. REFLECTIONMAP_SKYBOX: boolean;
  108018. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  108019. REFLECTIONMAP_EXPLICIT: boolean;
  108020. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  108021. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  108022. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  108023. INVERTCUBICMAP: boolean;
  108024. LOGARITHMICDEPTH: boolean;
  108025. REFRACTION: boolean;
  108026. REFRACTIONMAP_3D: boolean;
  108027. REFLECTIONOVERALPHA: boolean;
  108028. TWOSIDEDLIGHTING: boolean;
  108029. SHADOWFLOAT: boolean;
  108030. MORPHTARGETS: boolean;
  108031. MORPHTARGETS_NORMAL: boolean;
  108032. MORPHTARGETS_TANGENT: boolean;
  108033. MORPHTARGETS_UV: boolean;
  108034. NUM_MORPH_INFLUENCERS: number;
  108035. NONUNIFORMSCALING: boolean;
  108036. PREMULTIPLYALPHA: boolean;
  108037. IMAGEPROCESSING: boolean;
  108038. VIGNETTE: boolean;
  108039. VIGNETTEBLENDMODEMULTIPLY: boolean;
  108040. VIGNETTEBLENDMODEOPAQUE: boolean;
  108041. TONEMAPPING: boolean;
  108042. TONEMAPPING_ACES: boolean;
  108043. CONTRAST: boolean;
  108044. COLORCURVES: boolean;
  108045. COLORGRADING: boolean;
  108046. COLORGRADING3D: boolean;
  108047. SAMPLER3DGREENDEPTH: boolean;
  108048. SAMPLER3DBGRMAP: boolean;
  108049. IMAGEPROCESSINGPOSTPROCESS: boolean;
  108050. MULTIVIEW: boolean;
  108051. /**
  108052. * If the reflection texture on this material is in linear color space
  108053. * @hidden
  108054. */
  108055. IS_REFLECTION_LINEAR: boolean;
  108056. /**
  108057. * If the refraction texture on this material is in linear color space
  108058. * @hidden
  108059. */
  108060. IS_REFRACTION_LINEAR: boolean;
  108061. EXPOSURE: boolean;
  108062. constructor();
  108063. setReflectionMode(modeToEnable: string): void;
  108064. }
  108065. /**
  108066. * This is the default material used in Babylon. It is the best trade off between quality
  108067. * and performances.
  108068. * @see http://doc.babylonjs.com/babylon101/materials
  108069. */
  108070. export class StandardMaterial extends PushMaterial {
  108071. private _diffuseTexture;
  108072. /**
  108073. * The basic texture of the material as viewed under a light.
  108074. */
  108075. diffuseTexture: Nullable<BaseTexture>;
  108076. private _ambientTexture;
  108077. /**
  108078. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  108079. */
  108080. ambientTexture: Nullable<BaseTexture>;
  108081. private _opacityTexture;
  108082. /**
  108083. * Define the transparency of the material from a texture.
  108084. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  108085. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  108086. */
  108087. opacityTexture: Nullable<BaseTexture>;
  108088. private _reflectionTexture;
  108089. /**
  108090. * Define the texture used to display the reflection.
  108091. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108092. */
  108093. reflectionTexture: Nullable<BaseTexture>;
  108094. private _emissiveTexture;
  108095. /**
  108096. * Define texture of the material as if self lit.
  108097. * This will be mixed in the final result even in the absence of light.
  108098. */
  108099. emissiveTexture: Nullable<BaseTexture>;
  108100. private _specularTexture;
  108101. /**
  108102. * Define how the color and intensity of the highlight given by the light in the material.
  108103. */
  108104. specularTexture: Nullable<BaseTexture>;
  108105. private _bumpTexture;
  108106. /**
  108107. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  108108. * 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.
  108109. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  108110. */
  108111. bumpTexture: Nullable<BaseTexture>;
  108112. private _lightmapTexture;
  108113. /**
  108114. * Complex lighting can be computationally expensive to compute at runtime.
  108115. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  108116. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  108117. */
  108118. lightmapTexture: Nullable<BaseTexture>;
  108119. private _refractionTexture;
  108120. /**
  108121. * Define the texture used to display the refraction.
  108122. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108123. */
  108124. refractionTexture: Nullable<BaseTexture>;
  108125. /**
  108126. * The color of the material lit by the environmental background lighting.
  108127. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  108128. */
  108129. ambientColor: Color3;
  108130. /**
  108131. * The basic color of the material as viewed under a light.
  108132. */
  108133. diffuseColor: Color3;
  108134. /**
  108135. * Define how the color and intensity of the highlight given by the light in the material.
  108136. */
  108137. specularColor: Color3;
  108138. /**
  108139. * Define the color of the material as if self lit.
  108140. * This will be mixed in the final result even in the absence of light.
  108141. */
  108142. emissiveColor: Color3;
  108143. /**
  108144. * Defines how sharp are the highlights in the material.
  108145. * The bigger the value the sharper giving a more glossy feeling to the result.
  108146. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  108147. */
  108148. specularPower: number;
  108149. private _useAlphaFromDiffuseTexture;
  108150. /**
  108151. * Does the transparency come from the diffuse texture alpha channel.
  108152. */
  108153. useAlphaFromDiffuseTexture: boolean;
  108154. private _useEmissiveAsIllumination;
  108155. /**
  108156. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  108157. */
  108158. useEmissiveAsIllumination: boolean;
  108159. private _linkEmissiveWithDiffuse;
  108160. /**
  108161. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  108162. * the emissive level when the final color is close to one.
  108163. */
  108164. linkEmissiveWithDiffuse: boolean;
  108165. private _useSpecularOverAlpha;
  108166. /**
  108167. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  108168. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  108169. */
  108170. useSpecularOverAlpha: boolean;
  108171. private _useReflectionOverAlpha;
  108172. /**
  108173. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  108174. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  108175. */
  108176. useReflectionOverAlpha: boolean;
  108177. private _disableLighting;
  108178. /**
  108179. * Does lights from the scene impacts this material.
  108180. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  108181. */
  108182. disableLighting: boolean;
  108183. private _useObjectSpaceNormalMap;
  108184. /**
  108185. * Allows using an object space normal map (instead of tangent space).
  108186. */
  108187. useObjectSpaceNormalMap: boolean;
  108188. private _useParallax;
  108189. /**
  108190. * Is parallax enabled or not.
  108191. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  108192. */
  108193. useParallax: boolean;
  108194. private _useParallaxOcclusion;
  108195. /**
  108196. * Is parallax occlusion enabled or not.
  108197. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  108198. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  108199. */
  108200. useParallaxOcclusion: boolean;
  108201. /**
  108202. * 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.
  108203. */
  108204. parallaxScaleBias: number;
  108205. private _roughness;
  108206. /**
  108207. * Helps to define how blurry the reflections should appears in the material.
  108208. */
  108209. roughness: number;
  108210. /**
  108211. * In case of refraction, define the value of the index of refraction.
  108212. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108213. */
  108214. indexOfRefraction: number;
  108215. /**
  108216. * Invert the refraction texture alongside the y axis.
  108217. * It can be useful with procedural textures or probe for instance.
  108218. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108219. */
  108220. invertRefractionY: boolean;
  108221. /**
  108222. * Defines the alpha limits in alpha test mode.
  108223. */
  108224. alphaCutOff: number;
  108225. private _useLightmapAsShadowmap;
  108226. /**
  108227. * In case of light mapping, define whether the map contains light or shadow informations.
  108228. */
  108229. useLightmapAsShadowmap: boolean;
  108230. private _diffuseFresnelParameters;
  108231. /**
  108232. * Define the diffuse fresnel parameters of the material.
  108233. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108234. */
  108235. diffuseFresnelParameters: FresnelParameters;
  108236. private _opacityFresnelParameters;
  108237. /**
  108238. * Define the opacity fresnel parameters of the material.
  108239. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108240. */
  108241. opacityFresnelParameters: FresnelParameters;
  108242. private _reflectionFresnelParameters;
  108243. /**
  108244. * Define the reflection fresnel parameters of the material.
  108245. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108246. */
  108247. reflectionFresnelParameters: FresnelParameters;
  108248. private _refractionFresnelParameters;
  108249. /**
  108250. * Define the refraction fresnel parameters of the material.
  108251. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108252. */
  108253. refractionFresnelParameters: FresnelParameters;
  108254. private _emissiveFresnelParameters;
  108255. /**
  108256. * Define the emissive fresnel parameters of the material.
  108257. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108258. */
  108259. emissiveFresnelParameters: FresnelParameters;
  108260. private _useReflectionFresnelFromSpecular;
  108261. /**
  108262. * If true automatically deducts the fresnels values from the material specularity.
  108263. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108264. */
  108265. useReflectionFresnelFromSpecular: boolean;
  108266. private _useGlossinessFromSpecularMapAlpha;
  108267. /**
  108268. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  108269. */
  108270. useGlossinessFromSpecularMapAlpha: boolean;
  108271. private _maxSimultaneousLights;
  108272. /**
  108273. * Defines the maximum number of lights that can be used in the material
  108274. */
  108275. maxSimultaneousLights: number;
  108276. private _invertNormalMapX;
  108277. /**
  108278. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  108279. */
  108280. invertNormalMapX: boolean;
  108281. private _invertNormalMapY;
  108282. /**
  108283. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  108284. */
  108285. invertNormalMapY: boolean;
  108286. private _twoSidedLighting;
  108287. /**
  108288. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  108289. */
  108290. twoSidedLighting: boolean;
  108291. /**
  108292. * Default configuration related to image processing available in the standard Material.
  108293. */
  108294. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  108295. /**
  108296. * Gets the image processing configuration used either in this material.
  108297. */
  108298. /**
  108299. * Sets the Default image processing configuration used either in the this material.
  108300. *
  108301. * If sets to null, the scene one is in use.
  108302. */
  108303. imageProcessingConfiguration: ImageProcessingConfiguration;
  108304. /**
  108305. * Keep track of the image processing observer to allow dispose and replace.
  108306. */
  108307. private _imageProcessingObserver;
  108308. /**
  108309. * Attaches a new image processing configuration to the Standard Material.
  108310. * @param configuration
  108311. */
  108312. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  108313. /**
  108314. * Gets wether the color curves effect is enabled.
  108315. */
  108316. /**
  108317. * Sets wether the color curves effect is enabled.
  108318. */
  108319. cameraColorCurvesEnabled: boolean;
  108320. /**
  108321. * Gets wether the color grading effect is enabled.
  108322. */
  108323. /**
  108324. * Gets wether the color grading effect is enabled.
  108325. */
  108326. cameraColorGradingEnabled: boolean;
  108327. /**
  108328. * Gets wether tonemapping is enabled or not.
  108329. */
  108330. /**
  108331. * Sets wether tonemapping is enabled or not
  108332. */
  108333. cameraToneMappingEnabled: boolean;
  108334. /**
  108335. * The camera exposure used on this material.
  108336. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  108337. * This corresponds to a photographic exposure.
  108338. */
  108339. /**
  108340. * The camera exposure used on this material.
  108341. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  108342. * This corresponds to a photographic exposure.
  108343. */
  108344. cameraExposure: number;
  108345. /**
  108346. * Gets The camera contrast used on this material.
  108347. */
  108348. /**
  108349. * Sets The camera contrast used on this material.
  108350. */
  108351. cameraContrast: number;
  108352. /**
  108353. * Gets the Color Grading 2D Lookup Texture.
  108354. */
  108355. /**
  108356. * Sets the Color Grading 2D Lookup Texture.
  108357. */
  108358. cameraColorGradingTexture: Nullable<BaseTexture>;
  108359. /**
  108360. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  108361. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  108362. * 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;
  108363. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  108364. */
  108365. /**
  108366. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  108367. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  108368. * 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;
  108369. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  108370. */
  108371. cameraColorCurves: Nullable<ColorCurves>;
  108372. /**
  108373. * Custom callback helping to override the default shader used in the material.
  108374. */
  108375. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: StandardMaterialDefines) => string;
  108376. protected _renderTargets: SmartArray<RenderTargetTexture>;
  108377. protected _worldViewProjectionMatrix: Matrix;
  108378. protected _globalAmbientColor: Color3;
  108379. protected _useLogarithmicDepth: boolean;
  108380. protected _rebuildInParallel: boolean;
  108381. /**
  108382. * Instantiates a new standard material.
  108383. * This is the default material used in Babylon. It is the best trade off between quality
  108384. * and performances.
  108385. * @see http://doc.babylonjs.com/babylon101/materials
  108386. * @param name Define the name of the material in the scene
  108387. * @param scene Define the scene the material belong to
  108388. */
  108389. constructor(name: string, scene: Scene);
  108390. /**
  108391. * Gets a boolean indicating that current material needs to register RTT
  108392. */
  108393. readonly hasRenderTargetTextures: boolean;
  108394. /**
  108395. * Gets the current class name of the material e.g. "StandardMaterial"
  108396. * Mainly use in serialization.
  108397. * @returns the class name
  108398. */
  108399. getClassName(): string;
  108400. /**
  108401. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  108402. * You can try switching to logarithmic depth.
  108403. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  108404. */
  108405. useLogarithmicDepth: boolean;
  108406. /**
  108407. * Specifies if the material will require alpha blending
  108408. * @returns a boolean specifying if alpha blending is needed
  108409. */
  108410. needAlphaBlending(): boolean;
  108411. /**
  108412. * Specifies if this material should be rendered in alpha test mode
  108413. * @returns a boolean specifying if an alpha test is needed.
  108414. */
  108415. needAlphaTesting(): boolean;
  108416. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  108417. /**
  108418. * Get the texture used for alpha test purpose.
  108419. * @returns the diffuse texture in case of the standard material.
  108420. */
  108421. getAlphaTestTexture(): Nullable<BaseTexture>;
  108422. /**
  108423. * Get if the submesh is ready to be used and all its information available.
  108424. * Child classes can use it to update shaders
  108425. * @param mesh defines the mesh to check
  108426. * @param subMesh defines which submesh to check
  108427. * @param useInstances specifies that instances should be used
  108428. * @returns a boolean indicating that the submesh is ready or not
  108429. */
  108430. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  108431. /**
  108432. * Builds the material UBO layouts.
  108433. * Used internally during the effect preparation.
  108434. */
  108435. buildUniformLayout(): void;
  108436. /**
  108437. * Unbinds the material from the mesh
  108438. */
  108439. unbind(): void;
  108440. /**
  108441. * Binds the submesh to this material by preparing the effect and shader to draw
  108442. * @param world defines the world transformation matrix
  108443. * @param mesh defines the mesh containing the submesh
  108444. * @param subMesh defines the submesh to bind the material to
  108445. */
  108446. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  108447. /**
  108448. * Get the list of animatables in the material.
  108449. * @returns the list of animatables object used in the material
  108450. */
  108451. getAnimatables(): IAnimatable[];
  108452. /**
  108453. * Gets the active textures from the material
  108454. * @returns an array of textures
  108455. */
  108456. getActiveTextures(): BaseTexture[];
  108457. /**
  108458. * Specifies if the material uses a texture
  108459. * @param texture defines the texture to check against the material
  108460. * @returns a boolean specifying if the material uses the texture
  108461. */
  108462. hasTexture(texture: BaseTexture): boolean;
  108463. /**
  108464. * Disposes the material
  108465. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  108466. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  108467. */
  108468. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  108469. /**
  108470. * Makes a duplicate of the material, and gives it a new name
  108471. * @param name defines the new name for the duplicated material
  108472. * @returns the cloned material
  108473. */
  108474. clone(name: string): StandardMaterial;
  108475. /**
  108476. * Serializes this material in a JSON representation
  108477. * @returns the serialized material object
  108478. */
  108479. serialize(): any;
  108480. /**
  108481. * Creates a standard material from parsed material data
  108482. * @param source defines the JSON representation of the material
  108483. * @param scene defines the hosting scene
  108484. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  108485. * @returns a new standard material
  108486. */
  108487. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  108488. /**
  108489. * Are diffuse textures enabled in the application.
  108490. */
  108491. static DiffuseTextureEnabled: boolean;
  108492. /**
  108493. * Are ambient textures enabled in the application.
  108494. */
  108495. static AmbientTextureEnabled: boolean;
  108496. /**
  108497. * Are opacity textures enabled in the application.
  108498. */
  108499. static OpacityTextureEnabled: boolean;
  108500. /**
  108501. * Are reflection textures enabled in the application.
  108502. */
  108503. static ReflectionTextureEnabled: boolean;
  108504. /**
  108505. * Are emissive textures enabled in the application.
  108506. */
  108507. static EmissiveTextureEnabled: boolean;
  108508. /**
  108509. * Are specular textures enabled in the application.
  108510. */
  108511. static SpecularTextureEnabled: boolean;
  108512. /**
  108513. * Are bump textures enabled in the application.
  108514. */
  108515. static BumpTextureEnabled: boolean;
  108516. /**
  108517. * Are lightmap textures enabled in the application.
  108518. */
  108519. static LightmapTextureEnabled: boolean;
  108520. /**
  108521. * Are refraction textures enabled in the application.
  108522. */
  108523. static RefractionTextureEnabled: boolean;
  108524. /**
  108525. * Are color grading textures enabled in the application.
  108526. */
  108527. static ColorGradingTextureEnabled: boolean;
  108528. /**
  108529. * Are fresnels enabled in the application.
  108530. */
  108531. static FresnelEnabled: boolean;
  108532. }
  108533. }
  108534. declare module BABYLON {
  108535. /** @hidden */
  108536. export var imageProcessingPixelShader: {
  108537. name: string;
  108538. shader: string;
  108539. };
  108540. }
  108541. declare module BABYLON {
  108542. /**
  108543. * ImageProcessingPostProcess
  108544. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  108545. */
  108546. export class ImageProcessingPostProcess extends PostProcess {
  108547. /**
  108548. * Default configuration related to image processing available in the PBR Material.
  108549. */
  108550. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  108551. /**
  108552. * Gets the image processing configuration used either in this material.
  108553. */
  108554. /**
  108555. * Sets the Default image processing configuration used either in the this material.
  108556. *
  108557. * If sets to null, the scene one is in use.
  108558. */
  108559. imageProcessingConfiguration: ImageProcessingConfiguration;
  108560. /**
  108561. * Keep track of the image processing observer to allow dispose and replace.
  108562. */
  108563. private _imageProcessingObserver;
  108564. /**
  108565. * Attaches a new image processing configuration to the PBR Material.
  108566. * @param configuration
  108567. */
  108568. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  108569. /**
  108570. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  108571. */
  108572. /**
  108573. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  108574. */
  108575. colorCurves: Nullable<ColorCurves>;
  108576. /**
  108577. * Gets wether the color curves effect is enabled.
  108578. */
  108579. /**
  108580. * Sets wether the color curves effect is enabled.
  108581. */
  108582. colorCurvesEnabled: boolean;
  108583. /**
  108584. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  108585. */
  108586. /**
  108587. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  108588. */
  108589. colorGradingTexture: Nullable<BaseTexture>;
  108590. /**
  108591. * Gets wether the color grading effect is enabled.
  108592. */
  108593. /**
  108594. * Gets wether the color grading effect is enabled.
  108595. */
  108596. colorGradingEnabled: boolean;
  108597. /**
  108598. * Gets exposure used in the effect.
  108599. */
  108600. /**
  108601. * Sets exposure used in the effect.
  108602. */
  108603. exposure: number;
  108604. /**
  108605. * Gets wether tonemapping is enabled or not.
  108606. */
  108607. /**
  108608. * Sets wether tonemapping is enabled or not
  108609. */
  108610. toneMappingEnabled: boolean;
  108611. /**
  108612. * Gets the type of tone mapping effect.
  108613. */
  108614. /**
  108615. * Sets the type of tone mapping effect.
  108616. */
  108617. toneMappingType: number;
  108618. /**
  108619. * Gets contrast used in the effect.
  108620. */
  108621. /**
  108622. * Sets contrast used in the effect.
  108623. */
  108624. contrast: number;
  108625. /**
  108626. * Gets Vignette stretch size.
  108627. */
  108628. /**
  108629. * Sets Vignette stretch size.
  108630. */
  108631. vignetteStretch: number;
  108632. /**
  108633. * Gets Vignette centre X Offset.
  108634. */
  108635. /**
  108636. * Sets Vignette centre X Offset.
  108637. */
  108638. vignetteCentreX: number;
  108639. /**
  108640. * Gets Vignette centre Y Offset.
  108641. */
  108642. /**
  108643. * Sets Vignette centre Y Offset.
  108644. */
  108645. vignetteCentreY: number;
  108646. /**
  108647. * Gets Vignette weight or intensity of the vignette effect.
  108648. */
  108649. /**
  108650. * Sets Vignette weight or intensity of the vignette effect.
  108651. */
  108652. vignetteWeight: number;
  108653. /**
  108654. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  108655. * if vignetteEnabled is set to true.
  108656. */
  108657. /**
  108658. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  108659. * if vignetteEnabled is set to true.
  108660. */
  108661. vignetteColor: Color4;
  108662. /**
  108663. * Gets Camera field of view used by the Vignette effect.
  108664. */
  108665. /**
  108666. * Sets Camera field of view used by the Vignette effect.
  108667. */
  108668. vignetteCameraFov: number;
  108669. /**
  108670. * Gets the vignette blend mode allowing different kind of effect.
  108671. */
  108672. /**
  108673. * Sets the vignette blend mode allowing different kind of effect.
  108674. */
  108675. vignetteBlendMode: number;
  108676. /**
  108677. * Gets wether the vignette effect is enabled.
  108678. */
  108679. /**
  108680. * Sets wether the vignette effect is enabled.
  108681. */
  108682. vignetteEnabled: boolean;
  108683. private _fromLinearSpace;
  108684. /**
  108685. * Gets wether the input of the processing is in Gamma or Linear Space.
  108686. */
  108687. /**
  108688. * Sets wether the input of the processing is in Gamma or Linear Space.
  108689. */
  108690. fromLinearSpace: boolean;
  108691. /**
  108692. * Defines cache preventing GC.
  108693. */
  108694. private _defines;
  108695. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  108696. /**
  108697. * "ImageProcessingPostProcess"
  108698. * @returns "ImageProcessingPostProcess"
  108699. */
  108700. getClassName(): string;
  108701. protected _updateParameters(): void;
  108702. dispose(camera?: Camera): void;
  108703. }
  108704. }
  108705. declare module BABYLON {
  108706. /**
  108707. * Class containing static functions to help procedurally build meshes
  108708. */
  108709. export class GroundBuilder {
  108710. /**
  108711. * Creates a ground mesh
  108712. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  108713. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  108714. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108715. * @param name defines the name of the mesh
  108716. * @param options defines the options used to create the mesh
  108717. * @param scene defines the hosting scene
  108718. * @returns the ground mesh
  108719. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  108720. */
  108721. static CreateGround(name: string, options: {
  108722. width?: number;
  108723. height?: number;
  108724. subdivisions?: number;
  108725. subdivisionsX?: number;
  108726. subdivisionsY?: number;
  108727. updatable?: boolean;
  108728. }, scene: any): Mesh;
  108729. /**
  108730. * Creates a tiled ground mesh
  108731. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  108732. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  108733. * * 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
  108734. * * 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
  108735. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108736. * @param name defines the name of the mesh
  108737. * @param options defines the options used to create the mesh
  108738. * @param scene defines the hosting scene
  108739. * @returns the tiled ground mesh
  108740. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  108741. */
  108742. static CreateTiledGround(name: string, options: {
  108743. xmin: number;
  108744. zmin: number;
  108745. xmax: number;
  108746. zmax: number;
  108747. subdivisions?: {
  108748. w: number;
  108749. h: number;
  108750. };
  108751. precision?: {
  108752. w: number;
  108753. h: number;
  108754. };
  108755. updatable?: boolean;
  108756. }, scene?: Nullable<Scene>): Mesh;
  108757. /**
  108758. * Creates a ground mesh from a height map
  108759. * * The parameter `url` sets the URL of the height map image resource.
  108760. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  108761. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  108762. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  108763. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  108764. * * 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.
  108765. * * 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).
  108766. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  108767. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108768. * @param name defines the name of the mesh
  108769. * @param url defines the url to the height map
  108770. * @param options defines the options used to create the mesh
  108771. * @param scene defines the hosting scene
  108772. * @returns the ground mesh
  108773. * @see https://doc.babylonjs.com/babylon101/height_map
  108774. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  108775. */
  108776. static CreateGroundFromHeightMap(name: string, url: string, options: {
  108777. width?: number;
  108778. height?: number;
  108779. subdivisions?: number;
  108780. minHeight?: number;
  108781. maxHeight?: number;
  108782. colorFilter?: Color3;
  108783. alphaFilter?: number;
  108784. updatable?: boolean;
  108785. onReady?: (mesh: GroundMesh) => void;
  108786. }, scene?: Nullable<Scene>): GroundMesh;
  108787. }
  108788. }
  108789. declare module BABYLON {
  108790. /**
  108791. * Class containing static functions to help procedurally build meshes
  108792. */
  108793. export class TorusBuilder {
  108794. /**
  108795. * Creates a torus mesh
  108796. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  108797. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  108798. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  108799. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  108800. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108801. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108802. * @param name defines the name of the mesh
  108803. * @param options defines the options used to create the mesh
  108804. * @param scene defines the hosting scene
  108805. * @returns the torus mesh
  108806. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  108807. */
  108808. static CreateTorus(name: string, options: {
  108809. diameter?: number;
  108810. thickness?: number;
  108811. tessellation?: number;
  108812. updatable?: boolean;
  108813. sideOrientation?: number;
  108814. frontUVs?: Vector4;
  108815. backUVs?: Vector4;
  108816. }, scene: any): Mesh;
  108817. }
  108818. }
  108819. declare module BABYLON {
  108820. /**
  108821. * Class containing static functions to help procedurally build meshes
  108822. */
  108823. export class CylinderBuilder {
  108824. /**
  108825. * Creates a cylinder or a cone mesh
  108826. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  108827. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  108828. * * 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.
  108829. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  108830. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  108831. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  108832. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  108833. * * 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).
  108834. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  108835. * * 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).
  108836. * * 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
  108837. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  108838. * * 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
  108839. * * 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.
  108840. * * If `enclose` is false, a ring surface is one element.
  108841. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  108842. * * 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
  108843. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  108844. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108845. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108846. * @param name defines the name of the mesh
  108847. * @param options defines the options used to create the mesh
  108848. * @param scene defines the hosting scene
  108849. * @returns the cylinder mesh
  108850. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  108851. */
  108852. static CreateCylinder(name: string, options: {
  108853. height?: number;
  108854. diameterTop?: number;
  108855. diameterBottom?: number;
  108856. diameter?: number;
  108857. tessellation?: number;
  108858. subdivisions?: number;
  108859. arc?: number;
  108860. faceColors?: Color4[];
  108861. faceUV?: Vector4[];
  108862. updatable?: boolean;
  108863. hasRings?: boolean;
  108864. enclose?: boolean;
  108865. cap?: number;
  108866. sideOrientation?: number;
  108867. frontUVs?: Vector4;
  108868. backUVs?: Vector4;
  108869. }, scene: any): Mesh;
  108870. }
  108871. }
  108872. declare module BABYLON {
  108873. /**
  108874. * Options to modify the vr teleportation behavior.
  108875. */
  108876. export interface VRTeleportationOptions {
  108877. /**
  108878. * The name of the mesh which should be used as the teleportation floor. (default: null)
  108879. */
  108880. floorMeshName?: string;
  108881. /**
  108882. * A list of meshes to be used as the teleportation floor. (default: empty)
  108883. */
  108884. floorMeshes?: Mesh[];
  108885. }
  108886. /**
  108887. * Options to modify the vr experience helper's behavior.
  108888. */
  108889. export interface VRExperienceHelperOptions extends WebVROptions {
  108890. /**
  108891. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  108892. */
  108893. createDeviceOrientationCamera?: boolean;
  108894. /**
  108895. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  108896. */
  108897. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  108898. /**
  108899. * Uses the main button on the controller to toggle the laser casted. (default: true)
  108900. */
  108901. laserToggle?: boolean;
  108902. /**
  108903. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  108904. */
  108905. floorMeshes?: Mesh[];
  108906. /**
  108907. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  108908. */
  108909. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  108910. }
  108911. /**
  108912. * Event containing information after VR has been entered
  108913. */
  108914. export class OnAfterEnteringVRObservableEvent {
  108915. /**
  108916. * If entering vr was successful
  108917. */
  108918. success: boolean;
  108919. }
  108920. /**
  108921. * Helps to quickly add VR support to an existing scene.
  108922. * See http://doc.babylonjs.com/how_to/webvr_helper
  108923. */
  108924. export class VRExperienceHelper {
  108925. /** Options to modify the vr experience helper's behavior. */
  108926. webVROptions: VRExperienceHelperOptions;
  108927. private _scene;
  108928. private _position;
  108929. private _btnVR;
  108930. private _btnVRDisplayed;
  108931. private _webVRsupported;
  108932. private _webVRready;
  108933. private _webVRrequesting;
  108934. private _webVRpresenting;
  108935. private _hasEnteredVR;
  108936. private _fullscreenVRpresenting;
  108937. private _canvas;
  108938. private _webVRCamera;
  108939. private _vrDeviceOrientationCamera;
  108940. private _deviceOrientationCamera;
  108941. private _existingCamera;
  108942. private _onKeyDown;
  108943. private _onVrDisplayPresentChange;
  108944. private _onVRDisplayChanged;
  108945. private _onVRRequestPresentStart;
  108946. private _onVRRequestPresentComplete;
  108947. /**
  108948. * 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)
  108949. */
  108950. enableGazeEvenWhenNoPointerLock: boolean;
  108951. /**
  108952. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  108953. */
  108954. exitVROnDoubleTap: boolean;
  108955. /**
  108956. * Observable raised right before entering VR.
  108957. */
  108958. onEnteringVRObservable: Observable<VRExperienceHelper>;
  108959. /**
  108960. * Observable raised when entering VR has completed.
  108961. */
  108962. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  108963. /**
  108964. * Observable raised when exiting VR.
  108965. */
  108966. onExitingVRObservable: Observable<VRExperienceHelper>;
  108967. /**
  108968. * Observable raised when controller mesh is loaded.
  108969. */
  108970. onControllerMeshLoadedObservable: Observable<WebVRController>;
  108971. /** Return this.onEnteringVRObservable
  108972. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  108973. */
  108974. readonly onEnteringVR: Observable<VRExperienceHelper>;
  108975. /** Return this.onExitingVRObservable
  108976. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  108977. */
  108978. readonly onExitingVR: Observable<VRExperienceHelper>;
  108979. /** Return this.onControllerMeshLoadedObservable
  108980. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  108981. */
  108982. readonly onControllerMeshLoaded: Observable<WebVRController>;
  108983. private _rayLength;
  108984. private _useCustomVRButton;
  108985. private _teleportationRequested;
  108986. private _teleportActive;
  108987. private _floorMeshName;
  108988. private _floorMeshesCollection;
  108989. private _rotationAllowed;
  108990. private _teleportBackwardsVector;
  108991. private _teleportationTarget;
  108992. private _isDefaultTeleportationTarget;
  108993. private _postProcessMove;
  108994. private _teleportationFillColor;
  108995. private _teleportationBorderColor;
  108996. private _rotationAngle;
  108997. private _haloCenter;
  108998. private _cameraGazer;
  108999. private _padSensibilityUp;
  109000. private _padSensibilityDown;
  109001. private _leftController;
  109002. private _rightController;
  109003. /**
  109004. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  109005. */
  109006. onNewMeshSelected: Observable<AbstractMesh>;
  109007. /**
  109008. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  109009. * This observable will provide the mesh and the controller used to select the mesh
  109010. */
  109011. onMeshSelectedWithController: Observable<{
  109012. mesh: AbstractMesh;
  109013. controller: WebVRController;
  109014. }>;
  109015. /**
  109016. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  109017. */
  109018. onNewMeshPicked: Observable<PickingInfo>;
  109019. private _circleEase;
  109020. /**
  109021. * Observable raised before camera teleportation
  109022. */
  109023. onBeforeCameraTeleport: Observable<Vector3>;
  109024. /**
  109025. * Observable raised after camera teleportation
  109026. */
  109027. onAfterCameraTeleport: Observable<Vector3>;
  109028. /**
  109029. * Observable raised when current selected mesh gets unselected
  109030. */
  109031. onSelectedMeshUnselected: Observable<AbstractMesh>;
  109032. private _raySelectionPredicate;
  109033. /**
  109034. * To be optionaly changed by user to define custom ray selection
  109035. */
  109036. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  109037. /**
  109038. * To be optionaly changed by user to define custom selection logic (after ray selection)
  109039. */
  109040. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  109041. /**
  109042. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  109043. */
  109044. teleportationEnabled: boolean;
  109045. private _defaultHeight;
  109046. private _teleportationInitialized;
  109047. private _interactionsEnabled;
  109048. private _interactionsRequested;
  109049. private _displayGaze;
  109050. private _displayLaserPointer;
  109051. /**
  109052. * The mesh used to display where the user is going to teleport.
  109053. */
  109054. /**
  109055. * Sets the mesh to be used to display where the user is going to teleport.
  109056. */
  109057. teleportationTarget: Mesh;
  109058. /**
  109059. * 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
  109060. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  109061. * See http://doc.babylonjs.com/resources/baking_transformations
  109062. */
  109063. gazeTrackerMesh: Mesh;
  109064. /**
  109065. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  109066. */
  109067. updateGazeTrackerScale: boolean;
  109068. /**
  109069. * If the gaze trackers color should be updated when selecting meshes
  109070. */
  109071. updateGazeTrackerColor: boolean;
  109072. /**
  109073. * If the controller laser color should be updated when selecting meshes
  109074. */
  109075. updateControllerLaserColor: boolean;
  109076. /**
  109077. * The gaze tracking mesh corresponding to the left controller
  109078. */
  109079. readonly leftControllerGazeTrackerMesh: Nullable<Mesh>;
  109080. /**
  109081. * The gaze tracking mesh corresponding to the right controller
  109082. */
  109083. readonly rightControllerGazeTrackerMesh: Nullable<Mesh>;
  109084. /**
  109085. * If the ray of the gaze should be displayed.
  109086. */
  109087. /**
  109088. * Sets if the ray of the gaze should be displayed.
  109089. */
  109090. displayGaze: boolean;
  109091. /**
  109092. * If the ray of the LaserPointer should be displayed.
  109093. */
  109094. /**
  109095. * Sets if the ray of the LaserPointer should be displayed.
  109096. */
  109097. displayLaserPointer: boolean;
  109098. /**
  109099. * The deviceOrientationCamera used as the camera when not in VR.
  109100. */
  109101. readonly deviceOrientationCamera: Nullable<DeviceOrientationCamera>;
  109102. /**
  109103. * Based on the current WebVR support, returns the current VR camera used.
  109104. */
  109105. readonly currentVRCamera: Nullable<Camera>;
  109106. /**
  109107. * The webVRCamera which is used when in VR.
  109108. */
  109109. readonly webVRCamera: WebVRFreeCamera;
  109110. /**
  109111. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  109112. */
  109113. readonly vrDeviceOrientationCamera: Nullable<VRDeviceOrientationFreeCamera>;
  109114. /**
  109115. * The html button that is used to trigger entering into VR.
  109116. */
  109117. readonly vrButton: Nullable<HTMLButtonElement>;
  109118. private readonly _teleportationRequestInitiated;
  109119. /**
  109120. * Defines wether or not Pointer lock should be requested when switching to
  109121. * full screen.
  109122. */
  109123. requestPointerLockOnFullScreen: boolean;
  109124. /**
  109125. * Instantiates a VRExperienceHelper.
  109126. * Helps to quickly add VR support to an existing scene.
  109127. * @param scene The scene the VRExperienceHelper belongs to.
  109128. * @param webVROptions Options to modify the vr experience helper's behavior.
  109129. */
  109130. constructor(scene: Scene,
  109131. /** Options to modify the vr experience helper's behavior. */
  109132. webVROptions?: VRExperienceHelperOptions);
  109133. private _onDefaultMeshLoaded;
  109134. private _onResize;
  109135. private _onFullscreenChange;
  109136. /**
  109137. * Gets a value indicating if we are currently in VR mode.
  109138. */
  109139. readonly isInVRMode: boolean;
  109140. private onVrDisplayPresentChange;
  109141. private onVRDisplayChanged;
  109142. private moveButtonToBottomRight;
  109143. private displayVRButton;
  109144. private updateButtonVisibility;
  109145. private _cachedAngularSensibility;
  109146. /**
  109147. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  109148. * Otherwise, will use the fullscreen API.
  109149. */
  109150. enterVR(): void;
  109151. /**
  109152. * Attempt to exit VR, or fullscreen.
  109153. */
  109154. exitVR(): void;
  109155. /**
  109156. * The position of the vr experience helper.
  109157. */
  109158. /**
  109159. * Sets the position of the vr experience helper.
  109160. */
  109161. position: Vector3;
  109162. /**
  109163. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  109164. */
  109165. enableInteractions(): void;
  109166. private readonly _noControllerIsActive;
  109167. private beforeRender;
  109168. private _isTeleportationFloor;
  109169. /**
  109170. * Adds a floor mesh to be used for teleportation.
  109171. * @param floorMesh the mesh to be used for teleportation.
  109172. */
  109173. addFloorMesh(floorMesh: Mesh): void;
  109174. /**
  109175. * Removes a floor mesh from being used for teleportation.
  109176. * @param floorMesh the mesh to be removed.
  109177. */
  109178. removeFloorMesh(floorMesh: Mesh): void;
  109179. /**
  109180. * Enables interactions and teleportation using the VR controllers and gaze.
  109181. * @param vrTeleportationOptions options to modify teleportation behavior.
  109182. */
  109183. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  109184. private _onNewGamepadConnected;
  109185. private _tryEnableInteractionOnController;
  109186. private _onNewGamepadDisconnected;
  109187. private _enableInteractionOnController;
  109188. private _checkTeleportWithRay;
  109189. private _checkRotate;
  109190. private _checkTeleportBackwards;
  109191. private _enableTeleportationOnController;
  109192. private _createTeleportationCircles;
  109193. private _displayTeleportationTarget;
  109194. private _hideTeleportationTarget;
  109195. private _rotateCamera;
  109196. private _moveTeleportationSelectorTo;
  109197. private _workingVector;
  109198. private _workingQuaternion;
  109199. private _workingMatrix;
  109200. /**
  109201. * Teleports the users feet to the desired location
  109202. * @param location The location where the user's feet should be placed
  109203. */
  109204. teleportCamera(location: Vector3): void;
  109205. private _convertNormalToDirectionOfRay;
  109206. private _castRayAndSelectObject;
  109207. private _notifySelectedMeshUnselected;
  109208. /**
  109209. * Sets the color of the laser ray from the vr controllers.
  109210. * @param color new color for the ray.
  109211. */
  109212. changeLaserColor(color: Color3): void;
  109213. /**
  109214. * Sets the color of the ray from the vr headsets gaze.
  109215. * @param color new color for the ray.
  109216. */
  109217. changeGazeColor(color: Color3): void;
  109218. /**
  109219. * Exits VR and disposes of the vr experience helper
  109220. */
  109221. dispose(): void;
  109222. /**
  109223. * Gets the name of the VRExperienceHelper class
  109224. * @returns "VRExperienceHelper"
  109225. */
  109226. getClassName(): string;
  109227. }
  109228. }
  109229. declare module BABYLON {
  109230. /**
  109231. * States of the webXR experience
  109232. */
  109233. export enum WebXRState {
  109234. /**
  109235. * Transitioning to being in XR mode
  109236. */
  109237. ENTERING_XR = 0,
  109238. /**
  109239. * Transitioning to non XR mode
  109240. */
  109241. EXITING_XR = 1,
  109242. /**
  109243. * In XR mode and presenting
  109244. */
  109245. IN_XR = 2,
  109246. /**
  109247. * Not entered XR mode
  109248. */
  109249. NOT_IN_XR = 3
  109250. }
  109251. /**
  109252. * Abstraction of the XR render target
  109253. */
  109254. export interface WebXRRenderTarget extends IDisposable {
  109255. /**
  109256. * xrpresent context of the canvas which can be used to display/mirror xr content
  109257. */
  109258. canvasContext: WebGLRenderingContext;
  109259. /**
  109260. * xr layer for the canvas
  109261. */
  109262. xrLayer: Nullable<XRWebGLLayer>;
  109263. /**
  109264. * Initializes the xr layer for the session
  109265. * @param xrSession xr session
  109266. * @returns a promise that will resolve once the XR Layer has been created
  109267. */
  109268. initializeXRLayerAsync(xrSession: XRSession): Promise<void>;
  109269. }
  109270. }
  109271. declare module BABYLON {
  109272. /**
  109273. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  109274. */
  109275. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  109276. private _engine;
  109277. private _canvas;
  109278. /**
  109279. * xrpresent context of the canvas which can be used to display/mirror xr content
  109280. */
  109281. canvasContext: WebGLRenderingContext;
  109282. /**
  109283. * xr layer for the canvas
  109284. */
  109285. xrLayer: Nullable<XRWebGLLayer>;
  109286. /**
  109287. * Initializes the xr layer for the session
  109288. * @param xrSession xr session
  109289. * @returns a promise that will resolve once the XR Layer has been created
  109290. */
  109291. initializeXRLayerAsync(xrSession: any): any;
  109292. /**
  109293. * Initializes the canvas to be added/removed upon entering/exiting xr
  109294. * @param engine the Babylon engine
  109295. * @param canvas The canvas to be added/removed (If not specified a full screen canvas will be created)
  109296. * @param onStateChangedObservable the mechanism by which the canvas will be added/removed based on XR state
  109297. */
  109298. constructor(engine: ThinEngine, canvas?: HTMLCanvasElement, onStateChangedObservable?: Observable<WebXRState>);
  109299. /**
  109300. * Disposes of the object
  109301. */
  109302. dispose(): void;
  109303. private _setManagedOutputCanvas;
  109304. private _addCanvas;
  109305. private _removeCanvas;
  109306. }
  109307. }
  109308. declare module BABYLON {
  109309. /**
  109310. * Manages an XRSession to work with Babylon's engine
  109311. * @see https://doc.babylonjs.com/how_to/webxr
  109312. */
  109313. export class WebXRSessionManager implements IDisposable {
  109314. private scene;
  109315. /**
  109316. * Fires every time a new xrFrame arrives which can be used to update the camera
  109317. */
  109318. onXRFrameObservable: Observable<any>;
  109319. /**
  109320. * Fires when the xr session is ended either by the device or manually done
  109321. */
  109322. onXRSessionEnded: Observable<any>;
  109323. /**
  109324. * Underlying xr session
  109325. */
  109326. session: XRSession;
  109327. /**
  109328. * Type of reference space used when creating the session
  109329. */
  109330. referenceSpace: XRReferenceSpace;
  109331. /**
  109332. * Current XR frame
  109333. */
  109334. currentFrame: Nullable<XRFrame>;
  109335. private _xrNavigator;
  109336. private baseLayer;
  109337. private _rttProvider;
  109338. private _sessionEnded;
  109339. /**
  109340. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  109341. * @param scene The scene which the session should be created for
  109342. */
  109343. constructor(scene: Scene);
  109344. /**
  109345. * Initializes the manager
  109346. * After initialization enterXR can be called to start an XR session
  109347. * @returns Promise which resolves after it is initialized
  109348. */
  109349. initializeAsync(): Promise<void>;
  109350. /**
  109351. * Initializes an xr session
  109352. * @param xrSessionMode mode to initialize
  109353. * @returns a promise which will resolve once the session has been initialized
  109354. */
  109355. initializeSessionAsync(xrSessionMode: XRSessionMode): any;
  109356. /**
  109357. * Sets the reference space on the xr session
  109358. * @param referenceSpace space to set
  109359. * @returns a promise that will resolve once the reference space has been set
  109360. */
  109361. setReferenceSpaceAsync(referenceSpace: XRReferenceSpaceType): Promise<void>;
  109362. /**
  109363. * Updates the render state of the session
  109364. * @param state state to set
  109365. * @returns a promise that resolves once the render state has been updated
  109366. */
  109367. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  109368. /**
  109369. * Starts rendering to the xr layer
  109370. * @returns a promise that will resolve once rendering has started
  109371. */
  109372. startRenderingToXRAsync(): Promise<void>;
  109373. /**
  109374. * Gets the correct render target texture to be rendered this frame for this eye
  109375. * @param eye the eye for which to get the render target
  109376. * @returns the render target for the specified eye
  109377. */
  109378. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  109379. /**
  109380. * Stops the xrSession and restores the renderloop
  109381. * @returns Promise which resolves after it exits XR
  109382. */
  109383. exitXRAsync(): Promise<void>;
  109384. /**
  109385. * Checks if a session would be supported for the creation options specified
  109386. * @param sessionMode session mode to check if supported eg. immersive-vr
  109387. * @returns true if supported
  109388. */
  109389. supportsSessionAsync(sessionMode: XRSessionMode): any;
  109390. /**
  109391. * Creates a WebXRRenderTarget object for the XR session
  109392. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  109393. * @returns a WebXR render target to which the session can render
  109394. */
  109395. getWebXRRenderTarget(onStateChangedObservable?: Observable<WebXRState>): WebXRRenderTarget;
  109396. /**
  109397. * @hidden
  109398. * Converts the render layer of xrSession to a render target
  109399. * @param session session to create render target for
  109400. * @param scene scene the new render target should be created for
  109401. */
  109402. static _CreateRenderTargetTextureFromSession(session: XRSession, scene: Scene, baseLayer: XRWebGLLayer): RenderTargetTexture;
  109403. /**
  109404. * Disposes of the session manager
  109405. */
  109406. dispose(): void;
  109407. }
  109408. }
  109409. declare module BABYLON {
  109410. /**
  109411. * WebXR Camera which holds the views for the xrSession
  109412. * @see https://doc.babylonjs.com/how_to/webxr
  109413. */
  109414. export class WebXRCamera extends FreeCamera {
  109415. private static _TmpMatrix;
  109416. /**
  109417. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  109418. * @param name the name of the camera
  109419. * @param scene the scene to add the camera to
  109420. */
  109421. constructor(name: string, scene: Scene);
  109422. private _updateNumberOfRigCameras;
  109423. /** @hidden */
  109424. _updateForDualEyeDebugging(): void;
  109425. /**
  109426. * Updates the cameras position from the current pose information of the XR session
  109427. * @param xrSessionManager the session containing pose information
  109428. * @returns true if the camera has been updated, false if the session did not contain pose or frame data
  109429. */
  109430. updateFromXRSessionManager(xrSessionManager: WebXRSessionManager): boolean;
  109431. }
  109432. }
  109433. declare module BABYLON {
  109434. /**
  109435. * Base set of functionality needed to create an XR experince (WebXRSessionManager, Camera, StateManagement, etc.)
  109436. * @see https://doc.babylonjs.com/how_to/webxr
  109437. */
  109438. export class WebXRExperienceHelper implements IDisposable {
  109439. private scene;
  109440. /**
  109441. * Container which stores the xr camera and controllers as children. This can be used to move the camera/user as the camera's position is updated by the xr device
  109442. */
  109443. container: AbstractMesh;
  109444. /**
  109445. * Camera used to render xr content
  109446. */
  109447. camera: WebXRCamera;
  109448. /**
  109449. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  109450. */
  109451. state: WebXRState;
  109452. private _setState;
  109453. private static _TmpVector;
  109454. /**
  109455. * Fires when the state of the experience helper has changed
  109456. */
  109457. onStateChangedObservable: Observable<WebXRState>;
  109458. /** Session manager used to keep track of xr session */
  109459. sessionManager: WebXRSessionManager;
  109460. private _nonVRCamera;
  109461. private _originalSceneAutoClear;
  109462. private _supported;
  109463. /**
  109464. * Creates the experience helper
  109465. * @param scene the scene to attach the experience helper to
  109466. * @returns a promise for the experience helper
  109467. */
  109468. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  109469. /**
  109470. * Creates a WebXRExperienceHelper
  109471. * @param scene The scene the helper should be created in
  109472. */
  109473. private constructor();
  109474. /**
  109475. * Exits XR mode and returns the scene to its original state
  109476. * @returns promise that resolves after xr mode has exited
  109477. */
  109478. exitXRAsync(): Promise<void>;
  109479. /**
  109480. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  109481. * @param sessionCreationOptions options for the XR session
  109482. * @param referenceSpaceType frame of reference of the XR session
  109483. * @param renderTarget the output canvas that will be used to enter XR mode
  109484. * @returns promise that resolves after xr mode has entered
  109485. */
  109486. enterXRAsync(sessionCreationOptions: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget: WebXRRenderTarget): any;
  109487. /**
  109488. * Updates the global position of the camera by moving the camera's container
  109489. * This should be used instead of modifying the camera's position as it will be overwritten by an xrSessions's update frame
  109490. * @param position The desired global position of the camera
  109491. */
  109492. setPositionOfCameraUsingContainer(position: Vector3): void;
  109493. /**
  109494. * Rotates the xr camera by rotating the camera's container around the camera's position
  109495. * This should be used instead of modifying the camera's rotation as it will be overwritten by an xrSessions's update frame
  109496. * @param rotation the desired quaternion rotation to apply to the camera
  109497. */
  109498. rotateCameraByQuaternionUsingContainer(rotation: Quaternion): void;
  109499. /**
  109500. * Disposes of the experience helper
  109501. */
  109502. dispose(): void;
  109503. }
  109504. }
  109505. declare module BABYLON {
  109506. /**
  109507. * Button which can be used to enter a different mode of XR
  109508. */
  109509. export class WebXREnterExitUIButton {
  109510. /** button element */
  109511. element: HTMLElement;
  109512. /** XR initialization options for the button */
  109513. sessionMode: XRSessionMode;
  109514. /** Reference space type */
  109515. referenceSpaceType: XRReferenceSpaceType;
  109516. /**
  109517. * Creates a WebXREnterExitUIButton
  109518. * @param element button element
  109519. * @param sessionMode XR initialization session mode
  109520. * @param referenceSpaceType the type of reference space to be used
  109521. */
  109522. constructor(
  109523. /** button element */
  109524. element: HTMLElement,
  109525. /** XR initialization options for the button */
  109526. sessionMode: XRSessionMode,
  109527. /** Reference space type */
  109528. referenceSpaceType: XRReferenceSpaceType);
  109529. /**
  109530. * Overwritable function which can be used to update the button's visuals when the state changes
  109531. * @param activeButton the current active button in the UI
  109532. */
  109533. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  109534. }
  109535. /**
  109536. * Options to create the webXR UI
  109537. */
  109538. export class WebXREnterExitUIOptions {
  109539. /**
  109540. * Context to enter xr with
  109541. */
  109542. renderTarget?: Nullable<WebXRRenderTarget>;
  109543. /**
  109544. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  109545. */
  109546. customButtons?: Array<WebXREnterExitUIButton>;
  109547. }
  109548. /**
  109549. * UI to allow the user to enter/exit XR mode
  109550. */
  109551. export class WebXREnterExitUI implements IDisposable {
  109552. private scene;
  109553. private _overlay;
  109554. private _buttons;
  109555. private _activeButton;
  109556. /**
  109557. * Fired every time the active button is changed.
  109558. *
  109559. * When xr is entered via a button that launches xr that button will be the callback parameter
  109560. *
  109561. * When exiting xr the callback parameter will be null)
  109562. */
  109563. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  109564. /**
  109565. * Creates UI to allow the user to enter/exit XR mode
  109566. * @param scene the scene to add the ui to
  109567. * @param helper the xr experience helper to enter/exit xr with
  109568. * @param options options to configure the UI
  109569. * @returns the created ui
  109570. */
  109571. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  109572. private constructor();
  109573. private _updateButtons;
  109574. /**
  109575. * Disposes of the object
  109576. */
  109577. dispose(): void;
  109578. }
  109579. }
  109580. declare module BABYLON {
  109581. /**
  109582. * Represents an XR input
  109583. */
  109584. export class WebXRController {
  109585. private scene;
  109586. /** The underlying input source for the controller */
  109587. inputSource: XRInputSource;
  109588. private parentContainer;
  109589. /**
  109590. * 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
  109591. */
  109592. grip?: AbstractMesh;
  109593. /**
  109594. * Pointer which can be used to select objects or attach a visible laser to
  109595. */
  109596. pointer: AbstractMesh;
  109597. private _gamepadMode;
  109598. /**
  109599. * If available, this is the gamepad object related to this controller.
  109600. * Using this object it is possible to get click events and trackpad changes of the
  109601. * webxr controller that is currently being used.
  109602. */
  109603. gamepadController?: WebVRController;
  109604. /**
  109605. * Event that fires when the controller is removed/disposed
  109606. */
  109607. onDisposeObservable: Observable<{}>;
  109608. private _tmpMatrix;
  109609. private _tmpQuaternion;
  109610. private _tmpVector;
  109611. /**
  109612. * Creates the controller
  109613. * @see https://doc.babylonjs.com/how_to/webxr
  109614. * @param scene the scene which the controller should be associated to
  109615. * @param inputSource the underlying input source for the controller
  109616. * @param parentContainer parent that the controller meshes should be children of
  109617. */
  109618. constructor(scene: Scene,
  109619. /** The underlying input source for the controller */
  109620. inputSource: XRInputSource, parentContainer?: Nullable<AbstractMesh>);
  109621. /**
  109622. * Updates the controller pose based on the given XRFrame
  109623. * @param xrFrame xr frame to update the pose with
  109624. * @param referenceSpace reference space to use
  109625. */
  109626. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  109627. /**
  109628. * Gets a world space ray coming from the controller
  109629. * @param result the resulting ray
  109630. */
  109631. getWorldPointerRayToRef(result: Ray): void;
  109632. /**
  109633. * Get the scene associated with this controller
  109634. * @returns the scene object
  109635. */
  109636. getScene(): Scene;
  109637. /**
  109638. * Disposes of the object
  109639. */
  109640. dispose(): void;
  109641. }
  109642. }
  109643. declare module BABYLON {
  109644. /**
  109645. * XR input used to track XR inputs such as controllers/rays
  109646. */
  109647. export class WebXRInput implements IDisposable {
  109648. /**
  109649. * Base experience the input listens to
  109650. */
  109651. baseExperience: WebXRExperienceHelper;
  109652. /**
  109653. * XR controllers being tracked
  109654. */
  109655. controllers: Array<WebXRController>;
  109656. private _frameObserver;
  109657. private _stateObserver;
  109658. /**
  109659. * Event when a controller has been connected/added
  109660. */
  109661. onControllerAddedObservable: Observable<WebXRController>;
  109662. /**
  109663. * Event when a controller has been removed/disconnected
  109664. */
  109665. onControllerRemovedObservable: Observable<WebXRController>;
  109666. /**
  109667. * Initializes the WebXRInput
  109668. * @param baseExperience experience helper which the input should be created for
  109669. */
  109670. constructor(
  109671. /**
  109672. * Base experience the input listens to
  109673. */
  109674. baseExperience: WebXRExperienceHelper);
  109675. private _onInputSourcesChange;
  109676. private _addAndRemoveControllers;
  109677. /**
  109678. * Disposes of the object
  109679. */
  109680. dispose(): void;
  109681. }
  109682. }
  109683. declare module BABYLON {
  109684. /**
  109685. * Enables teleportation
  109686. */
  109687. export class WebXRControllerTeleportation {
  109688. private _teleportationFillColor;
  109689. private _teleportationBorderColor;
  109690. private _tmpRay;
  109691. private _tmpVector;
  109692. /**
  109693. * Creates a WebXRControllerTeleportation
  109694. * @param input input manager to add teleportation to
  109695. * @param floorMeshes floormeshes which can be teleported to
  109696. */
  109697. constructor(input: WebXRInput, floorMeshes?: Array<AbstractMesh>);
  109698. }
  109699. }
  109700. declare module BABYLON {
  109701. /**
  109702. * Handles pointer input automatically for the pointer of XR controllers
  109703. */
  109704. export class WebXRControllerPointerSelection {
  109705. private static _idCounter;
  109706. private _tmpRay;
  109707. /**
  109708. * Creates a WebXRControllerPointerSelection
  109709. * @param input input manager to setup pointer selection
  109710. */
  109711. constructor(input: WebXRInput);
  109712. private _convertNormalToDirectionOfRay;
  109713. private _updatePointerDistance;
  109714. }
  109715. }
  109716. declare module BABYLON {
  109717. /**
  109718. * Class used to represent data loading progression
  109719. */
  109720. export class SceneLoaderProgressEvent {
  109721. /** defines if data length to load can be evaluated */
  109722. readonly lengthComputable: boolean;
  109723. /** defines the loaded data length */
  109724. readonly loaded: number;
  109725. /** defines the data length to load */
  109726. readonly total: number;
  109727. /**
  109728. * Create a new progress event
  109729. * @param lengthComputable defines if data length to load can be evaluated
  109730. * @param loaded defines the loaded data length
  109731. * @param total defines the data length to load
  109732. */
  109733. constructor(
  109734. /** defines if data length to load can be evaluated */
  109735. lengthComputable: boolean,
  109736. /** defines the loaded data length */
  109737. loaded: number,
  109738. /** defines the data length to load */
  109739. total: number);
  109740. /**
  109741. * Creates a new SceneLoaderProgressEvent from a ProgressEvent
  109742. * @param event defines the source event
  109743. * @returns a new SceneLoaderProgressEvent
  109744. */
  109745. static FromProgressEvent(event: ProgressEvent): SceneLoaderProgressEvent;
  109746. }
  109747. /**
  109748. * Interface used by SceneLoader plugins to define supported file extensions
  109749. */
  109750. export interface ISceneLoaderPluginExtensions {
  109751. /**
  109752. * Defines the list of supported extensions
  109753. */
  109754. [extension: string]: {
  109755. isBinary: boolean;
  109756. };
  109757. }
  109758. /**
  109759. * Interface used by SceneLoader plugin factory
  109760. */
  109761. export interface ISceneLoaderPluginFactory {
  109762. /**
  109763. * Defines the name of the factory
  109764. */
  109765. name: string;
  109766. /**
  109767. * Function called to create a new plugin
  109768. * @return the new plugin
  109769. */
  109770. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  109771. /**
  109772. * The callback that returns true if the data can be directly loaded.
  109773. * @param data string containing the file data
  109774. * @returns if the data can be loaded directly
  109775. */
  109776. canDirectLoad?(data: string): boolean;
  109777. }
  109778. /**
  109779. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  109780. */
  109781. export interface ISceneLoaderPluginBase {
  109782. /**
  109783. * The friendly name of this plugin.
  109784. */
  109785. name: string;
  109786. /**
  109787. * The file extensions supported by this plugin.
  109788. */
  109789. extensions: string | ISceneLoaderPluginExtensions;
  109790. /**
  109791. * The callback called when loading from a url.
  109792. * @param scene scene loading this url
  109793. * @param url url to load
  109794. * @param onSuccess callback called when the file successfully loads
  109795. * @param onProgress callback called while file is loading (if the server supports this mode)
  109796. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  109797. * @param onError callback called when the file fails to load
  109798. * @returns a file request object
  109799. */
  109800. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  109801. /**
  109802. * The callback called when loading from a file object.
  109803. * @param scene scene loading this file
  109804. * @param file defines the file to load
  109805. * @param onSuccess defines the callback to call when data is loaded
  109806. * @param onProgress defines the callback to call during loading process
  109807. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  109808. * @param onError defines the callback to call when an error occurs
  109809. * @returns a file request object
  109810. */
  109811. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  109812. /**
  109813. * The callback that returns true if the data can be directly loaded.
  109814. * @param data string containing the file data
  109815. * @returns if the data can be loaded directly
  109816. */
  109817. canDirectLoad?(data: string): boolean;
  109818. /**
  109819. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  109820. * @param scene scene loading this data
  109821. * @param data string containing the data
  109822. * @returns data to pass to the plugin
  109823. */
  109824. directLoad?(scene: Scene, data: string): any;
  109825. /**
  109826. * The callback that allows custom handling of the root url based on the response url.
  109827. * @param rootUrl the original root url
  109828. * @param responseURL the response url if available
  109829. * @returns the new root url
  109830. */
  109831. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  109832. }
  109833. /**
  109834. * Interface used to define a SceneLoader plugin
  109835. */
  109836. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  109837. /**
  109838. * Import meshes into a scene.
  109839. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  109840. * @param scene The scene to import into
  109841. * @param data The data to import
  109842. * @param rootUrl The root url for scene and resources
  109843. * @param meshes The meshes array to import into
  109844. * @param particleSystems The particle systems array to import into
  109845. * @param skeletons The skeletons array to import into
  109846. * @param onError The callback when import fails
  109847. * @returns True if successful or false otherwise
  109848. */
  109849. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  109850. /**
  109851. * Load into a scene.
  109852. * @param scene The scene to load into
  109853. * @param data The data to import
  109854. * @param rootUrl The root url for scene and resources
  109855. * @param onError The callback when import fails
  109856. * @returns True if successful or false otherwise
  109857. */
  109858. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  109859. /**
  109860. * Load into an asset container.
  109861. * @param scene The scene to load into
  109862. * @param data The data to import
  109863. * @param rootUrl The root url for scene and resources
  109864. * @param onError The callback when import fails
  109865. * @returns The loaded asset container
  109866. */
  109867. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  109868. }
  109869. /**
  109870. * Interface used to define an async SceneLoader plugin
  109871. */
  109872. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  109873. /**
  109874. * Import meshes into a scene.
  109875. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  109876. * @param scene The scene to import into
  109877. * @param data The data to import
  109878. * @param rootUrl The root url for scene and resources
  109879. * @param onProgress The callback when the load progresses
  109880. * @param fileName Defines the name of the file to load
  109881. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  109882. */
  109883. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  109884. meshes: AbstractMesh[];
  109885. particleSystems: IParticleSystem[];
  109886. skeletons: Skeleton[];
  109887. animationGroups: AnimationGroup[];
  109888. }>;
  109889. /**
  109890. * Load into a scene.
  109891. * @param scene The scene to load into
  109892. * @param data The data to import
  109893. * @param rootUrl The root url for scene and resources
  109894. * @param onProgress The callback when the load progresses
  109895. * @param fileName Defines the name of the file to load
  109896. * @returns Nothing
  109897. */
  109898. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  109899. /**
  109900. * Load into an asset container.
  109901. * @param scene The scene to load into
  109902. * @param data The data to import
  109903. * @param rootUrl The root url for scene and resources
  109904. * @param onProgress The callback when the load progresses
  109905. * @param fileName Defines the name of the file to load
  109906. * @returns The loaded asset container
  109907. */
  109908. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  109909. }
  109910. /**
  109911. * Class used to load scene from various file formats using registered plugins
  109912. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  109913. */
  109914. export class SceneLoader {
  109915. /**
  109916. * No logging while loading
  109917. */
  109918. static readonly NO_LOGGING: number;
  109919. /**
  109920. * Minimal logging while loading
  109921. */
  109922. static readonly MINIMAL_LOGGING: number;
  109923. /**
  109924. * Summary logging while loading
  109925. */
  109926. static readonly SUMMARY_LOGGING: number;
  109927. /**
  109928. * Detailled logging while loading
  109929. */
  109930. static readonly DETAILED_LOGGING: number;
  109931. /**
  109932. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  109933. */
  109934. static ForceFullSceneLoadingForIncremental: boolean;
  109935. /**
  109936. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  109937. */
  109938. static ShowLoadingScreen: boolean;
  109939. /**
  109940. * Defines the current logging level (while loading the scene)
  109941. * @ignorenaming
  109942. */
  109943. static loggingLevel: number;
  109944. /**
  109945. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  109946. */
  109947. static CleanBoneMatrixWeights: boolean;
  109948. /**
  109949. * Event raised when a plugin is used to load a scene
  109950. */
  109951. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  109952. private static _registeredPlugins;
  109953. private static _getDefaultPlugin;
  109954. private static _getPluginForExtension;
  109955. private static _getPluginForDirectLoad;
  109956. private static _getPluginForFilename;
  109957. private static _getDirectLoad;
  109958. private static _loadData;
  109959. private static _getFileInfo;
  109960. /**
  109961. * Gets a plugin that can load the given extension
  109962. * @param extension defines the extension to load
  109963. * @returns a plugin or null if none works
  109964. */
  109965. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  109966. /**
  109967. * Gets a boolean indicating that the given extension can be loaded
  109968. * @param extension defines the extension to load
  109969. * @returns true if the extension is supported
  109970. */
  109971. static IsPluginForExtensionAvailable(extension: string): boolean;
  109972. /**
  109973. * Adds a new plugin to the list of registered plugins
  109974. * @param plugin defines the plugin to add
  109975. */
  109976. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  109977. /**
  109978. * Import meshes into a scene
  109979. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  109980. * @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)
  109981. * @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)
  109982. * @param scene the instance of BABYLON.Scene to append to
  109983. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  109984. * @param onProgress a callback with a progress event for each file being loaded
  109985. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  109986. * @param pluginExtension the extension used to determine the plugin
  109987. * @returns The loaded plugin
  109988. */
  109989. static ImportMesh(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], animationGroups: AnimationGroup[]) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  109990. /**
  109991. * Import meshes into a scene
  109992. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  109993. * @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)
  109994. * @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)
  109995. * @param scene the instance of BABYLON.Scene to append to
  109996. * @param onProgress a callback with a progress event for each file being loaded
  109997. * @param pluginExtension the extension used to determine the plugin
  109998. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  109999. */
  110000. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  110001. meshes: AbstractMesh[];
  110002. particleSystems: IParticleSystem[];
  110003. skeletons: Skeleton[];
  110004. animationGroups: AnimationGroup[];
  110005. }>;
  110006. /**
  110007. * Load a scene
  110008. * @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)
  110009. * @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)
  110010. * @param engine is the instance of BABYLON.Engine to use to create the scene
  110011. * @param onSuccess a callback with the scene when import succeeds
  110012. * @param onProgress a callback with a progress event for each file being loaded
  110013. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  110014. * @param pluginExtension the extension used to determine the plugin
  110015. * @returns The loaded plugin
  110016. */
  110017. static Load(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  110018. /**
  110019. * Load a scene
  110020. * @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)
  110021. * @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)
  110022. * @param engine is the instance of BABYLON.Engine to use to create the scene
  110023. * @param onProgress a callback with a progress event for each file being loaded
  110024. * @param pluginExtension the extension used to determine the plugin
  110025. * @returns The loaded scene
  110026. */
  110027. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  110028. /**
  110029. * Append a scene
  110030. * @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)
  110031. * @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)
  110032. * @param scene is the instance of BABYLON.Scene to append to
  110033. * @param onSuccess a callback with the scene when import succeeds
  110034. * @param onProgress a callback with a progress event for each file being loaded
  110035. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  110036. * @param pluginExtension the extension used to determine the plugin
  110037. * @returns The loaded plugin
  110038. */
  110039. static Append(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  110040. /**
  110041. * Append a scene
  110042. * @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)
  110043. * @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)
  110044. * @param scene is the instance of BABYLON.Scene to append to
  110045. * @param onProgress a callback with a progress event for each file being loaded
  110046. * @param pluginExtension the extension used to determine the plugin
  110047. * @returns The given scene
  110048. */
  110049. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  110050. /**
  110051. * Load a scene into an asset container
  110052. * @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)
  110053. * @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)
  110054. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  110055. * @param onSuccess a callback with the scene when import succeeds
  110056. * @param onProgress a callback with a progress event for each file being loaded
  110057. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  110058. * @param pluginExtension the extension used to determine the plugin
  110059. * @returns The loaded plugin
  110060. */
  110061. static LoadAssetContainer(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(assets: AssetContainer) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  110062. /**
  110063. * Load a scene into an asset container
  110064. * @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)
  110065. * @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)
  110066. * @param scene is the instance of Scene to append to
  110067. * @param onProgress a callback with a progress event for each file being loaded
  110068. * @param pluginExtension the extension used to determine the plugin
  110069. * @returns The loaded asset container
  110070. */
  110071. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  110072. }
  110073. }
  110074. declare module BABYLON {
  110075. /**
  110076. * Generic Controller
  110077. */
  110078. export class GenericController extends WebVRController {
  110079. /**
  110080. * Base Url for the controller model.
  110081. */
  110082. static readonly MODEL_BASE_URL: string;
  110083. /**
  110084. * File name for the controller model.
  110085. */
  110086. static readonly MODEL_FILENAME: string;
  110087. /**
  110088. * Creates a new GenericController from a gamepad
  110089. * @param vrGamepad the gamepad that the controller should be created from
  110090. */
  110091. constructor(vrGamepad: any);
  110092. /**
  110093. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  110094. * @param scene scene in which to add meshes
  110095. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  110096. */
  110097. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  110098. /**
  110099. * Called once for each button that changed state since the last frame
  110100. * @param buttonIdx Which button index changed
  110101. * @param state New state of the button
  110102. * @param changes Which properties on the state changed since last frame
  110103. */
  110104. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  110105. }
  110106. }
  110107. declare module BABYLON {
  110108. /**
  110109. * Defines the WindowsMotionController object that the state of the windows motion controller
  110110. */
  110111. export class WindowsMotionController extends WebVRController {
  110112. /**
  110113. * The base url used to load the left and right controller models
  110114. */
  110115. static MODEL_BASE_URL: string;
  110116. /**
  110117. * The name of the left controller model file
  110118. */
  110119. static MODEL_LEFT_FILENAME: string;
  110120. /**
  110121. * The name of the right controller model file
  110122. */
  110123. static MODEL_RIGHT_FILENAME: string;
  110124. /**
  110125. * The controller name prefix for this controller type
  110126. */
  110127. static readonly GAMEPAD_ID_PREFIX: string;
  110128. /**
  110129. * The controller id pattern for this controller type
  110130. */
  110131. private static readonly GAMEPAD_ID_PATTERN;
  110132. private _loadedMeshInfo;
  110133. private readonly _mapping;
  110134. /**
  110135. * Fired when the trackpad on this controller is clicked
  110136. */
  110137. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  110138. /**
  110139. * Fired when the trackpad on this controller is modified
  110140. */
  110141. onTrackpadValuesChangedObservable: Observable<StickValues>;
  110142. /**
  110143. * The current x and y values of this controller's trackpad
  110144. */
  110145. trackpad: StickValues;
  110146. /**
  110147. * Creates a new WindowsMotionController from a gamepad
  110148. * @param vrGamepad the gamepad that the controller should be created from
  110149. */
  110150. constructor(vrGamepad: any);
  110151. /**
  110152. * Fired when the trigger on this controller is modified
  110153. */
  110154. readonly onTriggerButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110155. /**
  110156. * Fired when the menu button on this controller is modified
  110157. */
  110158. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110159. /**
  110160. * Fired when the grip button on this controller is modified
  110161. */
  110162. readonly onGripButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110163. /**
  110164. * Fired when the thumbstick button on this controller is modified
  110165. */
  110166. readonly onThumbstickButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110167. /**
  110168. * Fired when the touchpad button on this controller is modified
  110169. */
  110170. readonly onTouchpadButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110171. /**
  110172. * Fired when the touchpad values on this controller are modified
  110173. */
  110174. readonly onTouchpadValuesChangedObservable: Observable<StickValues>;
  110175. private _updateTrackpad;
  110176. /**
  110177. * Called once per frame by the engine.
  110178. */
  110179. update(): void;
  110180. /**
  110181. * Called once for each button that changed state since the last frame
  110182. * @param buttonIdx Which button index changed
  110183. * @param state New state of the button
  110184. * @param changes Which properties on the state changed since last frame
  110185. */
  110186. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  110187. /**
  110188. * Moves the buttons on the controller mesh based on their current state
  110189. * @param buttonName the name of the button to move
  110190. * @param buttonValue the value of the button which determines the buttons new position
  110191. */
  110192. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  110193. /**
  110194. * Moves the axis on the controller mesh based on its current state
  110195. * @param axis the index of the axis
  110196. * @param axisValue the value of the axis which determines the meshes new position
  110197. * @hidden
  110198. */
  110199. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  110200. /**
  110201. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  110202. * @param scene scene in which to add meshes
  110203. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  110204. */
  110205. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  110206. /**
  110207. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  110208. * can be transformed by button presses and axes values, based on this._mapping.
  110209. *
  110210. * @param scene scene in which the meshes exist
  110211. * @param meshes list of meshes that make up the controller model to process
  110212. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  110213. */
  110214. private processModel;
  110215. private createMeshInfo;
  110216. /**
  110217. * Gets the ray of the controller in the direction the controller is pointing
  110218. * @param length the length the resulting ray should be
  110219. * @returns a ray in the direction the controller is pointing
  110220. */
  110221. getForwardRay(length?: number): Ray;
  110222. /**
  110223. * Disposes of the controller
  110224. */
  110225. dispose(): void;
  110226. }
  110227. }
  110228. declare module BABYLON {
  110229. /**
  110230. * Oculus Touch Controller
  110231. */
  110232. export class OculusTouchController extends WebVRController {
  110233. /**
  110234. * Base Url for the controller model.
  110235. */
  110236. static MODEL_BASE_URL: string;
  110237. /**
  110238. * File name for the left controller model.
  110239. */
  110240. static MODEL_LEFT_FILENAME: string;
  110241. /**
  110242. * File name for the right controller model.
  110243. */
  110244. static MODEL_RIGHT_FILENAME: string;
  110245. /**
  110246. * Base Url for the Quest controller model.
  110247. */
  110248. static QUEST_MODEL_BASE_URL: string;
  110249. /**
  110250. * @hidden
  110251. * If the controllers are running on a device that needs the updated Quest controller models
  110252. */
  110253. static _IsQuest: boolean;
  110254. /**
  110255. * Fired when the secondary trigger on this controller is modified
  110256. */
  110257. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  110258. /**
  110259. * Fired when the thumb rest on this controller is modified
  110260. */
  110261. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  110262. /**
  110263. * Creates a new OculusTouchController from a gamepad
  110264. * @param vrGamepad the gamepad that the controller should be created from
  110265. */
  110266. constructor(vrGamepad: any);
  110267. /**
  110268. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  110269. * @param scene scene in which to add meshes
  110270. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  110271. */
  110272. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  110273. /**
  110274. * Fired when the A button on this controller is modified
  110275. */
  110276. readonly onAButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110277. /**
  110278. * Fired when the B button on this controller is modified
  110279. */
  110280. readonly onBButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110281. /**
  110282. * Fired when the X button on this controller is modified
  110283. */
  110284. readonly onXButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110285. /**
  110286. * Fired when the Y button on this controller is modified
  110287. */
  110288. readonly onYButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110289. /**
  110290. * Called once for each button that changed state since the last frame
  110291. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  110292. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  110293. * 2) secondary trigger (same)
  110294. * 3) A (right) X (left), touch, pressed = value
  110295. * 4) B / Y
  110296. * 5) thumb rest
  110297. * @param buttonIdx Which button index changed
  110298. * @param state New state of the button
  110299. * @param changes Which properties on the state changed since last frame
  110300. */
  110301. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  110302. }
  110303. }
  110304. declare module BABYLON {
  110305. /**
  110306. * Vive Controller
  110307. */
  110308. export class ViveController extends WebVRController {
  110309. /**
  110310. * Base Url for the controller model.
  110311. */
  110312. static MODEL_BASE_URL: string;
  110313. /**
  110314. * File name for the controller model.
  110315. */
  110316. static MODEL_FILENAME: string;
  110317. /**
  110318. * Creates a new ViveController from a gamepad
  110319. * @param vrGamepad the gamepad that the controller should be created from
  110320. */
  110321. constructor(vrGamepad: any);
  110322. /**
  110323. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  110324. * @param scene scene in which to add meshes
  110325. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  110326. */
  110327. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  110328. /**
  110329. * Fired when the left button on this controller is modified
  110330. */
  110331. readonly onLeftButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110332. /**
  110333. * Fired when the right button on this controller is modified
  110334. */
  110335. readonly onRightButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110336. /**
  110337. * Fired when the menu button on this controller is modified
  110338. */
  110339. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110340. /**
  110341. * Called once for each button that changed state since the last frame
  110342. * Vive mapping:
  110343. * 0: touchpad
  110344. * 1: trigger
  110345. * 2: left AND right buttons
  110346. * 3: menu button
  110347. * @param buttonIdx Which button index changed
  110348. * @param state New state of the button
  110349. * @param changes Which properties on the state changed since last frame
  110350. */
  110351. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  110352. }
  110353. }
  110354. declare module BABYLON {
  110355. /**
  110356. * Loads a controller model and adds it as a child of the WebXRControllers grip when the controller is created
  110357. */
  110358. export class WebXRControllerModelLoader {
  110359. /**
  110360. * Creates the WebXRControllerModelLoader
  110361. * @param input xr input that creates the controllers
  110362. */
  110363. constructor(input: WebXRInput);
  110364. }
  110365. }
  110366. declare module BABYLON {
  110367. /**
  110368. * Contains an array of blocks representing the octree
  110369. */
  110370. export interface IOctreeContainer<T> {
  110371. /**
  110372. * Blocks within the octree
  110373. */
  110374. blocks: Array<OctreeBlock<T>>;
  110375. }
  110376. /**
  110377. * Class used to store a cell in an octree
  110378. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  110379. */
  110380. export class OctreeBlock<T> {
  110381. /**
  110382. * Gets the content of the current block
  110383. */
  110384. entries: T[];
  110385. /**
  110386. * Gets the list of block children
  110387. */
  110388. blocks: Array<OctreeBlock<T>>;
  110389. private _depth;
  110390. private _maxDepth;
  110391. private _capacity;
  110392. private _minPoint;
  110393. private _maxPoint;
  110394. private _boundingVectors;
  110395. private _creationFunc;
  110396. /**
  110397. * Creates a new block
  110398. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  110399. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  110400. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  110401. * @param depth defines the current depth of this block in the octree
  110402. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  110403. * @param creationFunc defines a callback to call when an element is added to the block
  110404. */
  110405. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  110406. /**
  110407. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  110408. */
  110409. readonly capacity: number;
  110410. /**
  110411. * Gets the minimum vector (in world space) of the block's bounding box
  110412. */
  110413. readonly minPoint: Vector3;
  110414. /**
  110415. * Gets the maximum vector (in world space) of the block's bounding box
  110416. */
  110417. readonly maxPoint: Vector3;
  110418. /**
  110419. * Add a new element to this block
  110420. * @param entry defines the element to add
  110421. */
  110422. addEntry(entry: T): void;
  110423. /**
  110424. * Remove an element from this block
  110425. * @param entry defines the element to remove
  110426. */
  110427. removeEntry(entry: T): void;
  110428. /**
  110429. * Add an array of elements to this block
  110430. * @param entries defines the array of elements to add
  110431. */
  110432. addEntries(entries: T[]): void;
  110433. /**
  110434. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  110435. * @param frustumPlanes defines the frustum planes to test
  110436. * @param selection defines the array to store current content if selection is positive
  110437. * @param allowDuplicate defines if the selection array can contains duplicated entries
  110438. */
  110439. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  110440. /**
  110441. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  110442. * @param sphereCenter defines the bounding sphere center
  110443. * @param sphereRadius defines the bounding sphere radius
  110444. * @param selection defines the array to store current content if selection is positive
  110445. * @param allowDuplicate defines if the selection array can contains duplicated entries
  110446. */
  110447. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  110448. /**
  110449. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  110450. * @param ray defines the ray to test with
  110451. * @param selection defines the array to store current content if selection is positive
  110452. */
  110453. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  110454. /**
  110455. * Subdivide the content into child blocks (this block will then be empty)
  110456. */
  110457. createInnerBlocks(): void;
  110458. /**
  110459. * @hidden
  110460. */
  110461. 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;
  110462. }
  110463. }
  110464. declare module BABYLON {
  110465. /**
  110466. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  110467. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  110468. */
  110469. export class Octree<T> {
  110470. /** 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.) */
  110471. maxDepth: number;
  110472. /**
  110473. * Blocks within the octree containing objects
  110474. */
  110475. blocks: Array<OctreeBlock<T>>;
  110476. /**
  110477. * Content stored in the octree
  110478. */
  110479. dynamicContent: T[];
  110480. private _maxBlockCapacity;
  110481. private _selectionContent;
  110482. private _creationFunc;
  110483. /**
  110484. * Creates a octree
  110485. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  110486. * @param creationFunc function to be used to instatiate the octree
  110487. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  110488. * @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.)
  110489. */
  110490. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  110491. /** 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.) */
  110492. maxDepth?: number);
  110493. /**
  110494. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  110495. * @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);
  110496. * @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);
  110497. * @param entries meshes to be added to the octree blocks
  110498. */
  110499. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  110500. /**
  110501. * Adds a mesh to the octree
  110502. * @param entry Mesh to add to the octree
  110503. */
  110504. addMesh(entry: T): void;
  110505. /**
  110506. * Remove an element from the octree
  110507. * @param entry defines the element to remove
  110508. */
  110509. removeMesh(entry: T): void;
  110510. /**
  110511. * Selects an array of meshes within the frustum
  110512. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  110513. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  110514. * @returns array of meshes within the frustum
  110515. */
  110516. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  110517. /**
  110518. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  110519. * @param sphereCenter defines the bounding sphere center
  110520. * @param sphereRadius defines the bounding sphere radius
  110521. * @param allowDuplicate defines if the selection array can contains duplicated entries
  110522. * @returns an array of objects that intersect the sphere
  110523. */
  110524. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  110525. /**
  110526. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  110527. * @param ray defines the ray to test with
  110528. * @returns array of intersected objects
  110529. */
  110530. intersectsRay(ray: Ray): SmartArray<T>;
  110531. /**
  110532. * Adds a mesh into the octree block if it intersects the block
  110533. */
  110534. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  110535. /**
  110536. * Adds a submesh into the octree block if it intersects the block
  110537. */
  110538. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  110539. }
  110540. }
  110541. declare module BABYLON {
  110542. interface Scene {
  110543. /**
  110544. * @hidden
  110545. * Backing Filed
  110546. */
  110547. _selectionOctree: Octree<AbstractMesh>;
  110548. /**
  110549. * Gets the octree used to boost mesh selection (picking)
  110550. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  110551. */
  110552. selectionOctree: Octree<AbstractMesh>;
  110553. /**
  110554. * Creates or updates the octree used to boost selection (picking)
  110555. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  110556. * @param maxCapacity defines the maximum capacity per leaf
  110557. * @param maxDepth defines the maximum depth of the octree
  110558. * @returns an octree of AbstractMesh
  110559. */
  110560. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  110561. }
  110562. interface AbstractMesh {
  110563. /**
  110564. * @hidden
  110565. * Backing Field
  110566. */
  110567. _submeshesOctree: Octree<SubMesh>;
  110568. /**
  110569. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  110570. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  110571. * @param maxCapacity defines the maximum size of each block (64 by default)
  110572. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  110573. * @returns the new octree
  110574. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  110575. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  110576. */
  110577. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  110578. }
  110579. /**
  110580. * Defines the octree scene component responsible to manage any octrees
  110581. * in a given scene.
  110582. */
  110583. export class OctreeSceneComponent {
  110584. /**
  110585. * The component name help to identify the component in the list of scene components.
  110586. */
  110587. readonly name: string;
  110588. /**
  110589. * The scene the component belongs to.
  110590. */
  110591. scene: Scene;
  110592. /**
  110593. * Indicates if the meshes have been checked to make sure they are isEnabled()
  110594. */
  110595. readonly checksIsEnabled: boolean;
  110596. /**
  110597. * Creates a new instance of the component for the given scene
  110598. * @param scene Defines the scene to register the component in
  110599. */
  110600. constructor(scene: Scene);
  110601. /**
  110602. * Registers the component in a given scene
  110603. */
  110604. register(): void;
  110605. /**
  110606. * Return the list of active meshes
  110607. * @returns the list of active meshes
  110608. */
  110609. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  110610. /**
  110611. * Return the list of active sub meshes
  110612. * @param mesh The mesh to get the candidates sub meshes from
  110613. * @returns the list of active sub meshes
  110614. */
  110615. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  110616. private _tempRay;
  110617. /**
  110618. * Return the list of sub meshes intersecting with a given local ray
  110619. * @param mesh defines the mesh to find the submesh for
  110620. * @param localRay defines the ray in local space
  110621. * @returns the list of intersecting sub meshes
  110622. */
  110623. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  110624. /**
  110625. * Return the list of sub meshes colliding with a collider
  110626. * @param mesh defines the mesh to find the submesh for
  110627. * @param collider defines the collider to evaluate the collision against
  110628. * @returns the list of colliding sub meshes
  110629. */
  110630. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  110631. /**
  110632. * Rebuilds the elements related to this component in case of
  110633. * context lost for instance.
  110634. */
  110635. rebuild(): void;
  110636. /**
  110637. * Disposes the component and the associated ressources.
  110638. */
  110639. dispose(): void;
  110640. }
  110641. }
  110642. declare module BABYLON {
  110643. /**
  110644. * Renders a layer on top of an existing scene
  110645. */
  110646. export class UtilityLayerRenderer implements IDisposable {
  110647. /** the original scene that will be rendered on top of */
  110648. originalScene: Scene;
  110649. private _pointerCaptures;
  110650. private _lastPointerEvents;
  110651. private static _DefaultUtilityLayer;
  110652. private static _DefaultKeepDepthUtilityLayer;
  110653. private _sharedGizmoLight;
  110654. private _renderCamera;
  110655. /**
  110656. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  110657. * @returns the camera that is used when rendering the utility layer
  110658. */
  110659. getRenderCamera(): Nullable<Camera>;
  110660. /**
  110661. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  110662. * @param cam the camera that should be used when rendering the utility layer
  110663. */
  110664. setRenderCamera(cam: Nullable<Camera>): void;
  110665. /**
  110666. * @hidden
  110667. * Light which used by gizmos to get light shading
  110668. */
  110669. _getSharedGizmoLight(): HemisphericLight;
  110670. /**
  110671. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  110672. */
  110673. pickUtilitySceneFirst: boolean;
  110674. /**
  110675. * 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)
  110676. */
  110677. static readonly DefaultUtilityLayer: UtilityLayerRenderer;
  110678. /**
  110679. * 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)
  110680. */
  110681. static readonly DefaultKeepDepthUtilityLayer: UtilityLayerRenderer;
  110682. /**
  110683. * The scene that is rendered on top of the original scene
  110684. */
  110685. utilityLayerScene: Scene;
  110686. /**
  110687. * If the utility layer should automatically be rendered on top of existing scene
  110688. */
  110689. shouldRender: boolean;
  110690. /**
  110691. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  110692. */
  110693. onlyCheckPointerDownEvents: boolean;
  110694. /**
  110695. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  110696. */
  110697. processAllEvents: boolean;
  110698. /**
  110699. * Observable raised when the pointer move from the utility layer scene to the main scene
  110700. */
  110701. onPointerOutObservable: Observable<number>;
  110702. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  110703. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  110704. private _afterRenderObserver;
  110705. private _sceneDisposeObserver;
  110706. private _originalPointerObserver;
  110707. /**
  110708. * Instantiates a UtilityLayerRenderer
  110709. * @param originalScene the original scene that will be rendered on top of
  110710. * @param handleEvents boolean indicating if the utility layer should handle events
  110711. */
  110712. constructor(
  110713. /** the original scene that will be rendered on top of */
  110714. originalScene: Scene, handleEvents?: boolean);
  110715. private _notifyObservers;
  110716. /**
  110717. * Renders the utility layers scene on top of the original scene
  110718. */
  110719. render(): void;
  110720. /**
  110721. * Disposes of the renderer
  110722. */
  110723. dispose(): void;
  110724. private _updateCamera;
  110725. }
  110726. }
  110727. declare module BABYLON {
  110728. /**
  110729. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  110730. */
  110731. export class Gizmo implements IDisposable {
  110732. /** The utility layer the gizmo will be added to */
  110733. gizmoLayer: UtilityLayerRenderer;
  110734. /**
  110735. * The root mesh of the gizmo
  110736. */
  110737. _rootMesh: Mesh;
  110738. private _attachedMesh;
  110739. /**
  110740. * Ratio for the scale of the gizmo (Default: 1)
  110741. */
  110742. scaleRatio: number;
  110743. /**
  110744. * If a custom mesh has been set (Default: false)
  110745. */
  110746. protected _customMeshSet: boolean;
  110747. /**
  110748. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  110749. * * When set, interactions will be enabled
  110750. */
  110751. attachedMesh: Nullable<AbstractMesh>;
  110752. /**
  110753. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  110754. * @param mesh The mesh to replace the default mesh of the gizmo
  110755. */
  110756. setCustomMesh(mesh: Mesh): void;
  110757. /**
  110758. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  110759. */
  110760. updateGizmoRotationToMatchAttachedMesh: boolean;
  110761. /**
  110762. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  110763. */
  110764. updateGizmoPositionToMatchAttachedMesh: boolean;
  110765. /**
  110766. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  110767. */
  110768. updateScale: boolean;
  110769. protected _interactionsEnabled: boolean;
  110770. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  110771. private _beforeRenderObserver;
  110772. private _tempVector;
  110773. /**
  110774. * Creates a gizmo
  110775. * @param gizmoLayer The utility layer the gizmo will be added to
  110776. */
  110777. constructor(
  110778. /** The utility layer the gizmo will be added to */
  110779. gizmoLayer?: UtilityLayerRenderer);
  110780. /**
  110781. * Updates the gizmo to match the attached mesh's position/rotation
  110782. */
  110783. protected _update(): void;
  110784. /**
  110785. * Disposes of the gizmo
  110786. */
  110787. dispose(): void;
  110788. }
  110789. }
  110790. declare module BABYLON {
  110791. /**
  110792. * Single plane drag gizmo
  110793. */
  110794. export class PlaneDragGizmo extends Gizmo {
  110795. /**
  110796. * Drag behavior responsible for the gizmos dragging interactions
  110797. */
  110798. dragBehavior: PointerDragBehavior;
  110799. private _pointerObserver;
  110800. /**
  110801. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  110802. */
  110803. snapDistance: number;
  110804. /**
  110805. * Event that fires each time the gizmo snaps to a new location.
  110806. * * snapDistance is the the change in distance
  110807. */
  110808. onSnapObservable: Observable<{
  110809. snapDistance: number;
  110810. }>;
  110811. private _plane;
  110812. private _coloredMaterial;
  110813. private _hoverMaterial;
  110814. private _isEnabled;
  110815. private _parent;
  110816. /** @hidden */
  110817. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  110818. /** @hidden */
  110819. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  110820. /**
  110821. * Creates a PlaneDragGizmo
  110822. * @param gizmoLayer The utility layer the gizmo will be added to
  110823. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  110824. * @param color The color of the gizmo
  110825. */
  110826. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  110827. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  110828. /**
  110829. * If the gizmo is enabled
  110830. */
  110831. isEnabled: boolean;
  110832. /**
  110833. * Disposes of the gizmo
  110834. */
  110835. dispose(): void;
  110836. }
  110837. }
  110838. declare module BABYLON {
  110839. /**
  110840. * Gizmo that enables dragging a mesh along 3 axis
  110841. */
  110842. export class PositionGizmo extends Gizmo {
  110843. /**
  110844. * Internal gizmo used for interactions on the x axis
  110845. */
  110846. xGizmo: AxisDragGizmo;
  110847. /**
  110848. * Internal gizmo used for interactions on the y axis
  110849. */
  110850. yGizmo: AxisDragGizmo;
  110851. /**
  110852. * Internal gizmo used for interactions on the z axis
  110853. */
  110854. zGizmo: AxisDragGizmo;
  110855. /**
  110856. * Internal gizmo used for interactions on the yz plane
  110857. */
  110858. xPlaneGizmo: PlaneDragGizmo;
  110859. /**
  110860. * Internal gizmo used for interactions on the xz plane
  110861. */
  110862. yPlaneGizmo: PlaneDragGizmo;
  110863. /**
  110864. * Internal gizmo used for interactions on the xy plane
  110865. */
  110866. zPlaneGizmo: PlaneDragGizmo;
  110867. /**
  110868. * private variables
  110869. */
  110870. private _meshAttached;
  110871. private _updateGizmoRotationToMatchAttachedMesh;
  110872. private _snapDistance;
  110873. private _scaleRatio;
  110874. /** Fires an event when any of it's sub gizmos are dragged */
  110875. onDragStartObservable: Observable<unknown>;
  110876. /** Fires an event when any of it's sub gizmos are released from dragging */
  110877. onDragEndObservable: Observable<unknown>;
  110878. /**
  110879. * If set to true, planar drag is enabled
  110880. */
  110881. private _planarGizmoEnabled;
  110882. attachedMesh: Nullable<AbstractMesh>;
  110883. /**
  110884. * Creates a PositionGizmo
  110885. * @param gizmoLayer The utility layer the gizmo will be added to
  110886. */
  110887. constructor(gizmoLayer?: UtilityLayerRenderer);
  110888. /**
  110889. * If the planar drag gizmo is enabled
  110890. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  110891. */
  110892. planarGizmoEnabled: boolean;
  110893. updateGizmoRotationToMatchAttachedMesh: boolean;
  110894. /**
  110895. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  110896. */
  110897. snapDistance: number;
  110898. /**
  110899. * Ratio for the scale of the gizmo (Default: 1)
  110900. */
  110901. scaleRatio: number;
  110902. /**
  110903. * Disposes of the gizmo
  110904. */
  110905. dispose(): void;
  110906. /**
  110907. * CustomMeshes are not supported by this gizmo
  110908. * @param mesh The mesh to replace the default mesh of the gizmo
  110909. */
  110910. setCustomMesh(mesh: Mesh): void;
  110911. }
  110912. }
  110913. declare module BABYLON {
  110914. /**
  110915. * Single axis drag gizmo
  110916. */
  110917. export class AxisDragGizmo extends Gizmo {
  110918. /**
  110919. * Drag behavior responsible for the gizmos dragging interactions
  110920. */
  110921. dragBehavior: PointerDragBehavior;
  110922. private _pointerObserver;
  110923. /**
  110924. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  110925. */
  110926. snapDistance: number;
  110927. /**
  110928. * Event that fires each time the gizmo snaps to a new location.
  110929. * * snapDistance is the the change in distance
  110930. */
  110931. onSnapObservable: Observable<{
  110932. snapDistance: number;
  110933. }>;
  110934. private _isEnabled;
  110935. private _parent;
  110936. private _arrow;
  110937. private _coloredMaterial;
  110938. private _hoverMaterial;
  110939. /** @hidden */
  110940. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  110941. /** @hidden */
  110942. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  110943. /**
  110944. * Creates an AxisDragGizmo
  110945. * @param gizmoLayer The utility layer the gizmo will be added to
  110946. * @param dragAxis The axis which the gizmo will be able to drag on
  110947. * @param color The color of the gizmo
  110948. */
  110949. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  110950. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  110951. /**
  110952. * If the gizmo is enabled
  110953. */
  110954. isEnabled: boolean;
  110955. /**
  110956. * Disposes of the gizmo
  110957. */
  110958. dispose(): void;
  110959. }
  110960. }
  110961. declare module BABYLON.Debug {
  110962. /**
  110963. * The Axes viewer will show 3 axes in a specific point in space
  110964. */
  110965. export class AxesViewer {
  110966. private _xAxis;
  110967. private _yAxis;
  110968. private _zAxis;
  110969. private _scaleLinesFactor;
  110970. private _instanced;
  110971. /**
  110972. * Gets the hosting scene
  110973. */
  110974. scene: Scene;
  110975. /**
  110976. * Gets or sets a number used to scale line length
  110977. */
  110978. scaleLines: number;
  110979. /** Gets the node hierarchy used to render x-axis */
  110980. readonly xAxis: TransformNode;
  110981. /** Gets the node hierarchy used to render y-axis */
  110982. readonly yAxis: TransformNode;
  110983. /** Gets the node hierarchy used to render z-axis */
  110984. readonly zAxis: TransformNode;
  110985. /**
  110986. * Creates a new AxesViewer
  110987. * @param scene defines the hosting scene
  110988. * @param scaleLines defines a number used to scale line length (1 by default)
  110989. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  110990. * @param xAxis defines the node hierarchy used to render the x-axis
  110991. * @param yAxis defines the node hierarchy used to render the y-axis
  110992. * @param zAxis defines the node hierarchy used to render the z-axis
  110993. */
  110994. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  110995. /**
  110996. * Force the viewer to update
  110997. * @param position defines the position of the viewer
  110998. * @param xaxis defines the x axis of the viewer
  110999. * @param yaxis defines the y axis of the viewer
  111000. * @param zaxis defines the z axis of the viewer
  111001. */
  111002. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  111003. /**
  111004. * Creates an instance of this axes viewer.
  111005. * @returns a new axes viewer with instanced meshes
  111006. */
  111007. createInstance(): AxesViewer;
  111008. /** Releases resources */
  111009. dispose(): void;
  111010. private static _SetRenderingGroupId;
  111011. }
  111012. }
  111013. declare module BABYLON.Debug {
  111014. /**
  111015. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  111016. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  111017. */
  111018. export class BoneAxesViewer extends AxesViewer {
  111019. /**
  111020. * Gets or sets the target mesh where to display the axes viewer
  111021. */
  111022. mesh: Nullable<Mesh>;
  111023. /**
  111024. * Gets or sets the target bone where to display the axes viewer
  111025. */
  111026. bone: Nullable<Bone>;
  111027. /** Gets current position */
  111028. pos: Vector3;
  111029. /** Gets direction of X axis */
  111030. xaxis: Vector3;
  111031. /** Gets direction of Y axis */
  111032. yaxis: Vector3;
  111033. /** Gets direction of Z axis */
  111034. zaxis: Vector3;
  111035. /**
  111036. * Creates a new BoneAxesViewer
  111037. * @param scene defines the hosting scene
  111038. * @param bone defines the target bone
  111039. * @param mesh defines the target mesh
  111040. * @param scaleLines defines a scaling factor for line length (1 by default)
  111041. */
  111042. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  111043. /**
  111044. * Force the viewer to update
  111045. */
  111046. update(): void;
  111047. /** Releases resources */
  111048. dispose(): void;
  111049. }
  111050. }
  111051. declare module BABYLON {
  111052. /**
  111053. * Interface used to define scene explorer extensibility option
  111054. */
  111055. export interface IExplorerExtensibilityOption {
  111056. /**
  111057. * Define the option label
  111058. */
  111059. label: string;
  111060. /**
  111061. * Defines the action to execute on click
  111062. */
  111063. action: (entity: any) => void;
  111064. }
  111065. /**
  111066. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  111067. */
  111068. export interface IExplorerExtensibilityGroup {
  111069. /**
  111070. * Defines a predicate to test if a given type mut be extended
  111071. */
  111072. predicate: (entity: any) => boolean;
  111073. /**
  111074. * Gets the list of options added to a type
  111075. */
  111076. entries: IExplorerExtensibilityOption[];
  111077. }
  111078. /**
  111079. * Interface used to define the options to use to create the Inspector
  111080. */
  111081. export interface IInspectorOptions {
  111082. /**
  111083. * Display in overlay mode (default: false)
  111084. */
  111085. overlay?: boolean;
  111086. /**
  111087. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  111088. */
  111089. globalRoot?: HTMLElement;
  111090. /**
  111091. * Display the Scene explorer
  111092. */
  111093. showExplorer?: boolean;
  111094. /**
  111095. * Display the property inspector
  111096. */
  111097. showInspector?: boolean;
  111098. /**
  111099. * Display in embed mode (both panes on the right)
  111100. */
  111101. embedMode?: boolean;
  111102. /**
  111103. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  111104. */
  111105. handleResize?: boolean;
  111106. /**
  111107. * Allow the panes to popup (default: true)
  111108. */
  111109. enablePopup?: boolean;
  111110. /**
  111111. * Allow the panes to be closed by users (default: true)
  111112. */
  111113. enableClose?: boolean;
  111114. /**
  111115. * Optional list of extensibility entries
  111116. */
  111117. explorerExtensibility?: IExplorerExtensibilityGroup[];
  111118. /**
  111119. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  111120. */
  111121. inspectorURL?: string;
  111122. }
  111123. interface Scene {
  111124. /**
  111125. * @hidden
  111126. * Backing field
  111127. */
  111128. _debugLayer: DebugLayer;
  111129. /**
  111130. * Gets the debug layer (aka Inspector) associated with the scene
  111131. * @see http://doc.babylonjs.com/features/playground_debuglayer
  111132. */
  111133. debugLayer: DebugLayer;
  111134. }
  111135. /**
  111136. * The debug layer (aka Inspector) is the go to tool in order to better understand
  111137. * what is happening in your scene
  111138. * @see http://doc.babylonjs.com/features/playground_debuglayer
  111139. */
  111140. export class DebugLayer {
  111141. /**
  111142. * Define the url to get the inspector script from.
  111143. * By default it uses the babylonjs CDN.
  111144. * @ignoreNaming
  111145. */
  111146. static InspectorURL: string;
  111147. private _scene;
  111148. private BJSINSPECTOR;
  111149. private _onPropertyChangedObservable?;
  111150. /**
  111151. * Observable triggered when a property is changed through the inspector.
  111152. */
  111153. readonly onPropertyChangedObservable: any;
  111154. /**
  111155. * Instantiates a new debug layer.
  111156. * The debug layer (aka Inspector) is the go to tool in order to better understand
  111157. * what is happening in your scene
  111158. * @see http://doc.babylonjs.com/features/playground_debuglayer
  111159. * @param scene Defines the scene to inspect
  111160. */
  111161. constructor(scene: Scene);
  111162. /** Creates the inspector window. */
  111163. private _createInspector;
  111164. /**
  111165. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  111166. * @param entity defines the entity to select
  111167. * @param lineContainerTitle defines the specific block to highlight
  111168. */
  111169. select(entity: any, lineContainerTitle?: string): void;
  111170. /** Get the inspector from bundle or global */
  111171. private _getGlobalInspector;
  111172. /**
  111173. * Get if the inspector is visible or not.
  111174. * @returns true if visible otherwise, false
  111175. */
  111176. isVisible(): boolean;
  111177. /**
  111178. * Hide the inspector and close its window.
  111179. */
  111180. hide(): void;
  111181. /**
  111182. * Launch the debugLayer.
  111183. * @param config Define the configuration of the inspector
  111184. * @return a promise fulfilled when the debug layer is visible
  111185. */
  111186. show(config?: IInspectorOptions): Promise<DebugLayer>;
  111187. }
  111188. }
  111189. declare module BABYLON {
  111190. /**
  111191. * Class containing static functions to help procedurally build meshes
  111192. */
  111193. export class BoxBuilder {
  111194. /**
  111195. * Creates a box mesh
  111196. * * The parameter `size` sets the size (float) of each box side (default 1)
  111197. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  111198. * * 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)
  111199. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  111200. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  111201. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  111202. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111203. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  111204. * @param name defines the name of the mesh
  111205. * @param options defines the options used to create the mesh
  111206. * @param scene defines the hosting scene
  111207. * @returns the box mesh
  111208. */
  111209. static CreateBox(name: string, options: {
  111210. size?: number;
  111211. width?: number;
  111212. height?: number;
  111213. depth?: number;
  111214. faceUV?: Vector4[];
  111215. faceColors?: Color4[];
  111216. sideOrientation?: number;
  111217. frontUVs?: Vector4;
  111218. backUVs?: Vector4;
  111219. wrap?: boolean;
  111220. topBaseAt?: number;
  111221. bottomBaseAt?: number;
  111222. updatable?: boolean;
  111223. }, scene?: Nullable<Scene>): Mesh;
  111224. }
  111225. }
  111226. declare module BABYLON {
  111227. /**
  111228. * Class containing static functions to help procedurally build meshes
  111229. */
  111230. export class SphereBuilder {
  111231. /**
  111232. * Creates a sphere mesh
  111233. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  111234. * * 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`)
  111235. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  111236. * * 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
  111237. * * 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)
  111238. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  111239. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  111240. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111241. * @param name defines the name of the mesh
  111242. * @param options defines the options used to create the mesh
  111243. * @param scene defines the hosting scene
  111244. * @returns the sphere mesh
  111245. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  111246. */
  111247. static CreateSphere(name: string, options: {
  111248. segments?: number;
  111249. diameter?: number;
  111250. diameterX?: number;
  111251. diameterY?: number;
  111252. diameterZ?: number;
  111253. arc?: number;
  111254. slice?: number;
  111255. sideOrientation?: number;
  111256. frontUVs?: Vector4;
  111257. backUVs?: Vector4;
  111258. updatable?: boolean;
  111259. }, scene?: Nullable<Scene>): Mesh;
  111260. }
  111261. }
  111262. declare module BABYLON.Debug {
  111263. /**
  111264. * Used to show the physics impostor around the specific mesh
  111265. */
  111266. export class PhysicsViewer {
  111267. /** @hidden */
  111268. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  111269. /** @hidden */
  111270. protected _meshes: Array<Nullable<AbstractMesh>>;
  111271. /** @hidden */
  111272. protected _scene: Nullable<Scene>;
  111273. /** @hidden */
  111274. protected _numMeshes: number;
  111275. /** @hidden */
  111276. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  111277. private _renderFunction;
  111278. private _utilityLayer;
  111279. private _debugBoxMesh;
  111280. private _debugSphereMesh;
  111281. private _debugCylinderMesh;
  111282. private _debugMaterial;
  111283. private _debugMeshMeshes;
  111284. /**
  111285. * Creates a new PhysicsViewer
  111286. * @param scene defines the hosting scene
  111287. */
  111288. constructor(scene: Scene);
  111289. /** @hidden */
  111290. protected _updateDebugMeshes(): void;
  111291. /**
  111292. * Renders a specified physic impostor
  111293. * @param impostor defines the impostor to render
  111294. * @param targetMesh defines the mesh represented by the impostor
  111295. * @returns the new debug mesh used to render the impostor
  111296. */
  111297. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  111298. /**
  111299. * Hides a specified physic impostor
  111300. * @param impostor defines the impostor to hide
  111301. */
  111302. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  111303. private _getDebugMaterial;
  111304. private _getDebugBoxMesh;
  111305. private _getDebugSphereMesh;
  111306. private _getDebugCylinderMesh;
  111307. private _getDebugMeshMesh;
  111308. private _getDebugMesh;
  111309. /** Releases all resources */
  111310. dispose(): void;
  111311. }
  111312. }
  111313. declare module BABYLON {
  111314. /**
  111315. * Class containing static functions to help procedurally build meshes
  111316. */
  111317. export class LinesBuilder {
  111318. /**
  111319. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  111320. * * 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
  111321. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  111322. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  111323. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  111324. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  111325. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  111326. * * 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
  111327. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  111328. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111329. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  111330. * @param name defines the name of the new line system
  111331. * @param options defines the options used to create the line system
  111332. * @param scene defines the hosting scene
  111333. * @returns a new line system mesh
  111334. */
  111335. static CreateLineSystem(name: string, options: {
  111336. lines: Vector3[][];
  111337. updatable?: boolean;
  111338. instance?: Nullable<LinesMesh>;
  111339. colors?: Nullable<Color4[][]>;
  111340. useVertexAlpha?: boolean;
  111341. }, scene: Nullable<Scene>): LinesMesh;
  111342. /**
  111343. * Creates a line mesh
  111344. * 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
  111345. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  111346. * * The parameter `points` is an array successive Vector3
  111347. * * 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
  111348. * * The optional parameter `colors` is an array of successive Color4, one per line point
  111349. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  111350. * * When updating an instance, remember that only point positions can change, not the number of points
  111351. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111352. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  111353. * @param name defines the name of the new line system
  111354. * @param options defines the options used to create the line system
  111355. * @param scene defines the hosting scene
  111356. * @returns a new line mesh
  111357. */
  111358. static CreateLines(name: string, options: {
  111359. points: Vector3[];
  111360. updatable?: boolean;
  111361. instance?: Nullable<LinesMesh>;
  111362. colors?: Color4[];
  111363. useVertexAlpha?: boolean;
  111364. }, scene?: Nullable<Scene>): LinesMesh;
  111365. /**
  111366. * Creates a dashed line mesh
  111367. * * 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
  111368. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  111369. * * The parameter `points` is an array successive Vector3
  111370. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  111371. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  111372. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  111373. * * 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
  111374. * * When updating an instance, remember that only point positions can change, not the number of points
  111375. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111376. * @param name defines the name of the mesh
  111377. * @param options defines the options used to create the mesh
  111378. * @param scene defines the hosting scene
  111379. * @returns the dashed line mesh
  111380. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  111381. */
  111382. static CreateDashedLines(name: string, options: {
  111383. points: Vector3[];
  111384. dashSize?: number;
  111385. gapSize?: number;
  111386. dashNb?: number;
  111387. updatable?: boolean;
  111388. instance?: LinesMesh;
  111389. }, scene?: Nullable<Scene>): LinesMesh;
  111390. }
  111391. }
  111392. declare module BABYLON {
  111393. /**
  111394. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  111395. * in order to better appreciate the issue one might have.
  111396. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  111397. */
  111398. export class RayHelper {
  111399. /**
  111400. * Defines the ray we are currently tryin to visualize.
  111401. */
  111402. ray: Nullable<Ray>;
  111403. private _renderPoints;
  111404. private _renderLine;
  111405. private _renderFunction;
  111406. private _scene;
  111407. private _updateToMeshFunction;
  111408. private _attachedToMesh;
  111409. private _meshSpaceDirection;
  111410. private _meshSpaceOrigin;
  111411. /**
  111412. * Helper function to create a colored helper in a scene in one line.
  111413. * @param ray Defines the ray we are currently tryin to visualize
  111414. * @param scene Defines the scene the ray is used in
  111415. * @param color Defines the color we want to see the ray in
  111416. * @returns The newly created ray helper.
  111417. */
  111418. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  111419. /**
  111420. * Instantiate a new ray helper.
  111421. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  111422. * in order to better appreciate the issue one might have.
  111423. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  111424. * @param ray Defines the ray we are currently tryin to visualize
  111425. */
  111426. constructor(ray: Ray);
  111427. /**
  111428. * Shows the ray we are willing to debug.
  111429. * @param scene Defines the scene the ray needs to be rendered in
  111430. * @param color Defines the color the ray needs to be rendered in
  111431. */
  111432. show(scene: Scene, color?: Color3): void;
  111433. /**
  111434. * Hides the ray we are debugging.
  111435. */
  111436. hide(): void;
  111437. private _render;
  111438. /**
  111439. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  111440. * @param mesh Defines the mesh we want the helper attached to
  111441. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  111442. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  111443. * @param length Defines the length of the ray
  111444. */
  111445. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  111446. /**
  111447. * Detach the ray helper from the mesh it has previously been attached to.
  111448. */
  111449. detachFromMesh(): void;
  111450. private _updateToMesh;
  111451. /**
  111452. * Dispose the helper and release its associated resources.
  111453. */
  111454. dispose(): void;
  111455. }
  111456. }
  111457. declare module BABYLON.Debug {
  111458. /**
  111459. * Class used to render a debug view of a given skeleton
  111460. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  111461. */
  111462. export class SkeletonViewer {
  111463. /** defines the skeleton to render */
  111464. skeleton: Skeleton;
  111465. /** defines the mesh attached to the skeleton */
  111466. mesh: AbstractMesh;
  111467. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  111468. autoUpdateBonesMatrices: boolean;
  111469. /** defines the rendering group id to use with the viewer */
  111470. renderingGroupId: number;
  111471. /** Gets or sets the color used to render the skeleton */
  111472. color: Color3;
  111473. private _scene;
  111474. private _debugLines;
  111475. private _debugMesh;
  111476. private _isEnabled;
  111477. private _renderFunction;
  111478. private _utilityLayer;
  111479. /**
  111480. * Returns the mesh used to render the bones
  111481. */
  111482. readonly debugMesh: Nullable<LinesMesh>;
  111483. /**
  111484. * Creates a new SkeletonViewer
  111485. * @param skeleton defines the skeleton to render
  111486. * @param mesh defines the mesh attached to the skeleton
  111487. * @param scene defines the hosting scene
  111488. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  111489. * @param renderingGroupId defines the rendering group id to use with the viewer
  111490. */
  111491. constructor(
  111492. /** defines the skeleton to render */
  111493. skeleton: Skeleton,
  111494. /** defines the mesh attached to the skeleton */
  111495. mesh: AbstractMesh, scene: Scene,
  111496. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  111497. autoUpdateBonesMatrices?: boolean,
  111498. /** defines the rendering group id to use with the viewer */
  111499. renderingGroupId?: number);
  111500. /** Gets or sets a boolean indicating if the viewer is enabled */
  111501. isEnabled: boolean;
  111502. private _getBonePosition;
  111503. private _getLinesForBonesWithLength;
  111504. private _getLinesForBonesNoLength;
  111505. /** Update the viewer to sync with current skeleton state */
  111506. update(): void;
  111507. /** Release associated resources */
  111508. dispose(): void;
  111509. }
  111510. }
  111511. declare module BABYLON {
  111512. /**
  111513. * Options to create the null engine
  111514. */
  111515. export class NullEngineOptions {
  111516. /**
  111517. * Render width (Default: 512)
  111518. */
  111519. renderWidth: number;
  111520. /**
  111521. * Render height (Default: 256)
  111522. */
  111523. renderHeight: number;
  111524. /**
  111525. * Texture size (Default: 512)
  111526. */
  111527. textureSize: number;
  111528. /**
  111529. * If delta time between frames should be constant
  111530. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  111531. */
  111532. deterministicLockstep: boolean;
  111533. /**
  111534. * Maximum about of steps between frames (Default: 4)
  111535. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  111536. */
  111537. lockstepMaxSteps: number;
  111538. }
  111539. /**
  111540. * The null engine class provides support for headless version of babylon.js.
  111541. * This can be used in server side scenario or for testing purposes
  111542. */
  111543. export class NullEngine extends Engine {
  111544. private _options;
  111545. /**
  111546. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  111547. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  111548. * @returns true if engine is in deterministic lock step mode
  111549. */
  111550. isDeterministicLockStep(): boolean;
  111551. /**
  111552. * Gets the max steps when engine is running in deterministic lock step
  111553. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  111554. * @returns the max steps
  111555. */
  111556. getLockstepMaxSteps(): number;
  111557. /**
  111558. * Gets the current hardware scaling level.
  111559. * By default the hardware scaling level is computed from the window device ratio.
  111560. * 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.
  111561. * @returns a number indicating the current hardware scaling level
  111562. */
  111563. getHardwareScalingLevel(): number;
  111564. constructor(options?: NullEngineOptions);
  111565. /**
  111566. * Creates a vertex buffer
  111567. * @param vertices the data for the vertex buffer
  111568. * @returns the new WebGL static buffer
  111569. */
  111570. createVertexBuffer(vertices: FloatArray): DataBuffer;
  111571. /**
  111572. * Creates a new index buffer
  111573. * @param indices defines the content of the index buffer
  111574. * @param updatable defines if the index buffer must be updatable
  111575. * @returns a new webGL buffer
  111576. */
  111577. createIndexBuffer(indices: IndicesArray): DataBuffer;
  111578. /**
  111579. * Clear the current render buffer or the current render target (if any is set up)
  111580. * @param color defines the color to use
  111581. * @param backBuffer defines if the back buffer must be cleared
  111582. * @param depth defines if the depth buffer must be cleared
  111583. * @param stencil defines if the stencil buffer must be cleared
  111584. */
  111585. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  111586. /**
  111587. * Gets the current render width
  111588. * @param useScreen defines if screen size must be used (or the current render target if any)
  111589. * @returns a number defining the current render width
  111590. */
  111591. getRenderWidth(useScreen?: boolean): number;
  111592. /**
  111593. * Gets the current render height
  111594. * @param useScreen defines if screen size must be used (or the current render target if any)
  111595. * @returns a number defining the current render height
  111596. */
  111597. getRenderHeight(useScreen?: boolean): number;
  111598. /**
  111599. * Set the WebGL's viewport
  111600. * @param viewport defines the viewport element to be used
  111601. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  111602. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  111603. */
  111604. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  111605. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  111606. /**
  111607. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  111608. * @param pipelineContext defines the pipeline context to use
  111609. * @param uniformsNames defines the list of uniform names
  111610. * @returns an array of webGL uniform locations
  111611. */
  111612. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  111613. /**
  111614. * Gets the lsit of active attributes for a given webGL program
  111615. * @param pipelineContext defines the pipeline context to use
  111616. * @param attributesNames defines the list of attribute names to get
  111617. * @returns an array of indices indicating the offset of each attribute
  111618. */
  111619. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  111620. /**
  111621. * Binds an effect to the webGL context
  111622. * @param effect defines the effect to bind
  111623. */
  111624. bindSamplers(effect: Effect): void;
  111625. /**
  111626. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  111627. * @param effect defines the effect to activate
  111628. */
  111629. enableEffect(effect: Effect): void;
  111630. /**
  111631. * Set various states to the webGL context
  111632. * @param culling defines backface culling state
  111633. * @param zOffset defines the value to apply to zOffset (0 by default)
  111634. * @param force defines if states must be applied even if cache is up to date
  111635. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  111636. */
  111637. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  111638. /**
  111639. * Set the value of an uniform to an array of int32
  111640. * @param uniform defines the webGL uniform location where to store the value
  111641. * @param array defines the array of int32 to store
  111642. */
  111643. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  111644. /**
  111645. * Set the value of an uniform to an array of int32 (stored as vec2)
  111646. * @param uniform defines the webGL uniform location where to store the value
  111647. * @param array defines the array of int32 to store
  111648. */
  111649. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  111650. /**
  111651. * Set the value of an uniform to an array of int32 (stored as vec3)
  111652. * @param uniform defines the webGL uniform location where to store the value
  111653. * @param array defines the array of int32 to store
  111654. */
  111655. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  111656. /**
  111657. * Set the value of an uniform to an array of int32 (stored as vec4)
  111658. * @param uniform defines the webGL uniform location where to store the value
  111659. * @param array defines the array of int32 to store
  111660. */
  111661. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  111662. /**
  111663. * Set the value of an uniform to an array of float32
  111664. * @param uniform defines the webGL uniform location where to store the value
  111665. * @param array defines the array of float32 to store
  111666. */
  111667. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  111668. /**
  111669. * Set the value of an uniform to an array of float32 (stored as vec2)
  111670. * @param uniform defines the webGL uniform location where to store the value
  111671. * @param array defines the array of float32 to store
  111672. */
  111673. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  111674. /**
  111675. * Set the value of an uniform to an array of float32 (stored as vec3)
  111676. * @param uniform defines the webGL uniform location where to store the value
  111677. * @param array defines the array of float32 to store
  111678. */
  111679. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  111680. /**
  111681. * Set the value of an uniform to an array of float32 (stored as vec4)
  111682. * @param uniform defines the webGL uniform location where to store the value
  111683. * @param array defines the array of float32 to store
  111684. */
  111685. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  111686. /**
  111687. * Set the value of an uniform to an array of number
  111688. * @param uniform defines the webGL uniform location where to store the value
  111689. * @param array defines the array of number to store
  111690. */
  111691. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  111692. /**
  111693. * Set the value of an uniform to an array of number (stored as vec2)
  111694. * @param uniform defines the webGL uniform location where to store the value
  111695. * @param array defines the array of number to store
  111696. */
  111697. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  111698. /**
  111699. * Set the value of an uniform to an array of number (stored as vec3)
  111700. * @param uniform defines the webGL uniform location where to store the value
  111701. * @param array defines the array of number to store
  111702. */
  111703. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  111704. /**
  111705. * Set the value of an uniform to an array of number (stored as vec4)
  111706. * @param uniform defines the webGL uniform location where to store the value
  111707. * @param array defines the array of number to store
  111708. */
  111709. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  111710. /**
  111711. * Set the value of an uniform to an array of float32 (stored as matrices)
  111712. * @param uniform defines the webGL uniform location where to store the value
  111713. * @param matrices defines the array of float32 to store
  111714. */
  111715. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  111716. /**
  111717. * Set the value of an uniform to a matrix (3x3)
  111718. * @param uniform defines the webGL uniform location where to store the value
  111719. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  111720. */
  111721. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  111722. /**
  111723. * Set the value of an uniform to a matrix (2x2)
  111724. * @param uniform defines the webGL uniform location where to store the value
  111725. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  111726. */
  111727. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  111728. /**
  111729. * Set the value of an uniform to a number (float)
  111730. * @param uniform defines the webGL uniform location where to store the value
  111731. * @param value defines the float number to store
  111732. */
  111733. setFloat(uniform: WebGLUniformLocation, value: number): void;
  111734. /**
  111735. * Set the value of an uniform to a vec2
  111736. * @param uniform defines the webGL uniform location where to store the value
  111737. * @param x defines the 1st component of the value
  111738. * @param y defines the 2nd component of the value
  111739. */
  111740. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  111741. /**
  111742. * Set the value of an uniform to a vec3
  111743. * @param uniform defines the webGL uniform location where to store the value
  111744. * @param x defines the 1st component of the value
  111745. * @param y defines the 2nd component of the value
  111746. * @param z defines the 3rd component of the value
  111747. */
  111748. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  111749. /**
  111750. * Set the value of an uniform to a boolean
  111751. * @param uniform defines the webGL uniform location where to store the value
  111752. * @param bool defines the boolean to store
  111753. */
  111754. setBool(uniform: WebGLUniformLocation, bool: number): void;
  111755. /**
  111756. * Set the value of an uniform to a vec4
  111757. * @param uniform defines the webGL uniform location where to store the value
  111758. * @param x defines the 1st component of the value
  111759. * @param y defines the 2nd component of the value
  111760. * @param z defines the 3rd component of the value
  111761. * @param w defines the 4th component of the value
  111762. */
  111763. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  111764. /**
  111765. * Sets the current alpha mode
  111766. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  111767. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  111768. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  111769. */
  111770. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  111771. /**
  111772. * Bind webGl buffers directly to the webGL context
  111773. * @param vertexBuffers defines the vertex buffer to bind
  111774. * @param indexBuffer defines the index buffer to bind
  111775. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  111776. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  111777. * @param effect defines the effect associated with the vertex buffer
  111778. */
  111779. bindBuffers(vertexBuffers: {
  111780. [key: string]: VertexBuffer;
  111781. }, indexBuffer: DataBuffer, effect: Effect): void;
  111782. /**
  111783. * Force the entire cache to be cleared
  111784. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  111785. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  111786. */
  111787. wipeCaches(bruteForce?: boolean): void;
  111788. /**
  111789. * Send a draw order
  111790. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  111791. * @param indexStart defines the starting index
  111792. * @param indexCount defines the number of index to draw
  111793. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  111794. */
  111795. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  111796. /**
  111797. * Draw a list of indexed primitives
  111798. * @param fillMode defines the primitive to use
  111799. * @param indexStart defines the starting index
  111800. * @param indexCount defines the number of index to draw
  111801. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  111802. */
  111803. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  111804. /**
  111805. * Draw a list of unindexed primitives
  111806. * @param fillMode defines the primitive to use
  111807. * @param verticesStart defines the index of first vertex to draw
  111808. * @param verticesCount defines the count of vertices to draw
  111809. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  111810. */
  111811. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  111812. /** @hidden */
  111813. _createTexture(): WebGLTexture;
  111814. /** @hidden */
  111815. _releaseTexture(texture: InternalTexture): void;
  111816. /**
  111817. * Usually called from Texture.ts.
  111818. * Passed information to create a WebGLTexture
  111819. * @param urlArg defines a value which contains one of the following:
  111820. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  111821. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  111822. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  111823. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  111824. * @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)
  111825. * @param scene needed for loading to the correct scene
  111826. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  111827. * @param onLoad optional callback to be called upon successful completion
  111828. * @param onError optional callback to be called upon failure
  111829. * @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
  111830. * @param fallBack an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  111831. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  111832. * @param forcedExtension defines the extension to use to pick the right loader
  111833. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  111834. * @returns a InternalTexture for assignment back into BABYLON.Texture
  111835. */
  111836. createTexture(urlArg: string, noMipmap: boolean, invertY: boolean, scene: Scene, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<ArrayBuffer | HTMLImageElement>, fallBack?: InternalTexture, format?: number): InternalTexture;
  111837. /**
  111838. * Creates a new render target texture
  111839. * @param size defines the size of the texture
  111840. * @param options defines the options used to create the texture
  111841. * @returns a new render target texture stored in an InternalTexture
  111842. */
  111843. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  111844. /**
  111845. * Update the sampling mode of a given texture
  111846. * @param samplingMode defines the required sampling mode
  111847. * @param texture defines the texture to update
  111848. */
  111849. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  111850. /**
  111851. * Binds the frame buffer to the specified texture.
  111852. * @param texture The texture to render to or null for the default canvas
  111853. * @param faceIndex The face of the texture to render to in case of cube texture
  111854. * @param requiredWidth The width of the target to render to
  111855. * @param requiredHeight The height of the target to render to
  111856. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  111857. * @param depthStencilTexture The depth stencil texture to use to render
  111858. * @param lodLevel defines le lod level to bind to the frame buffer
  111859. */
  111860. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  111861. /**
  111862. * Unbind the current render target texture from the webGL context
  111863. * @param texture defines the render target texture to unbind
  111864. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  111865. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  111866. */
  111867. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  111868. /**
  111869. * Creates a dynamic vertex buffer
  111870. * @param vertices the data for the dynamic vertex buffer
  111871. * @returns the new WebGL dynamic buffer
  111872. */
  111873. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  111874. /**
  111875. * Update the content of a dynamic texture
  111876. * @param texture defines the texture to update
  111877. * @param canvas defines the canvas containing the source
  111878. * @param invertY defines if data must be stored with Y axis inverted
  111879. * @param premulAlpha defines if alpha is stored as premultiplied
  111880. * @param format defines the format of the data
  111881. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  111882. */
  111883. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  111884. /**
  111885. * Gets a boolean indicating if all created effects are ready
  111886. * @returns true if all effects are ready
  111887. */
  111888. areAllEffectsReady(): boolean;
  111889. /**
  111890. * @hidden
  111891. * Get the current error code of the webGL context
  111892. * @returns the error code
  111893. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  111894. */
  111895. getError(): number;
  111896. /** @hidden */
  111897. _getUnpackAlignement(): number;
  111898. /** @hidden */
  111899. _unpackFlipY(value: boolean): void;
  111900. /**
  111901. * Update a dynamic index buffer
  111902. * @param indexBuffer defines the target index buffer
  111903. * @param indices defines the data to update
  111904. * @param offset defines the offset in the target index buffer where update should start
  111905. */
  111906. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  111907. /**
  111908. * Updates a dynamic vertex buffer.
  111909. * @param vertexBuffer the vertex buffer to update
  111910. * @param vertices the data used to update the vertex buffer
  111911. * @param byteOffset the byte offset of the data (optional)
  111912. * @param byteLength the byte length of the data (optional)
  111913. */
  111914. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  111915. /** @hidden */
  111916. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  111917. /** @hidden */
  111918. _bindTexture(channel: number, texture: InternalTexture): void;
  111919. protected _deleteBuffer(buffer: WebGLBuffer): void;
  111920. /**
  111921. * 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
  111922. */
  111923. releaseEffects(): void;
  111924. displayLoadingUI(): void;
  111925. hideLoadingUI(): void;
  111926. /** @hidden */
  111927. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  111928. /** @hidden */
  111929. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  111930. /** @hidden */
  111931. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  111932. /** @hidden */
  111933. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  111934. }
  111935. }
  111936. declare module BABYLON {
  111937. /** @hidden */
  111938. export class _OcclusionDataStorage {
  111939. /** @hidden */
  111940. occlusionInternalRetryCounter: number;
  111941. /** @hidden */
  111942. isOcclusionQueryInProgress: boolean;
  111943. /** @hidden */
  111944. isOccluded: boolean;
  111945. /** @hidden */
  111946. occlusionRetryCount: number;
  111947. /** @hidden */
  111948. occlusionType: number;
  111949. /** @hidden */
  111950. occlusionQueryAlgorithmType: number;
  111951. }
  111952. interface Engine {
  111953. /**
  111954. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  111955. * @return the new query
  111956. */
  111957. createQuery(): WebGLQuery;
  111958. /**
  111959. * Delete and release a webGL query
  111960. * @param query defines the query to delete
  111961. * @return the current engine
  111962. */
  111963. deleteQuery(query: WebGLQuery): Engine;
  111964. /**
  111965. * Check if a given query has resolved and got its value
  111966. * @param query defines the query to check
  111967. * @returns true if the query got its value
  111968. */
  111969. isQueryResultAvailable(query: WebGLQuery): boolean;
  111970. /**
  111971. * Gets the value of a given query
  111972. * @param query defines the query to check
  111973. * @returns the value of the query
  111974. */
  111975. getQueryResult(query: WebGLQuery): number;
  111976. /**
  111977. * Initiates an occlusion query
  111978. * @param algorithmType defines the algorithm to use
  111979. * @param query defines the query to use
  111980. * @returns the current engine
  111981. * @see http://doc.babylonjs.com/features/occlusionquery
  111982. */
  111983. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  111984. /**
  111985. * Ends an occlusion query
  111986. * @see http://doc.babylonjs.com/features/occlusionquery
  111987. * @param algorithmType defines the algorithm to use
  111988. * @returns the current engine
  111989. */
  111990. endOcclusionQuery(algorithmType: number): Engine;
  111991. /**
  111992. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  111993. * Please note that only one query can be issued at a time
  111994. * @returns a time token used to track the time span
  111995. */
  111996. startTimeQuery(): Nullable<_TimeToken>;
  111997. /**
  111998. * Ends a time query
  111999. * @param token defines the token used to measure the time span
  112000. * @returns the time spent (in ns)
  112001. */
  112002. endTimeQuery(token: _TimeToken): int;
  112003. /** @hidden */
  112004. _currentNonTimestampToken: Nullable<_TimeToken>;
  112005. /** @hidden */
  112006. _createTimeQuery(): WebGLQuery;
  112007. /** @hidden */
  112008. _deleteTimeQuery(query: WebGLQuery): void;
  112009. /** @hidden */
  112010. _getGlAlgorithmType(algorithmType: number): number;
  112011. /** @hidden */
  112012. _getTimeQueryResult(query: WebGLQuery): any;
  112013. /** @hidden */
  112014. _getTimeQueryAvailability(query: WebGLQuery): any;
  112015. }
  112016. interface AbstractMesh {
  112017. /**
  112018. * Backing filed
  112019. * @hidden
  112020. */
  112021. __occlusionDataStorage: _OcclusionDataStorage;
  112022. /**
  112023. * Access property
  112024. * @hidden
  112025. */
  112026. _occlusionDataStorage: _OcclusionDataStorage;
  112027. /**
  112028. * 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.
  112029. * The default value is -1 which means don't break the query and wait till the result
  112030. * @see http://doc.babylonjs.com/features/occlusionquery
  112031. */
  112032. occlusionRetryCount: number;
  112033. /**
  112034. * 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:
  112035. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  112036. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  112037. * * 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.
  112038. * @see http://doc.babylonjs.com/features/occlusionquery
  112039. */
  112040. occlusionType: number;
  112041. /**
  112042. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  112043. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  112044. * * 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.
  112045. * @see http://doc.babylonjs.com/features/occlusionquery
  112046. */
  112047. occlusionQueryAlgorithmType: number;
  112048. /**
  112049. * 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
  112050. * @see http://doc.babylonjs.com/features/occlusionquery
  112051. */
  112052. isOccluded: boolean;
  112053. /**
  112054. * Flag to check the progress status of the query
  112055. * @see http://doc.babylonjs.com/features/occlusionquery
  112056. */
  112057. isOcclusionQueryInProgress: boolean;
  112058. }
  112059. }
  112060. declare module BABYLON {
  112061. /** @hidden */
  112062. export var _forceTransformFeedbackToBundle: boolean;
  112063. interface Engine {
  112064. /**
  112065. * Creates a webGL transform feedback object
  112066. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  112067. * @returns the webGL transform feedback object
  112068. */
  112069. createTransformFeedback(): WebGLTransformFeedback;
  112070. /**
  112071. * Delete a webGL transform feedback object
  112072. * @param value defines the webGL transform feedback object to delete
  112073. */
  112074. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  112075. /**
  112076. * Bind a webGL transform feedback object to the webgl context
  112077. * @param value defines the webGL transform feedback object to bind
  112078. */
  112079. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  112080. /**
  112081. * Begins a transform feedback operation
  112082. * @param usePoints defines if points or triangles must be used
  112083. */
  112084. beginTransformFeedback(usePoints: boolean): void;
  112085. /**
  112086. * Ends a transform feedback operation
  112087. */
  112088. endTransformFeedback(): void;
  112089. /**
  112090. * Specify the varyings to use with transform feedback
  112091. * @param program defines the associated webGL program
  112092. * @param value defines the list of strings representing the varying names
  112093. */
  112094. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  112095. /**
  112096. * Bind a webGL buffer for a transform feedback operation
  112097. * @param value defines the webGL buffer to bind
  112098. */
  112099. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  112100. }
  112101. }
  112102. declare module BABYLON {
  112103. /**
  112104. * Creation options of the multi render target texture.
  112105. */
  112106. export interface IMultiRenderTargetOptions {
  112107. /**
  112108. * Define if the texture needs to create mip maps after render.
  112109. */
  112110. generateMipMaps?: boolean;
  112111. /**
  112112. * Define the types of all the draw buffers we want to create
  112113. */
  112114. types?: number[];
  112115. /**
  112116. * Define the sampling modes of all the draw buffers we want to create
  112117. */
  112118. samplingModes?: number[];
  112119. /**
  112120. * Define if a depth buffer is required
  112121. */
  112122. generateDepthBuffer?: boolean;
  112123. /**
  112124. * Define if a stencil buffer is required
  112125. */
  112126. generateStencilBuffer?: boolean;
  112127. /**
  112128. * Define if a depth texture is required instead of a depth buffer
  112129. */
  112130. generateDepthTexture?: boolean;
  112131. /**
  112132. * Define the number of desired draw buffers
  112133. */
  112134. textureCount?: number;
  112135. /**
  112136. * Define if aspect ratio should be adapted to the texture or stay the scene one
  112137. */
  112138. doNotChangeAspectRatio?: boolean;
  112139. /**
  112140. * Define the default type of the buffers we are creating
  112141. */
  112142. defaultType?: number;
  112143. }
  112144. /**
  112145. * A multi render target, like a render target provides the ability to render to a texture.
  112146. * Unlike the render target, it can render to several draw buffers in one draw.
  112147. * This is specially interesting in deferred rendering or for any effects requiring more than
  112148. * just one color from a single pass.
  112149. */
  112150. export class MultiRenderTarget extends RenderTargetTexture {
  112151. private _internalTextures;
  112152. private _textures;
  112153. private _multiRenderTargetOptions;
  112154. /**
  112155. * Get if draw buffers are currently supported by the used hardware and browser.
  112156. */
  112157. readonly isSupported: boolean;
  112158. /**
  112159. * Get the list of textures generated by the multi render target.
  112160. */
  112161. readonly textures: Texture[];
  112162. /**
  112163. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  112164. */
  112165. readonly depthTexture: Texture;
  112166. /**
  112167. * Set the wrapping mode on U of all the textures we are rendering to.
  112168. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  112169. */
  112170. wrapU: number;
  112171. /**
  112172. * Set the wrapping mode on V of all the textures we are rendering to.
  112173. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  112174. */
  112175. wrapV: number;
  112176. /**
  112177. * Instantiate a new multi render target texture.
  112178. * A multi render target, like a render target provides the ability to render to a texture.
  112179. * Unlike the render target, it can render to several draw buffers in one draw.
  112180. * This is specially interesting in deferred rendering or for any effects requiring more than
  112181. * just one color from a single pass.
  112182. * @param name Define the name of the texture
  112183. * @param size Define the size of the buffers to render to
  112184. * @param count Define the number of target we are rendering into
  112185. * @param scene Define the scene the texture belongs to
  112186. * @param options Define the options used to create the multi render target
  112187. */
  112188. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  112189. /** @hidden */
  112190. _rebuild(): void;
  112191. private _createInternalTextures;
  112192. private _createTextures;
  112193. /**
  112194. * Define the number of samples used if MSAA is enabled.
  112195. */
  112196. samples: number;
  112197. /**
  112198. * Resize all the textures in the multi render target.
  112199. * Be carrefull as it will recreate all the data in the new texture.
  112200. * @param size Define the new size
  112201. */
  112202. resize(size: any): void;
  112203. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  112204. /**
  112205. * Dispose the render targets and their associated resources
  112206. */
  112207. dispose(): void;
  112208. /**
  112209. * Release all the underlying texture used as draw buffers.
  112210. */
  112211. releaseInternalTextures(): void;
  112212. }
  112213. }
  112214. declare module BABYLON {
  112215. interface ThinEngine {
  112216. /**
  112217. * Unbind a list of render target textures from the webGL context
  112218. * This is used only when drawBuffer extension or webGL2 are active
  112219. * @param textures defines the render target textures to unbind
  112220. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  112221. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  112222. */
  112223. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  112224. /**
  112225. * Create a multi render target texture
  112226. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  112227. * @param size defines the size of the texture
  112228. * @param options defines the creation options
  112229. * @returns the cube texture as an InternalTexture
  112230. */
  112231. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  112232. /**
  112233. * Update the sample count for a given multiple render target texture
  112234. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  112235. * @param textures defines the textures to update
  112236. * @param samples defines the sample count to set
  112237. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  112238. */
  112239. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  112240. }
  112241. }
  112242. declare module BABYLON {
  112243. /**
  112244. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  112245. */
  112246. export interface CubeMapInfo {
  112247. /**
  112248. * The pixel array for the front face.
  112249. * This is stored in format, left to right, up to down format.
  112250. */
  112251. front: Nullable<ArrayBufferView>;
  112252. /**
  112253. * The pixel array for the back face.
  112254. * This is stored in format, left to right, up to down format.
  112255. */
  112256. back: Nullable<ArrayBufferView>;
  112257. /**
  112258. * The pixel array for the left face.
  112259. * This is stored in format, left to right, up to down format.
  112260. */
  112261. left: Nullable<ArrayBufferView>;
  112262. /**
  112263. * The pixel array for the right face.
  112264. * This is stored in format, left to right, up to down format.
  112265. */
  112266. right: Nullable<ArrayBufferView>;
  112267. /**
  112268. * The pixel array for the up face.
  112269. * This is stored in format, left to right, up to down format.
  112270. */
  112271. up: Nullable<ArrayBufferView>;
  112272. /**
  112273. * The pixel array for the down face.
  112274. * This is stored in format, left to right, up to down format.
  112275. */
  112276. down: Nullable<ArrayBufferView>;
  112277. /**
  112278. * The size of the cubemap stored.
  112279. *
  112280. * Each faces will be size * size pixels.
  112281. */
  112282. size: number;
  112283. /**
  112284. * The format of the texture.
  112285. *
  112286. * RGBA, RGB.
  112287. */
  112288. format: number;
  112289. /**
  112290. * The type of the texture data.
  112291. *
  112292. * UNSIGNED_INT, FLOAT.
  112293. */
  112294. type: number;
  112295. /**
  112296. * Specifies whether the texture is in gamma space.
  112297. */
  112298. gammaSpace: boolean;
  112299. }
  112300. /**
  112301. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  112302. */
  112303. export class PanoramaToCubeMapTools {
  112304. private static FACE_FRONT;
  112305. private static FACE_BACK;
  112306. private static FACE_RIGHT;
  112307. private static FACE_LEFT;
  112308. private static FACE_DOWN;
  112309. private static FACE_UP;
  112310. /**
  112311. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  112312. *
  112313. * @param float32Array The source data.
  112314. * @param inputWidth The width of the input panorama.
  112315. * @param inputHeight The height of the input panorama.
  112316. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  112317. * @return The cubemap data
  112318. */
  112319. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  112320. private static CreateCubemapTexture;
  112321. private static CalcProjectionSpherical;
  112322. }
  112323. }
  112324. declare module BABYLON {
  112325. /**
  112326. * Helper class dealing with the extraction of spherical polynomial dataArray
  112327. * from a cube map.
  112328. */
  112329. export class CubeMapToSphericalPolynomialTools {
  112330. private static FileFaces;
  112331. /**
  112332. * Converts a texture to the according Spherical Polynomial data.
  112333. * This extracts the first 3 orders only as they are the only one used in the lighting.
  112334. *
  112335. * @param texture The texture to extract the information from.
  112336. * @return The Spherical Polynomial data.
  112337. */
  112338. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  112339. /**
  112340. * Converts a cubemap to the according Spherical Polynomial data.
  112341. * This extracts the first 3 orders only as they are the only one used in the lighting.
  112342. *
  112343. * @param cubeInfo The Cube map to extract the information from.
  112344. * @return The Spherical Polynomial data.
  112345. */
  112346. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  112347. }
  112348. }
  112349. declare module BABYLON {
  112350. interface BaseTexture {
  112351. /**
  112352. * Get the polynomial representation of the texture data.
  112353. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  112354. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  112355. */
  112356. sphericalPolynomial: Nullable<SphericalPolynomial>;
  112357. }
  112358. }
  112359. declare module BABYLON {
  112360. /** @hidden */
  112361. export var rgbdEncodePixelShader: {
  112362. name: string;
  112363. shader: string;
  112364. };
  112365. }
  112366. declare module BABYLON {
  112367. /** @hidden */
  112368. export var rgbdDecodePixelShader: {
  112369. name: string;
  112370. shader: string;
  112371. };
  112372. }
  112373. declare module BABYLON {
  112374. /**
  112375. * Raw texture data and descriptor sufficient for WebGL texture upload
  112376. */
  112377. export interface EnvironmentTextureInfo {
  112378. /**
  112379. * Version of the environment map
  112380. */
  112381. version: number;
  112382. /**
  112383. * Width of image
  112384. */
  112385. width: number;
  112386. /**
  112387. * Irradiance information stored in the file.
  112388. */
  112389. irradiance: any;
  112390. /**
  112391. * Specular information stored in the file.
  112392. */
  112393. specular: any;
  112394. }
  112395. /**
  112396. * Defines One Image in the file. It requires only the position in the file
  112397. * as well as the length.
  112398. */
  112399. interface BufferImageData {
  112400. /**
  112401. * Length of the image data.
  112402. */
  112403. length: number;
  112404. /**
  112405. * Position of the data from the null terminator delimiting the end of the JSON.
  112406. */
  112407. position: number;
  112408. }
  112409. /**
  112410. * Defines the specular data enclosed in the file.
  112411. * This corresponds to the version 1 of the data.
  112412. */
  112413. export interface EnvironmentTextureSpecularInfoV1 {
  112414. /**
  112415. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  112416. */
  112417. specularDataPosition?: number;
  112418. /**
  112419. * This contains all the images data needed to reconstruct the cubemap.
  112420. */
  112421. mipmaps: Array<BufferImageData>;
  112422. /**
  112423. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  112424. */
  112425. lodGenerationScale: number;
  112426. }
  112427. /**
  112428. * Sets of helpers addressing the serialization and deserialization of environment texture
  112429. * stored in a BabylonJS env file.
  112430. * Those files are usually stored as .env files.
  112431. */
  112432. export class EnvironmentTextureTools {
  112433. /**
  112434. * Magic number identifying the env file.
  112435. */
  112436. private static _MagicBytes;
  112437. /**
  112438. * Gets the environment info from an env file.
  112439. * @param data The array buffer containing the .env bytes.
  112440. * @returns the environment file info (the json header) if successfully parsed.
  112441. */
  112442. static GetEnvInfo(data: ArrayBuffer): Nullable<EnvironmentTextureInfo>;
  112443. /**
  112444. * Creates an environment texture from a loaded cube texture.
  112445. * @param texture defines the cube texture to convert in env file
  112446. * @return a promise containing the environment data if succesfull.
  112447. */
  112448. static CreateEnvTextureAsync(texture: CubeTexture): Promise<ArrayBuffer>;
  112449. /**
  112450. * Creates a JSON representation of the spherical data.
  112451. * @param texture defines the texture containing the polynomials
  112452. * @return the JSON representation of the spherical info
  112453. */
  112454. private static _CreateEnvTextureIrradiance;
  112455. /**
  112456. * Creates the ArrayBufferViews used for initializing environment texture image data.
  112457. * @param arrayBuffer the underlying ArrayBuffer to which the views refer
  112458. * @param info parameters that determine what views will be created for accessing the underlying buffer
  112459. * @return the views described by info providing access to the underlying buffer
  112460. */
  112461. static CreateImageDataArrayBufferViews(arrayBuffer: any, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  112462. /**
  112463. * Uploads the texture info contained in the env file to the GPU.
  112464. * @param texture defines the internal texture to upload to
  112465. * @param arrayBuffer defines the buffer cotaining the data to load
  112466. * @param info defines the texture info retrieved through the GetEnvInfo method
  112467. * @returns a promise
  112468. */
  112469. static UploadEnvLevelsAsync(texture: InternalTexture, arrayBuffer: any, info: EnvironmentTextureInfo): Promise<void>;
  112470. private static _OnImageReadyAsync;
  112471. /**
  112472. * Uploads the levels of image data to the GPU.
  112473. * @param texture defines the internal texture to upload to
  112474. * @param imageData defines the array buffer views of image data [mipmap][face]
  112475. * @returns a promise
  112476. */
  112477. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  112478. /**
  112479. * Uploads spherical polynomials information to the texture.
  112480. * @param texture defines the texture we are trying to upload the information to
  112481. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  112482. */
  112483. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  112484. /** @hidden */
  112485. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  112486. }
  112487. }
  112488. declare module BABYLON {
  112489. /**
  112490. * Contains position and normal vectors for a vertex
  112491. */
  112492. export class PositionNormalVertex {
  112493. /** the position of the vertex (defaut: 0,0,0) */
  112494. position: Vector3;
  112495. /** the normal of the vertex (defaut: 0,1,0) */
  112496. normal: Vector3;
  112497. /**
  112498. * Creates a PositionNormalVertex
  112499. * @param position the position of the vertex (defaut: 0,0,0)
  112500. * @param normal the normal of the vertex (defaut: 0,1,0)
  112501. */
  112502. constructor(
  112503. /** the position of the vertex (defaut: 0,0,0) */
  112504. position?: Vector3,
  112505. /** the normal of the vertex (defaut: 0,1,0) */
  112506. normal?: Vector3);
  112507. /**
  112508. * Clones the PositionNormalVertex
  112509. * @returns the cloned PositionNormalVertex
  112510. */
  112511. clone(): PositionNormalVertex;
  112512. }
  112513. /**
  112514. * Contains position, normal and uv vectors for a vertex
  112515. */
  112516. export class PositionNormalTextureVertex {
  112517. /** the position of the vertex (defaut: 0,0,0) */
  112518. position: Vector3;
  112519. /** the normal of the vertex (defaut: 0,1,0) */
  112520. normal: Vector3;
  112521. /** the uv of the vertex (default: 0,0) */
  112522. uv: Vector2;
  112523. /**
  112524. * Creates a PositionNormalTextureVertex
  112525. * @param position the position of the vertex (defaut: 0,0,0)
  112526. * @param normal the normal of the vertex (defaut: 0,1,0)
  112527. * @param uv the uv of the vertex (default: 0,0)
  112528. */
  112529. constructor(
  112530. /** the position of the vertex (defaut: 0,0,0) */
  112531. position?: Vector3,
  112532. /** the normal of the vertex (defaut: 0,1,0) */
  112533. normal?: Vector3,
  112534. /** the uv of the vertex (default: 0,0) */
  112535. uv?: Vector2);
  112536. /**
  112537. * Clones the PositionNormalTextureVertex
  112538. * @returns the cloned PositionNormalTextureVertex
  112539. */
  112540. clone(): PositionNormalTextureVertex;
  112541. }
  112542. }
  112543. declare module BABYLON {
  112544. /** @hidden */
  112545. export class NativeShaderProcessor extends WebGL2ShaderProcessor {
  112546. private _genericAttributeLocation;
  112547. private _varyingLocationCount;
  112548. private _varyingLocationMap;
  112549. private _replacements;
  112550. private _textureCount;
  112551. private _uniforms;
  112552. lineProcessor(line: string): string;
  112553. attributeProcessor(attribute: string): string;
  112554. varyingProcessor(varying: string, isFragment: boolean): string;
  112555. uniformProcessor(uniform: string): string;
  112556. preProcessor(code: string, defines: string[], isFragment: boolean): string;
  112557. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  112558. }
  112559. }
  112560. declare module BABYLON {
  112561. /**
  112562. * Container for accessors for natively-stored mesh data buffers.
  112563. */
  112564. class NativeDataBuffer extends DataBuffer {
  112565. /**
  112566. * Accessor value used to identify/retrieve a natively-stored index buffer.
  112567. */
  112568. nativeIndexBuffer?: any;
  112569. /**
  112570. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  112571. */
  112572. nativeVertexBuffer?: any;
  112573. }
  112574. /** @hidden */
  112575. class NativeTexture extends InternalTexture {
  112576. getInternalTexture(): InternalTexture;
  112577. getViewCount(): number;
  112578. }
  112579. /** @hidden */
  112580. export class NativeEngine extends Engine {
  112581. private readonly _native;
  112582. getHardwareScalingLevel(): number;
  112583. constructor();
  112584. /**
  112585. * Can be used to override the current requestAnimationFrame requester.
  112586. * @hidden
  112587. */
  112588. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  112589. /**
  112590. * Override default engine behavior.
  112591. * @param color
  112592. * @param backBuffer
  112593. * @param depth
  112594. * @param stencil
  112595. */
  112596. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  112597. clear(color: Color4, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  112598. createIndexBuffer(indices: IndicesArray): NativeDataBuffer;
  112599. createVertexBuffer(data: DataArray): NativeDataBuffer;
  112600. recordVertexArrayObject(vertexBuffers: {
  112601. [key: string]: VertexBuffer;
  112602. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  112603. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  112604. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  112605. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  112606. /**
  112607. * Draw a list of indexed primitives
  112608. * @param fillMode defines the primitive to use
  112609. * @param indexStart defines the starting index
  112610. * @param indexCount defines the number of index to draw
  112611. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112612. */
  112613. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  112614. /**
  112615. * Draw a list of unindexed primitives
  112616. * @param fillMode defines the primitive to use
  112617. * @param verticesStart defines the index of first vertex to draw
  112618. * @param verticesCount defines the count of vertices to draw
  112619. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112620. */
  112621. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  112622. createPipelineContext(): IPipelineContext;
  112623. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  112624. /** @hidden */
  112625. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  112626. /** @hidden */
  112627. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  112628. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  112629. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  112630. protected _setProgram(program: WebGLProgram): void;
  112631. _releaseEffect(effect: Effect): void;
  112632. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  112633. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  112634. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  112635. bindSamplers(effect: Effect): void;
  112636. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  112637. getRenderWidth(useScreen?: boolean): number;
  112638. getRenderHeight(useScreen?: boolean): number;
  112639. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  112640. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  112641. /**
  112642. * Set the z offset to apply to current rendering
  112643. * @param value defines the offset to apply
  112644. */
  112645. setZOffset(value: number): void;
  112646. /**
  112647. * Gets the current value of the zOffset
  112648. * @returns the current zOffset state
  112649. */
  112650. getZOffset(): number;
  112651. /**
  112652. * Enable or disable depth buffering
  112653. * @param enable defines the state to set
  112654. */
  112655. setDepthBuffer(enable: boolean): void;
  112656. /**
  112657. * Gets a boolean indicating if depth writing is enabled
  112658. * @returns the current depth writing state
  112659. */
  112660. getDepthWrite(): boolean;
  112661. /**
  112662. * Enable or disable depth writing
  112663. * @param enable defines the state to set
  112664. */
  112665. setDepthWrite(enable: boolean): void;
  112666. /**
  112667. * Enable or disable color writing
  112668. * @param enable defines the state to set
  112669. */
  112670. setColorWrite(enable: boolean): void;
  112671. /**
  112672. * Gets a boolean indicating if color writing is enabled
  112673. * @returns the current color writing state
  112674. */
  112675. getColorWrite(): boolean;
  112676. /**
  112677. * Sets alpha constants used by some alpha blending modes
  112678. * @param r defines the red component
  112679. * @param g defines the green component
  112680. * @param b defines the blue component
  112681. * @param a defines the alpha component
  112682. */
  112683. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  112684. /**
  112685. * Sets the current alpha mode
  112686. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  112687. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  112688. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  112689. */
  112690. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  112691. /**
  112692. * Gets the current alpha mode
  112693. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  112694. * @returns the current alpha mode
  112695. */
  112696. getAlphaMode(): number;
  112697. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  112698. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  112699. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  112700. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  112701. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  112702. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  112703. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  112704. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  112705. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  112706. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  112707. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  112708. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  112709. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  112710. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  112711. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  112712. setFloat(uniform: WebGLUniformLocation, value: number): void;
  112713. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  112714. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  112715. setBool(uniform: WebGLUniformLocation, bool: number): void;
  112716. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  112717. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  112718. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  112719. wipeCaches(bruteForce?: boolean): void;
  112720. _createTexture(): WebGLTexture;
  112721. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  112722. /**
  112723. * Usually called from BABYLON.Texture.ts.
  112724. * Passed information to create a WebGLTexture
  112725. * @param urlArg defines a value which contains one of the following:
  112726. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  112727. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  112728. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  112729. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  112730. * @param invertY when true, image is flipped when loaded. You probably want true. Ignored for compressed textures. Must be flipped in the file
  112731. * @param scene needed for loading to the correct scene
  112732. * @param samplingMode mode with should be used sample / access the texture (Default: BABYLON.Texture.TRILINEAR_SAMPLINGMODE)
  112733. * @param onLoad optional callback to be called upon successful completion
  112734. * @param onError optional callback to be called upon failure
  112735. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), or a Blob
  112736. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  112737. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  112738. * @param forcedExtension defines the extension to use to pick the right loader
  112739. * @returns a InternalTexture for assignment back into BABYLON.Texture
  112740. */
  112741. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<Scene>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | Blob>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>): InternalTexture;
  112742. /**
  112743. * Creates a cube texture
  112744. * @param rootUrl defines the url where the files to load is located
  112745. * @param scene defines the current scene
  112746. * @param files defines the list of files to load (1 per face)
  112747. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  112748. * @param onLoad defines an optional callback raised when the texture is loaded
  112749. * @param onError defines an optional callback raised if there is an issue to load the texture
  112750. * @param format defines the format of the data
  112751. * @param forcedExtension defines the extension to use to pick the right loader
  112752. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  112753. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  112754. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  112755. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  112756. * @returns the cube texture as an InternalTexture
  112757. */
  112758. 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;
  112759. private _getSamplingFilter;
  112760. private static _GetNativeTextureFormat;
  112761. createRenderTargetTexture(size: number | {
  112762. width: number;
  112763. height: number;
  112764. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  112765. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  112766. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  112767. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  112768. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  112769. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  112770. /**
  112771. * Updates a dynamic vertex buffer.
  112772. * @param vertexBuffer the vertex buffer to update
  112773. * @param data the data used to update the vertex buffer
  112774. * @param byteOffset the byte offset of the data (optional)
  112775. * @param byteLength the byte length of the data (optional)
  112776. */
  112777. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  112778. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  112779. private _updateAnisotropicLevel;
  112780. private _getAddressMode;
  112781. /** @hidden */
  112782. _bindTexture(channel: number, texture: InternalTexture): void;
  112783. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  112784. releaseEffects(): void;
  112785. /** @hidden */
  112786. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  112787. /** @hidden */
  112788. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  112789. /** @hidden */
  112790. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  112791. /** @hidden */
  112792. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  112793. }
  112794. }
  112795. declare module BABYLON {
  112796. /**
  112797. * Gather the list of clipboard event types as constants.
  112798. */
  112799. export class ClipboardEventTypes {
  112800. /**
  112801. * The clipboard event is fired when a copy command is active (pressed).
  112802. */
  112803. static readonly COPY: number;
  112804. /**
  112805. * The clipboard event is fired when a cut command is active (pressed).
  112806. */
  112807. static readonly CUT: number;
  112808. /**
  112809. * The clipboard event is fired when a paste command is active (pressed).
  112810. */
  112811. static readonly PASTE: number;
  112812. }
  112813. /**
  112814. * This class is used to store clipboard related info for the onClipboardObservable event.
  112815. */
  112816. export class ClipboardInfo {
  112817. /**
  112818. * Defines the type of event (BABYLON.ClipboardEventTypes)
  112819. */
  112820. type: number;
  112821. /**
  112822. * Defines the related dom event
  112823. */
  112824. event: ClipboardEvent;
  112825. /**
  112826. *Creates an instance of ClipboardInfo.
  112827. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  112828. * @param event Defines the related dom event
  112829. */
  112830. constructor(
  112831. /**
  112832. * Defines the type of event (BABYLON.ClipboardEventTypes)
  112833. */
  112834. type: number,
  112835. /**
  112836. * Defines the related dom event
  112837. */
  112838. event: ClipboardEvent);
  112839. /**
  112840. * Get the clipboard event's type from the keycode.
  112841. * @param keyCode Defines the keyCode for the current keyboard event.
  112842. * @return {number}
  112843. */
  112844. static GetTypeFromCharacter(keyCode: number): number;
  112845. }
  112846. }
  112847. declare module BABYLON {
  112848. /**
  112849. * Google Daydream controller
  112850. */
  112851. export class DaydreamController extends WebVRController {
  112852. /**
  112853. * Base Url for the controller model.
  112854. */
  112855. static MODEL_BASE_URL: string;
  112856. /**
  112857. * File name for the controller model.
  112858. */
  112859. static MODEL_FILENAME: string;
  112860. /**
  112861. * Gamepad Id prefix used to identify Daydream Controller.
  112862. */
  112863. static readonly GAMEPAD_ID_PREFIX: string;
  112864. /**
  112865. * Creates a new DaydreamController from a gamepad
  112866. * @param vrGamepad the gamepad that the controller should be created from
  112867. */
  112868. constructor(vrGamepad: any);
  112869. /**
  112870. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  112871. * @param scene scene in which to add meshes
  112872. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  112873. */
  112874. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  112875. /**
  112876. * Called once for each button that changed state since the last frame
  112877. * @param buttonIdx Which button index changed
  112878. * @param state New state of the button
  112879. * @param changes Which properties on the state changed since last frame
  112880. */
  112881. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  112882. }
  112883. }
  112884. declare module BABYLON {
  112885. /**
  112886. * Gear VR Controller
  112887. */
  112888. export class GearVRController extends WebVRController {
  112889. /**
  112890. * Base Url for the controller model.
  112891. */
  112892. static MODEL_BASE_URL: string;
  112893. /**
  112894. * File name for the controller model.
  112895. */
  112896. static MODEL_FILENAME: string;
  112897. /**
  112898. * Gamepad Id prefix used to identify this controller.
  112899. */
  112900. static readonly GAMEPAD_ID_PREFIX: string;
  112901. private readonly _buttonIndexToObservableNameMap;
  112902. /**
  112903. * Creates a new GearVRController from a gamepad
  112904. * @param vrGamepad the gamepad that the controller should be created from
  112905. */
  112906. constructor(vrGamepad: any);
  112907. /**
  112908. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  112909. * @param scene scene in which to add meshes
  112910. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  112911. */
  112912. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  112913. /**
  112914. * Called once for each button that changed state since the last frame
  112915. * @param buttonIdx Which button index changed
  112916. * @param state New state of the button
  112917. * @param changes Which properties on the state changed since last frame
  112918. */
  112919. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  112920. }
  112921. }
  112922. declare module BABYLON {
  112923. /**
  112924. * Class containing static functions to help procedurally build meshes
  112925. */
  112926. export class PolyhedronBuilder {
  112927. /**
  112928. * Creates a polyhedron mesh
  112929. * * 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
  112930. * * The parameter `size` (positive float, default 1) sets the polygon size
  112931. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  112932. * * 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`
  112933. * * 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
  112934. * * 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)`)
  112935. * * 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
  112936. * * 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
  112937. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  112938. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  112939. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  112940. * @param name defines the name of the mesh
  112941. * @param options defines the options used to create the mesh
  112942. * @param scene defines the hosting scene
  112943. * @returns the polyhedron mesh
  112944. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  112945. */
  112946. static CreatePolyhedron(name: string, options: {
  112947. type?: number;
  112948. size?: number;
  112949. sizeX?: number;
  112950. sizeY?: number;
  112951. sizeZ?: number;
  112952. custom?: any;
  112953. faceUV?: Vector4[];
  112954. faceColors?: Color4[];
  112955. flat?: boolean;
  112956. updatable?: boolean;
  112957. sideOrientation?: number;
  112958. frontUVs?: Vector4;
  112959. backUVs?: Vector4;
  112960. }, scene?: Nullable<Scene>): Mesh;
  112961. }
  112962. }
  112963. declare module BABYLON {
  112964. /**
  112965. * Gizmo that enables scaling a mesh along 3 axis
  112966. */
  112967. export class ScaleGizmo extends Gizmo {
  112968. /**
  112969. * Internal gizmo used for interactions on the x axis
  112970. */
  112971. xGizmo: AxisScaleGizmo;
  112972. /**
  112973. * Internal gizmo used for interactions on the y axis
  112974. */
  112975. yGizmo: AxisScaleGizmo;
  112976. /**
  112977. * Internal gizmo used for interactions on the z axis
  112978. */
  112979. zGizmo: AxisScaleGizmo;
  112980. /**
  112981. * Internal gizmo used to scale all axis equally
  112982. */
  112983. uniformScaleGizmo: AxisScaleGizmo;
  112984. private _meshAttached;
  112985. private _updateGizmoRotationToMatchAttachedMesh;
  112986. private _snapDistance;
  112987. private _scaleRatio;
  112988. private _uniformScalingMesh;
  112989. private _octahedron;
  112990. /** Fires an event when any of it's sub gizmos are dragged */
  112991. onDragStartObservable: Observable<unknown>;
  112992. /** Fires an event when any of it's sub gizmos are released from dragging */
  112993. onDragEndObservable: Observable<unknown>;
  112994. attachedMesh: Nullable<AbstractMesh>;
  112995. /**
  112996. * Creates a ScaleGizmo
  112997. * @param gizmoLayer The utility layer the gizmo will be added to
  112998. */
  112999. constructor(gizmoLayer?: UtilityLayerRenderer);
  113000. updateGizmoRotationToMatchAttachedMesh: boolean;
  113001. /**
  113002. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  113003. */
  113004. snapDistance: number;
  113005. /**
  113006. * Ratio for the scale of the gizmo (Default: 1)
  113007. */
  113008. scaleRatio: number;
  113009. /**
  113010. * Disposes of the gizmo
  113011. */
  113012. dispose(): void;
  113013. }
  113014. }
  113015. declare module BABYLON {
  113016. /**
  113017. * Single axis scale gizmo
  113018. */
  113019. export class AxisScaleGizmo extends Gizmo {
  113020. /**
  113021. * Drag behavior responsible for the gizmos dragging interactions
  113022. */
  113023. dragBehavior: PointerDragBehavior;
  113024. private _pointerObserver;
  113025. /**
  113026. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  113027. */
  113028. snapDistance: number;
  113029. /**
  113030. * Event that fires each time the gizmo snaps to a new location.
  113031. * * snapDistance is the the change in distance
  113032. */
  113033. onSnapObservable: Observable<{
  113034. snapDistance: number;
  113035. }>;
  113036. /**
  113037. * If the scaling operation should be done on all axis (default: false)
  113038. */
  113039. uniformScaling: boolean;
  113040. private _isEnabled;
  113041. private _parent;
  113042. private _arrow;
  113043. private _coloredMaterial;
  113044. private _hoverMaterial;
  113045. /**
  113046. * Creates an AxisScaleGizmo
  113047. * @param gizmoLayer The utility layer the gizmo will be added to
  113048. * @param dragAxis The axis which the gizmo will be able to scale on
  113049. * @param color The color of the gizmo
  113050. */
  113051. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  113052. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  113053. /**
  113054. * If the gizmo is enabled
  113055. */
  113056. isEnabled: boolean;
  113057. /**
  113058. * Disposes of the gizmo
  113059. */
  113060. dispose(): void;
  113061. /**
  113062. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  113063. * @param mesh The mesh to replace the default mesh of the gizmo
  113064. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  113065. */
  113066. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  113067. }
  113068. }
  113069. declare module BABYLON {
  113070. /**
  113071. * Bounding box gizmo
  113072. */
  113073. export class BoundingBoxGizmo extends Gizmo {
  113074. private _lineBoundingBox;
  113075. private _rotateSpheresParent;
  113076. private _scaleBoxesParent;
  113077. private _boundingDimensions;
  113078. private _renderObserver;
  113079. private _pointerObserver;
  113080. private _scaleDragSpeed;
  113081. private _tmpQuaternion;
  113082. private _tmpVector;
  113083. private _tmpRotationMatrix;
  113084. /**
  113085. * 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)
  113086. */
  113087. ignoreChildren: boolean;
  113088. /**
  113089. * 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)
  113090. */
  113091. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  113092. /**
  113093. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  113094. */
  113095. rotationSphereSize: number;
  113096. /**
  113097. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  113098. */
  113099. scaleBoxSize: number;
  113100. /**
  113101. * 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)
  113102. */
  113103. fixedDragMeshScreenSize: boolean;
  113104. /**
  113105. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  113106. */
  113107. fixedDragMeshScreenSizeDistanceFactor: number;
  113108. /**
  113109. * Fired when a rotation sphere or scale box is dragged
  113110. */
  113111. onDragStartObservable: Observable<{}>;
  113112. /**
  113113. * Fired when a scale box is dragged
  113114. */
  113115. onScaleBoxDragObservable: Observable<{}>;
  113116. /**
  113117. * Fired when a scale box drag is ended
  113118. */
  113119. onScaleBoxDragEndObservable: Observable<{}>;
  113120. /**
  113121. * Fired when a rotation sphere is dragged
  113122. */
  113123. onRotationSphereDragObservable: Observable<{}>;
  113124. /**
  113125. * Fired when a rotation sphere drag is ended
  113126. */
  113127. onRotationSphereDragEndObservable: Observable<{}>;
  113128. /**
  113129. * 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)
  113130. */
  113131. scalePivot: Nullable<Vector3>;
  113132. /**
  113133. * Mesh used as a pivot to rotate the attached mesh
  113134. */
  113135. private _anchorMesh;
  113136. private _existingMeshScale;
  113137. private _dragMesh;
  113138. private pointerDragBehavior;
  113139. private coloredMaterial;
  113140. private hoverColoredMaterial;
  113141. /**
  113142. * Sets the color of the bounding box gizmo
  113143. * @param color the color to set
  113144. */
  113145. setColor(color: Color3): void;
  113146. /**
  113147. * Creates an BoundingBoxGizmo
  113148. * @param gizmoLayer The utility layer the gizmo will be added to
  113149. * @param color The color of the gizmo
  113150. */
  113151. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  113152. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  113153. private _selectNode;
  113154. /**
  113155. * Updates the bounding box information for the Gizmo
  113156. */
  113157. updateBoundingBox(): void;
  113158. private _updateRotationSpheres;
  113159. private _updateScaleBoxes;
  113160. /**
  113161. * Enables rotation on the specified axis and disables rotation on the others
  113162. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  113163. */
  113164. setEnabledRotationAxis(axis: string): void;
  113165. /**
  113166. * Enables/disables scaling
  113167. * @param enable if scaling should be enabled
  113168. */
  113169. setEnabledScaling(enable: boolean): void;
  113170. private _updateDummy;
  113171. /**
  113172. * Enables a pointer drag behavior on the bounding box of the gizmo
  113173. */
  113174. enableDragBehavior(): void;
  113175. /**
  113176. * Disposes of the gizmo
  113177. */
  113178. dispose(): void;
  113179. /**
  113180. * 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)
  113181. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  113182. * @returns the bounding box mesh with the passed in mesh as a child
  113183. */
  113184. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  113185. /**
  113186. * CustomMeshes are not supported by this gizmo
  113187. * @param mesh The mesh to replace the default mesh of the gizmo
  113188. */
  113189. setCustomMesh(mesh: Mesh): void;
  113190. }
  113191. }
  113192. declare module BABYLON {
  113193. /**
  113194. * Single plane rotation gizmo
  113195. */
  113196. export class PlaneRotationGizmo extends Gizmo {
  113197. /**
  113198. * Drag behavior responsible for the gizmos dragging interactions
  113199. */
  113200. dragBehavior: PointerDragBehavior;
  113201. private _pointerObserver;
  113202. /**
  113203. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  113204. */
  113205. snapDistance: number;
  113206. /**
  113207. * Event that fires each time the gizmo snaps to a new location.
  113208. * * snapDistance is the the change in distance
  113209. */
  113210. onSnapObservable: Observable<{
  113211. snapDistance: number;
  113212. }>;
  113213. private _isEnabled;
  113214. private _parent;
  113215. /**
  113216. * Creates a PlaneRotationGizmo
  113217. * @param gizmoLayer The utility layer the gizmo will be added to
  113218. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  113219. * @param color The color of the gizmo
  113220. * @param tessellation Amount of tessellation to be used when creating rotation circles
  113221. * @param useEulerRotation Use and update Euler angle instead of quaternion
  113222. */
  113223. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  113224. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  113225. /**
  113226. * If the gizmo is enabled
  113227. */
  113228. isEnabled: boolean;
  113229. /**
  113230. * Disposes of the gizmo
  113231. */
  113232. dispose(): void;
  113233. }
  113234. }
  113235. declare module BABYLON {
  113236. /**
  113237. * Gizmo that enables rotating a mesh along 3 axis
  113238. */
  113239. export class RotationGizmo extends Gizmo {
  113240. /**
  113241. * Internal gizmo used for interactions on the x axis
  113242. */
  113243. xGizmo: PlaneRotationGizmo;
  113244. /**
  113245. * Internal gizmo used for interactions on the y axis
  113246. */
  113247. yGizmo: PlaneRotationGizmo;
  113248. /**
  113249. * Internal gizmo used for interactions on the z axis
  113250. */
  113251. zGizmo: PlaneRotationGizmo;
  113252. /** Fires an event when any of it's sub gizmos are dragged */
  113253. onDragStartObservable: Observable<unknown>;
  113254. /** Fires an event when any of it's sub gizmos are released from dragging */
  113255. onDragEndObservable: Observable<unknown>;
  113256. private _meshAttached;
  113257. attachedMesh: Nullable<AbstractMesh>;
  113258. /**
  113259. * Creates a RotationGizmo
  113260. * @param gizmoLayer The utility layer the gizmo will be added to
  113261. * @param tessellation Amount of tessellation to be used when creating rotation circles
  113262. * @param useEulerRotation Use and update Euler angle instead of quaternion
  113263. */
  113264. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  113265. updateGizmoRotationToMatchAttachedMesh: boolean;
  113266. /**
  113267. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  113268. */
  113269. snapDistance: number;
  113270. /**
  113271. * Ratio for the scale of the gizmo (Default: 1)
  113272. */
  113273. scaleRatio: number;
  113274. /**
  113275. * Disposes of the gizmo
  113276. */
  113277. dispose(): void;
  113278. /**
  113279. * CustomMeshes are not supported by this gizmo
  113280. * @param mesh The mesh to replace the default mesh of the gizmo
  113281. */
  113282. setCustomMesh(mesh: Mesh): void;
  113283. }
  113284. }
  113285. declare module BABYLON {
  113286. /**
  113287. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  113288. */
  113289. export class GizmoManager implements IDisposable {
  113290. private scene;
  113291. /**
  113292. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  113293. */
  113294. gizmos: {
  113295. positionGizmo: Nullable<PositionGizmo>;
  113296. rotationGizmo: Nullable<RotationGizmo>;
  113297. scaleGizmo: Nullable<ScaleGizmo>;
  113298. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  113299. };
  113300. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  113301. clearGizmoOnEmptyPointerEvent: boolean;
  113302. /** Fires an event when the manager is attached to a mesh */
  113303. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  113304. private _gizmosEnabled;
  113305. private _pointerObserver;
  113306. private _attachedMesh;
  113307. private _boundingBoxColor;
  113308. private _defaultUtilityLayer;
  113309. private _defaultKeepDepthUtilityLayer;
  113310. /**
  113311. * When bounding box gizmo is enabled, this can be used to track drag/end events
  113312. */
  113313. boundingBoxDragBehavior: SixDofDragBehavior;
  113314. /**
  113315. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  113316. */
  113317. attachableMeshes: Nullable<Array<AbstractMesh>>;
  113318. /**
  113319. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  113320. */
  113321. usePointerToAttachGizmos: boolean;
  113322. /**
  113323. * Utility layer that the bounding box gizmo belongs to
  113324. */
  113325. readonly keepDepthUtilityLayer: UtilityLayerRenderer;
  113326. /**
  113327. * Utility layer that all gizmos besides bounding box belong to
  113328. */
  113329. readonly utilityLayer: UtilityLayerRenderer;
  113330. /**
  113331. * Instatiates a gizmo manager
  113332. * @param scene the scene to overlay the gizmos on top of
  113333. */
  113334. constructor(scene: Scene);
  113335. /**
  113336. * Attaches a set of gizmos to the specified mesh
  113337. * @param mesh The mesh the gizmo's should be attached to
  113338. */
  113339. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  113340. /**
  113341. * If the position gizmo is enabled
  113342. */
  113343. positionGizmoEnabled: boolean;
  113344. /**
  113345. * If the rotation gizmo is enabled
  113346. */
  113347. rotationGizmoEnabled: boolean;
  113348. /**
  113349. * If the scale gizmo is enabled
  113350. */
  113351. scaleGizmoEnabled: boolean;
  113352. /**
  113353. * If the boundingBox gizmo is enabled
  113354. */
  113355. boundingBoxGizmoEnabled: boolean;
  113356. /**
  113357. * Disposes of the gizmo manager
  113358. */
  113359. dispose(): void;
  113360. }
  113361. }
  113362. declare module BABYLON {
  113363. /**
  113364. * A directional light is defined by a direction (what a surprise!).
  113365. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  113366. * 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.
  113367. * Documentation: https://doc.babylonjs.com/babylon101/lights
  113368. */
  113369. export class DirectionalLight extends ShadowLight {
  113370. private _shadowFrustumSize;
  113371. /**
  113372. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  113373. */
  113374. /**
  113375. * Specifies a fix frustum size for the shadow generation.
  113376. */
  113377. shadowFrustumSize: number;
  113378. private _shadowOrthoScale;
  113379. /**
  113380. * Gets the shadow projection scale against the optimal computed one.
  113381. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  113382. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  113383. */
  113384. /**
  113385. * Sets the shadow projection scale against the optimal computed one.
  113386. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  113387. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  113388. */
  113389. shadowOrthoScale: number;
  113390. /**
  113391. * Automatically compute the projection matrix to best fit (including all the casters)
  113392. * on each frame.
  113393. */
  113394. autoUpdateExtends: boolean;
  113395. private _orthoLeft;
  113396. private _orthoRight;
  113397. private _orthoTop;
  113398. private _orthoBottom;
  113399. /**
  113400. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  113401. * The directional light is emitted from everywhere in the given direction.
  113402. * It can cast shadows.
  113403. * Documentation : https://doc.babylonjs.com/babylon101/lights
  113404. * @param name The friendly name of the light
  113405. * @param direction The direction of the light
  113406. * @param scene The scene the light belongs to
  113407. */
  113408. constructor(name: string, direction: Vector3, scene: Scene);
  113409. /**
  113410. * Returns the string "DirectionalLight".
  113411. * @return The class name
  113412. */
  113413. getClassName(): string;
  113414. /**
  113415. * Returns the integer 1.
  113416. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  113417. */
  113418. getTypeID(): number;
  113419. /**
  113420. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  113421. * Returns the DirectionalLight Shadow projection matrix.
  113422. */
  113423. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  113424. /**
  113425. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  113426. * Returns the DirectionalLight Shadow projection matrix.
  113427. */
  113428. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  113429. /**
  113430. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  113431. * Returns the DirectionalLight Shadow projection matrix.
  113432. */
  113433. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  113434. protected _buildUniformLayout(): void;
  113435. /**
  113436. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  113437. * @param effect The effect to update
  113438. * @param lightIndex The index of the light in the effect to update
  113439. * @returns The directional light
  113440. */
  113441. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  113442. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  113443. /**
  113444. * Gets the minZ used for shadow according to both the scene and the light.
  113445. *
  113446. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  113447. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  113448. * @param activeCamera The camera we are returning the min for
  113449. * @returns the depth min z
  113450. */
  113451. getDepthMinZ(activeCamera: Camera): number;
  113452. /**
  113453. * Gets the maxZ used for shadow according to both the scene and the light.
  113454. *
  113455. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  113456. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  113457. * @param activeCamera The camera we are returning the max for
  113458. * @returns the depth max z
  113459. */
  113460. getDepthMaxZ(activeCamera: Camera): number;
  113461. /**
  113462. * Prepares the list of defines specific to the light type.
  113463. * @param defines the list of defines
  113464. * @param lightIndex defines the index of the light for the effect
  113465. */
  113466. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  113467. }
  113468. }
  113469. declare module BABYLON {
  113470. /**
  113471. * Class containing static functions to help procedurally build meshes
  113472. */
  113473. export class HemisphereBuilder {
  113474. /**
  113475. * Creates a hemisphere mesh
  113476. * @param name defines the name of the mesh
  113477. * @param options defines the options used to create the mesh
  113478. * @param scene defines the hosting scene
  113479. * @returns the hemisphere mesh
  113480. */
  113481. static CreateHemisphere(name: string, options: {
  113482. segments?: number;
  113483. diameter?: number;
  113484. sideOrientation?: number;
  113485. }, scene: any): Mesh;
  113486. }
  113487. }
  113488. declare module BABYLON {
  113489. /**
  113490. * A spot light is defined by a position, a direction, an angle, and an exponent.
  113491. * These values define a cone of light starting from the position, emitting toward the direction.
  113492. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  113493. * and the exponent defines the speed of the decay of the light with distance (reach).
  113494. * Documentation: https://doc.babylonjs.com/babylon101/lights
  113495. */
  113496. export class SpotLight extends ShadowLight {
  113497. private _angle;
  113498. private _innerAngle;
  113499. private _cosHalfAngle;
  113500. private _lightAngleScale;
  113501. private _lightAngleOffset;
  113502. /**
  113503. * Gets the cone angle of the spot light in Radians.
  113504. */
  113505. /**
  113506. * Sets the cone angle of the spot light in Radians.
  113507. */
  113508. angle: number;
  113509. /**
  113510. * Only used in gltf falloff mode, this defines the angle where
  113511. * the directional falloff will start before cutting at angle which could be seen
  113512. * as outer angle.
  113513. */
  113514. /**
  113515. * Only used in gltf falloff mode, this defines the angle where
  113516. * the directional falloff will start before cutting at angle which could be seen
  113517. * as outer angle.
  113518. */
  113519. innerAngle: number;
  113520. private _shadowAngleScale;
  113521. /**
  113522. * Allows scaling the angle of the light for shadow generation only.
  113523. */
  113524. /**
  113525. * Allows scaling the angle of the light for shadow generation only.
  113526. */
  113527. shadowAngleScale: number;
  113528. /**
  113529. * The light decay speed with the distance from the emission spot.
  113530. */
  113531. exponent: number;
  113532. private _projectionTextureMatrix;
  113533. /**
  113534. * Allows reading the projecton texture
  113535. */
  113536. readonly projectionTextureMatrix: Matrix;
  113537. protected _projectionTextureLightNear: number;
  113538. /**
  113539. * Gets the near clip of the Spotlight for texture projection.
  113540. */
  113541. /**
  113542. * Sets the near clip of the Spotlight for texture projection.
  113543. */
  113544. projectionTextureLightNear: number;
  113545. protected _projectionTextureLightFar: number;
  113546. /**
  113547. * Gets the far clip of the Spotlight for texture projection.
  113548. */
  113549. /**
  113550. * Sets the far clip of the Spotlight for texture projection.
  113551. */
  113552. projectionTextureLightFar: number;
  113553. protected _projectionTextureUpDirection: Vector3;
  113554. /**
  113555. * Gets the Up vector of the Spotlight for texture projection.
  113556. */
  113557. /**
  113558. * Sets the Up vector of the Spotlight for texture projection.
  113559. */
  113560. projectionTextureUpDirection: Vector3;
  113561. private _projectionTexture;
  113562. /**
  113563. * Gets the projection texture of the light.
  113564. */
  113565. /**
  113566. * Sets the projection texture of the light.
  113567. */
  113568. projectionTexture: Nullable<BaseTexture>;
  113569. private _projectionTextureViewLightDirty;
  113570. private _projectionTextureProjectionLightDirty;
  113571. private _projectionTextureDirty;
  113572. private _projectionTextureViewTargetVector;
  113573. private _projectionTextureViewLightMatrix;
  113574. private _projectionTextureProjectionLightMatrix;
  113575. private _projectionTextureScalingMatrix;
  113576. /**
  113577. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  113578. * It can cast shadows.
  113579. * Documentation : https://doc.babylonjs.com/babylon101/lights
  113580. * @param name The light friendly name
  113581. * @param position The position of the spot light in the scene
  113582. * @param direction The direction of the light in the scene
  113583. * @param angle The cone angle of the light in Radians
  113584. * @param exponent The light decay speed with the distance from the emission spot
  113585. * @param scene The scene the lights belongs to
  113586. */
  113587. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  113588. /**
  113589. * Returns the string "SpotLight".
  113590. * @returns the class name
  113591. */
  113592. getClassName(): string;
  113593. /**
  113594. * Returns the integer 2.
  113595. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  113596. */
  113597. getTypeID(): number;
  113598. /**
  113599. * Overrides the direction setter to recompute the projection texture view light Matrix.
  113600. */
  113601. protected _setDirection(value: Vector3): void;
  113602. /**
  113603. * Overrides the position setter to recompute the projection texture view light Matrix.
  113604. */
  113605. protected _setPosition(value: Vector3): void;
  113606. /**
  113607. * 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.
  113608. * Returns the SpotLight.
  113609. */
  113610. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  113611. protected _computeProjectionTextureViewLightMatrix(): void;
  113612. protected _computeProjectionTextureProjectionLightMatrix(): void;
  113613. /**
  113614. * Main function for light texture projection matrix computing.
  113615. */
  113616. protected _computeProjectionTextureMatrix(): void;
  113617. protected _buildUniformLayout(): void;
  113618. private _computeAngleValues;
  113619. /**
  113620. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  113621. * @param effect The effect to update
  113622. * @param lightIndex The index of the light in the effect to update
  113623. * @returns The spot light
  113624. */
  113625. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  113626. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  113627. /**
  113628. * Disposes the light and the associated resources.
  113629. */
  113630. dispose(): void;
  113631. /**
  113632. * Prepares the list of defines specific to the light type.
  113633. * @param defines the list of defines
  113634. * @param lightIndex defines the index of the light for the effect
  113635. */
  113636. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  113637. }
  113638. }
  113639. declare module BABYLON {
  113640. /**
  113641. * Gizmo that enables viewing a light
  113642. */
  113643. export class LightGizmo extends Gizmo {
  113644. private _lightMesh;
  113645. private _material;
  113646. private cachedPosition;
  113647. private cachedForward;
  113648. /**
  113649. * Creates a LightGizmo
  113650. * @param gizmoLayer The utility layer the gizmo will be added to
  113651. */
  113652. constructor(gizmoLayer?: UtilityLayerRenderer);
  113653. private _light;
  113654. /**
  113655. * The light that the gizmo is attached to
  113656. */
  113657. light: Nullable<Light>;
  113658. /**
  113659. * Gets the material used to render the light gizmo
  113660. */
  113661. readonly material: StandardMaterial;
  113662. /**
  113663. * @hidden
  113664. * Updates the gizmo to match the attached mesh's position/rotation
  113665. */
  113666. protected _update(): void;
  113667. private static _Scale;
  113668. /**
  113669. * Creates the lines for a light mesh
  113670. */
  113671. private static _createLightLines;
  113672. /**
  113673. * Disposes of the light gizmo
  113674. */
  113675. dispose(): void;
  113676. private static _CreateHemisphericLightMesh;
  113677. private static _CreatePointLightMesh;
  113678. private static _CreateSpotLightMesh;
  113679. private static _CreateDirectionalLightMesh;
  113680. }
  113681. }
  113682. declare module BABYLON {
  113683. /** @hidden */
  113684. export var backgroundFragmentDeclaration: {
  113685. name: string;
  113686. shader: string;
  113687. };
  113688. }
  113689. declare module BABYLON {
  113690. /** @hidden */
  113691. export var backgroundUboDeclaration: {
  113692. name: string;
  113693. shader: string;
  113694. };
  113695. }
  113696. declare module BABYLON {
  113697. /** @hidden */
  113698. export var backgroundPixelShader: {
  113699. name: string;
  113700. shader: string;
  113701. };
  113702. }
  113703. declare module BABYLON {
  113704. /** @hidden */
  113705. export var backgroundVertexDeclaration: {
  113706. name: string;
  113707. shader: string;
  113708. };
  113709. }
  113710. declare module BABYLON {
  113711. /** @hidden */
  113712. export var backgroundVertexShader: {
  113713. name: string;
  113714. shader: string;
  113715. };
  113716. }
  113717. declare module BABYLON {
  113718. /**
  113719. * Background material used to create an efficient environement around your scene.
  113720. */
  113721. export class BackgroundMaterial extends PushMaterial {
  113722. /**
  113723. * Standard reflectance value at parallel view angle.
  113724. */
  113725. static StandardReflectance0: number;
  113726. /**
  113727. * Standard reflectance value at grazing angle.
  113728. */
  113729. static StandardReflectance90: number;
  113730. protected _primaryColor: Color3;
  113731. /**
  113732. * Key light Color (multiply against the environement texture)
  113733. */
  113734. primaryColor: Color3;
  113735. protected __perceptualColor: Nullable<Color3>;
  113736. /**
  113737. * Experimental Internal Use Only.
  113738. *
  113739. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  113740. * This acts as a helper to set the primary color to a more "human friendly" value.
  113741. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  113742. * output color as close as possible from the chosen value.
  113743. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  113744. * part of lighting setup.)
  113745. */
  113746. _perceptualColor: Nullable<Color3>;
  113747. protected _primaryColorShadowLevel: float;
  113748. /**
  113749. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  113750. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  113751. */
  113752. primaryColorShadowLevel: float;
  113753. protected _primaryColorHighlightLevel: float;
  113754. /**
  113755. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  113756. * The primary color is used at the level chosen to define what the white area would look.
  113757. */
  113758. primaryColorHighlightLevel: float;
  113759. protected _reflectionTexture: Nullable<BaseTexture>;
  113760. /**
  113761. * Reflection Texture used in the material.
  113762. * Should be author in a specific way for the best result (refer to the documentation).
  113763. */
  113764. reflectionTexture: Nullable<BaseTexture>;
  113765. protected _reflectionBlur: float;
  113766. /**
  113767. * Reflection Texture level of blur.
  113768. *
  113769. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  113770. * texture twice.
  113771. */
  113772. reflectionBlur: float;
  113773. protected _diffuseTexture: Nullable<BaseTexture>;
  113774. /**
  113775. * Diffuse Texture used in the material.
  113776. * Should be author in a specific way for the best result (refer to the documentation).
  113777. */
  113778. diffuseTexture: Nullable<BaseTexture>;
  113779. protected _shadowLights: Nullable<IShadowLight[]>;
  113780. /**
  113781. * Specify the list of lights casting shadow on the material.
  113782. * All scene shadow lights will be included if null.
  113783. */
  113784. shadowLights: Nullable<IShadowLight[]>;
  113785. protected _shadowLevel: float;
  113786. /**
  113787. * Helps adjusting the shadow to a softer level if required.
  113788. * 0 means black shadows and 1 means no shadows.
  113789. */
  113790. shadowLevel: float;
  113791. protected _sceneCenter: Vector3;
  113792. /**
  113793. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  113794. * It is usually zero but might be interesting to modify according to your setup.
  113795. */
  113796. sceneCenter: Vector3;
  113797. protected _opacityFresnel: boolean;
  113798. /**
  113799. * This helps specifying that the material is falling off to the sky box at grazing angle.
  113800. * This helps ensuring a nice transition when the camera goes under the ground.
  113801. */
  113802. opacityFresnel: boolean;
  113803. protected _reflectionFresnel: boolean;
  113804. /**
  113805. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  113806. * This helps adding a mirror texture on the ground.
  113807. */
  113808. reflectionFresnel: boolean;
  113809. protected _reflectionFalloffDistance: number;
  113810. /**
  113811. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  113812. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  113813. */
  113814. reflectionFalloffDistance: number;
  113815. protected _reflectionAmount: number;
  113816. /**
  113817. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  113818. */
  113819. reflectionAmount: number;
  113820. protected _reflectionReflectance0: number;
  113821. /**
  113822. * This specifies the weight of the reflection at grazing angle.
  113823. */
  113824. reflectionReflectance0: number;
  113825. protected _reflectionReflectance90: number;
  113826. /**
  113827. * This specifies the weight of the reflection at a perpendicular point of view.
  113828. */
  113829. reflectionReflectance90: number;
  113830. /**
  113831. * Sets the reflection reflectance fresnel values according to the default standard
  113832. * empirically know to work well :-)
  113833. */
  113834. reflectionStandardFresnelWeight: number;
  113835. protected _useRGBColor: boolean;
  113836. /**
  113837. * Helps to directly use the maps channels instead of their level.
  113838. */
  113839. useRGBColor: boolean;
  113840. protected _enableNoise: boolean;
  113841. /**
  113842. * This helps reducing the banding effect that could occur on the background.
  113843. */
  113844. enableNoise: boolean;
  113845. /**
  113846. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  113847. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  113848. * Recommended to be keep at 1.0 except for special cases.
  113849. */
  113850. fovMultiplier: number;
  113851. private _fovMultiplier;
  113852. /**
  113853. * Enable the FOV adjustment feature controlled by fovMultiplier.
  113854. */
  113855. useEquirectangularFOV: boolean;
  113856. private _maxSimultaneousLights;
  113857. /**
  113858. * Number of Simultaneous lights allowed on the material.
  113859. */
  113860. maxSimultaneousLights: int;
  113861. /**
  113862. * Default configuration related to image processing available in the Background Material.
  113863. */
  113864. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  113865. /**
  113866. * Keep track of the image processing observer to allow dispose and replace.
  113867. */
  113868. private _imageProcessingObserver;
  113869. /**
  113870. * Attaches a new image processing configuration to the PBR Material.
  113871. * @param configuration (if null the scene configuration will be use)
  113872. */
  113873. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  113874. /**
  113875. * Gets the image processing configuration used either in this material.
  113876. */
  113877. /**
  113878. * Sets the Default image processing configuration used either in the this material.
  113879. *
  113880. * If sets to null, the scene one is in use.
  113881. */
  113882. imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  113883. /**
  113884. * Gets wether the color curves effect is enabled.
  113885. */
  113886. /**
  113887. * Sets wether the color curves effect is enabled.
  113888. */
  113889. cameraColorCurvesEnabled: boolean;
  113890. /**
  113891. * Gets wether the color grading effect is enabled.
  113892. */
  113893. /**
  113894. * Gets wether the color grading effect is enabled.
  113895. */
  113896. cameraColorGradingEnabled: boolean;
  113897. /**
  113898. * Gets wether tonemapping is enabled or not.
  113899. */
  113900. /**
  113901. * Sets wether tonemapping is enabled or not
  113902. */
  113903. cameraToneMappingEnabled: boolean;
  113904. /**
  113905. * The camera exposure used on this material.
  113906. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  113907. * This corresponds to a photographic exposure.
  113908. */
  113909. /**
  113910. * The camera exposure used on this material.
  113911. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  113912. * This corresponds to a photographic exposure.
  113913. */
  113914. cameraExposure: float;
  113915. /**
  113916. * Gets The camera contrast used on this material.
  113917. */
  113918. /**
  113919. * Sets The camera contrast used on this material.
  113920. */
  113921. cameraContrast: float;
  113922. /**
  113923. * Gets the Color Grading 2D Lookup Texture.
  113924. */
  113925. /**
  113926. * Sets the Color Grading 2D Lookup Texture.
  113927. */
  113928. cameraColorGradingTexture: Nullable<BaseTexture>;
  113929. /**
  113930. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  113931. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  113932. * 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;
  113933. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  113934. */
  113935. /**
  113936. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  113937. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  113938. * 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;
  113939. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  113940. */
  113941. cameraColorCurves: Nullable<ColorCurves>;
  113942. /**
  113943. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  113944. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  113945. */
  113946. switchToBGR: boolean;
  113947. private _renderTargets;
  113948. private _reflectionControls;
  113949. private _white;
  113950. private _primaryShadowColor;
  113951. private _primaryHighlightColor;
  113952. /**
  113953. * Instantiates a Background Material in the given scene
  113954. * @param name The friendly name of the material
  113955. * @param scene The scene to add the material to
  113956. */
  113957. constructor(name: string, scene: Scene);
  113958. /**
  113959. * Gets a boolean indicating that current material needs to register RTT
  113960. */
  113961. readonly hasRenderTargetTextures: boolean;
  113962. /**
  113963. * The entire material has been created in order to prevent overdraw.
  113964. * @returns false
  113965. */
  113966. needAlphaTesting(): boolean;
  113967. /**
  113968. * The entire material has been created in order to prevent overdraw.
  113969. * @returns true if blending is enable
  113970. */
  113971. needAlphaBlending(): boolean;
  113972. /**
  113973. * Checks wether the material is ready to be rendered for a given mesh.
  113974. * @param mesh The mesh to render
  113975. * @param subMesh The submesh to check against
  113976. * @param useInstances Specify wether or not the material is used with instances
  113977. * @returns true if all the dependencies are ready (Textures, Effects...)
  113978. */
  113979. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  113980. /**
  113981. * Compute the primary color according to the chosen perceptual color.
  113982. */
  113983. private _computePrimaryColorFromPerceptualColor;
  113984. /**
  113985. * Compute the highlights and shadow colors according to their chosen levels.
  113986. */
  113987. private _computePrimaryColors;
  113988. /**
  113989. * Build the uniform buffer used in the material.
  113990. */
  113991. buildUniformLayout(): void;
  113992. /**
  113993. * Unbind the material.
  113994. */
  113995. unbind(): void;
  113996. /**
  113997. * Bind only the world matrix to the material.
  113998. * @param world The world matrix to bind.
  113999. */
  114000. bindOnlyWorldMatrix(world: Matrix): void;
  114001. /**
  114002. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  114003. * @param world The world matrix to bind.
  114004. * @param subMesh The submesh to bind for.
  114005. */
  114006. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  114007. /**
  114008. * Checks to see if a texture is used in the material.
  114009. * @param texture - Base texture to use.
  114010. * @returns - Boolean specifying if a texture is used in the material.
  114011. */
  114012. hasTexture(texture: BaseTexture): boolean;
  114013. /**
  114014. * Dispose the material.
  114015. * @param forceDisposeEffect Force disposal of the associated effect.
  114016. * @param forceDisposeTextures Force disposal of the associated textures.
  114017. */
  114018. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  114019. /**
  114020. * Clones the material.
  114021. * @param name The cloned name.
  114022. * @returns The cloned material.
  114023. */
  114024. clone(name: string): BackgroundMaterial;
  114025. /**
  114026. * Serializes the current material to its JSON representation.
  114027. * @returns The JSON representation.
  114028. */
  114029. serialize(): any;
  114030. /**
  114031. * Gets the class name of the material
  114032. * @returns "BackgroundMaterial"
  114033. */
  114034. getClassName(): string;
  114035. /**
  114036. * Parse a JSON input to create back a background material.
  114037. * @param source The JSON data to parse
  114038. * @param scene The scene to create the parsed material in
  114039. * @param rootUrl The root url of the assets the material depends upon
  114040. * @returns the instantiated BackgroundMaterial.
  114041. */
  114042. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  114043. }
  114044. }
  114045. declare module BABYLON {
  114046. /**
  114047. * Represents the different options available during the creation of
  114048. * a Environment helper.
  114049. *
  114050. * This can control the default ground, skybox and image processing setup of your scene.
  114051. */
  114052. export interface IEnvironmentHelperOptions {
  114053. /**
  114054. * Specifies wether or not to create a ground.
  114055. * True by default.
  114056. */
  114057. createGround: boolean;
  114058. /**
  114059. * Specifies the ground size.
  114060. * 15 by default.
  114061. */
  114062. groundSize: number;
  114063. /**
  114064. * The texture used on the ground for the main color.
  114065. * Comes from the BabylonJS CDN by default.
  114066. *
  114067. * Remarks: Can be either a texture or a url.
  114068. */
  114069. groundTexture: string | BaseTexture;
  114070. /**
  114071. * The color mixed in the ground texture by default.
  114072. * BabylonJS clearColor by default.
  114073. */
  114074. groundColor: Color3;
  114075. /**
  114076. * Specifies the ground opacity.
  114077. * 1 by default.
  114078. */
  114079. groundOpacity: number;
  114080. /**
  114081. * Enables the ground to receive shadows.
  114082. * True by default.
  114083. */
  114084. enableGroundShadow: boolean;
  114085. /**
  114086. * Helps preventing the shadow to be fully black on the ground.
  114087. * 0.5 by default.
  114088. */
  114089. groundShadowLevel: number;
  114090. /**
  114091. * Creates a mirror texture attach to the ground.
  114092. * false by default.
  114093. */
  114094. enableGroundMirror: boolean;
  114095. /**
  114096. * Specifies the ground mirror size ratio.
  114097. * 0.3 by default as the default kernel is 64.
  114098. */
  114099. groundMirrorSizeRatio: number;
  114100. /**
  114101. * Specifies the ground mirror blur kernel size.
  114102. * 64 by default.
  114103. */
  114104. groundMirrorBlurKernel: number;
  114105. /**
  114106. * Specifies the ground mirror visibility amount.
  114107. * 1 by default
  114108. */
  114109. groundMirrorAmount: number;
  114110. /**
  114111. * Specifies the ground mirror reflectance weight.
  114112. * This uses the standard weight of the background material to setup the fresnel effect
  114113. * of the mirror.
  114114. * 1 by default.
  114115. */
  114116. groundMirrorFresnelWeight: number;
  114117. /**
  114118. * Specifies the ground mirror Falloff distance.
  114119. * This can helps reducing the size of the reflection.
  114120. * 0 by Default.
  114121. */
  114122. groundMirrorFallOffDistance: number;
  114123. /**
  114124. * Specifies the ground mirror texture type.
  114125. * Unsigned Int by Default.
  114126. */
  114127. groundMirrorTextureType: number;
  114128. /**
  114129. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  114130. * the shown objects.
  114131. */
  114132. groundYBias: number;
  114133. /**
  114134. * Specifies wether or not to create a skybox.
  114135. * True by default.
  114136. */
  114137. createSkybox: boolean;
  114138. /**
  114139. * Specifies the skybox size.
  114140. * 20 by default.
  114141. */
  114142. skyboxSize: number;
  114143. /**
  114144. * The texture used on the skybox for the main color.
  114145. * Comes from the BabylonJS CDN by default.
  114146. *
  114147. * Remarks: Can be either a texture or a url.
  114148. */
  114149. skyboxTexture: string | BaseTexture;
  114150. /**
  114151. * The color mixed in the skybox texture by default.
  114152. * BabylonJS clearColor by default.
  114153. */
  114154. skyboxColor: Color3;
  114155. /**
  114156. * The background rotation around the Y axis of the scene.
  114157. * This helps aligning the key lights of your scene with the background.
  114158. * 0 by default.
  114159. */
  114160. backgroundYRotation: number;
  114161. /**
  114162. * Compute automatically the size of the elements to best fit with the scene.
  114163. */
  114164. sizeAuto: boolean;
  114165. /**
  114166. * Default position of the rootMesh if autoSize is not true.
  114167. */
  114168. rootPosition: Vector3;
  114169. /**
  114170. * Sets up the image processing in the scene.
  114171. * true by default.
  114172. */
  114173. setupImageProcessing: boolean;
  114174. /**
  114175. * The texture used as your environment texture in the scene.
  114176. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  114177. *
  114178. * Remarks: Can be either a texture or a url.
  114179. */
  114180. environmentTexture: string | BaseTexture;
  114181. /**
  114182. * The value of the exposure to apply to the scene.
  114183. * 0.6 by default if setupImageProcessing is true.
  114184. */
  114185. cameraExposure: number;
  114186. /**
  114187. * The value of the contrast to apply to the scene.
  114188. * 1.6 by default if setupImageProcessing is true.
  114189. */
  114190. cameraContrast: number;
  114191. /**
  114192. * Specifies wether or not tonemapping should be enabled in the scene.
  114193. * true by default if setupImageProcessing is true.
  114194. */
  114195. toneMappingEnabled: boolean;
  114196. }
  114197. /**
  114198. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  114199. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  114200. * It also helps with the default setup of your imageProcessing configuration.
  114201. */
  114202. export class EnvironmentHelper {
  114203. /**
  114204. * Default ground texture URL.
  114205. */
  114206. private static _groundTextureCDNUrl;
  114207. /**
  114208. * Default skybox texture URL.
  114209. */
  114210. private static _skyboxTextureCDNUrl;
  114211. /**
  114212. * Default environment texture URL.
  114213. */
  114214. private static _environmentTextureCDNUrl;
  114215. /**
  114216. * Creates the default options for the helper.
  114217. */
  114218. private static _getDefaultOptions;
  114219. private _rootMesh;
  114220. /**
  114221. * Gets the root mesh created by the helper.
  114222. */
  114223. readonly rootMesh: Mesh;
  114224. private _skybox;
  114225. /**
  114226. * Gets the skybox created by the helper.
  114227. */
  114228. readonly skybox: Nullable<Mesh>;
  114229. private _skyboxTexture;
  114230. /**
  114231. * Gets the skybox texture created by the helper.
  114232. */
  114233. readonly skyboxTexture: Nullable<BaseTexture>;
  114234. private _skyboxMaterial;
  114235. /**
  114236. * Gets the skybox material created by the helper.
  114237. */
  114238. readonly skyboxMaterial: Nullable<BackgroundMaterial>;
  114239. private _ground;
  114240. /**
  114241. * Gets the ground mesh created by the helper.
  114242. */
  114243. readonly ground: Nullable<Mesh>;
  114244. private _groundTexture;
  114245. /**
  114246. * Gets the ground texture created by the helper.
  114247. */
  114248. readonly groundTexture: Nullable<BaseTexture>;
  114249. private _groundMirror;
  114250. /**
  114251. * Gets the ground mirror created by the helper.
  114252. */
  114253. readonly groundMirror: Nullable<MirrorTexture>;
  114254. /**
  114255. * Gets the ground mirror render list to helps pushing the meshes
  114256. * you wish in the ground reflection.
  114257. */
  114258. readonly groundMirrorRenderList: Nullable<AbstractMesh[]>;
  114259. private _groundMaterial;
  114260. /**
  114261. * Gets the ground material created by the helper.
  114262. */
  114263. readonly groundMaterial: Nullable<BackgroundMaterial>;
  114264. /**
  114265. * Stores the creation options.
  114266. */
  114267. private readonly _scene;
  114268. private _options;
  114269. /**
  114270. * This observable will be notified with any error during the creation of the environment,
  114271. * mainly texture creation errors.
  114272. */
  114273. onErrorObservable: Observable<{
  114274. message?: string;
  114275. exception?: any;
  114276. }>;
  114277. /**
  114278. * constructor
  114279. * @param options Defines the options we want to customize the helper
  114280. * @param scene The scene to add the material to
  114281. */
  114282. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  114283. /**
  114284. * Updates the background according to the new options
  114285. * @param options
  114286. */
  114287. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  114288. /**
  114289. * Sets the primary color of all the available elements.
  114290. * @param color the main color to affect to the ground and the background
  114291. */
  114292. setMainColor(color: Color3): void;
  114293. /**
  114294. * Setup the image processing according to the specified options.
  114295. */
  114296. private _setupImageProcessing;
  114297. /**
  114298. * Setup the environment texture according to the specified options.
  114299. */
  114300. private _setupEnvironmentTexture;
  114301. /**
  114302. * Setup the background according to the specified options.
  114303. */
  114304. private _setupBackground;
  114305. /**
  114306. * Get the scene sizes according to the setup.
  114307. */
  114308. private _getSceneSize;
  114309. /**
  114310. * Setup the ground according to the specified options.
  114311. */
  114312. private _setupGround;
  114313. /**
  114314. * Setup the ground material according to the specified options.
  114315. */
  114316. private _setupGroundMaterial;
  114317. /**
  114318. * Setup the ground diffuse texture according to the specified options.
  114319. */
  114320. private _setupGroundDiffuseTexture;
  114321. /**
  114322. * Setup the ground mirror texture according to the specified options.
  114323. */
  114324. private _setupGroundMirrorTexture;
  114325. /**
  114326. * Setup the ground to receive the mirror texture.
  114327. */
  114328. private _setupMirrorInGroundMaterial;
  114329. /**
  114330. * Setup the skybox according to the specified options.
  114331. */
  114332. private _setupSkybox;
  114333. /**
  114334. * Setup the skybox material according to the specified options.
  114335. */
  114336. private _setupSkyboxMaterial;
  114337. /**
  114338. * Setup the skybox reflection texture according to the specified options.
  114339. */
  114340. private _setupSkyboxReflectionTexture;
  114341. private _errorHandler;
  114342. /**
  114343. * Dispose all the elements created by the Helper.
  114344. */
  114345. dispose(): void;
  114346. }
  114347. }
  114348. declare module BABYLON {
  114349. /**
  114350. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  114351. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  114352. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  114353. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  114354. */
  114355. export class PhotoDome extends TransformNode {
  114356. /**
  114357. * Define the image as a Monoscopic panoramic 360 image.
  114358. */
  114359. static readonly MODE_MONOSCOPIC: number;
  114360. /**
  114361. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  114362. */
  114363. static readonly MODE_TOPBOTTOM: number;
  114364. /**
  114365. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  114366. */
  114367. static readonly MODE_SIDEBYSIDE: number;
  114368. private _useDirectMapping;
  114369. /**
  114370. * The texture being displayed on the sphere
  114371. */
  114372. protected _photoTexture: Texture;
  114373. /**
  114374. * Gets or sets the texture being displayed on the sphere
  114375. */
  114376. photoTexture: Texture;
  114377. /**
  114378. * Observable raised when an error occured while loading the 360 image
  114379. */
  114380. onLoadErrorObservable: Observable<string>;
  114381. /**
  114382. * The skybox material
  114383. */
  114384. protected _material: BackgroundMaterial;
  114385. /**
  114386. * The surface used for the skybox
  114387. */
  114388. protected _mesh: Mesh;
  114389. /**
  114390. * Gets the mesh used for the skybox.
  114391. */
  114392. readonly mesh: Mesh;
  114393. /**
  114394. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  114395. * Also see the options.resolution property.
  114396. */
  114397. fovMultiplier: number;
  114398. private _imageMode;
  114399. /**
  114400. * Gets or set the current video mode for the video. It can be:
  114401. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  114402. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  114403. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  114404. */
  114405. imageMode: number;
  114406. /**
  114407. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  114408. * @param name Element's name, child elements will append suffixes for their own names.
  114409. * @param urlsOfPhoto defines the url of the photo to display
  114410. * @param options defines an object containing optional or exposed sub element properties
  114411. * @param onError defines a callback called when an error occured while loading the texture
  114412. */
  114413. constructor(name: string, urlOfPhoto: string, options: {
  114414. resolution?: number;
  114415. size?: number;
  114416. useDirectMapping?: boolean;
  114417. faceForward?: boolean;
  114418. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  114419. private _onBeforeCameraRenderObserver;
  114420. private _changeImageMode;
  114421. /**
  114422. * Releases resources associated with this node.
  114423. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  114424. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  114425. */
  114426. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  114427. }
  114428. }
  114429. declare module BABYLON {
  114430. /**
  114431. * Class used to host RGBD texture specific utilities
  114432. */
  114433. export class RGBDTextureTools {
  114434. /**
  114435. * Expand the RGBD Texture from RGBD to Half Float if possible.
  114436. * @param texture the texture to expand.
  114437. */
  114438. static ExpandRGBDTexture(texture: Texture): void;
  114439. }
  114440. }
  114441. declare module BABYLON {
  114442. /**
  114443. * Class used to host texture specific utilities
  114444. */
  114445. export class BRDFTextureTools {
  114446. /**
  114447. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  114448. * @param scene defines the hosting scene
  114449. * @returns the environment BRDF texture
  114450. */
  114451. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  114452. private static _environmentBRDFBase64Texture;
  114453. }
  114454. }
  114455. declare module BABYLON {
  114456. /**
  114457. * @hidden
  114458. */
  114459. export interface IMaterialClearCoatDefines {
  114460. CLEARCOAT: boolean;
  114461. CLEARCOAT_DEFAULTIOR: boolean;
  114462. CLEARCOAT_TEXTURE: boolean;
  114463. CLEARCOAT_TEXTUREDIRECTUV: number;
  114464. CLEARCOAT_BUMP: boolean;
  114465. CLEARCOAT_BUMPDIRECTUV: number;
  114466. CLEARCOAT_TINT: boolean;
  114467. CLEARCOAT_TINT_TEXTURE: boolean;
  114468. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  114469. /** @hidden */
  114470. _areTexturesDirty: boolean;
  114471. }
  114472. /**
  114473. * Define the code related to the clear coat parameters of the pbr material.
  114474. */
  114475. export class PBRClearCoatConfiguration {
  114476. /**
  114477. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  114478. * The default fits with a polyurethane material.
  114479. */
  114480. private static readonly _DefaultIndexOfRefraction;
  114481. private _isEnabled;
  114482. /**
  114483. * Defines if the clear coat is enabled in the material.
  114484. */
  114485. isEnabled: boolean;
  114486. /**
  114487. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  114488. */
  114489. intensity: number;
  114490. /**
  114491. * Defines the clear coat layer roughness.
  114492. */
  114493. roughness: number;
  114494. private _indexOfRefraction;
  114495. /**
  114496. * Defines the index of refraction of the clear coat.
  114497. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  114498. * The default fits with a polyurethane material.
  114499. * Changing the default value is more performance intensive.
  114500. */
  114501. indexOfRefraction: number;
  114502. private _texture;
  114503. /**
  114504. * Stores the clear coat values in a texture.
  114505. */
  114506. texture: Nullable<BaseTexture>;
  114507. private _bumpTexture;
  114508. /**
  114509. * Define the clear coat specific bump texture.
  114510. */
  114511. bumpTexture: Nullable<BaseTexture>;
  114512. private _isTintEnabled;
  114513. /**
  114514. * Defines if the clear coat tint is enabled in the material.
  114515. */
  114516. isTintEnabled: boolean;
  114517. /**
  114518. * Defines the clear coat tint of the material.
  114519. * This is only use if tint is enabled
  114520. */
  114521. tintColor: Color3;
  114522. /**
  114523. * Defines the distance at which the tint color should be found in the
  114524. * clear coat media.
  114525. * This is only use if tint is enabled
  114526. */
  114527. tintColorAtDistance: number;
  114528. /**
  114529. * Defines the clear coat layer thickness.
  114530. * This is only use if tint is enabled
  114531. */
  114532. tintThickness: number;
  114533. private _tintTexture;
  114534. /**
  114535. * Stores the clear tint values in a texture.
  114536. * rgb is tint
  114537. * a is a thickness factor
  114538. */
  114539. tintTexture: Nullable<BaseTexture>;
  114540. /** @hidden */
  114541. private _internalMarkAllSubMeshesAsTexturesDirty;
  114542. /** @hidden */
  114543. _markAllSubMeshesAsTexturesDirty(): void;
  114544. /**
  114545. * Instantiate a new istance of clear coat configuration.
  114546. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  114547. */
  114548. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  114549. /**
  114550. * Gets wehter the submesh is ready to be used or not.
  114551. * @param defines the list of "defines" to update.
  114552. * @param scene defines the scene the material belongs to.
  114553. * @param engine defines the engine the material belongs to.
  114554. * @param disableBumpMap defines wether the material disables bump or not.
  114555. * @returns - boolean indicating that the submesh is ready or not.
  114556. */
  114557. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  114558. /**
  114559. * Checks to see if a texture is used in the material.
  114560. * @param defines the list of "defines" to update.
  114561. * @param scene defines the scene to the material belongs to.
  114562. */
  114563. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  114564. /**
  114565. * Binds the material data.
  114566. * @param uniformBuffer defines the Uniform buffer to fill in.
  114567. * @param scene defines the scene the material belongs to.
  114568. * @param engine defines the engine the material belongs to.
  114569. * @param disableBumpMap defines wether the material disables bump or not.
  114570. * @param isFrozen defines wether the material is frozen or not.
  114571. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  114572. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  114573. */
  114574. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  114575. /**
  114576. * Checks to see if a texture is used in the material.
  114577. * @param texture - Base texture to use.
  114578. * @returns - Boolean specifying if a texture is used in the material.
  114579. */
  114580. hasTexture(texture: BaseTexture): boolean;
  114581. /**
  114582. * Returns an array of the actively used textures.
  114583. * @param activeTextures Array of BaseTextures
  114584. */
  114585. getActiveTextures(activeTextures: BaseTexture[]): void;
  114586. /**
  114587. * Returns the animatable textures.
  114588. * @param animatables Array of animatable textures.
  114589. */
  114590. getAnimatables(animatables: IAnimatable[]): void;
  114591. /**
  114592. * Disposes the resources of the material.
  114593. * @param forceDisposeTextures - Forces the disposal of all textures.
  114594. */
  114595. dispose(forceDisposeTextures?: boolean): void;
  114596. /**
  114597. * Get the current class name of the texture useful for serialization or dynamic coding.
  114598. * @returns "PBRClearCoatConfiguration"
  114599. */
  114600. getClassName(): string;
  114601. /**
  114602. * Add fallbacks to the effect fallbacks list.
  114603. * @param defines defines the Base texture to use.
  114604. * @param fallbacks defines the current fallback list.
  114605. * @param currentRank defines the current fallback rank.
  114606. * @returns the new fallback rank.
  114607. */
  114608. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  114609. /**
  114610. * Add the required uniforms to the current list.
  114611. * @param uniforms defines the current uniform list.
  114612. */
  114613. static AddUniforms(uniforms: string[]): void;
  114614. /**
  114615. * Add the required samplers to the current list.
  114616. * @param samplers defines the current sampler list.
  114617. */
  114618. static AddSamplers(samplers: string[]): void;
  114619. /**
  114620. * Add the required uniforms to the current buffer.
  114621. * @param uniformBuffer defines the current uniform buffer.
  114622. */
  114623. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  114624. /**
  114625. * Makes a duplicate of the current configuration into another one.
  114626. * @param clearCoatConfiguration define the config where to copy the info
  114627. */
  114628. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  114629. /**
  114630. * Serializes this clear coat configuration.
  114631. * @returns - An object with the serialized config.
  114632. */
  114633. serialize(): any;
  114634. /**
  114635. * Parses a anisotropy Configuration from a serialized object.
  114636. * @param source - Serialized object.
  114637. * @param scene Defines the scene we are parsing for
  114638. * @param rootUrl Defines the rootUrl to load from
  114639. */
  114640. parse(source: any, scene: Scene, rootUrl: string): void;
  114641. }
  114642. }
  114643. declare module BABYLON {
  114644. /**
  114645. * @hidden
  114646. */
  114647. export interface IMaterialAnisotropicDefines {
  114648. ANISOTROPIC: boolean;
  114649. ANISOTROPIC_TEXTURE: boolean;
  114650. ANISOTROPIC_TEXTUREDIRECTUV: number;
  114651. MAINUV1: boolean;
  114652. _areTexturesDirty: boolean;
  114653. _needUVs: boolean;
  114654. }
  114655. /**
  114656. * Define the code related to the anisotropic parameters of the pbr material.
  114657. */
  114658. export class PBRAnisotropicConfiguration {
  114659. private _isEnabled;
  114660. /**
  114661. * Defines if the anisotropy is enabled in the material.
  114662. */
  114663. isEnabled: boolean;
  114664. /**
  114665. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  114666. */
  114667. intensity: number;
  114668. /**
  114669. * Defines if the effect is along the tangents, bitangents or in between.
  114670. * By default, the effect is "strectching" the highlights along the tangents.
  114671. */
  114672. direction: Vector2;
  114673. private _texture;
  114674. /**
  114675. * Stores the anisotropy values in a texture.
  114676. * rg is direction (like normal from -1 to 1)
  114677. * b is a intensity
  114678. */
  114679. texture: Nullable<BaseTexture>;
  114680. /** @hidden */
  114681. private _internalMarkAllSubMeshesAsTexturesDirty;
  114682. /** @hidden */
  114683. _markAllSubMeshesAsTexturesDirty(): void;
  114684. /**
  114685. * Instantiate a new istance of anisotropy configuration.
  114686. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  114687. */
  114688. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  114689. /**
  114690. * Specifies that the submesh is ready to be used.
  114691. * @param defines the list of "defines" to update.
  114692. * @param scene defines the scene the material belongs to.
  114693. * @returns - boolean indicating that the submesh is ready or not.
  114694. */
  114695. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  114696. /**
  114697. * Checks to see if a texture is used in the material.
  114698. * @param defines the list of "defines" to update.
  114699. * @param mesh the mesh we are preparing the defines for.
  114700. * @param scene defines the scene the material belongs to.
  114701. */
  114702. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  114703. /**
  114704. * Binds the material data.
  114705. * @param uniformBuffer defines the Uniform buffer to fill in.
  114706. * @param scene defines the scene the material belongs to.
  114707. * @param isFrozen defines wether the material is frozen or not.
  114708. */
  114709. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  114710. /**
  114711. * Checks to see if a texture is used in the material.
  114712. * @param texture - Base texture to use.
  114713. * @returns - Boolean specifying if a texture is used in the material.
  114714. */
  114715. hasTexture(texture: BaseTexture): boolean;
  114716. /**
  114717. * Returns an array of the actively used textures.
  114718. * @param activeTextures Array of BaseTextures
  114719. */
  114720. getActiveTextures(activeTextures: BaseTexture[]): void;
  114721. /**
  114722. * Returns the animatable textures.
  114723. * @param animatables Array of animatable textures.
  114724. */
  114725. getAnimatables(animatables: IAnimatable[]): void;
  114726. /**
  114727. * Disposes the resources of the material.
  114728. * @param forceDisposeTextures - Forces the disposal of all textures.
  114729. */
  114730. dispose(forceDisposeTextures?: boolean): void;
  114731. /**
  114732. * Get the current class name of the texture useful for serialization or dynamic coding.
  114733. * @returns "PBRAnisotropicConfiguration"
  114734. */
  114735. getClassName(): string;
  114736. /**
  114737. * Add fallbacks to the effect fallbacks list.
  114738. * @param defines defines the Base texture to use.
  114739. * @param fallbacks defines the current fallback list.
  114740. * @param currentRank defines the current fallback rank.
  114741. * @returns the new fallback rank.
  114742. */
  114743. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  114744. /**
  114745. * Add the required uniforms to the current list.
  114746. * @param uniforms defines the current uniform list.
  114747. */
  114748. static AddUniforms(uniforms: string[]): void;
  114749. /**
  114750. * Add the required uniforms to the current buffer.
  114751. * @param uniformBuffer defines the current uniform buffer.
  114752. */
  114753. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  114754. /**
  114755. * Add the required samplers to the current list.
  114756. * @param samplers defines the current sampler list.
  114757. */
  114758. static AddSamplers(samplers: string[]): void;
  114759. /**
  114760. * Makes a duplicate of the current configuration into another one.
  114761. * @param anisotropicConfiguration define the config where to copy the info
  114762. */
  114763. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  114764. /**
  114765. * Serializes this anisotropy configuration.
  114766. * @returns - An object with the serialized config.
  114767. */
  114768. serialize(): any;
  114769. /**
  114770. * Parses a anisotropy Configuration from a serialized object.
  114771. * @param source - Serialized object.
  114772. * @param scene Defines the scene we are parsing for
  114773. * @param rootUrl Defines the rootUrl to load from
  114774. */
  114775. parse(source: any, scene: Scene, rootUrl: string): void;
  114776. }
  114777. }
  114778. declare module BABYLON {
  114779. /**
  114780. * @hidden
  114781. */
  114782. export interface IMaterialBRDFDefines {
  114783. BRDF_V_HEIGHT_CORRELATED: boolean;
  114784. MS_BRDF_ENERGY_CONSERVATION: boolean;
  114785. SPHERICAL_HARMONICS: boolean;
  114786. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  114787. /** @hidden */
  114788. _areMiscDirty: boolean;
  114789. }
  114790. /**
  114791. * Define the code related to the BRDF parameters of the pbr material.
  114792. */
  114793. export class PBRBRDFConfiguration {
  114794. /**
  114795. * Default value used for the energy conservation.
  114796. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  114797. */
  114798. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  114799. /**
  114800. * Default value used for the Smith Visibility Height Correlated mode.
  114801. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  114802. */
  114803. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  114804. /**
  114805. * Default value used for the IBL diffuse part.
  114806. * This can help switching back to the polynomials mode globally which is a tiny bit
  114807. * less GPU intensive at the drawback of a lower quality.
  114808. */
  114809. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  114810. /**
  114811. * Default value used for activating energy conservation for the specular workflow.
  114812. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  114813. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  114814. */
  114815. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  114816. private _useEnergyConservation;
  114817. /**
  114818. * Defines if the material uses energy conservation.
  114819. */
  114820. useEnergyConservation: boolean;
  114821. private _useSmithVisibilityHeightCorrelated;
  114822. /**
  114823. * LEGACY Mode set to false
  114824. * Defines if the material uses height smith correlated visibility term.
  114825. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  114826. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  114827. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  114828. * Not relying on height correlated will also disable energy conservation.
  114829. */
  114830. useSmithVisibilityHeightCorrelated: boolean;
  114831. private _useSphericalHarmonics;
  114832. /**
  114833. * LEGACY Mode set to false
  114834. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  114835. * diffuse part of the IBL.
  114836. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  114837. * to the ground truth.
  114838. */
  114839. useSphericalHarmonics: boolean;
  114840. private _useSpecularGlossinessInputEnergyConservation;
  114841. /**
  114842. * Defines if the material uses energy conservation, when the specular workflow is active.
  114843. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  114844. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  114845. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  114846. */
  114847. useSpecularGlossinessInputEnergyConservation: boolean;
  114848. /** @hidden */
  114849. private _internalMarkAllSubMeshesAsMiscDirty;
  114850. /** @hidden */
  114851. _markAllSubMeshesAsMiscDirty(): void;
  114852. /**
  114853. * Instantiate a new istance of clear coat configuration.
  114854. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  114855. */
  114856. constructor(markAllSubMeshesAsMiscDirty: () => void);
  114857. /**
  114858. * Checks to see if a texture is used in the material.
  114859. * @param defines the list of "defines" to update.
  114860. */
  114861. prepareDefines(defines: IMaterialBRDFDefines): void;
  114862. /**
  114863. * Get the current class name of the texture useful for serialization or dynamic coding.
  114864. * @returns "PBRClearCoatConfiguration"
  114865. */
  114866. getClassName(): string;
  114867. /**
  114868. * Makes a duplicate of the current configuration into another one.
  114869. * @param brdfConfiguration define the config where to copy the info
  114870. */
  114871. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  114872. /**
  114873. * Serializes this BRDF configuration.
  114874. * @returns - An object with the serialized config.
  114875. */
  114876. serialize(): any;
  114877. /**
  114878. * Parses a anisotropy Configuration from a serialized object.
  114879. * @param source - Serialized object.
  114880. * @param scene Defines the scene we are parsing for
  114881. * @param rootUrl Defines the rootUrl to load from
  114882. */
  114883. parse(source: any, scene: Scene, rootUrl: string): void;
  114884. }
  114885. }
  114886. declare module BABYLON {
  114887. /**
  114888. * @hidden
  114889. */
  114890. export interface IMaterialSheenDefines {
  114891. SHEEN: boolean;
  114892. SHEEN_TEXTURE: boolean;
  114893. SHEEN_TEXTUREDIRECTUV: number;
  114894. SHEEN_LINKWITHALBEDO: boolean;
  114895. /** @hidden */
  114896. _areTexturesDirty: boolean;
  114897. }
  114898. /**
  114899. * Define the code related to the Sheen parameters of the pbr material.
  114900. */
  114901. export class PBRSheenConfiguration {
  114902. private _isEnabled;
  114903. /**
  114904. * Defines if the material uses sheen.
  114905. */
  114906. isEnabled: boolean;
  114907. private _linkSheenWithAlbedo;
  114908. /**
  114909. * Defines if the sheen is linked to the sheen color.
  114910. */
  114911. linkSheenWithAlbedo: boolean;
  114912. /**
  114913. * Defines the sheen intensity.
  114914. */
  114915. intensity: number;
  114916. /**
  114917. * Defines the sheen color.
  114918. */
  114919. color: Color3;
  114920. private _texture;
  114921. /**
  114922. * Stores the sheen tint values in a texture.
  114923. * rgb is tint
  114924. * a is a intensity
  114925. */
  114926. texture: Nullable<BaseTexture>;
  114927. /** @hidden */
  114928. private _internalMarkAllSubMeshesAsTexturesDirty;
  114929. /** @hidden */
  114930. _markAllSubMeshesAsTexturesDirty(): void;
  114931. /**
  114932. * Instantiate a new istance of clear coat configuration.
  114933. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  114934. */
  114935. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  114936. /**
  114937. * Specifies that the submesh is ready to be used.
  114938. * @param defines the list of "defines" to update.
  114939. * @param scene defines the scene the material belongs to.
  114940. * @returns - boolean indicating that the submesh is ready or not.
  114941. */
  114942. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  114943. /**
  114944. * Checks to see if a texture is used in the material.
  114945. * @param defines the list of "defines" to update.
  114946. * @param scene defines the scene the material belongs to.
  114947. */
  114948. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  114949. /**
  114950. * Binds the material data.
  114951. * @param uniformBuffer defines the Uniform buffer to fill in.
  114952. * @param scene defines the scene the material belongs to.
  114953. * @param isFrozen defines wether the material is frozen or not.
  114954. */
  114955. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  114956. /**
  114957. * Checks to see if a texture is used in the material.
  114958. * @param texture - Base texture to use.
  114959. * @returns - Boolean specifying if a texture is used in the material.
  114960. */
  114961. hasTexture(texture: BaseTexture): boolean;
  114962. /**
  114963. * Returns an array of the actively used textures.
  114964. * @param activeTextures Array of BaseTextures
  114965. */
  114966. getActiveTextures(activeTextures: BaseTexture[]): void;
  114967. /**
  114968. * Returns the animatable textures.
  114969. * @param animatables Array of animatable textures.
  114970. */
  114971. getAnimatables(animatables: IAnimatable[]): void;
  114972. /**
  114973. * Disposes the resources of the material.
  114974. * @param forceDisposeTextures - Forces the disposal of all textures.
  114975. */
  114976. dispose(forceDisposeTextures?: boolean): void;
  114977. /**
  114978. * Get the current class name of the texture useful for serialization or dynamic coding.
  114979. * @returns "PBRSheenConfiguration"
  114980. */
  114981. getClassName(): string;
  114982. /**
  114983. * Add fallbacks to the effect fallbacks list.
  114984. * @param defines defines the Base texture to use.
  114985. * @param fallbacks defines the current fallback list.
  114986. * @param currentRank defines the current fallback rank.
  114987. * @returns the new fallback rank.
  114988. */
  114989. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  114990. /**
  114991. * Add the required uniforms to the current list.
  114992. * @param uniforms defines the current uniform list.
  114993. */
  114994. static AddUniforms(uniforms: string[]): void;
  114995. /**
  114996. * Add the required uniforms to the current buffer.
  114997. * @param uniformBuffer defines the current uniform buffer.
  114998. */
  114999. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  115000. /**
  115001. * Add the required samplers to the current list.
  115002. * @param samplers defines the current sampler list.
  115003. */
  115004. static AddSamplers(samplers: string[]): void;
  115005. /**
  115006. * Makes a duplicate of the current configuration into another one.
  115007. * @param sheenConfiguration define the config where to copy the info
  115008. */
  115009. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  115010. /**
  115011. * Serializes this BRDF configuration.
  115012. * @returns - An object with the serialized config.
  115013. */
  115014. serialize(): any;
  115015. /**
  115016. * Parses a anisotropy Configuration from a serialized object.
  115017. * @param source - Serialized object.
  115018. * @param scene Defines the scene we are parsing for
  115019. * @param rootUrl Defines the rootUrl to load from
  115020. */
  115021. parse(source: any, scene: Scene, rootUrl: string): void;
  115022. }
  115023. }
  115024. declare module BABYLON {
  115025. /**
  115026. * @hidden
  115027. */
  115028. export interface IMaterialSubSurfaceDefines {
  115029. SUBSURFACE: boolean;
  115030. SS_REFRACTION: boolean;
  115031. SS_TRANSLUCENCY: boolean;
  115032. SS_SCATERRING: boolean;
  115033. SS_THICKNESSANDMASK_TEXTURE: boolean;
  115034. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  115035. SS_REFRACTIONMAP_3D: boolean;
  115036. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  115037. SS_LODINREFRACTIONALPHA: boolean;
  115038. SS_GAMMAREFRACTION: boolean;
  115039. SS_RGBDREFRACTION: boolean;
  115040. SS_LINEARSPECULARREFRACTION: boolean;
  115041. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  115042. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  115043. /** @hidden */
  115044. _areTexturesDirty: boolean;
  115045. }
  115046. /**
  115047. * Define the code related to the sub surface parameters of the pbr material.
  115048. */
  115049. export class PBRSubSurfaceConfiguration {
  115050. private _isRefractionEnabled;
  115051. /**
  115052. * Defines if the refraction is enabled in the material.
  115053. */
  115054. isRefractionEnabled: boolean;
  115055. private _isTranslucencyEnabled;
  115056. /**
  115057. * Defines if the translucency is enabled in the material.
  115058. */
  115059. isTranslucencyEnabled: boolean;
  115060. private _isScatteringEnabled;
  115061. /**
  115062. * Defines the refraction intensity of the material.
  115063. * The refraction when enabled replaces the Diffuse part of the material.
  115064. * The intensity helps transitionning between diffuse and refraction.
  115065. */
  115066. refractionIntensity: number;
  115067. /**
  115068. * Defines the translucency intensity of the material.
  115069. * When translucency has been enabled, this defines how much of the "translucency"
  115070. * is addded to the diffuse part of the material.
  115071. */
  115072. translucencyIntensity: number;
  115073. /**
  115074. * Defines the scattering intensity of the material.
  115075. * When scattering has been enabled, this defines how much of the "scattered light"
  115076. * is addded to the diffuse part of the material.
  115077. */
  115078. scatteringIntensity: number;
  115079. private _thicknessTexture;
  115080. /**
  115081. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  115082. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  115083. * 0 would mean minimumThickness
  115084. * 1 would mean maximumThickness
  115085. * The other channels might be use as a mask to vary the different effects intensity.
  115086. */
  115087. thicknessTexture: Nullable<BaseTexture>;
  115088. private _refractionTexture;
  115089. /**
  115090. * Defines the texture to use for refraction.
  115091. */
  115092. refractionTexture: Nullable<BaseTexture>;
  115093. private _indexOfRefraction;
  115094. /**
  115095. * Defines the index of refraction used in the material.
  115096. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  115097. */
  115098. indexOfRefraction: number;
  115099. private _invertRefractionY;
  115100. /**
  115101. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  115102. */
  115103. invertRefractionY: boolean;
  115104. private _linkRefractionWithTransparency;
  115105. /**
  115106. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  115107. * Materials half opaque for instance using refraction could benefit from this control.
  115108. */
  115109. linkRefractionWithTransparency: boolean;
  115110. /**
  115111. * Defines the minimum thickness stored in the thickness map.
  115112. * If no thickness map is defined, this value will be used to simulate thickness.
  115113. */
  115114. minimumThickness: number;
  115115. /**
  115116. * Defines the maximum thickness stored in the thickness map.
  115117. */
  115118. maximumThickness: number;
  115119. /**
  115120. * Defines the volume tint of the material.
  115121. * This is used for both translucency and scattering.
  115122. */
  115123. tintColor: Color3;
  115124. /**
  115125. * Defines the distance at which the tint color should be found in the media.
  115126. * This is used for refraction only.
  115127. */
  115128. tintColorAtDistance: number;
  115129. /**
  115130. * Defines how far each channel transmit through the media.
  115131. * It is defined as a color to simplify it selection.
  115132. */
  115133. diffusionDistance: Color3;
  115134. private _useMaskFromThicknessTexture;
  115135. /**
  115136. * Stores the intensity of the different subsurface effects in the thickness texture.
  115137. * * the green channel is the translucency intensity.
  115138. * * the blue channel is the scattering intensity.
  115139. * * the alpha channel is the refraction intensity.
  115140. */
  115141. useMaskFromThicknessTexture: boolean;
  115142. /** @hidden */
  115143. private _internalMarkAllSubMeshesAsTexturesDirty;
  115144. /** @hidden */
  115145. _markAllSubMeshesAsTexturesDirty(): void;
  115146. /**
  115147. * Instantiate a new istance of sub surface configuration.
  115148. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  115149. */
  115150. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  115151. /**
  115152. * Gets wehter the submesh is ready to be used or not.
  115153. * @param defines the list of "defines" to update.
  115154. * @param scene defines the scene the material belongs to.
  115155. * @returns - boolean indicating that the submesh is ready or not.
  115156. */
  115157. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  115158. /**
  115159. * Checks to see if a texture is used in the material.
  115160. * @param defines the list of "defines" to update.
  115161. * @param scene defines the scene to the material belongs to.
  115162. */
  115163. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  115164. /**
  115165. * Binds the material data.
  115166. * @param uniformBuffer defines the Uniform buffer to fill in.
  115167. * @param scene defines the scene the material belongs to.
  115168. * @param engine defines the engine the material belongs to.
  115169. * @param isFrozen defines wether the material is frozen or not.
  115170. * @param lodBasedMicrosurface defines wether the material relies on lod based microsurface or not.
  115171. */
  115172. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean): void;
  115173. /**
  115174. * Unbinds the material from the mesh.
  115175. * @param activeEffect defines the effect that should be unbound from.
  115176. * @returns true if unbound, otherwise false
  115177. */
  115178. unbind(activeEffect: Effect): boolean;
  115179. /**
  115180. * Returns the texture used for refraction or null if none is used.
  115181. * @param scene defines the scene the material belongs to.
  115182. * @returns - Refraction texture if present. If no refraction texture and refraction
  115183. * is linked with transparency, returns environment texture. Otherwise, returns null.
  115184. */
  115185. private _getRefractionTexture;
  115186. /**
  115187. * Returns true if alpha blending should be disabled.
  115188. */
  115189. readonly disableAlphaBlending: boolean;
  115190. /**
  115191. * Fills the list of render target textures.
  115192. * @param renderTargets the list of render targets to update
  115193. */
  115194. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  115195. /**
  115196. * Checks to see if a texture is used in the material.
  115197. * @param texture - Base texture to use.
  115198. * @returns - Boolean specifying if a texture is used in the material.
  115199. */
  115200. hasTexture(texture: BaseTexture): boolean;
  115201. /**
  115202. * Gets a boolean indicating that current material needs to register RTT
  115203. * @returns true if this uses a render target otherwise false.
  115204. */
  115205. hasRenderTargetTextures(): boolean;
  115206. /**
  115207. * Returns an array of the actively used textures.
  115208. * @param activeTextures Array of BaseTextures
  115209. */
  115210. getActiveTextures(activeTextures: BaseTexture[]): void;
  115211. /**
  115212. * Returns the animatable textures.
  115213. * @param animatables Array of animatable textures.
  115214. */
  115215. getAnimatables(animatables: IAnimatable[]): void;
  115216. /**
  115217. * Disposes the resources of the material.
  115218. * @param forceDisposeTextures - Forces the disposal of all textures.
  115219. */
  115220. dispose(forceDisposeTextures?: boolean): void;
  115221. /**
  115222. * Get the current class name of the texture useful for serialization or dynamic coding.
  115223. * @returns "PBRSubSurfaceConfiguration"
  115224. */
  115225. getClassName(): string;
  115226. /**
  115227. * Add fallbacks to the effect fallbacks list.
  115228. * @param defines defines the Base texture to use.
  115229. * @param fallbacks defines the current fallback list.
  115230. * @param currentRank defines the current fallback rank.
  115231. * @returns the new fallback rank.
  115232. */
  115233. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  115234. /**
  115235. * Add the required uniforms to the current list.
  115236. * @param uniforms defines the current uniform list.
  115237. */
  115238. static AddUniforms(uniforms: string[]): void;
  115239. /**
  115240. * Add the required samplers to the current list.
  115241. * @param samplers defines the current sampler list.
  115242. */
  115243. static AddSamplers(samplers: string[]): void;
  115244. /**
  115245. * Add the required uniforms to the current buffer.
  115246. * @param uniformBuffer defines the current uniform buffer.
  115247. */
  115248. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  115249. /**
  115250. * Makes a duplicate of the current configuration into another one.
  115251. * @param configuration define the config where to copy the info
  115252. */
  115253. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  115254. /**
  115255. * Serializes this Sub Surface configuration.
  115256. * @returns - An object with the serialized config.
  115257. */
  115258. serialize(): any;
  115259. /**
  115260. * Parses a anisotropy Configuration from a serialized object.
  115261. * @param source - Serialized object.
  115262. * @param scene Defines the scene we are parsing for
  115263. * @param rootUrl Defines the rootUrl to load from
  115264. */
  115265. parse(source: any, scene: Scene, rootUrl: string): void;
  115266. }
  115267. }
  115268. declare module BABYLON {
  115269. /** @hidden */
  115270. export var pbrFragmentDeclaration: {
  115271. name: string;
  115272. shader: string;
  115273. };
  115274. }
  115275. declare module BABYLON {
  115276. /** @hidden */
  115277. export var pbrUboDeclaration: {
  115278. name: string;
  115279. shader: string;
  115280. };
  115281. }
  115282. declare module BABYLON {
  115283. /** @hidden */
  115284. export var pbrFragmentExtraDeclaration: {
  115285. name: string;
  115286. shader: string;
  115287. };
  115288. }
  115289. declare module BABYLON {
  115290. /** @hidden */
  115291. export var pbrFragmentSamplersDeclaration: {
  115292. name: string;
  115293. shader: string;
  115294. };
  115295. }
  115296. declare module BABYLON {
  115297. /** @hidden */
  115298. export var pbrHelperFunctions: {
  115299. name: string;
  115300. shader: string;
  115301. };
  115302. }
  115303. declare module BABYLON {
  115304. /** @hidden */
  115305. export var harmonicsFunctions: {
  115306. name: string;
  115307. shader: string;
  115308. };
  115309. }
  115310. declare module BABYLON {
  115311. /** @hidden */
  115312. export var pbrDirectLightingSetupFunctions: {
  115313. name: string;
  115314. shader: string;
  115315. };
  115316. }
  115317. declare module BABYLON {
  115318. /** @hidden */
  115319. export var pbrDirectLightingFalloffFunctions: {
  115320. name: string;
  115321. shader: string;
  115322. };
  115323. }
  115324. declare module BABYLON {
  115325. /** @hidden */
  115326. export var pbrBRDFFunctions: {
  115327. name: string;
  115328. shader: string;
  115329. };
  115330. }
  115331. declare module BABYLON {
  115332. /** @hidden */
  115333. export var pbrDirectLightingFunctions: {
  115334. name: string;
  115335. shader: string;
  115336. };
  115337. }
  115338. declare module BABYLON {
  115339. /** @hidden */
  115340. export var pbrIBLFunctions: {
  115341. name: string;
  115342. shader: string;
  115343. };
  115344. }
  115345. declare module BABYLON {
  115346. /** @hidden */
  115347. export var pbrDebug: {
  115348. name: string;
  115349. shader: string;
  115350. };
  115351. }
  115352. declare module BABYLON {
  115353. /** @hidden */
  115354. export var pbrPixelShader: {
  115355. name: string;
  115356. shader: string;
  115357. };
  115358. }
  115359. declare module BABYLON {
  115360. /** @hidden */
  115361. export var pbrVertexDeclaration: {
  115362. name: string;
  115363. shader: string;
  115364. };
  115365. }
  115366. declare module BABYLON {
  115367. /** @hidden */
  115368. export var pbrVertexShader: {
  115369. name: string;
  115370. shader: string;
  115371. };
  115372. }
  115373. declare module BABYLON {
  115374. /**
  115375. * Manages the defines for the PBR Material.
  115376. * @hidden
  115377. */
  115378. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines {
  115379. PBR: boolean;
  115380. MAINUV1: boolean;
  115381. MAINUV2: boolean;
  115382. UV1: boolean;
  115383. UV2: boolean;
  115384. ALBEDO: boolean;
  115385. ALBEDODIRECTUV: number;
  115386. VERTEXCOLOR: boolean;
  115387. AMBIENT: boolean;
  115388. AMBIENTDIRECTUV: number;
  115389. AMBIENTINGRAYSCALE: boolean;
  115390. OPACITY: boolean;
  115391. VERTEXALPHA: boolean;
  115392. OPACITYDIRECTUV: number;
  115393. OPACITYRGB: boolean;
  115394. ALPHATEST: boolean;
  115395. DEPTHPREPASS: boolean;
  115396. ALPHABLEND: boolean;
  115397. ALPHAFROMALBEDO: boolean;
  115398. ALPHATESTVALUE: string;
  115399. SPECULAROVERALPHA: boolean;
  115400. RADIANCEOVERALPHA: boolean;
  115401. ALPHAFRESNEL: boolean;
  115402. LINEARALPHAFRESNEL: boolean;
  115403. PREMULTIPLYALPHA: boolean;
  115404. EMISSIVE: boolean;
  115405. EMISSIVEDIRECTUV: number;
  115406. REFLECTIVITY: boolean;
  115407. REFLECTIVITYDIRECTUV: number;
  115408. SPECULARTERM: boolean;
  115409. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  115410. MICROSURFACEAUTOMATIC: boolean;
  115411. LODBASEDMICROSFURACE: boolean;
  115412. MICROSURFACEMAP: boolean;
  115413. MICROSURFACEMAPDIRECTUV: number;
  115414. METALLICWORKFLOW: boolean;
  115415. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  115416. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  115417. METALLNESSSTOREINMETALMAPBLUE: boolean;
  115418. AOSTOREINMETALMAPRED: boolean;
  115419. ENVIRONMENTBRDF: boolean;
  115420. ENVIRONMENTBRDF_RGBD: boolean;
  115421. NORMAL: boolean;
  115422. TANGENT: boolean;
  115423. BUMP: boolean;
  115424. BUMPDIRECTUV: number;
  115425. OBJECTSPACE_NORMALMAP: boolean;
  115426. PARALLAX: boolean;
  115427. PARALLAXOCCLUSION: boolean;
  115428. NORMALXYSCALE: boolean;
  115429. LIGHTMAP: boolean;
  115430. LIGHTMAPDIRECTUV: number;
  115431. USELIGHTMAPASSHADOWMAP: boolean;
  115432. GAMMALIGHTMAP: boolean;
  115433. RGBDLIGHTMAP: boolean;
  115434. REFLECTION: boolean;
  115435. REFLECTIONMAP_3D: boolean;
  115436. REFLECTIONMAP_SPHERICAL: boolean;
  115437. REFLECTIONMAP_PLANAR: boolean;
  115438. REFLECTIONMAP_CUBIC: boolean;
  115439. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  115440. REFLECTIONMAP_PROJECTION: boolean;
  115441. REFLECTIONMAP_SKYBOX: boolean;
  115442. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  115443. REFLECTIONMAP_EXPLICIT: boolean;
  115444. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  115445. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  115446. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  115447. INVERTCUBICMAP: boolean;
  115448. USESPHERICALFROMREFLECTIONMAP: boolean;
  115449. USEIRRADIANCEMAP: boolean;
  115450. SPHERICAL_HARMONICS: boolean;
  115451. USESPHERICALINVERTEX: boolean;
  115452. REFLECTIONMAP_OPPOSITEZ: boolean;
  115453. LODINREFLECTIONALPHA: boolean;
  115454. GAMMAREFLECTION: boolean;
  115455. RGBDREFLECTION: boolean;
  115456. LINEARSPECULARREFLECTION: boolean;
  115457. RADIANCEOCCLUSION: boolean;
  115458. HORIZONOCCLUSION: boolean;
  115459. INSTANCES: boolean;
  115460. NUM_BONE_INFLUENCERS: number;
  115461. BonesPerMesh: number;
  115462. BONETEXTURE: boolean;
  115463. NONUNIFORMSCALING: boolean;
  115464. MORPHTARGETS: boolean;
  115465. MORPHTARGETS_NORMAL: boolean;
  115466. MORPHTARGETS_TANGENT: boolean;
  115467. MORPHTARGETS_UV: boolean;
  115468. NUM_MORPH_INFLUENCERS: number;
  115469. IMAGEPROCESSING: boolean;
  115470. VIGNETTE: boolean;
  115471. VIGNETTEBLENDMODEMULTIPLY: boolean;
  115472. VIGNETTEBLENDMODEOPAQUE: boolean;
  115473. TONEMAPPING: boolean;
  115474. TONEMAPPING_ACES: boolean;
  115475. CONTRAST: boolean;
  115476. COLORCURVES: boolean;
  115477. COLORGRADING: boolean;
  115478. COLORGRADING3D: boolean;
  115479. SAMPLER3DGREENDEPTH: boolean;
  115480. SAMPLER3DBGRMAP: boolean;
  115481. IMAGEPROCESSINGPOSTPROCESS: boolean;
  115482. EXPOSURE: boolean;
  115483. MULTIVIEW: boolean;
  115484. USEPHYSICALLIGHTFALLOFF: boolean;
  115485. USEGLTFLIGHTFALLOFF: boolean;
  115486. TWOSIDEDLIGHTING: boolean;
  115487. SHADOWFLOAT: boolean;
  115488. CLIPPLANE: boolean;
  115489. CLIPPLANE2: boolean;
  115490. CLIPPLANE3: boolean;
  115491. CLIPPLANE4: boolean;
  115492. POINTSIZE: boolean;
  115493. FOG: boolean;
  115494. LOGARITHMICDEPTH: boolean;
  115495. FORCENORMALFORWARD: boolean;
  115496. SPECULARAA: boolean;
  115497. CLEARCOAT: boolean;
  115498. CLEARCOAT_DEFAULTIOR: boolean;
  115499. CLEARCOAT_TEXTURE: boolean;
  115500. CLEARCOAT_TEXTUREDIRECTUV: number;
  115501. CLEARCOAT_BUMP: boolean;
  115502. CLEARCOAT_BUMPDIRECTUV: number;
  115503. CLEARCOAT_TINT: boolean;
  115504. CLEARCOAT_TINT_TEXTURE: boolean;
  115505. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  115506. ANISOTROPIC: boolean;
  115507. ANISOTROPIC_TEXTURE: boolean;
  115508. ANISOTROPIC_TEXTUREDIRECTUV: number;
  115509. BRDF_V_HEIGHT_CORRELATED: boolean;
  115510. MS_BRDF_ENERGY_CONSERVATION: boolean;
  115511. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  115512. SHEEN: boolean;
  115513. SHEEN_TEXTURE: boolean;
  115514. SHEEN_TEXTUREDIRECTUV: number;
  115515. SHEEN_LINKWITHALBEDO: boolean;
  115516. SUBSURFACE: boolean;
  115517. SS_REFRACTION: boolean;
  115518. SS_TRANSLUCENCY: boolean;
  115519. SS_SCATERRING: boolean;
  115520. SS_THICKNESSANDMASK_TEXTURE: boolean;
  115521. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  115522. SS_REFRACTIONMAP_3D: boolean;
  115523. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  115524. SS_LODINREFRACTIONALPHA: boolean;
  115525. SS_GAMMAREFRACTION: boolean;
  115526. SS_RGBDREFRACTION: boolean;
  115527. SS_LINEARSPECULARREFRACTION: boolean;
  115528. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  115529. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  115530. UNLIT: boolean;
  115531. DEBUGMODE: number;
  115532. /**
  115533. * Initializes the PBR Material defines.
  115534. */
  115535. constructor();
  115536. /**
  115537. * Resets the PBR Material defines.
  115538. */
  115539. reset(): void;
  115540. }
  115541. /**
  115542. * The Physically based material base class of BJS.
  115543. *
  115544. * This offers the main features of a standard PBR material.
  115545. * For more information, please refer to the documentation :
  115546. * https://doc.babylonjs.com/how_to/physically_based_rendering
  115547. */
  115548. export abstract class PBRBaseMaterial extends PushMaterial {
  115549. /**
  115550. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  115551. */
  115552. static readonly PBRMATERIAL_OPAQUE: number;
  115553. /**
  115554. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  115555. */
  115556. static readonly PBRMATERIAL_ALPHATEST: number;
  115557. /**
  115558. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  115559. */
  115560. static readonly PBRMATERIAL_ALPHABLEND: number;
  115561. /**
  115562. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  115563. * They are also discarded below the alpha cutoff threshold to improve performances.
  115564. */
  115565. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  115566. /**
  115567. * Defines the default value of how much AO map is occluding the analytical lights
  115568. * (point spot...).
  115569. */
  115570. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  115571. /**
  115572. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  115573. */
  115574. static readonly LIGHTFALLOFF_PHYSICAL: number;
  115575. /**
  115576. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  115577. * to enhance interoperability with other engines.
  115578. */
  115579. static readonly LIGHTFALLOFF_GLTF: number;
  115580. /**
  115581. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  115582. * to enhance interoperability with other materials.
  115583. */
  115584. static readonly LIGHTFALLOFF_STANDARD: number;
  115585. /**
  115586. * Intensity of the direct lights e.g. the four lights available in your scene.
  115587. * This impacts both the direct diffuse and specular highlights.
  115588. */
  115589. protected _directIntensity: number;
  115590. /**
  115591. * Intensity of the emissive part of the material.
  115592. * This helps controlling the emissive effect without modifying the emissive color.
  115593. */
  115594. protected _emissiveIntensity: number;
  115595. /**
  115596. * Intensity of the environment e.g. how much the environment will light the object
  115597. * either through harmonics for rough material or through the refelction for shiny ones.
  115598. */
  115599. protected _environmentIntensity: number;
  115600. /**
  115601. * This is a special control allowing the reduction of the specular highlights coming from the
  115602. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  115603. */
  115604. protected _specularIntensity: number;
  115605. /**
  115606. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  115607. */
  115608. private _lightingInfos;
  115609. /**
  115610. * Debug Control allowing disabling the bump map on this material.
  115611. */
  115612. protected _disableBumpMap: boolean;
  115613. /**
  115614. * AKA Diffuse Texture in standard nomenclature.
  115615. */
  115616. protected _albedoTexture: Nullable<BaseTexture>;
  115617. /**
  115618. * AKA Occlusion Texture in other nomenclature.
  115619. */
  115620. protected _ambientTexture: Nullable<BaseTexture>;
  115621. /**
  115622. * AKA Occlusion Texture Intensity in other nomenclature.
  115623. */
  115624. protected _ambientTextureStrength: number;
  115625. /**
  115626. * Defines how much the AO map is occluding the analytical lights (point spot...).
  115627. * 1 means it completely occludes it
  115628. * 0 mean it has no impact
  115629. */
  115630. protected _ambientTextureImpactOnAnalyticalLights: number;
  115631. /**
  115632. * Stores the alpha values in a texture.
  115633. */
  115634. protected _opacityTexture: Nullable<BaseTexture>;
  115635. /**
  115636. * Stores the reflection values in a texture.
  115637. */
  115638. protected _reflectionTexture: Nullable<BaseTexture>;
  115639. /**
  115640. * Stores the emissive values in a texture.
  115641. */
  115642. protected _emissiveTexture: Nullable<BaseTexture>;
  115643. /**
  115644. * AKA Specular texture in other nomenclature.
  115645. */
  115646. protected _reflectivityTexture: Nullable<BaseTexture>;
  115647. /**
  115648. * Used to switch from specular/glossiness to metallic/roughness workflow.
  115649. */
  115650. protected _metallicTexture: Nullable<BaseTexture>;
  115651. /**
  115652. * Specifies the metallic scalar of the metallic/roughness workflow.
  115653. * Can also be used to scale the metalness values of the metallic texture.
  115654. */
  115655. protected _metallic: Nullable<number>;
  115656. /**
  115657. * Specifies the roughness scalar of the metallic/roughness workflow.
  115658. * Can also be used to scale the roughness values of the metallic texture.
  115659. */
  115660. protected _roughness: Nullable<number>;
  115661. /**
  115662. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  115663. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  115664. */
  115665. protected _microSurfaceTexture: Nullable<BaseTexture>;
  115666. /**
  115667. * Stores surface normal data used to displace a mesh in a texture.
  115668. */
  115669. protected _bumpTexture: Nullable<BaseTexture>;
  115670. /**
  115671. * Stores the pre-calculated light information of a mesh in a texture.
  115672. */
  115673. protected _lightmapTexture: Nullable<BaseTexture>;
  115674. /**
  115675. * The color of a material in ambient lighting.
  115676. */
  115677. protected _ambientColor: Color3;
  115678. /**
  115679. * AKA Diffuse Color in other nomenclature.
  115680. */
  115681. protected _albedoColor: Color3;
  115682. /**
  115683. * AKA Specular Color in other nomenclature.
  115684. */
  115685. protected _reflectivityColor: Color3;
  115686. /**
  115687. * The color applied when light is reflected from a material.
  115688. */
  115689. protected _reflectionColor: Color3;
  115690. /**
  115691. * The color applied when light is emitted from a material.
  115692. */
  115693. protected _emissiveColor: Color3;
  115694. /**
  115695. * AKA Glossiness in other nomenclature.
  115696. */
  115697. protected _microSurface: number;
  115698. /**
  115699. * Specifies that the material will use the light map as a show map.
  115700. */
  115701. protected _useLightmapAsShadowmap: boolean;
  115702. /**
  115703. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  115704. * makes the reflect vector face the model (under horizon).
  115705. */
  115706. protected _useHorizonOcclusion: boolean;
  115707. /**
  115708. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  115709. * too much the area relying on ambient texture to define their ambient occlusion.
  115710. */
  115711. protected _useRadianceOcclusion: boolean;
  115712. /**
  115713. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  115714. */
  115715. protected _useAlphaFromAlbedoTexture: boolean;
  115716. /**
  115717. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  115718. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  115719. */
  115720. protected _useSpecularOverAlpha: boolean;
  115721. /**
  115722. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  115723. */
  115724. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  115725. /**
  115726. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  115727. */
  115728. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  115729. /**
  115730. * Specifies if the metallic texture contains the roughness information in its green channel.
  115731. */
  115732. protected _useRoughnessFromMetallicTextureGreen: boolean;
  115733. /**
  115734. * Specifies if the metallic texture contains the metallness information in its blue channel.
  115735. */
  115736. protected _useMetallnessFromMetallicTextureBlue: boolean;
  115737. /**
  115738. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  115739. */
  115740. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  115741. /**
  115742. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  115743. */
  115744. protected _useAmbientInGrayScale: boolean;
  115745. /**
  115746. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  115747. * The material will try to infer what glossiness each pixel should be.
  115748. */
  115749. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  115750. /**
  115751. * Defines the falloff type used in this material.
  115752. * It by default is Physical.
  115753. */
  115754. protected _lightFalloff: number;
  115755. /**
  115756. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  115757. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  115758. */
  115759. protected _useRadianceOverAlpha: boolean;
  115760. /**
  115761. * Allows using an object space normal map (instead of tangent space).
  115762. */
  115763. protected _useObjectSpaceNormalMap: boolean;
  115764. /**
  115765. * Allows using the bump map in parallax mode.
  115766. */
  115767. protected _useParallax: boolean;
  115768. /**
  115769. * Allows using the bump map in parallax occlusion mode.
  115770. */
  115771. protected _useParallaxOcclusion: boolean;
  115772. /**
  115773. * Controls the scale bias of the parallax mode.
  115774. */
  115775. protected _parallaxScaleBias: number;
  115776. /**
  115777. * If sets to true, disables all the lights affecting the material.
  115778. */
  115779. protected _disableLighting: boolean;
  115780. /**
  115781. * Number of Simultaneous lights allowed on the material.
  115782. */
  115783. protected _maxSimultaneousLights: number;
  115784. /**
  115785. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  115786. */
  115787. protected _invertNormalMapX: boolean;
  115788. /**
  115789. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  115790. */
  115791. protected _invertNormalMapY: boolean;
  115792. /**
  115793. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  115794. */
  115795. protected _twoSidedLighting: boolean;
  115796. /**
  115797. * Defines the alpha limits in alpha test mode.
  115798. */
  115799. protected _alphaCutOff: number;
  115800. /**
  115801. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  115802. */
  115803. protected _forceAlphaTest: boolean;
  115804. /**
  115805. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  115806. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  115807. */
  115808. protected _useAlphaFresnel: boolean;
  115809. /**
  115810. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  115811. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  115812. */
  115813. protected _useLinearAlphaFresnel: boolean;
  115814. /**
  115815. * The transparency mode of the material.
  115816. */
  115817. protected _transparencyMode: Nullable<number>;
  115818. /**
  115819. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  115820. * from cos thetav and roughness:
  115821. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  115822. */
  115823. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  115824. /**
  115825. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  115826. */
  115827. protected _forceIrradianceInFragment: boolean;
  115828. /**
  115829. * Force normal to face away from face.
  115830. */
  115831. protected _forceNormalForward: boolean;
  115832. /**
  115833. * Enables specular anti aliasing in the PBR shader.
  115834. * It will both interacts on the Geometry for analytical and IBL lighting.
  115835. * It also prefilter the roughness map based on the bump values.
  115836. */
  115837. protected _enableSpecularAntiAliasing: boolean;
  115838. /**
  115839. * Default configuration related to image processing available in the PBR Material.
  115840. */
  115841. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  115842. /**
  115843. * Keep track of the image processing observer to allow dispose and replace.
  115844. */
  115845. private _imageProcessingObserver;
  115846. /**
  115847. * Attaches a new image processing configuration to the PBR Material.
  115848. * @param configuration
  115849. */
  115850. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  115851. /**
  115852. * Stores the available render targets.
  115853. */
  115854. private _renderTargets;
  115855. /**
  115856. * Sets the global ambient color for the material used in lighting calculations.
  115857. */
  115858. private _globalAmbientColor;
  115859. /**
  115860. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  115861. */
  115862. private _useLogarithmicDepth;
  115863. /**
  115864. * If set to true, no lighting calculations will be applied.
  115865. */
  115866. private _unlit;
  115867. private _debugMode;
  115868. /**
  115869. * @hidden
  115870. * This is reserved for the inspector.
  115871. * Defines the material debug mode.
  115872. * It helps seeing only some components of the material while troubleshooting.
  115873. */
  115874. debugMode: number;
  115875. /**
  115876. * @hidden
  115877. * This is reserved for the inspector.
  115878. * Specify from where on screen the debug mode should start.
  115879. * The value goes from -1 (full screen) to 1 (not visible)
  115880. * It helps with side by side comparison against the final render
  115881. * This defaults to -1
  115882. */
  115883. private debugLimit;
  115884. /**
  115885. * @hidden
  115886. * This is reserved for the inspector.
  115887. * As the default viewing range might not be enough (if the ambient is really small for instance)
  115888. * You can use the factor to better multiply the final value.
  115889. */
  115890. private debugFactor;
  115891. /**
  115892. * Defines the clear coat layer parameters for the material.
  115893. */
  115894. readonly clearCoat: PBRClearCoatConfiguration;
  115895. /**
  115896. * Defines the anisotropic parameters for the material.
  115897. */
  115898. readonly anisotropy: PBRAnisotropicConfiguration;
  115899. /**
  115900. * Defines the BRDF parameters for the material.
  115901. */
  115902. readonly brdf: PBRBRDFConfiguration;
  115903. /**
  115904. * Defines the Sheen parameters for the material.
  115905. */
  115906. readonly sheen: PBRSheenConfiguration;
  115907. /**
  115908. * Defines the SubSurface parameters for the material.
  115909. */
  115910. readonly subSurface: PBRSubSurfaceConfiguration;
  115911. /**
  115912. * Custom callback helping to override the default shader used in the material.
  115913. */
  115914. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: PBRMaterialDefines) => string;
  115915. protected _rebuildInParallel: boolean;
  115916. /**
  115917. * Instantiates a new PBRMaterial instance.
  115918. *
  115919. * @param name The material name
  115920. * @param scene The scene the material will be use in.
  115921. */
  115922. constructor(name: string, scene: Scene);
  115923. /**
  115924. * Gets a boolean indicating that current material needs to register RTT
  115925. */
  115926. readonly hasRenderTargetTextures: boolean;
  115927. /**
  115928. * Gets the name of the material class.
  115929. */
  115930. getClassName(): string;
  115931. /**
  115932. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  115933. */
  115934. /**
  115935. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  115936. */
  115937. useLogarithmicDepth: boolean;
  115938. /**
  115939. * Gets the current transparency mode.
  115940. */
  115941. /**
  115942. * Sets the transparency mode of the material.
  115943. *
  115944. * | Value | Type | Description |
  115945. * | ----- | ----------------------------------- | ----------- |
  115946. * | 0 | OPAQUE | |
  115947. * | 1 | ALPHATEST | |
  115948. * | 2 | ALPHABLEND | |
  115949. * | 3 | ALPHATESTANDBLEND | |
  115950. *
  115951. */
  115952. transparencyMode: Nullable<number>;
  115953. /**
  115954. * Returns true if alpha blending should be disabled.
  115955. */
  115956. private readonly _disableAlphaBlending;
  115957. /**
  115958. * Specifies whether or not this material should be rendered in alpha blend mode.
  115959. */
  115960. needAlphaBlending(): boolean;
  115961. /**
  115962. * Specifies if the mesh will require alpha blending.
  115963. * @param mesh - BJS mesh.
  115964. */
  115965. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  115966. /**
  115967. * Specifies whether or not this material should be rendered in alpha test mode.
  115968. */
  115969. needAlphaTesting(): boolean;
  115970. /**
  115971. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  115972. */
  115973. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  115974. /**
  115975. * Gets the texture used for the alpha test.
  115976. */
  115977. getAlphaTestTexture(): Nullable<BaseTexture>;
  115978. /**
  115979. * Specifies that the submesh is ready to be used.
  115980. * @param mesh - BJS mesh.
  115981. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  115982. * @param useInstances - Specifies that instances should be used.
  115983. * @returns - boolean indicating that the submesh is ready or not.
  115984. */
  115985. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  115986. /**
  115987. * Specifies if the material uses metallic roughness workflow.
  115988. * @returns boolean specifiying if the material uses metallic roughness workflow.
  115989. */
  115990. isMetallicWorkflow(): boolean;
  115991. private _prepareEffect;
  115992. private _prepareDefines;
  115993. /**
  115994. * Force shader compilation
  115995. */
  115996. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  115997. /**
  115998. * Initializes the uniform buffer layout for the shader.
  115999. */
  116000. buildUniformLayout(): void;
  116001. /**
  116002. * Unbinds the material from the mesh
  116003. */
  116004. unbind(): void;
  116005. /**
  116006. * Binds the submesh data.
  116007. * @param world - The world matrix.
  116008. * @param mesh - The BJS mesh.
  116009. * @param subMesh - A submesh of the BJS mesh.
  116010. */
  116011. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  116012. /**
  116013. * Returns the animatable textures.
  116014. * @returns - Array of animatable textures.
  116015. */
  116016. getAnimatables(): IAnimatable[];
  116017. /**
  116018. * Returns the texture used for reflections.
  116019. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  116020. */
  116021. private _getReflectionTexture;
  116022. /**
  116023. * Returns an array of the actively used textures.
  116024. * @returns - Array of BaseTextures
  116025. */
  116026. getActiveTextures(): BaseTexture[];
  116027. /**
  116028. * Checks to see if a texture is used in the material.
  116029. * @param texture - Base texture to use.
  116030. * @returns - Boolean specifying if a texture is used in the material.
  116031. */
  116032. hasTexture(texture: BaseTexture): boolean;
  116033. /**
  116034. * Disposes the resources of the material.
  116035. * @param forceDisposeEffect - Forces the disposal of effects.
  116036. * @param forceDisposeTextures - Forces the disposal of all textures.
  116037. */
  116038. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  116039. }
  116040. }
  116041. declare module BABYLON {
  116042. /**
  116043. * The Physically based material of BJS.
  116044. *
  116045. * This offers the main features of a standard PBR material.
  116046. * For more information, please refer to the documentation :
  116047. * https://doc.babylonjs.com/how_to/physically_based_rendering
  116048. */
  116049. export class PBRMaterial extends PBRBaseMaterial {
  116050. /**
  116051. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  116052. */
  116053. static readonly PBRMATERIAL_OPAQUE: number;
  116054. /**
  116055. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  116056. */
  116057. static readonly PBRMATERIAL_ALPHATEST: number;
  116058. /**
  116059. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  116060. */
  116061. static readonly PBRMATERIAL_ALPHABLEND: number;
  116062. /**
  116063. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  116064. * They are also discarded below the alpha cutoff threshold to improve performances.
  116065. */
  116066. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  116067. /**
  116068. * Defines the default value of how much AO map is occluding the analytical lights
  116069. * (point spot...).
  116070. */
  116071. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  116072. /**
  116073. * Intensity of the direct lights e.g. the four lights available in your scene.
  116074. * This impacts both the direct diffuse and specular highlights.
  116075. */
  116076. directIntensity: number;
  116077. /**
  116078. * Intensity of the emissive part of the material.
  116079. * This helps controlling the emissive effect without modifying the emissive color.
  116080. */
  116081. emissiveIntensity: number;
  116082. /**
  116083. * Intensity of the environment e.g. how much the environment will light the object
  116084. * either through harmonics for rough material or through the refelction for shiny ones.
  116085. */
  116086. environmentIntensity: number;
  116087. /**
  116088. * This is a special control allowing the reduction of the specular highlights coming from the
  116089. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  116090. */
  116091. specularIntensity: number;
  116092. /**
  116093. * Debug Control allowing disabling the bump map on this material.
  116094. */
  116095. disableBumpMap: boolean;
  116096. /**
  116097. * AKA Diffuse Texture in standard nomenclature.
  116098. */
  116099. albedoTexture: BaseTexture;
  116100. /**
  116101. * AKA Occlusion Texture in other nomenclature.
  116102. */
  116103. ambientTexture: BaseTexture;
  116104. /**
  116105. * AKA Occlusion Texture Intensity in other nomenclature.
  116106. */
  116107. ambientTextureStrength: number;
  116108. /**
  116109. * Defines how much the AO map is occluding the analytical lights (point spot...).
  116110. * 1 means it completely occludes it
  116111. * 0 mean it has no impact
  116112. */
  116113. ambientTextureImpactOnAnalyticalLights: number;
  116114. /**
  116115. * Stores the alpha values in a texture.
  116116. */
  116117. opacityTexture: BaseTexture;
  116118. /**
  116119. * Stores the reflection values in a texture.
  116120. */
  116121. reflectionTexture: Nullable<BaseTexture>;
  116122. /**
  116123. * Stores the emissive values in a texture.
  116124. */
  116125. emissiveTexture: BaseTexture;
  116126. /**
  116127. * AKA Specular texture in other nomenclature.
  116128. */
  116129. reflectivityTexture: BaseTexture;
  116130. /**
  116131. * Used to switch from specular/glossiness to metallic/roughness workflow.
  116132. */
  116133. metallicTexture: BaseTexture;
  116134. /**
  116135. * Specifies the metallic scalar of the metallic/roughness workflow.
  116136. * Can also be used to scale the metalness values of the metallic texture.
  116137. */
  116138. metallic: Nullable<number>;
  116139. /**
  116140. * Specifies the roughness scalar of the metallic/roughness workflow.
  116141. * Can also be used to scale the roughness values of the metallic texture.
  116142. */
  116143. roughness: Nullable<number>;
  116144. /**
  116145. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  116146. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  116147. */
  116148. microSurfaceTexture: BaseTexture;
  116149. /**
  116150. * Stores surface normal data used to displace a mesh in a texture.
  116151. */
  116152. bumpTexture: BaseTexture;
  116153. /**
  116154. * Stores the pre-calculated light information of a mesh in a texture.
  116155. */
  116156. lightmapTexture: BaseTexture;
  116157. /**
  116158. * Stores the refracted light information in a texture.
  116159. */
  116160. refractionTexture: Nullable<BaseTexture>;
  116161. /**
  116162. * The color of a material in ambient lighting.
  116163. */
  116164. ambientColor: Color3;
  116165. /**
  116166. * AKA Diffuse Color in other nomenclature.
  116167. */
  116168. albedoColor: Color3;
  116169. /**
  116170. * AKA Specular Color in other nomenclature.
  116171. */
  116172. reflectivityColor: Color3;
  116173. /**
  116174. * The color reflected from the material.
  116175. */
  116176. reflectionColor: Color3;
  116177. /**
  116178. * The color emitted from the material.
  116179. */
  116180. emissiveColor: Color3;
  116181. /**
  116182. * AKA Glossiness in other nomenclature.
  116183. */
  116184. microSurface: number;
  116185. /**
  116186. * source material index of refraction (IOR)' / 'destination material IOR.
  116187. */
  116188. indexOfRefraction: number;
  116189. /**
  116190. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  116191. */
  116192. invertRefractionY: boolean;
  116193. /**
  116194. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  116195. * Materials half opaque for instance using refraction could benefit from this control.
  116196. */
  116197. linkRefractionWithTransparency: boolean;
  116198. /**
  116199. * If true, the light map contains occlusion information instead of lighting info.
  116200. */
  116201. useLightmapAsShadowmap: boolean;
  116202. /**
  116203. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  116204. */
  116205. useAlphaFromAlbedoTexture: boolean;
  116206. /**
  116207. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  116208. */
  116209. forceAlphaTest: boolean;
  116210. /**
  116211. * Defines the alpha limits in alpha test mode.
  116212. */
  116213. alphaCutOff: number;
  116214. /**
  116215. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  116216. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  116217. */
  116218. useSpecularOverAlpha: boolean;
  116219. /**
  116220. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  116221. */
  116222. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  116223. /**
  116224. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  116225. */
  116226. useRoughnessFromMetallicTextureAlpha: boolean;
  116227. /**
  116228. * Specifies if the metallic texture contains the roughness information in its green channel.
  116229. */
  116230. useRoughnessFromMetallicTextureGreen: boolean;
  116231. /**
  116232. * Specifies if the metallic texture contains the metallness information in its blue channel.
  116233. */
  116234. useMetallnessFromMetallicTextureBlue: boolean;
  116235. /**
  116236. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  116237. */
  116238. useAmbientOcclusionFromMetallicTextureRed: boolean;
  116239. /**
  116240. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  116241. */
  116242. useAmbientInGrayScale: boolean;
  116243. /**
  116244. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  116245. * The material will try to infer what glossiness each pixel should be.
  116246. */
  116247. useAutoMicroSurfaceFromReflectivityMap: boolean;
  116248. /**
  116249. * BJS is using an harcoded light falloff based on a manually sets up range.
  116250. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  116251. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  116252. */
  116253. /**
  116254. * BJS is using an harcoded light falloff based on a manually sets up range.
  116255. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  116256. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  116257. */
  116258. usePhysicalLightFalloff: boolean;
  116259. /**
  116260. * In order to support the falloff compatibility with gltf, a special mode has been added
  116261. * to reproduce the gltf light falloff.
  116262. */
  116263. /**
  116264. * In order to support the falloff compatibility with gltf, a special mode has been added
  116265. * to reproduce the gltf light falloff.
  116266. */
  116267. useGLTFLightFalloff: boolean;
  116268. /**
  116269. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  116270. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  116271. */
  116272. useRadianceOverAlpha: boolean;
  116273. /**
  116274. * Allows using an object space normal map (instead of tangent space).
  116275. */
  116276. useObjectSpaceNormalMap: boolean;
  116277. /**
  116278. * Allows using the bump map in parallax mode.
  116279. */
  116280. useParallax: boolean;
  116281. /**
  116282. * Allows using the bump map in parallax occlusion mode.
  116283. */
  116284. useParallaxOcclusion: boolean;
  116285. /**
  116286. * Controls the scale bias of the parallax mode.
  116287. */
  116288. parallaxScaleBias: number;
  116289. /**
  116290. * If sets to true, disables all the lights affecting the material.
  116291. */
  116292. disableLighting: boolean;
  116293. /**
  116294. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  116295. */
  116296. forceIrradianceInFragment: boolean;
  116297. /**
  116298. * Number of Simultaneous lights allowed on the material.
  116299. */
  116300. maxSimultaneousLights: number;
  116301. /**
  116302. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  116303. */
  116304. invertNormalMapX: boolean;
  116305. /**
  116306. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  116307. */
  116308. invertNormalMapY: boolean;
  116309. /**
  116310. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  116311. */
  116312. twoSidedLighting: boolean;
  116313. /**
  116314. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  116315. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  116316. */
  116317. useAlphaFresnel: boolean;
  116318. /**
  116319. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  116320. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  116321. */
  116322. useLinearAlphaFresnel: boolean;
  116323. /**
  116324. * Let user defines the brdf lookup texture used for IBL.
  116325. * A default 8bit version is embedded but you could point at :
  116326. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  116327. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  116328. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  116329. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  116330. */
  116331. environmentBRDFTexture: Nullable<BaseTexture>;
  116332. /**
  116333. * Force normal to face away from face.
  116334. */
  116335. forceNormalForward: boolean;
  116336. /**
  116337. * Enables specular anti aliasing in the PBR shader.
  116338. * It will both interacts on the Geometry for analytical and IBL lighting.
  116339. * It also prefilter the roughness map based on the bump values.
  116340. */
  116341. enableSpecularAntiAliasing: boolean;
  116342. /**
  116343. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  116344. * makes the reflect vector face the model (under horizon).
  116345. */
  116346. useHorizonOcclusion: boolean;
  116347. /**
  116348. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  116349. * too much the area relying on ambient texture to define their ambient occlusion.
  116350. */
  116351. useRadianceOcclusion: boolean;
  116352. /**
  116353. * If set to true, no lighting calculations will be applied.
  116354. */
  116355. unlit: boolean;
  116356. /**
  116357. * Gets the image processing configuration used either in this material.
  116358. */
  116359. /**
  116360. * Sets the Default image processing configuration used either in the this material.
  116361. *
  116362. * If sets to null, the scene one is in use.
  116363. */
  116364. imageProcessingConfiguration: ImageProcessingConfiguration;
  116365. /**
  116366. * Gets wether the color curves effect is enabled.
  116367. */
  116368. /**
  116369. * Sets wether the color curves effect is enabled.
  116370. */
  116371. cameraColorCurvesEnabled: boolean;
  116372. /**
  116373. * Gets wether the color grading effect is enabled.
  116374. */
  116375. /**
  116376. * Gets wether the color grading effect is enabled.
  116377. */
  116378. cameraColorGradingEnabled: boolean;
  116379. /**
  116380. * Gets wether tonemapping is enabled or not.
  116381. */
  116382. /**
  116383. * Sets wether tonemapping is enabled or not
  116384. */
  116385. cameraToneMappingEnabled: boolean;
  116386. /**
  116387. * The camera exposure used on this material.
  116388. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  116389. * This corresponds to a photographic exposure.
  116390. */
  116391. /**
  116392. * The camera exposure used on this material.
  116393. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  116394. * This corresponds to a photographic exposure.
  116395. */
  116396. cameraExposure: number;
  116397. /**
  116398. * Gets The camera contrast used on this material.
  116399. */
  116400. /**
  116401. * Sets The camera contrast used on this material.
  116402. */
  116403. cameraContrast: number;
  116404. /**
  116405. * Gets the Color Grading 2D Lookup Texture.
  116406. */
  116407. /**
  116408. * Sets the Color Grading 2D Lookup Texture.
  116409. */
  116410. cameraColorGradingTexture: Nullable<BaseTexture>;
  116411. /**
  116412. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  116413. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  116414. * 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;
  116415. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  116416. */
  116417. /**
  116418. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  116419. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  116420. * 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;
  116421. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  116422. */
  116423. cameraColorCurves: Nullable<ColorCurves>;
  116424. /**
  116425. * Instantiates a new PBRMaterial instance.
  116426. *
  116427. * @param name The material name
  116428. * @param scene The scene the material will be use in.
  116429. */
  116430. constructor(name: string, scene: Scene);
  116431. /**
  116432. * Returns the name of this material class.
  116433. */
  116434. getClassName(): string;
  116435. /**
  116436. * Makes a duplicate of the current material.
  116437. * @param name - name to use for the new material.
  116438. */
  116439. clone(name: string): PBRMaterial;
  116440. /**
  116441. * Serializes this PBR Material.
  116442. * @returns - An object with the serialized material.
  116443. */
  116444. serialize(): any;
  116445. /**
  116446. * Parses a PBR Material from a serialized object.
  116447. * @param source - Serialized object.
  116448. * @param scene - BJS scene instance.
  116449. * @param rootUrl - url for the scene object
  116450. * @returns - PBRMaterial
  116451. */
  116452. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  116453. }
  116454. }
  116455. declare module BABYLON {
  116456. /**
  116457. * Direct draw surface info
  116458. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  116459. */
  116460. export interface DDSInfo {
  116461. /**
  116462. * Width of the texture
  116463. */
  116464. width: number;
  116465. /**
  116466. * Width of the texture
  116467. */
  116468. height: number;
  116469. /**
  116470. * Number of Mipmaps for the texture
  116471. * @see https://en.wikipedia.org/wiki/Mipmap
  116472. */
  116473. mipmapCount: number;
  116474. /**
  116475. * If the textures format is a known fourCC format
  116476. * @see https://www.fourcc.org/
  116477. */
  116478. isFourCC: boolean;
  116479. /**
  116480. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  116481. */
  116482. isRGB: boolean;
  116483. /**
  116484. * If the texture is a lumincance format
  116485. */
  116486. isLuminance: boolean;
  116487. /**
  116488. * If this is a cube texture
  116489. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  116490. */
  116491. isCube: boolean;
  116492. /**
  116493. * If the texture is a compressed format eg. FOURCC_DXT1
  116494. */
  116495. isCompressed: boolean;
  116496. /**
  116497. * The dxgiFormat of the texture
  116498. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  116499. */
  116500. dxgiFormat: number;
  116501. /**
  116502. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  116503. */
  116504. textureType: number;
  116505. /**
  116506. * Sphericle polynomial created for the dds texture
  116507. */
  116508. sphericalPolynomial?: SphericalPolynomial;
  116509. }
  116510. /**
  116511. * Class used to provide DDS decompression tools
  116512. */
  116513. export class DDSTools {
  116514. /**
  116515. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  116516. */
  116517. static StoreLODInAlphaChannel: boolean;
  116518. /**
  116519. * Gets DDS information from an array buffer
  116520. * @param arrayBuffer defines the array buffer to read data from
  116521. * @returns the DDS information
  116522. */
  116523. static GetDDSInfo(arrayBuffer: any): DDSInfo;
  116524. private static _FloatView;
  116525. private static _Int32View;
  116526. private static _ToHalfFloat;
  116527. private static _FromHalfFloat;
  116528. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  116529. private static _GetHalfFloatRGBAArrayBuffer;
  116530. private static _GetFloatRGBAArrayBuffer;
  116531. private static _GetFloatAsUIntRGBAArrayBuffer;
  116532. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  116533. private static _GetRGBAArrayBuffer;
  116534. private static _ExtractLongWordOrder;
  116535. private static _GetRGBArrayBuffer;
  116536. private static _GetLuminanceArrayBuffer;
  116537. /**
  116538. * Uploads DDS Levels to a Babylon Texture
  116539. * @hidden
  116540. */
  116541. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, arrayBuffer: any, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  116542. }
  116543. interface ThinEngine {
  116544. /**
  116545. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  116546. * @param rootUrl defines the url where the file to load is located
  116547. * @param scene defines the current scene
  116548. * @param lodScale defines scale to apply to the mip map selection
  116549. * @param lodOffset defines offset to apply to the mip map selection
  116550. * @param onLoad defines an optional callback raised when the texture is loaded
  116551. * @param onError defines an optional callback raised if there is an issue to load the texture
  116552. * @param format defines the format of the data
  116553. * @param forcedExtension defines the extension to use to pick the right loader
  116554. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  116555. * @returns the cube texture as an InternalTexture
  116556. */
  116557. 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;
  116558. }
  116559. }
  116560. declare module BABYLON {
  116561. /**
  116562. * Implementation of the DDS Texture Loader.
  116563. * @hidden
  116564. */
  116565. export class _DDSTextureLoader implements IInternalTextureLoader {
  116566. /**
  116567. * Defines wether the loader supports cascade loading the different faces.
  116568. */
  116569. readonly supportCascades: boolean;
  116570. /**
  116571. * This returns if the loader support the current file information.
  116572. * @param extension defines the file extension of the file being loaded
  116573. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116574. * @param fallback defines the fallback internal texture if any
  116575. * @param isBase64 defines whether the texture is encoded as a base64
  116576. * @param isBuffer defines whether the texture data are stored as a buffer
  116577. * @returns true if the loader can load the specified file
  116578. */
  116579. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  116580. /**
  116581. * Transform the url before loading if required.
  116582. * @param rootUrl the url of the texture
  116583. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116584. * @returns the transformed texture
  116585. */
  116586. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  116587. /**
  116588. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  116589. * @param rootUrl the url of the texture
  116590. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116591. * @returns the fallback texture
  116592. */
  116593. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  116594. /**
  116595. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  116596. * @param data contains the texture data
  116597. * @param texture defines the BabylonJS internal texture
  116598. * @param createPolynomials will be true if polynomials have been requested
  116599. * @param onLoad defines the callback to trigger once the texture is ready
  116600. * @param onError defines the callback to trigger in case of error
  116601. */
  116602. loadCubeData(imgs: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  116603. /**
  116604. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  116605. * @param data contains the texture data
  116606. * @param texture defines the BabylonJS internal texture
  116607. * @param callback defines the method to call once ready to upload
  116608. */
  116609. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  116610. }
  116611. }
  116612. declare module BABYLON {
  116613. /**
  116614. * Implementation of the ENV Texture Loader.
  116615. * @hidden
  116616. */
  116617. export class _ENVTextureLoader implements IInternalTextureLoader {
  116618. /**
  116619. * Defines wether the loader supports cascade loading the different faces.
  116620. */
  116621. readonly supportCascades: boolean;
  116622. /**
  116623. * This returns if the loader support the current file information.
  116624. * @param extension defines the file extension of the file being loaded
  116625. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116626. * @param fallback defines the fallback internal texture if any
  116627. * @param isBase64 defines whether the texture is encoded as a base64
  116628. * @param isBuffer defines whether the texture data are stored as a buffer
  116629. * @returns true if the loader can load the specified file
  116630. */
  116631. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  116632. /**
  116633. * Transform the url before loading if required.
  116634. * @param rootUrl the url of the texture
  116635. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116636. * @returns the transformed texture
  116637. */
  116638. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  116639. /**
  116640. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  116641. * @param rootUrl the url of the texture
  116642. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116643. * @returns the fallback texture
  116644. */
  116645. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  116646. /**
  116647. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  116648. * @param data contains the texture data
  116649. * @param texture defines the BabylonJS internal texture
  116650. * @param createPolynomials will be true if polynomials have been requested
  116651. * @param onLoad defines the callback to trigger once the texture is ready
  116652. * @param onError defines the callback to trigger in case of error
  116653. */
  116654. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  116655. /**
  116656. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  116657. * @param data contains the texture data
  116658. * @param texture defines the BabylonJS internal texture
  116659. * @param callback defines the method to call once ready to upload
  116660. */
  116661. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  116662. }
  116663. }
  116664. declare module BABYLON {
  116665. /**
  116666. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  116667. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  116668. */
  116669. export class KhronosTextureContainer {
  116670. /** contents of the KTX container file */
  116671. arrayBuffer: any;
  116672. private static HEADER_LEN;
  116673. private static COMPRESSED_2D;
  116674. private static COMPRESSED_3D;
  116675. private static TEX_2D;
  116676. private static TEX_3D;
  116677. /**
  116678. * Gets the openGL type
  116679. */
  116680. glType: number;
  116681. /**
  116682. * Gets the openGL type size
  116683. */
  116684. glTypeSize: number;
  116685. /**
  116686. * Gets the openGL format
  116687. */
  116688. glFormat: number;
  116689. /**
  116690. * Gets the openGL internal format
  116691. */
  116692. glInternalFormat: number;
  116693. /**
  116694. * Gets the base internal format
  116695. */
  116696. glBaseInternalFormat: number;
  116697. /**
  116698. * Gets image width in pixel
  116699. */
  116700. pixelWidth: number;
  116701. /**
  116702. * Gets image height in pixel
  116703. */
  116704. pixelHeight: number;
  116705. /**
  116706. * Gets image depth in pixels
  116707. */
  116708. pixelDepth: number;
  116709. /**
  116710. * Gets the number of array elements
  116711. */
  116712. numberOfArrayElements: number;
  116713. /**
  116714. * Gets the number of faces
  116715. */
  116716. numberOfFaces: number;
  116717. /**
  116718. * Gets the number of mipmap levels
  116719. */
  116720. numberOfMipmapLevels: number;
  116721. /**
  116722. * Gets the bytes of key value data
  116723. */
  116724. bytesOfKeyValueData: number;
  116725. /**
  116726. * Gets the load type
  116727. */
  116728. loadType: number;
  116729. /**
  116730. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  116731. */
  116732. isInvalid: boolean;
  116733. /**
  116734. * Creates a new KhronosTextureContainer
  116735. * @param arrayBuffer contents of the KTX container file
  116736. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  116737. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  116738. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  116739. */
  116740. constructor(
  116741. /** contents of the KTX container file */
  116742. arrayBuffer: any, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  116743. /**
  116744. * Uploads KTX content to a Babylon Texture.
  116745. * It is assumed that the texture has already been created & is currently bound
  116746. * @hidden
  116747. */
  116748. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  116749. private _upload2DCompressedLevels;
  116750. }
  116751. }
  116752. declare module BABYLON {
  116753. /**
  116754. * Implementation of the KTX Texture Loader.
  116755. * @hidden
  116756. */
  116757. export class _KTXTextureLoader implements IInternalTextureLoader {
  116758. /**
  116759. * Defines wether the loader supports cascade loading the different faces.
  116760. */
  116761. readonly supportCascades: boolean;
  116762. /**
  116763. * This returns if the loader support the current file information.
  116764. * @param extension defines the file extension of the file being loaded
  116765. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116766. * @param fallback defines the fallback internal texture if any
  116767. * @param isBase64 defines whether the texture is encoded as a base64
  116768. * @param isBuffer defines whether the texture data are stored as a buffer
  116769. * @returns true if the loader can load the specified file
  116770. */
  116771. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  116772. /**
  116773. * Transform the url before loading if required.
  116774. * @param rootUrl the url of the texture
  116775. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116776. * @returns the transformed texture
  116777. */
  116778. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  116779. /**
  116780. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  116781. * @param rootUrl the url of the texture
  116782. * @param textureFormatInUse defines the current compressed format in use iun the engine
  116783. * @returns the fallback texture
  116784. */
  116785. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  116786. /**
  116787. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  116788. * @param data contains the texture data
  116789. * @param texture defines the BabylonJS internal texture
  116790. * @param createPolynomials will be true if polynomials have been requested
  116791. * @param onLoad defines the callback to trigger once the texture is ready
  116792. * @param onError defines the callback to trigger in case of error
  116793. */
  116794. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  116795. /**
  116796. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  116797. * @param data contains the texture data
  116798. * @param texture defines the BabylonJS internal texture
  116799. * @param callback defines the method to call once ready to upload
  116800. */
  116801. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  116802. }
  116803. }
  116804. declare module BABYLON {
  116805. /**
  116806. * Options for the default xr helper
  116807. */
  116808. export class WebXRDefaultExperienceOptions {
  116809. /**
  116810. * Floor meshes that should be used for teleporting
  116811. */
  116812. floorMeshes: Array<AbstractMesh>;
  116813. /**
  116814. * Enable or disable default UI to enter XR
  116815. */
  116816. disableDefaultUI: boolean;
  116817. }
  116818. /**
  116819. * Default experience which provides a similar setup to the previous webVRExperience
  116820. */
  116821. export class WebXRDefaultExperience {
  116822. /**
  116823. * Base experience
  116824. */
  116825. baseExperience: WebXRExperienceHelper;
  116826. /**
  116827. * Input experience extension
  116828. */
  116829. input: WebXRInput;
  116830. /**
  116831. * Loads the controller models
  116832. */
  116833. controllerModelLoader: WebXRControllerModelLoader;
  116834. /**
  116835. * Enables laser pointer and selection
  116836. */
  116837. pointerSelection: WebXRControllerPointerSelection;
  116838. /**
  116839. * Enables teleportation
  116840. */
  116841. teleportation: WebXRControllerTeleportation;
  116842. /**
  116843. * Enables ui for enetering/exiting xr
  116844. */
  116845. enterExitUI: WebXREnterExitUI;
  116846. /**
  116847. * Default target xr should render to
  116848. */
  116849. renderTarget: WebXRRenderTarget;
  116850. /**
  116851. * Creates the default xr experience
  116852. * @param scene scene
  116853. * @param options options for basic configuration
  116854. * @returns resulting WebXRDefaultExperience
  116855. */
  116856. static CreateAsync(scene: Scene, options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  116857. private constructor();
  116858. /**
  116859. * DIsposes of the experience helper
  116860. */
  116861. dispose(): void;
  116862. }
  116863. }
  116864. declare module BABYLON {
  116865. /** @hidden */
  116866. export var _forceSceneHelpersToBundle: boolean;
  116867. interface Scene {
  116868. /**
  116869. * Creates a default light for the scene.
  116870. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  116871. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  116872. */
  116873. createDefaultLight(replace?: boolean): void;
  116874. /**
  116875. * Creates a default camera for the scene.
  116876. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  116877. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  116878. * @param replace has default false, when true replaces the active camera in the scene
  116879. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  116880. */
  116881. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  116882. /**
  116883. * Creates a default camera and a default light.
  116884. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  116885. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  116886. * @param replace has the default false, when true replaces the active camera/light in the scene
  116887. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  116888. */
  116889. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  116890. /**
  116891. * Creates a new sky box
  116892. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  116893. * @param environmentTexture defines the texture to use as environment texture
  116894. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  116895. * @param scale defines the overall scale of the skybox
  116896. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  116897. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  116898. * @returns a new mesh holding the sky box
  116899. */
  116900. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  116901. /**
  116902. * Creates a new environment
  116903. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  116904. * @param options defines the options you can use to configure the environment
  116905. * @returns the new EnvironmentHelper
  116906. */
  116907. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  116908. /**
  116909. * Creates a new VREXperienceHelper
  116910. * @see http://doc.babylonjs.com/how_to/webvr_helper
  116911. * @param webVROptions defines the options used to create the new VREXperienceHelper
  116912. * @returns a new VREXperienceHelper
  116913. */
  116914. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  116915. /**
  116916. * Creates a new WebXRDefaultExperience
  116917. * @see http://doc.babylonjs.com/how_to/webxr
  116918. * @param options experience options
  116919. * @returns a promise for a new WebXRDefaultExperience
  116920. */
  116921. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  116922. }
  116923. }
  116924. declare module BABYLON {
  116925. /**
  116926. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  116927. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  116928. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  116929. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  116930. */
  116931. export class VideoDome extends TransformNode {
  116932. /**
  116933. * Define the video source as a Monoscopic panoramic 360 video.
  116934. */
  116935. static readonly MODE_MONOSCOPIC: number;
  116936. /**
  116937. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  116938. */
  116939. static readonly MODE_TOPBOTTOM: number;
  116940. /**
  116941. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  116942. */
  116943. static readonly MODE_SIDEBYSIDE: number;
  116944. private _halfDome;
  116945. private _useDirectMapping;
  116946. /**
  116947. * The video texture being displayed on the sphere
  116948. */
  116949. protected _videoTexture: VideoTexture;
  116950. /**
  116951. * Gets the video texture being displayed on the sphere
  116952. */
  116953. readonly videoTexture: VideoTexture;
  116954. /**
  116955. * The skybox material
  116956. */
  116957. protected _material: BackgroundMaterial;
  116958. /**
  116959. * The surface used for the skybox
  116960. */
  116961. protected _mesh: Mesh;
  116962. /**
  116963. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  116964. */
  116965. private _halfDomeMask;
  116966. /**
  116967. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  116968. * Also see the options.resolution property.
  116969. */
  116970. fovMultiplier: number;
  116971. private _videoMode;
  116972. /**
  116973. * Gets or set the current video mode for the video. It can be:
  116974. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  116975. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  116976. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  116977. */
  116978. videoMode: number;
  116979. /**
  116980. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  116981. *
  116982. */
  116983. /**
  116984. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  116985. */
  116986. halfDome: boolean;
  116987. /**
  116988. * Oberserver used in Stereoscopic VR Mode.
  116989. */
  116990. private _onBeforeCameraRenderObserver;
  116991. /**
  116992. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  116993. * @param name Element's name, child elements will append suffixes for their own names.
  116994. * @param urlsOrVideo defines the url(s) or the video element to use
  116995. * @param options An object containing optional or exposed sub element properties
  116996. */
  116997. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  116998. resolution?: number;
  116999. clickToPlay?: boolean;
  117000. autoPlay?: boolean;
  117001. loop?: boolean;
  117002. size?: number;
  117003. poster?: string;
  117004. faceForward?: boolean;
  117005. useDirectMapping?: boolean;
  117006. halfDomeMode?: boolean;
  117007. }, scene: Scene);
  117008. private _changeVideoMode;
  117009. /**
  117010. * Releases resources associated with this node.
  117011. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  117012. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  117013. */
  117014. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  117015. }
  117016. }
  117017. declare module BABYLON {
  117018. /**
  117019. * This class can be used to get instrumentation data from a Babylon engine
  117020. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  117021. */
  117022. export class EngineInstrumentation implements IDisposable {
  117023. /**
  117024. * Define the instrumented engine.
  117025. */
  117026. engine: Engine;
  117027. private _captureGPUFrameTime;
  117028. private _gpuFrameTimeToken;
  117029. private _gpuFrameTime;
  117030. private _captureShaderCompilationTime;
  117031. private _shaderCompilationTime;
  117032. private _onBeginFrameObserver;
  117033. private _onEndFrameObserver;
  117034. private _onBeforeShaderCompilationObserver;
  117035. private _onAfterShaderCompilationObserver;
  117036. /**
  117037. * Gets the perf counter used for GPU frame time
  117038. */
  117039. readonly gpuFrameTimeCounter: PerfCounter;
  117040. /**
  117041. * Gets the GPU frame time capture status
  117042. */
  117043. /**
  117044. * Enable or disable the GPU frame time capture
  117045. */
  117046. captureGPUFrameTime: boolean;
  117047. /**
  117048. * Gets the perf counter used for shader compilation time
  117049. */
  117050. readonly shaderCompilationTimeCounter: PerfCounter;
  117051. /**
  117052. * Gets the shader compilation time capture status
  117053. */
  117054. /**
  117055. * Enable or disable the shader compilation time capture
  117056. */
  117057. captureShaderCompilationTime: boolean;
  117058. /**
  117059. * Instantiates a new engine instrumentation.
  117060. * This class can be used to get instrumentation data from a Babylon engine
  117061. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  117062. * @param engine Defines the engine to instrument
  117063. */
  117064. constructor(
  117065. /**
  117066. * Define the instrumented engine.
  117067. */
  117068. engine: Engine);
  117069. /**
  117070. * Dispose and release associated resources.
  117071. */
  117072. dispose(): void;
  117073. }
  117074. }
  117075. declare module BABYLON {
  117076. /**
  117077. * This class can be used to get instrumentation data from a Babylon engine
  117078. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  117079. */
  117080. export class SceneInstrumentation implements IDisposable {
  117081. /**
  117082. * Defines the scene to instrument
  117083. */
  117084. scene: Scene;
  117085. private _captureActiveMeshesEvaluationTime;
  117086. private _activeMeshesEvaluationTime;
  117087. private _captureRenderTargetsRenderTime;
  117088. private _renderTargetsRenderTime;
  117089. private _captureFrameTime;
  117090. private _frameTime;
  117091. private _captureRenderTime;
  117092. private _renderTime;
  117093. private _captureInterFrameTime;
  117094. private _interFrameTime;
  117095. private _captureParticlesRenderTime;
  117096. private _particlesRenderTime;
  117097. private _captureSpritesRenderTime;
  117098. private _spritesRenderTime;
  117099. private _capturePhysicsTime;
  117100. private _physicsTime;
  117101. private _captureAnimationsTime;
  117102. private _animationsTime;
  117103. private _captureCameraRenderTime;
  117104. private _cameraRenderTime;
  117105. private _onBeforeActiveMeshesEvaluationObserver;
  117106. private _onAfterActiveMeshesEvaluationObserver;
  117107. private _onBeforeRenderTargetsRenderObserver;
  117108. private _onAfterRenderTargetsRenderObserver;
  117109. private _onAfterRenderObserver;
  117110. private _onBeforeDrawPhaseObserver;
  117111. private _onAfterDrawPhaseObserver;
  117112. private _onBeforeAnimationsObserver;
  117113. private _onBeforeParticlesRenderingObserver;
  117114. private _onAfterParticlesRenderingObserver;
  117115. private _onBeforeSpritesRenderingObserver;
  117116. private _onAfterSpritesRenderingObserver;
  117117. private _onBeforePhysicsObserver;
  117118. private _onAfterPhysicsObserver;
  117119. private _onAfterAnimationsObserver;
  117120. private _onBeforeCameraRenderObserver;
  117121. private _onAfterCameraRenderObserver;
  117122. /**
  117123. * Gets the perf counter used for active meshes evaluation time
  117124. */
  117125. readonly activeMeshesEvaluationTimeCounter: PerfCounter;
  117126. /**
  117127. * Gets the active meshes evaluation time capture status
  117128. */
  117129. /**
  117130. * Enable or disable the active meshes evaluation time capture
  117131. */
  117132. captureActiveMeshesEvaluationTime: boolean;
  117133. /**
  117134. * Gets the perf counter used for render targets render time
  117135. */
  117136. readonly renderTargetsRenderTimeCounter: PerfCounter;
  117137. /**
  117138. * Gets the render targets render time capture status
  117139. */
  117140. /**
  117141. * Enable or disable the render targets render time capture
  117142. */
  117143. captureRenderTargetsRenderTime: boolean;
  117144. /**
  117145. * Gets the perf counter used for particles render time
  117146. */
  117147. readonly particlesRenderTimeCounter: PerfCounter;
  117148. /**
  117149. * Gets the particles render time capture status
  117150. */
  117151. /**
  117152. * Enable or disable the particles render time capture
  117153. */
  117154. captureParticlesRenderTime: boolean;
  117155. /**
  117156. * Gets the perf counter used for sprites render time
  117157. */
  117158. readonly spritesRenderTimeCounter: PerfCounter;
  117159. /**
  117160. * Gets the sprites render time capture status
  117161. */
  117162. /**
  117163. * Enable or disable the sprites render time capture
  117164. */
  117165. captureSpritesRenderTime: boolean;
  117166. /**
  117167. * Gets the perf counter used for physics time
  117168. */
  117169. readonly physicsTimeCounter: PerfCounter;
  117170. /**
  117171. * Gets the physics time capture status
  117172. */
  117173. /**
  117174. * Enable or disable the physics time capture
  117175. */
  117176. capturePhysicsTime: boolean;
  117177. /**
  117178. * Gets the perf counter used for animations time
  117179. */
  117180. readonly animationsTimeCounter: PerfCounter;
  117181. /**
  117182. * Gets the animations time capture status
  117183. */
  117184. /**
  117185. * Enable or disable the animations time capture
  117186. */
  117187. captureAnimationsTime: boolean;
  117188. /**
  117189. * Gets the perf counter used for frame time capture
  117190. */
  117191. readonly frameTimeCounter: PerfCounter;
  117192. /**
  117193. * Gets the frame time capture status
  117194. */
  117195. /**
  117196. * Enable or disable the frame time capture
  117197. */
  117198. captureFrameTime: boolean;
  117199. /**
  117200. * Gets the perf counter used for inter-frames time capture
  117201. */
  117202. readonly interFrameTimeCounter: PerfCounter;
  117203. /**
  117204. * Gets the inter-frames time capture status
  117205. */
  117206. /**
  117207. * Enable or disable the inter-frames time capture
  117208. */
  117209. captureInterFrameTime: boolean;
  117210. /**
  117211. * Gets the perf counter used for render time capture
  117212. */
  117213. readonly renderTimeCounter: PerfCounter;
  117214. /**
  117215. * Gets the render time capture status
  117216. */
  117217. /**
  117218. * Enable or disable the render time capture
  117219. */
  117220. captureRenderTime: boolean;
  117221. /**
  117222. * Gets the perf counter used for camera render time capture
  117223. */
  117224. readonly cameraRenderTimeCounter: PerfCounter;
  117225. /**
  117226. * Gets the camera render time capture status
  117227. */
  117228. /**
  117229. * Enable or disable the camera render time capture
  117230. */
  117231. captureCameraRenderTime: boolean;
  117232. /**
  117233. * Gets the perf counter used for draw calls
  117234. */
  117235. readonly drawCallsCounter: PerfCounter;
  117236. /**
  117237. * Instantiates a new scene instrumentation.
  117238. * This class can be used to get instrumentation data from a Babylon engine
  117239. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  117240. * @param scene Defines the scene to instrument
  117241. */
  117242. constructor(
  117243. /**
  117244. * Defines the scene to instrument
  117245. */
  117246. scene: Scene);
  117247. /**
  117248. * Dispose and release associated resources.
  117249. */
  117250. dispose(): void;
  117251. }
  117252. }
  117253. declare module BABYLON {
  117254. /** @hidden */
  117255. export var glowMapGenerationPixelShader: {
  117256. name: string;
  117257. shader: string;
  117258. };
  117259. }
  117260. declare module BABYLON {
  117261. /** @hidden */
  117262. export var glowMapGenerationVertexShader: {
  117263. name: string;
  117264. shader: string;
  117265. };
  117266. }
  117267. declare module BABYLON {
  117268. /**
  117269. * Effect layer options. This helps customizing the behaviour
  117270. * of the effect layer.
  117271. */
  117272. export interface IEffectLayerOptions {
  117273. /**
  117274. * Multiplication factor apply to the canvas size to compute the render target size
  117275. * used to generated the objects (the smaller the faster).
  117276. */
  117277. mainTextureRatio: number;
  117278. /**
  117279. * Enforces a fixed size texture to ensure effect stability across devices.
  117280. */
  117281. mainTextureFixedSize?: number;
  117282. /**
  117283. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  117284. */
  117285. alphaBlendingMode: number;
  117286. /**
  117287. * The camera attached to the layer.
  117288. */
  117289. camera: Nullable<Camera>;
  117290. /**
  117291. * The rendering group to draw the layer in.
  117292. */
  117293. renderingGroupId: number;
  117294. }
  117295. /**
  117296. * The effect layer Helps adding post process effect blended with the main pass.
  117297. *
  117298. * This can be for instance use to generate glow or higlight effects on the scene.
  117299. *
  117300. * The effect layer class can not be used directly and is intented to inherited from to be
  117301. * customized per effects.
  117302. */
  117303. export abstract class EffectLayer {
  117304. private _vertexBuffers;
  117305. private _indexBuffer;
  117306. private _cachedDefines;
  117307. private _effectLayerMapGenerationEffect;
  117308. private _effectLayerOptions;
  117309. private _mergeEffect;
  117310. protected _scene: Scene;
  117311. protected _engine: Engine;
  117312. protected _maxSize: number;
  117313. protected _mainTextureDesiredSize: ISize;
  117314. protected _mainTexture: RenderTargetTexture;
  117315. protected _shouldRender: boolean;
  117316. protected _postProcesses: PostProcess[];
  117317. protected _textures: BaseTexture[];
  117318. protected _emissiveTextureAndColor: {
  117319. texture: Nullable<BaseTexture>;
  117320. color: Color4;
  117321. };
  117322. /**
  117323. * The name of the layer
  117324. */
  117325. name: string;
  117326. /**
  117327. * The clear color of the texture used to generate the glow map.
  117328. */
  117329. neutralColor: Color4;
  117330. /**
  117331. * Specifies wether the highlight layer is enabled or not.
  117332. */
  117333. isEnabled: boolean;
  117334. /**
  117335. * Gets the camera attached to the layer.
  117336. */
  117337. readonly camera: Nullable<Camera>;
  117338. /**
  117339. * Gets the rendering group id the layer should render in.
  117340. */
  117341. renderingGroupId: number;
  117342. /**
  117343. * An event triggered when the effect layer has been disposed.
  117344. */
  117345. onDisposeObservable: Observable<EffectLayer>;
  117346. /**
  117347. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  117348. */
  117349. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  117350. /**
  117351. * An event triggered when the generated texture is being merged in the scene.
  117352. */
  117353. onBeforeComposeObservable: Observable<EffectLayer>;
  117354. /**
  117355. * An event triggered when the mesh is rendered into the effect render target.
  117356. */
  117357. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  117358. /**
  117359. * An event triggered after the mesh has been rendered into the effect render target.
  117360. */
  117361. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  117362. /**
  117363. * An event triggered when the generated texture has been merged in the scene.
  117364. */
  117365. onAfterComposeObservable: Observable<EffectLayer>;
  117366. /**
  117367. * An event triggered when the efffect layer changes its size.
  117368. */
  117369. onSizeChangedObservable: Observable<EffectLayer>;
  117370. /** @hidden */
  117371. static _SceneComponentInitialization: (scene: Scene) => void;
  117372. /**
  117373. * Instantiates a new effect Layer and references it in the scene.
  117374. * @param name The name of the layer
  117375. * @param scene The scene to use the layer in
  117376. */
  117377. constructor(
  117378. /** The Friendly of the effect in the scene */
  117379. name: string, scene: Scene);
  117380. /**
  117381. * Get the effect name of the layer.
  117382. * @return The effect name
  117383. */
  117384. abstract getEffectName(): string;
  117385. /**
  117386. * Checks for the readiness of the element composing the layer.
  117387. * @param subMesh the mesh to check for
  117388. * @param useInstances specify wether or not to use instances to render the mesh
  117389. * @return true if ready otherwise, false
  117390. */
  117391. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  117392. /**
  117393. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  117394. * @returns true if the effect requires stencil during the main canvas render pass.
  117395. */
  117396. abstract needStencil(): boolean;
  117397. /**
  117398. * Create the merge effect. This is the shader use to blit the information back
  117399. * to the main canvas at the end of the scene rendering.
  117400. * @returns The effect containing the shader used to merge the effect on the main canvas
  117401. */
  117402. protected abstract _createMergeEffect(): Effect;
  117403. /**
  117404. * Creates the render target textures and post processes used in the effect layer.
  117405. */
  117406. protected abstract _createTextureAndPostProcesses(): void;
  117407. /**
  117408. * Implementation specific of rendering the generating effect on the main canvas.
  117409. * @param effect The effect used to render through
  117410. */
  117411. protected abstract _internalRender(effect: Effect): void;
  117412. /**
  117413. * Sets the required values for both the emissive texture and and the main color.
  117414. */
  117415. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  117416. /**
  117417. * Free any resources and references associated to a mesh.
  117418. * Internal use
  117419. * @param mesh The mesh to free.
  117420. */
  117421. abstract _disposeMesh(mesh: Mesh): void;
  117422. /**
  117423. * Serializes this layer (Glow or Highlight for example)
  117424. * @returns a serialized layer object
  117425. */
  117426. abstract serialize?(): any;
  117427. /**
  117428. * Initializes the effect layer with the required options.
  117429. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  117430. */
  117431. protected _init(options: Partial<IEffectLayerOptions>): void;
  117432. /**
  117433. * Generates the index buffer of the full screen quad blending to the main canvas.
  117434. */
  117435. private _generateIndexBuffer;
  117436. /**
  117437. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  117438. */
  117439. private _generateVertexBuffer;
  117440. /**
  117441. * Sets the main texture desired size which is the closest power of two
  117442. * of the engine canvas size.
  117443. */
  117444. private _setMainTextureSize;
  117445. /**
  117446. * Creates the main texture for the effect layer.
  117447. */
  117448. protected _createMainTexture(): void;
  117449. /**
  117450. * Adds specific effects defines.
  117451. * @param defines The defines to add specifics to.
  117452. */
  117453. protected _addCustomEffectDefines(defines: string[]): void;
  117454. /**
  117455. * Checks for the readiness of the element composing the layer.
  117456. * @param subMesh the mesh to check for
  117457. * @param useInstances specify wether or not to use instances to render the mesh
  117458. * @param emissiveTexture the associated emissive texture used to generate the glow
  117459. * @return true if ready otherwise, false
  117460. */
  117461. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  117462. /**
  117463. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  117464. */
  117465. render(): void;
  117466. /**
  117467. * Determine if a given mesh will be used in the current effect.
  117468. * @param mesh mesh to test
  117469. * @returns true if the mesh will be used
  117470. */
  117471. hasMesh(mesh: AbstractMesh): boolean;
  117472. /**
  117473. * Returns true if the layer contains information to display, otherwise false.
  117474. * @returns true if the glow layer should be rendered
  117475. */
  117476. shouldRender(): boolean;
  117477. /**
  117478. * Returns true if the mesh should render, otherwise false.
  117479. * @param mesh The mesh to render
  117480. * @returns true if it should render otherwise false
  117481. */
  117482. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  117483. /**
  117484. * Returns true if the mesh can be rendered, otherwise false.
  117485. * @param mesh The mesh to render
  117486. * @param material The material used on the mesh
  117487. * @returns true if it can be rendered otherwise false
  117488. */
  117489. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  117490. /**
  117491. * Returns true if the mesh should render, otherwise false.
  117492. * @param mesh The mesh to render
  117493. * @returns true if it should render otherwise false
  117494. */
  117495. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  117496. /**
  117497. * Renders the submesh passed in parameter to the generation map.
  117498. */
  117499. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  117500. /**
  117501. * Defines wether the current material of the mesh should be use to render the effect.
  117502. * @param mesh defines the current mesh to render
  117503. */
  117504. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  117505. /**
  117506. * Rebuild the required buffers.
  117507. * @hidden Internal use only.
  117508. */
  117509. _rebuild(): void;
  117510. /**
  117511. * Dispose only the render target textures and post process.
  117512. */
  117513. private _disposeTextureAndPostProcesses;
  117514. /**
  117515. * Dispose the highlight layer and free resources.
  117516. */
  117517. dispose(): void;
  117518. /**
  117519. * Gets the class name of the effect layer
  117520. * @returns the string with the class name of the effect layer
  117521. */
  117522. getClassName(): string;
  117523. /**
  117524. * Creates an effect layer from parsed effect layer data
  117525. * @param parsedEffectLayer defines effect layer data
  117526. * @param scene defines the current scene
  117527. * @param rootUrl defines the root URL containing the effect layer information
  117528. * @returns a parsed effect Layer
  117529. */
  117530. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  117531. }
  117532. }
  117533. declare module BABYLON {
  117534. interface AbstractScene {
  117535. /**
  117536. * The list of effect layers (highlights/glow) added to the scene
  117537. * @see http://doc.babylonjs.com/how_to/highlight_layer
  117538. * @see http://doc.babylonjs.com/how_to/glow_layer
  117539. */
  117540. effectLayers: Array<EffectLayer>;
  117541. /**
  117542. * Removes the given effect layer from this scene.
  117543. * @param toRemove defines the effect layer to remove
  117544. * @returns the index of the removed effect layer
  117545. */
  117546. removeEffectLayer(toRemove: EffectLayer): number;
  117547. /**
  117548. * Adds the given effect layer to this scene
  117549. * @param newEffectLayer defines the effect layer to add
  117550. */
  117551. addEffectLayer(newEffectLayer: EffectLayer): void;
  117552. }
  117553. /**
  117554. * Defines the layer scene component responsible to manage any effect layers
  117555. * in a given scene.
  117556. */
  117557. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  117558. /**
  117559. * The component name helpfull to identify the component in the list of scene components.
  117560. */
  117561. readonly name: string;
  117562. /**
  117563. * The scene the component belongs to.
  117564. */
  117565. scene: Scene;
  117566. private _engine;
  117567. private _renderEffects;
  117568. private _needStencil;
  117569. private _previousStencilState;
  117570. /**
  117571. * Creates a new instance of the component for the given scene
  117572. * @param scene Defines the scene to register the component in
  117573. */
  117574. constructor(scene: Scene);
  117575. /**
  117576. * Registers the component in a given scene
  117577. */
  117578. register(): void;
  117579. /**
  117580. * Rebuilds the elements related to this component in case of
  117581. * context lost for instance.
  117582. */
  117583. rebuild(): void;
  117584. /**
  117585. * Serializes the component data to the specified json object
  117586. * @param serializationObject The object to serialize to
  117587. */
  117588. serialize(serializationObject: any): void;
  117589. /**
  117590. * Adds all the elements from the container to the scene
  117591. * @param container the container holding the elements
  117592. */
  117593. addFromContainer(container: AbstractScene): void;
  117594. /**
  117595. * Removes all the elements in the container from the scene
  117596. * @param container contains the elements to remove
  117597. * @param dispose if the removed element should be disposed (default: false)
  117598. */
  117599. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  117600. /**
  117601. * Disposes the component and the associated ressources.
  117602. */
  117603. dispose(): void;
  117604. private _isReadyForMesh;
  117605. private _renderMainTexture;
  117606. private _setStencil;
  117607. private _setStencilBack;
  117608. private _draw;
  117609. private _drawCamera;
  117610. private _drawRenderingGroup;
  117611. }
  117612. }
  117613. declare module BABYLON {
  117614. /** @hidden */
  117615. export var glowMapMergePixelShader: {
  117616. name: string;
  117617. shader: string;
  117618. };
  117619. }
  117620. declare module BABYLON {
  117621. /** @hidden */
  117622. export var glowMapMergeVertexShader: {
  117623. name: string;
  117624. shader: string;
  117625. };
  117626. }
  117627. declare module BABYLON {
  117628. interface AbstractScene {
  117629. /**
  117630. * Return a the first highlight layer of the scene with a given name.
  117631. * @param name The name of the highlight layer to look for.
  117632. * @return The highlight layer if found otherwise null.
  117633. */
  117634. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  117635. }
  117636. /**
  117637. * Glow layer options. This helps customizing the behaviour
  117638. * of the glow layer.
  117639. */
  117640. export interface IGlowLayerOptions {
  117641. /**
  117642. * Multiplication factor apply to the canvas size to compute the render target size
  117643. * used to generated the glowing objects (the smaller the faster).
  117644. */
  117645. mainTextureRatio: number;
  117646. /**
  117647. * Enforces a fixed size texture to ensure resize independant blur.
  117648. */
  117649. mainTextureFixedSize?: number;
  117650. /**
  117651. * How big is the kernel of the blur texture.
  117652. */
  117653. blurKernelSize: number;
  117654. /**
  117655. * The camera attached to the layer.
  117656. */
  117657. camera: Nullable<Camera>;
  117658. /**
  117659. * Enable MSAA by chosing the number of samples.
  117660. */
  117661. mainTextureSamples?: number;
  117662. /**
  117663. * The rendering group to draw the layer in.
  117664. */
  117665. renderingGroupId: number;
  117666. }
  117667. /**
  117668. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  117669. *
  117670. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  117671. *
  117672. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  117673. */
  117674. export class GlowLayer extends EffectLayer {
  117675. /**
  117676. * Effect Name of the layer.
  117677. */
  117678. static readonly EffectName: string;
  117679. /**
  117680. * The default blur kernel size used for the glow.
  117681. */
  117682. static DefaultBlurKernelSize: number;
  117683. /**
  117684. * The default texture size ratio used for the glow.
  117685. */
  117686. static DefaultTextureRatio: number;
  117687. /**
  117688. * Sets the kernel size of the blur.
  117689. */
  117690. /**
  117691. * Gets the kernel size of the blur.
  117692. */
  117693. blurKernelSize: number;
  117694. /**
  117695. * Sets the glow intensity.
  117696. */
  117697. /**
  117698. * Gets the glow intensity.
  117699. */
  117700. intensity: number;
  117701. private _options;
  117702. private _intensity;
  117703. private _horizontalBlurPostprocess1;
  117704. private _verticalBlurPostprocess1;
  117705. private _horizontalBlurPostprocess2;
  117706. private _verticalBlurPostprocess2;
  117707. private _blurTexture1;
  117708. private _blurTexture2;
  117709. private _postProcesses1;
  117710. private _postProcesses2;
  117711. private _includedOnlyMeshes;
  117712. private _excludedMeshes;
  117713. private _meshesUsingTheirOwnMaterials;
  117714. /**
  117715. * Callback used to let the user override the color selection on a per mesh basis
  117716. */
  117717. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  117718. /**
  117719. * Callback used to let the user override the texture selection on a per mesh basis
  117720. */
  117721. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  117722. /**
  117723. * Instantiates a new glow Layer and references it to the scene.
  117724. * @param name The name of the layer
  117725. * @param scene The scene to use the layer in
  117726. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  117727. */
  117728. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  117729. /**
  117730. * Get the effect name of the layer.
  117731. * @return The effect name
  117732. */
  117733. getEffectName(): string;
  117734. /**
  117735. * Create the merge effect. This is the shader use to blit the information back
  117736. * to the main canvas at the end of the scene rendering.
  117737. */
  117738. protected _createMergeEffect(): Effect;
  117739. /**
  117740. * Creates the render target textures and post processes used in the glow layer.
  117741. */
  117742. protected _createTextureAndPostProcesses(): void;
  117743. /**
  117744. * Checks for the readiness of the element composing the layer.
  117745. * @param subMesh the mesh to check for
  117746. * @param useInstances specify wether or not to use instances to render the mesh
  117747. * @param emissiveTexture the associated emissive texture used to generate the glow
  117748. * @return true if ready otherwise, false
  117749. */
  117750. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  117751. /**
  117752. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  117753. */
  117754. needStencil(): boolean;
  117755. /**
  117756. * Returns true if the mesh can be rendered, otherwise false.
  117757. * @param mesh The mesh to render
  117758. * @param material The material used on the mesh
  117759. * @returns true if it can be rendered otherwise false
  117760. */
  117761. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  117762. /**
  117763. * Implementation specific of rendering the generating effect on the main canvas.
  117764. * @param effect The effect used to render through
  117765. */
  117766. protected _internalRender(effect: Effect): void;
  117767. /**
  117768. * Sets the required values for both the emissive texture and and the main color.
  117769. */
  117770. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  117771. /**
  117772. * Returns true if the mesh should render, otherwise false.
  117773. * @param mesh The mesh to render
  117774. * @returns true if it should render otherwise false
  117775. */
  117776. protected _shouldRenderMesh(mesh: Mesh): boolean;
  117777. /**
  117778. * Adds specific effects defines.
  117779. * @param defines The defines to add specifics to.
  117780. */
  117781. protected _addCustomEffectDefines(defines: string[]): void;
  117782. /**
  117783. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  117784. * @param mesh The mesh to exclude from the glow layer
  117785. */
  117786. addExcludedMesh(mesh: Mesh): void;
  117787. /**
  117788. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  117789. * @param mesh The mesh to remove
  117790. */
  117791. removeExcludedMesh(mesh: Mesh): void;
  117792. /**
  117793. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  117794. * @param mesh The mesh to include in the glow layer
  117795. */
  117796. addIncludedOnlyMesh(mesh: Mesh): void;
  117797. /**
  117798. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  117799. * @param mesh The mesh to remove
  117800. */
  117801. removeIncludedOnlyMesh(mesh: Mesh): void;
  117802. /**
  117803. * Determine if a given mesh will be used in the glow layer
  117804. * @param mesh The mesh to test
  117805. * @returns true if the mesh will be highlighted by the current glow layer
  117806. */
  117807. hasMesh(mesh: AbstractMesh): boolean;
  117808. /**
  117809. * Defines wether the current material of the mesh should be use to render the effect.
  117810. * @param mesh defines the current mesh to render
  117811. */
  117812. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  117813. /**
  117814. * Add a mesh to be rendered through its own material and not with emissive only.
  117815. * @param mesh The mesh for which we need to use its material
  117816. */
  117817. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  117818. /**
  117819. * Remove a mesh from being rendered through its own material and not with emissive only.
  117820. * @param mesh The mesh for which we need to not use its material
  117821. */
  117822. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  117823. /**
  117824. * Free any resources and references associated to a mesh.
  117825. * Internal use
  117826. * @param mesh The mesh to free.
  117827. * @hidden
  117828. */
  117829. _disposeMesh(mesh: Mesh): void;
  117830. /**
  117831. * Gets the class name of the effect layer
  117832. * @returns the string with the class name of the effect layer
  117833. */
  117834. getClassName(): string;
  117835. /**
  117836. * Serializes this glow layer
  117837. * @returns a serialized glow layer object
  117838. */
  117839. serialize(): any;
  117840. /**
  117841. * Creates a Glow Layer from parsed glow layer data
  117842. * @param parsedGlowLayer defines glow layer data
  117843. * @param scene defines the current scene
  117844. * @param rootUrl defines the root URL containing the glow layer information
  117845. * @returns a parsed Glow Layer
  117846. */
  117847. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  117848. }
  117849. }
  117850. declare module BABYLON {
  117851. /** @hidden */
  117852. export var glowBlurPostProcessPixelShader: {
  117853. name: string;
  117854. shader: string;
  117855. };
  117856. }
  117857. declare module BABYLON {
  117858. interface AbstractScene {
  117859. /**
  117860. * Return a the first highlight layer of the scene with a given name.
  117861. * @param name The name of the highlight layer to look for.
  117862. * @return The highlight layer if found otherwise null.
  117863. */
  117864. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  117865. }
  117866. /**
  117867. * Highlight layer options. This helps customizing the behaviour
  117868. * of the highlight layer.
  117869. */
  117870. export interface IHighlightLayerOptions {
  117871. /**
  117872. * Multiplication factor apply to the canvas size to compute the render target size
  117873. * used to generated the glowing objects (the smaller the faster).
  117874. */
  117875. mainTextureRatio: number;
  117876. /**
  117877. * Enforces a fixed size texture to ensure resize independant blur.
  117878. */
  117879. mainTextureFixedSize?: number;
  117880. /**
  117881. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  117882. * of the picture to blur (the smaller the faster).
  117883. */
  117884. blurTextureSizeRatio: number;
  117885. /**
  117886. * How big in texel of the blur texture is the vertical blur.
  117887. */
  117888. blurVerticalSize: number;
  117889. /**
  117890. * How big in texel of the blur texture is the horizontal blur.
  117891. */
  117892. blurHorizontalSize: number;
  117893. /**
  117894. * Alpha blending mode used to apply the blur. Default is combine.
  117895. */
  117896. alphaBlendingMode: number;
  117897. /**
  117898. * The camera attached to the layer.
  117899. */
  117900. camera: Nullable<Camera>;
  117901. /**
  117902. * Should we display highlight as a solid stroke?
  117903. */
  117904. isStroke?: boolean;
  117905. /**
  117906. * The rendering group to draw the layer in.
  117907. */
  117908. renderingGroupId: number;
  117909. }
  117910. /**
  117911. * The highlight layer Helps adding a glow effect around a mesh.
  117912. *
  117913. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  117914. * glowy meshes to your scene.
  117915. *
  117916. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  117917. */
  117918. export class HighlightLayer extends EffectLayer {
  117919. name: string;
  117920. /**
  117921. * Effect Name of the highlight layer.
  117922. */
  117923. static readonly EffectName: string;
  117924. /**
  117925. * The neutral color used during the preparation of the glow effect.
  117926. * This is black by default as the blend operation is a blend operation.
  117927. */
  117928. static NeutralColor: Color4;
  117929. /**
  117930. * Stencil value used for glowing meshes.
  117931. */
  117932. static GlowingMeshStencilReference: number;
  117933. /**
  117934. * Stencil value used for the other meshes in the scene.
  117935. */
  117936. static NormalMeshStencilReference: number;
  117937. /**
  117938. * Specifies whether or not the inner glow is ACTIVE in the layer.
  117939. */
  117940. innerGlow: boolean;
  117941. /**
  117942. * Specifies whether or not the outer glow is ACTIVE in the layer.
  117943. */
  117944. outerGlow: boolean;
  117945. /**
  117946. * Specifies the horizontal size of the blur.
  117947. */
  117948. /**
  117949. * Gets the horizontal size of the blur.
  117950. */
  117951. blurHorizontalSize: number;
  117952. /**
  117953. * Specifies the vertical size of the blur.
  117954. */
  117955. /**
  117956. * Gets the vertical size of the blur.
  117957. */
  117958. blurVerticalSize: number;
  117959. /**
  117960. * An event triggered when the highlight layer is being blurred.
  117961. */
  117962. onBeforeBlurObservable: Observable<HighlightLayer>;
  117963. /**
  117964. * An event triggered when the highlight layer has been blurred.
  117965. */
  117966. onAfterBlurObservable: Observable<HighlightLayer>;
  117967. private _instanceGlowingMeshStencilReference;
  117968. private _options;
  117969. private _downSamplePostprocess;
  117970. private _horizontalBlurPostprocess;
  117971. private _verticalBlurPostprocess;
  117972. private _blurTexture;
  117973. private _meshes;
  117974. private _excludedMeshes;
  117975. /**
  117976. * Instantiates a new highlight Layer and references it to the scene..
  117977. * @param name The name of the layer
  117978. * @param scene The scene to use the layer in
  117979. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  117980. */
  117981. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  117982. /**
  117983. * Get the effect name of the layer.
  117984. * @return The effect name
  117985. */
  117986. getEffectName(): string;
  117987. /**
  117988. * Create the merge effect. This is the shader use to blit the information back
  117989. * to the main canvas at the end of the scene rendering.
  117990. */
  117991. protected _createMergeEffect(): Effect;
  117992. /**
  117993. * Creates the render target textures and post processes used in the highlight layer.
  117994. */
  117995. protected _createTextureAndPostProcesses(): void;
  117996. /**
  117997. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  117998. */
  117999. needStencil(): boolean;
  118000. /**
  118001. * Checks for the readiness of the element composing the layer.
  118002. * @param subMesh the mesh to check for
  118003. * @param useInstances specify wether or not to use instances to render the mesh
  118004. * @param emissiveTexture the associated emissive texture used to generate the glow
  118005. * @return true if ready otherwise, false
  118006. */
  118007. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  118008. /**
  118009. * Implementation specific of rendering the generating effect on the main canvas.
  118010. * @param effect The effect used to render through
  118011. */
  118012. protected _internalRender(effect: Effect): void;
  118013. /**
  118014. * Returns true if the layer contains information to display, otherwise false.
  118015. */
  118016. shouldRender(): boolean;
  118017. /**
  118018. * Returns true if the mesh should render, otherwise false.
  118019. * @param mesh The mesh to render
  118020. * @returns true if it should render otherwise false
  118021. */
  118022. protected _shouldRenderMesh(mesh: Mesh): boolean;
  118023. /**
  118024. * Sets the required values for both the emissive texture and and the main color.
  118025. */
  118026. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  118027. /**
  118028. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  118029. * @param mesh The mesh to exclude from the highlight layer
  118030. */
  118031. addExcludedMesh(mesh: Mesh): void;
  118032. /**
  118033. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  118034. * @param mesh The mesh to highlight
  118035. */
  118036. removeExcludedMesh(mesh: Mesh): void;
  118037. /**
  118038. * Determine if a given mesh will be highlighted by the current HighlightLayer
  118039. * @param mesh mesh to test
  118040. * @returns true if the mesh will be highlighted by the current HighlightLayer
  118041. */
  118042. hasMesh(mesh: AbstractMesh): boolean;
  118043. /**
  118044. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  118045. * @param mesh The mesh to highlight
  118046. * @param color The color of the highlight
  118047. * @param glowEmissiveOnly Extract the glow from the emissive texture
  118048. */
  118049. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  118050. /**
  118051. * Remove a mesh from the highlight layer in order to make it stop glowing.
  118052. * @param mesh The mesh to highlight
  118053. */
  118054. removeMesh(mesh: Mesh): void;
  118055. /**
  118056. * Force the stencil to the normal expected value for none glowing parts
  118057. */
  118058. private _defaultStencilReference;
  118059. /**
  118060. * Free any resources and references associated to a mesh.
  118061. * Internal use
  118062. * @param mesh The mesh to free.
  118063. * @hidden
  118064. */
  118065. _disposeMesh(mesh: Mesh): void;
  118066. /**
  118067. * Dispose the highlight layer and free resources.
  118068. */
  118069. dispose(): void;
  118070. /**
  118071. * Gets the class name of the effect layer
  118072. * @returns the string with the class name of the effect layer
  118073. */
  118074. getClassName(): string;
  118075. /**
  118076. * Serializes this Highlight layer
  118077. * @returns a serialized Highlight layer object
  118078. */
  118079. serialize(): any;
  118080. /**
  118081. * Creates a Highlight layer from parsed Highlight layer data
  118082. * @param parsedHightlightLayer defines the Highlight layer data
  118083. * @param scene defines the current scene
  118084. * @param rootUrl defines the root URL containing the Highlight layer information
  118085. * @returns a parsed Highlight layer
  118086. */
  118087. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  118088. }
  118089. }
  118090. declare module BABYLON {
  118091. interface AbstractScene {
  118092. /**
  118093. * The list of layers (background and foreground) of the scene
  118094. */
  118095. layers: Array<Layer>;
  118096. }
  118097. /**
  118098. * Defines the layer scene component responsible to manage any layers
  118099. * in a given scene.
  118100. */
  118101. export class LayerSceneComponent implements ISceneComponent {
  118102. /**
  118103. * The component name helpfull to identify the component in the list of scene components.
  118104. */
  118105. readonly name: string;
  118106. /**
  118107. * The scene the component belongs to.
  118108. */
  118109. scene: Scene;
  118110. private _engine;
  118111. /**
  118112. * Creates a new instance of the component for the given scene
  118113. * @param scene Defines the scene to register the component in
  118114. */
  118115. constructor(scene: Scene);
  118116. /**
  118117. * Registers the component in a given scene
  118118. */
  118119. register(): void;
  118120. /**
  118121. * Rebuilds the elements related to this component in case of
  118122. * context lost for instance.
  118123. */
  118124. rebuild(): void;
  118125. /**
  118126. * Disposes the component and the associated ressources.
  118127. */
  118128. dispose(): void;
  118129. private _draw;
  118130. private _drawCameraPredicate;
  118131. private _drawCameraBackground;
  118132. private _drawCameraForeground;
  118133. private _drawRenderTargetPredicate;
  118134. private _drawRenderTargetBackground;
  118135. private _drawRenderTargetForeground;
  118136. /**
  118137. * Adds all the elements from the container to the scene
  118138. * @param container the container holding the elements
  118139. */
  118140. addFromContainer(container: AbstractScene): void;
  118141. /**
  118142. * Removes all the elements in the container from the scene
  118143. * @param container contains the elements to remove
  118144. * @param dispose if the removed element should be disposed (default: false)
  118145. */
  118146. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  118147. }
  118148. }
  118149. declare module BABYLON {
  118150. /** @hidden */
  118151. export var layerPixelShader: {
  118152. name: string;
  118153. shader: string;
  118154. };
  118155. }
  118156. declare module BABYLON {
  118157. /** @hidden */
  118158. export var layerVertexShader: {
  118159. name: string;
  118160. shader: string;
  118161. };
  118162. }
  118163. declare module BABYLON {
  118164. /**
  118165. * This represents a full screen 2d layer.
  118166. * This can be useful to display a picture in the background of your scene for instance.
  118167. * @see https://www.babylonjs-playground.com/#08A2BS#1
  118168. */
  118169. export class Layer {
  118170. /**
  118171. * Define the name of the layer.
  118172. */
  118173. name: string;
  118174. /**
  118175. * Define the texture the layer should display.
  118176. */
  118177. texture: Nullable<Texture>;
  118178. /**
  118179. * Is the layer in background or foreground.
  118180. */
  118181. isBackground: boolean;
  118182. /**
  118183. * Define the color of the layer (instead of texture).
  118184. */
  118185. color: Color4;
  118186. /**
  118187. * Define the scale of the layer in order to zoom in out of the texture.
  118188. */
  118189. scale: Vector2;
  118190. /**
  118191. * Define an offset for the layer in order to shift the texture.
  118192. */
  118193. offset: Vector2;
  118194. /**
  118195. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  118196. */
  118197. alphaBlendingMode: number;
  118198. /**
  118199. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  118200. * Alpha test will not mix with the background color in case of transparency.
  118201. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  118202. */
  118203. alphaTest: boolean;
  118204. /**
  118205. * Define a mask to restrict the layer to only some of the scene cameras.
  118206. */
  118207. layerMask: number;
  118208. /**
  118209. * Define the list of render target the layer is visible into.
  118210. */
  118211. renderTargetTextures: RenderTargetTexture[];
  118212. /**
  118213. * Define if the layer is only used in renderTarget or if it also
  118214. * renders in the main frame buffer of the canvas.
  118215. */
  118216. renderOnlyInRenderTargetTextures: boolean;
  118217. private _scene;
  118218. private _vertexBuffers;
  118219. private _indexBuffer;
  118220. private _effect;
  118221. private _alphaTestEffect;
  118222. /**
  118223. * An event triggered when the layer is disposed.
  118224. */
  118225. onDisposeObservable: Observable<Layer>;
  118226. private _onDisposeObserver;
  118227. /**
  118228. * Back compatibility with callback before the onDisposeObservable existed.
  118229. * The set callback will be triggered when the layer has been disposed.
  118230. */
  118231. onDispose: () => void;
  118232. /**
  118233. * An event triggered before rendering the scene
  118234. */
  118235. onBeforeRenderObservable: Observable<Layer>;
  118236. private _onBeforeRenderObserver;
  118237. /**
  118238. * Back compatibility with callback before the onBeforeRenderObservable existed.
  118239. * The set callback will be triggered just before rendering the layer.
  118240. */
  118241. onBeforeRender: () => void;
  118242. /**
  118243. * An event triggered after rendering the scene
  118244. */
  118245. onAfterRenderObservable: Observable<Layer>;
  118246. private _onAfterRenderObserver;
  118247. /**
  118248. * Back compatibility with callback before the onAfterRenderObservable existed.
  118249. * The set callback will be triggered just after rendering the layer.
  118250. */
  118251. onAfterRender: () => void;
  118252. /**
  118253. * Instantiates a new layer.
  118254. * This represents a full screen 2d layer.
  118255. * This can be useful to display a picture in the background of your scene for instance.
  118256. * @see https://www.babylonjs-playground.com/#08A2BS#1
  118257. * @param name Define the name of the layer in the scene
  118258. * @param imgUrl Define the url of the texture to display in the layer
  118259. * @param scene Define the scene the layer belongs to
  118260. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  118261. * @param color Defines a color for the layer
  118262. */
  118263. constructor(
  118264. /**
  118265. * Define the name of the layer.
  118266. */
  118267. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  118268. private _createIndexBuffer;
  118269. /** @hidden */
  118270. _rebuild(): void;
  118271. /**
  118272. * Renders the layer in the scene.
  118273. */
  118274. render(): void;
  118275. /**
  118276. * Disposes and releases the associated ressources.
  118277. */
  118278. dispose(): void;
  118279. }
  118280. }
  118281. declare module BABYLON {
  118282. /** @hidden */
  118283. export var lensFlarePixelShader: {
  118284. name: string;
  118285. shader: string;
  118286. };
  118287. }
  118288. declare module BABYLON {
  118289. /** @hidden */
  118290. export var lensFlareVertexShader: {
  118291. name: string;
  118292. shader: string;
  118293. };
  118294. }
  118295. declare module BABYLON {
  118296. /**
  118297. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  118298. * It is usually composed of several `lensFlare`.
  118299. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  118300. */
  118301. export class LensFlareSystem {
  118302. /**
  118303. * Define the name of the lens flare system
  118304. */
  118305. name: string;
  118306. /**
  118307. * List of lens flares used in this system.
  118308. */
  118309. lensFlares: LensFlare[];
  118310. /**
  118311. * Define a limit from the border the lens flare can be visible.
  118312. */
  118313. borderLimit: number;
  118314. /**
  118315. * Define a viewport border we do not want to see the lens flare in.
  118316. */
  118317. viewportBorder: number;
  118318. /**
  118319. * Define a predicate which could limit the list of meshes able to occlude the effect.
  118320. */
  118321. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  118322. /**
  118323. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  118324. */
  118325. layerMask: number;
  118326. /**
  118327. * Define the id of the lens flare system in the scene.
  118328. * (equal to name by default)
  118329. */
  118330. id: string;
  118331. private _scene;
  118332. private _emitter;
  118333. private _vertexBuffers;
  118334. private _indexBuffer;
  118335. private _effect;
  118336. private _positionX;
  118337. private _positionY;
  118338. private _isEnabled;
  118339. /** @hidden */
  118340. static _SceneComponentInitialization: (scene: Scene) => void;
  118341. /**
  118342. * Instantiates a lens flare system.
  118343. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  118344. * It is usually composed of several `lensFlare`.
  118345. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  118346. * @param name Define the name of the lens flare system in the scene
  118347. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  118348. * @param scene Define the scene the lens flare system belongs to
  118349. */
  118350. constructor(
  118351. /**
  118352. * Define the name of the lens flare system
  118353. */
  118354. name: string, emitter: any, scene: Scene);
  118355. /**
  118356. * Define if the lens flare system is enabled.
  118357. */
  118358. isEnabled: boolean;
  118359. /**
  118360. * Get the scene the effects belongs to.
  118361. * @returns the scene holding the lens flare system
  118362. */
  118363. getScene(): Scene;
  118364. /**
  118365. * Get the emitter of the lens flare system.
  118366. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  118367. * @returns the emitter of the lens flare system
  118368. */
  118369. getEmitter(): any;
  118370. /**
  118371. * Set the emitter of the lens flare system.
  118372. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  118373. * @param newEmitter Define the new emitter of the system
  118374. */
  118375. setEmitter(newEmitter: any): void;
  118376. /**
  118377. * Get the lens flare system emitter position.
  118378. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  118379. * @returns the position
  118380. */
  118381. getEmitterPosition(): Vector3;
  118382. /**
  118383. * @hidden
  118384. */
  118385. computeEffectivePosition(globalViewport: Viewport): boolean;
  118386. /** @hidden */
  118387. _isVisible(): boolean;
  118388. /**
  118389. * @hidden
  118390. */
  118391. render(): boolean;
  118392. /**
  118393. * Dispose and release the lens flare with its associated resources.
  118394. */
  118395. dispose(): void;
  118396. /**
  118397. * Parse a lens flare system from a JSON repressentation
  118398. * @param parsedLensFlareSystem Define the JSON to parse
  118399. * @param scene Define the scene the parsed system should be instantiated in
  118400. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  118401. * @returns the parsed system
  118402. */
  118403. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  118404. /**
  118405. * Serialize the current Lens Flare System into a JSON representation.
  118406. * @returns the serialized JSON
  118407. */
  118408. serialize(): any;
  118409. }
  118410. }
  118411. declare module BABYLON {
  118412. /**
  118413. * This represents one of the lens effect in a `lensFlareSystem`.
  118414. * It controls one of the indiviual texture used in the effect.
  118415. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  118416. */
  118417. export class LensFlare {
  118418. /**
  118419. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  118420. */
  118421. size: number;
  118422. /**
  118423. * 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.
  118424. */
  118425. position: number;
  118426. /**
  118427. * Define the lens color.
  118428. */
  118429. color: Color3;
  118430. /**
  118431. * Define the lens texture.
  118432. */
  118433. texture: Nullable<Texture>;
  118434. /**
  118435. * Define the alpha mode to render this particular lens.
  118436. */
  118437. alphaMode: number;
  118438. private _system;
  118439. /**
  118440. * Creates a new Lens Flare.
  118441. * This represents one of the lens effect in a `lensFlareSystem`.
  118442. * It controls one of the indiviual texture used in the effect.
  118443. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  118444. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  118445. * @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.
  118446. * @param color Define the lens color
  118447. * @param imgUrl Define the lens texture url
  118448. * @param system Define the `lensFlareSystem` this flare is part of
  118449. * @returns The newly created Lens Flare
  118450. */
  118451. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  118452. /**
  118453. * Instantiates a new Lens Flare.
  118454. * This represents one of the lens effect in a `lensFlareSystem`.
  118455. * It controls one of the indiviual texture used in the effect.
  118456. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  118457. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  118458. * @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.
  118459. * @param color Define the lens color
  118460. * @param imgUrl Define the lens texture url
  118461. * @param system Define the `lensFlareSystem` this flare is part of
  118462. */
  118463. constructor(
  118464. /**
  118465. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  118466. */
  118467. size: number,
  118468. /**
  118469. * 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.
  118470. */
  118471. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  118472. /**
  118473. * Dispose and release the lens flare with its associated resources.
  118474. */
  118475. dispose(): void;
  118476. }
  118477. }
  118478. declare module BABYLON {
  118479. interface AbstractScene {
  118480. /**
  118481. * The list of lens flare system added to the scene
  118482. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  118483. */
  118484. lensFlareSystems: Array<LensFlareSystem>;
  118485. /**
  118486. * Removes the given lens flare system from this scene.
  118487. * @param toRemove The lens flare system to remove
  118488. * @returns The index of the removed lens flare system
  118489. */
  118490. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  118491. /**
  118492. * Adds the given lens flare system to this scene
  118493. * @param newLensFlareSystem The lens flare system to add
  118494. */
  118495. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  118496. /**
  118497. * Gets a lens flare system using its name
  118498. * @param name defines the name to look for
  118499. * @returns the lens flare system or null if not found
  118500. */
  118501. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  118502. /**
  118503. * Gets a lens flare system using its id
  118504. * @param id defines the id to look for
  118505. * @returns the lens flare system or null if not found
  118506. */
  118507. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  118508. }
  118509. /**
  118510. * Defines the lens flare scene component responsible to manage any lens flares
  118511. * in a given scene.
  118512. */
  118513. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  118514. /**
  118515. * The component name helpfull to identify the component in the list of scene components.
  118516. */
  118517. readonly name: string;
  118518. /**
  118519. * The scene the component belongs to.
  118520. */
  118521. scene: Scene;
  118522. /**
  118523. * Creates a new instance of the component for the given scene
  118524. * @param scene Defines the scene to register the component in
  118525. */
  118526. constructor(scene: Scene);
  118527. /**
  118528. * Registers the component in a given scene
  118529. */
  118530. register(): void;
  118531. /**
  118532. * Rebuilds the elements related to this component in case of
  118533. * context lost for instance.
  118534. */
  118535. rebuild(): void;
  118536. /**
  118537. * Adds all the elements from the container to the scene
  118538. * @param container the container holding the elements
  118539. */
  118540. addFromContainer(container: AbstractScene): void;
  118541. /**
  118542. * Removes all the elements in the container from the scene
  118543. * @param container contains the elements to remove
  118544. * @param dispose if the removed element should be disposed (default: false)
  118545. */
  118546. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  118547. /**
  118548. * Serializes the component data to the specified json object
  118549. * @param serializationObject The object to serialize to
  118550. */
  118551. serialize(serializationObject: any): void;
  118552. /**
  118553. * Disposes the component and the associated ressources.
  118554. */
  118555. dispose(): void;
  118556. private _draw;
  118557. }
  118558. }
  118559. declare module BABYLON {
  118560. /**
  118561. * Defines the shadow generator component responsible to manage any shadow generators
  118562. * in a given scene.
  118563. */
  118564. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  118565. /**
  118566. * The component name helpfull to identify the component in the list of scene components.
  118567. */
  118568. readonly name: string;
  118569. /**
  118570. * The scene the component belongs to.
  118571. */
  118572. scene: Scene;
  118573. /**
  118574. * Creates a new instance of the component for the given scene
  118575. * @param scene Defines the scene to register the component in
  118576. */
  118577. constructor(scene: Scene);
  118578. /**
  118579. * Registers the component in a given scene
  118580. */
  118581. register(): void;
  118582. /**
  118583. * Rebuilds the elements related to this component in case of
  118584. * context lost for instance.
  118585. */
  118586. rebuild(): void;
  118587. /**
  118588. * Serializes the component data to the specified json object
  118589. * @param serializationObject The object to serialize to
  118590. */
  118591. serialize(serializationObject: any): void;
  118592. /**
  118593. * Adds all the elements from the container to the scene
  118594. * @param container the container holding the elements
  118595. */
  118596. addFromContainer(container: AbstractScene): void;
  118597. /**
  118598. * Removes all the elements in the container from the scene
  118599. * @param container contains the elements to remove
  118600. * @param dispose if the removed element should be disposed (default: false)
  118601. */
  118602. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  118603. /**
  118604. * Rebuilds the elements related to this component in case of
  118605. * context lost for instance.
  118606. */
  118607. dispose(): void;
  118608. private _gatherRenderTargets;
  118609. }
  118610. }
  118611. declare module BABYLON {
  118612. /**
  118613. * A point light is a light defined by an unique point in world space.
  118614. * The light is emitted in every direction from this point.
  118615. * A good example of a point light is a standard light bulb.
  118616. * Documentation: https://doc.babylonjs.com/babylon101/lights
  118617. */
  118618. export class PointLight extends ShadowLight {
  118619. private _shadowAngle;
  118620. /**
  118621. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  118622. * This specifies what angle the shadow will use to be created.
  118623. *
  118624. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  118625. */
  118626. /**
  118627. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  118628. * This specifies what angle the shadow will use to be created.
  118629. *
  118630. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  118631. */
  118632. shadowAngle: number;
  118633. /**
  118634. * Gets the direction if it has been set.
  118635. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  118636. */
  118637. /**
  118638. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  118639. */
  118640. direction: Vector3;
  118641. /**
  118642. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  118643. * A PointLight emits the light in every direction.
  118644. * It can cast shadows.
  118645. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  118646. * ```javascript
  118647. * var pointLight = new PointLight("pl", camera.position, scene);
  118648. * ```
  118649. * Documentation : https://doc.babylonjs.com/babylon101/lights
  118650. * @param name The light friendly name
  118651. * @param position The position of the point light in the scene
  118652. * @param scene The scene the lights belongs to
  118653. */
  118654. constructor(name: string, position: Vector3, scene: Scene);
  118655. /**
  118656. * Returns the string "PointLight"
  118657. * @returns the class name
  118658. */
  118659. getClassName(): string;
  118660. /**
  118661. * Returns the integer 0.
  118662. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  118663. */
  118664. getTypeID(): number;
  118665. /**
  118666. * Specifies wether or not the shadowmap should be a cube texture.
  118667. * @returns true if the shadowmap needs to be a cube texture.
  118668. */
  118669. needCube(): boolean;
  118670. /**
  118671. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  118672. * @param faceIndex The index of the face we are computed the direction to generate shadow
  118673. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  118674. */
  118675. getShadowDirection(faceIndex?: number): Vector3;
  118676. /**
  118677. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  118678. * - fov = PI / 2
  118679. * - aspect ratio : 1.0
  118680. * - z-near and far equal to the active camera minZ and maxZ.
  118681. * Returns the PointLight.
  118682. */
  118683. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  118684. protected _buildUniformLayout(): void;
  118685. /**
  118686. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  118687. * @param effect The effect to update
  118688. * @param lightIndex The index of the light in the effect to update
  118689. * @returns The point light
  118690. */
  118691. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  118692. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  118693. /**
  118694. * Prepares the list of defines specific to the light type.
  118695. * @param defines the list of defines
  118696. * @param lightIndex defines the index of the light for the effect
  118697. */
  118698. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  118699. }
  118700. }
  118701. declare module BABYLON {
  118702. /**
  118703. * Header information of HDR texture files.
  118704. */
  118705. export interface HDRInfo {
  118706. /**
  118707. * The height of the texture in pixels.
  118708. */
  118709. height: number;
  118710. /**
  118711. * The width of the texture in pixels.
  118712. */
  118713. width: number;
  118714. /**
  118715. * The index of the beginning of the data in the binary file.
  118716. */
  118717. dataPosition: number;
  118718. }
  118719. /**
  118720. * This groups tools to convert HDR texture to native colors array.
  118721. */
  118722. export class HDRTools {
  118723. private static Ldexp;
  118724. private static Rgbe2float;
  118725. private static readStringLine;
  118726. /**
  118727. * Reads header information from an RGBE texture stored in a native array.
  118728. * More information on this format are available here:
  118729. * https://en.wikipedia.org/wiki/RGBE_image_format
  118730. *
  118731. * @param uint8array The binary file stored in native array.
  118732. * @return The header information.
  118733. */
  118734. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  118735. /**
  118736. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  118737. * This RGBE texture needs to store the information as a panorama.
  118738. *
  118739. * More information on this format are available here:
  118740. * https://en.wikipedia.org/wiki/RGBE_image_format
  118741. *
  118742. * @param buffer The binary file stored in an array buffer.
  118743. * @param size The expected size of the extracted cubemap.
  118744. * @return The Cube Map information.
  118745. */
  118746. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  118747. /**
  118748. * Returns the pixels data extracted from an RGBE texture.
  118749. * This pixels will be stored left to right up to down in the R G B order in one array.
  118750. *
  118751. * More information on this format are available here:
  118752. * https://en.wikipedia.org/wiki/RGBE_image_format
  118753. *
  118754. * @param uint8array The binary file stored in an array buffer.
  118755. * @param hdrInfo The header information of the file.
  118756. * @return The pixels data in RGB right to left up to down order.
  118757. */
  118758. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  118759. private static RGBE_ReadPixels_RLE;
  118760. }
  118761. }
  118762. declare module BABYLON {
  118763. /**
  118764. * This represents a texture coming from an HDR input.
  118765. *
  118766. * The only supported format is currently panorama picture stored in RGBE format.
  118767. * Example of such files can be found on HDRLib: http://hdrlib.com/
  118768. */
  118769. export class HDRCubeTexture extends BaseTexture {
  118770. private static _facesMapping;
  118771. private _generateHarmonics;
  118772. private _noMipmap;
  118773. private _textureMatrix;
  118774. private _size;
  118775. private _onLoad;
  118776. private _onError;
  118777. /**
  118778. * The texture URL.
  118779. */
  118780. url: string;
  118781. /**
  118782. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  118783. */
  118784. coordinatesMode: number;
  118785. protected _isBlocking: boolean;
  118786. /**
  118787. * Sets wether or not the texture is blocking during loading.
  118788. */
  118789. /**
  118790. * Gets wether or not the texture is blocking during loading.
  118791. */
  118792. isBlocking: boolean;
  118793. protected _rotationY: number;
  118794. /**
  118795. * Sets texture matrix rotation angle around Y axis in radians.
  118796. */
  118797. /**
  118798. * Gets texture matrix rotation angle around Y axis radians.
  118799. */
  118800. rotationY: number;
  118801. /**
  118802. * Gets or sets the center of the bounding box associated with the cube texture
  118803. * It must define where the camera used to render the texture was set
  118804. */
  118805. boundingBoxPosition: Vector3;
  118806. private _boundingBoxSize;
  118807. /**
  118808. * Gets or sets the size of the bounding box associated with the cube texture
  118809. * When defined, the cubemap will switch to local mode
  118810. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  118811. * @example https://www.babylonjs-playground.com/#RNASML
  118812. */
  118813. boundingBoxSize: Vector3;
  118814. /**
  118815. * Instantiates an HDRTexture from the following parameters.
  118816. *
  118817. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  118818. * @param scene The scene the texture will be used in
  118819. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  118820. * @param noMipmap Forces to not generate the mipmap if true
  118821. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  118822. * @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)
  118823. * @param reserved Reserved flag for internal use.
  118824. */
  118825. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  118826. /**
  118827. * Get the current class name of the texture useful for serialization or dynamic coding.
  118828. * @returns "HDRCubeTexture"
  118829. */
  118830. getClassName(): string;
  118831. /**
  118832. * Occurs when the file is raw .hdr file.
  118833. */
  118834. private loadTexture;
  118835. clone(): HDRCubeTexture;
  118836. delayLoad(): void;
  118837. /**
  118838. * Get the texture reflection matrix used to rotate/transform the reflection.
  118839. * @returns the reflection matrix
  118840. */
  118841. getReflectionTextureMatrix(): Matrix;
  118842. /**
  118843. * Set the texture reflection matrix used to rotate/transform the reflection.
  118844. * @param value Define the reflection matrix to set
  118845. */
  118846. setReflectionTextureMatrix(value: Matrix): void;
  118847. /**
  118848. * Parses a JSON representation of an HDR Texture in order to create the texture
  118849. * @param parsedTexture Define the JSON representation
  118850. * @param scene Define the scene the texture should be created in
  118851. * @param rootUrl Define the root url in case we need to load relative dependencies
  118852. * @returns the newly created texture after parsing
  118853. */
  118854. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  118855. serialize(): any;
  118856. }
  118857. }
  118858. declare module BABYLON {
  118859. /**
  118860. * Class used to control physics engine
  118861. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  118862. */
  118863. export class PhysicsEngine implements IPhysicsEngine {
  118864. private _physicsPlugin;
  118865. /**
  118866. * Global value used to control the smallest number supported by the simulation
  118867. */
  118868. static Epsilon: number;
  118869. private _impostors;
  118870. private _joints;
  118871. /**
  118872. * Gets the gravity vector used by the simulation
  118873. */
  118874. gravity: Vector3;
  118875. /**
  118876. * Factory used to create the default physics plugin.
  118877. * @returns The default physics plugin
  118878. */
  118879. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  118880. /**
  118881. * Creates a new Physics Engine
  118882. * @param gravity defines the gravity vector used by the simulation
  118883. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  118884. */
  118885. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  118886. /**
  118887. * Sets the gravity vector used by the simulation
  118888. * @param gravity defines the gravity vector to use
  118889. */
  118890. setGravity(gravity: Vector3): void;
  118891. /**
  118892. * Set the time step of the physics engine.
  118893. * Default is 1/60.
  118894. * To slow it down, enter 1/600 for example.
  118895. * To speed it up, 1/30
  118896. * @param newTimeStep defines the new timestep to apply to this world.
  118897. */
  118898. setTimeStep(newTimeStep?: number): void;
  118899. /**
  118900. * Get the time step of the physics engine.
  118901. * @returns the current time step
  118902. */
  118903. getTimeStep(): number;
  118904. /**
  118905. * Release all resources
  118906. */
  118907. dispose(): void;
  118908. /**
  118909. * Gets the name of the current physics plugin
  118910. * @returns the name of the plugin
  118911. */
  118912. getPhysicsPluginName(): string;
  118913. /**
  118914. * Adding a new impostor for the impostor tracking.
  118915. * This will be done by the impostor itself.
  118916. * @param impostor the impostor to add
  118917. */
  118918. addImpostor(impostor: PhysicsImpostor): void;
  118919. /**
  118920. * Remove an impostor from the engine.
  118921. * This impostor and its mesh will not longer be updated by the physics engine.
  118922. * @param impostor the impostor to remove
  118923. */
  118924. removeImpostor(impostor: PhysicsImpostor): void;
  118925. /**
  118926. * Add a joint to the physics engine
  118927. * @param mainImpostor defines the main impostor to which the joint is added.
  118928. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  118929. * @param joint defines the joint that will connect both impostors.
  118930. */
  118931. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  118932. /**
  118933. * Removes a joint from the simulation
  118934. * @param mainImpostor defines the impostor used with the joint
  118935. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  118936. * @param joint defines the joint to remove
  118937. */
  118938. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  118939. /**
  118940. * Called by the scene. No need to call it.
  118941. * @param delta defines the timespam between frames
  118942. */
  118943. _step(delta: number): void;
  118944. /**
  118945. * Gets the current plugin used to run the simulation
  118946. * @returns current plugin
  118947. */
  118948. getPhysicsPlugin(): IPhysicsEnginePlugin;
  118949. /**
  118950. * Gets the list of physic impostors
  118951. * @returns an array of PhysicsImpostor
  118952. */
  118953. getImpostors(): Array<PhysicsImpostor>;
  118954. /**
  118955. * Gets the impostor for a physics enabled object
  118956. * @param object defines the object impersonated by the impostor
  118957. * @returns the PhysicsImpostor or null if not found
  118958. */
  118959. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  118960. /**
  118961. * Gets the impostor for a physics body object
  118962. * @param body defines physics body used by the impostor
  118963. * @returns the PhysicsImpostor or null if not found
  118964. */
  118965. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  118966. /**
  118967. * Does a raycast in the physics world
  118968. * @param from when should the ray start?
  118969. * @param to when should the ray end?
  118970. * @returns PhysicsRaycastResult
  118971. */
  118972. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  118973. }
  118974. }
  118975. declare module BABYLON {
  118976. /** @hidden */
  118977. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  118978. private _useDeltaForWorldStep;
  118979. world: any;
  118980. name: string;
  118981. private _physicsMaterials;
  118982. private _fixedTimeStep;
  118983. private _cannonRaycastResult;
  118984. private _raycastResult;
  118985. private _physicsBodysToRemoveAfterStep;
  118986. BJSCANNON: any;
  118987. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  118988. setGravity(gravity: Vector3): void;
  118989. setTimeStep(timeStep: number): void;
  118990. getTimeStep(): number;
  118991. executeStep(delta: number): void;
  118992. private _removeMarkedPhysicsBodiesFromWorld;
  118993. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  118994. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  118995. generatePhysicsBody(impostor: PhysicsImpostor): void;
  118996. private _processChildMeshes;
  118997. removePhysicsBody(impostor: PhysicsImpostor): void;
  118998. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  118999. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  119000. private _addMaterial;
  119001. private _checkWithEpsilon;
  119002. private _createShape;
  119003. private _createHeightmap;
  119004. private _minus90X;
  119005. private _plus90X;
  119006. private _tmpPosition;
  119007. private _tmpDeltaPosition;
  119008. private _tmpUnityRotation;
  119009. private _updatePhysicsBodyTransformation;
  119010. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  119011. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  119012. isSupported(): boolean;
  119013. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119014. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119015. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119016. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119017. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  119018. getBodyMass(impostor: PhysicsImpostor): number;
  119019. getBodyFriction(impostor: PhysicsImpostor): number;
  119020. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  119021. getBodyRestitution(impostor: PhysicsImpostor): number;
  119022. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  119023. sleepBody(impostor: PhysicsImpostor): void;
  119024. wakeUpBody(impostor: PhysicsImpostor): void;
  119025. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  119026. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  119027. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  119028. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  119029. getRadius(impostor: PhysicsImpostor): number;
  119030. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  119031. dispose(): void;
  119032. private _extendNamespace;
  119033. /**
  119034. * Does a raycast in the physics world
  119035. * @param from when should the ray start?
  119036. * @param to when should the ray end?
  119037. * @returns PhysicsRaycastResult
  119038. */
  119039. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  119040. }
  119041. }
  119042. declare module BABYLON {
  119043. /** @hidden */
  119044. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  119045. world: any;
  119046. name: string;
  119047. BJSOIMO: any;
  119048. private _raycastResult;
  119049. constructor(iterations?: number, oimoInjection?: any);
  119050. setGravity(gravity: Vector3): void;
  119051. setTimeStep(timeStep: number): void;
  119052. getTimeStep(): number;
  119053. private _tmpImpostorsArray;
  119054. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  119055. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119056. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119057. generatePhysicsBody(impostor: PhysicsImpostor): void;
  119058. private _tmpPositionVector;
  119059. removePhysicsBody(impostor: PhysicsImpostor): void;
  119060. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  119061. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  119062. isSupported(): boolean;
  119063. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  119064. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  119065. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119066. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119067. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119068. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119069. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  119070. getBodyMass(impostor: PhysicsImpostor): number;
  119071. getBodyFriction(impostor: PhysicsImpostor): number;
  119072. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  119073. getBodyRestitution(impostor: PhysicsImpostor): number;
  119074. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  119075. sleepBody(impostor: PhysicsImpostor): void;
  119076. wakeUpBody(impostor: PhysicsImpostor): void;
  119077. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  119078. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  119079. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  119080. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  119081. getRadius(impostor: PhysicsImpostor): number;
  119082. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  119083. dispose(): void;
  119084. /**
  119085. * Does a raycast in the physics world
  119086. * @param from when should the ray start?
  119087. * @param to when should the ray end?
  119088. * @returns PhysicsRaycastResult
  119089. */
  119090. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  119091. }
  119092. }
  119093. declare module BABYLON {
  119094. /**
  119095. * Class containing static functions to help procedurally build meshes
  119096. */
  119097. export class RibbonBuilder {
  119098. /**
  119099. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  119100. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  119101. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  119102. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  119103. * * 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
  119104. * * 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
  119105. * * 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
  119106. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  119107. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  119108. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  119109. * * 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
  119110. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  119111. * * 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
  119112. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  119113. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  119114. * @param name defines the name of the mesh
  119115. * @param options defines the options used to create the mesh
  119116. * @param scene defines the hosting scene
  119117. * @returns the ribbon mesh
  119118. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  119119. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  119120. */
  119121. static CreateRibbon(name: string, options: {
  119122. pathArray: Vector3[][];
  119123. closeArray?: boolean;
  119124. closePath?: boolean;
  119125. offset?: number;
  119126. updatable?: boolean;
  119127. sideOrientation?: number;
  119128. frontUVs?: Vector4;
  119129. backUVs?: Vector4;
  119130. instance?: Mesh;
  119131. invertUV?: boolean;
  119132. uvs?: Vector2[];
  119133. colors?: Color4[];
  119134. }, scene?: Nullable<Scene>): Mesh;
  119135. }
  119136. }
  119137. declare module BABYLON {
  119138. /**
  119139. * Class containing static functions to help procedurally build meshes
  119140. */
  119141. export class ShapeBuilder {
  119142. /**
  119143. * 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.
  119144. * * 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.
  119145. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  119146. * * 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.
  119147. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  119148. * * 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
  119149. * * 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
  119150. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  119151. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  119152. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  119153. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  119154. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  119155. * @param name defines the name of the mesh
  119156. * @param options defines the options used to create the mesh
  119157. * @param scene defines the hosting scene
  119158. * @returns the extruded shape mesh
  119159. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  119160. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  119161. */
  119162. static ExtrudeShape(name: string, options: {
  119163. shape: Vector3[];
  119164. path: Vector3[];
  119165. scale?: number;
  119166. rotation?: number;
  119167. cap?: number;
  119168. updatable?: boolean;
  119169. sideOrientation?: number;
  119170. frontUVs?: Vector4;
  119171. backUVs?: Vector4;
  119172. instance?: Mesh;
  119173. invertUV?: boolean;
  119174. }, scene?: Nullable<Scene>): Mesh;
  119175. /**
  119176. * Creates an custom extruded shape mesh.
  119177. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  119178. * * 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.
  119179. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  119180. * * 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
  119181. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  119182. * * 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
  119183. * * It must returns a float value that will be the scale value applied to the shape on each path point
  119184. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  119185. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  119186. * * 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
  119187. * * 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
  119188. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  119189. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  119190. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  119191. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  119192. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  119193. * @param name defines the name of the mesh
  119194. * @param options defines the options used to create the mesh
  119195. * @param scene defines the hosting scene
  119196. * @returns the custom extruded shape mesh
  119197. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  119198. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  119199. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  119200. */
  119201. static ExtrudeShapeCustom(name: string, options: {
  119202. shape: Vector3[];
  119203. path: Vector3[];
  119204. scaleFunction?: any;
  119205. rotationFunction?: any;
  119206. ribbonCloseArray?: boolean;
  119207. ribbonClosePath?: boolean;
  119208. cap?: number;
  119209. updatable?: boolean;
  119210. sideOrientation?: number;
  119211. frontUVs?: Vector4;
  119212. backUVs?: Vector4;
  119213. instance?: Mesh;
  119214. invertUV?: boolean;
  119215. }, scene?: Nullable<Scene>): Mesh;
  119216. private static _ExtrudeShapeGeneric;
  119217. }
  119218. }
  119219. declare module BABYLON {
  119220. /**
  119221. * AmmoJS Physics plugin
  119222. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  119223. * @see https://github.com/kripken/ammo.js/
  119224. */
  119225. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  119226. private _useDeltaForWorldStep;
  119227. /**
  119228. * Reference to the Ammo library
  119229. */
  119230. bjsAMMO: any;
  119231. /**
  119232. * Created ammoJS world which physics bodies are added to
  119233. */
  119234. world: any;
  119235. /**
  119236. * Name of the plugin
  119237. */
  119238. name: string;
  119239. private _timeStep;
  119240. private _fixedTimeStep;
  119241. private _maxSteps;
  119242. private _tmpQuaternion;
  119243. private _tmpAmmoTransform;
  119244. private _tmpAmmoQuaternion;
  119245. private _tmpAmmoConcreteContactResultCallback;
  119246. private _collisionConfiguration;
  119247. private _dispatcher;
  119248. private _overlappingPairCache;
  119249. private _solver;
  119250. private _softBodySolver;
  119251. private _tmpAmmoVectorA;
  119252. private _tmpAmmoVectorB;
  119253. private _tmpAmmoVectorC;
  119254. private _tmpAmmoVectorD;
  119255. private _tmpContactCallbackResult;
  119256. private _tmpAmmoVectorRCA;
  119257. private _tmpAmmoVectorRCB;
  119258. private _raycastResult;
  119259. private static readonly DISABLE_COLLISION_FLAG;
  119260. private static readonly KINEMATIC_FLAG;
  119261. private static readonly DISABLE_DEACTIVATION_FLAG;
  119262. /**
  119263. * Initializes the ammoJS plugin
  119264. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  119265. * @param ammoInjection can be used to inject your own ammo reference
  119266. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  119267. */
  119268. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  119269. /**
  119270. * Sets the gravity of the physics world (m/(s^2))
  119271. * @param gravity Gravity to set
  119272. */
  119273. setGravity(gravity: Vector3): void;
  119274. /**
  119275. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  119276. * @param timeStep timestep to use in seconds
  119277. */
  119278. setTimeStep(timeStep: number): void;
  119279. /**
  119280. * 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)
  119281. * @param fixedTimeStep fixedTimeStep to use in seconds
  119282. */
  119283. setFixedTimeStep(fixedTimeStep: number): void;
  119284. /**
  119285. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  119286. * @param maxSteps the maximum number of steps by the physics engine per frame
  119287. */
  119288. setMaxSteps(maxSteps: number): void;
  119289. /**
  119290. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  119291. * @returns the current timestep in seconds
  119292. */
  119293. getTimeStep(): number;
  119294. private _isImpostorInContact;
  119295. private _isImpostorPairInContact;
  119296. private _stepSimulation;
  119297. /**
  119298. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  119299. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  119300. * After the step the babylon meshes are set to the position of the physics imposters
  119301. * @param delta amount of time to step forward
  119302. * @param impostors array of imposters to update before/after the step
  119303. */
  119304. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  119305. /**
  119306. * Update babylon mesh to match physics world object
  119307. * @param impostor imposter to match
  119308. */
  119309. private _afterSoftStep;
  119310. /**
  119311. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  119312. * @param impostor imposter to match
  119313. */
  119314. private _ropeStep;
  119315. /**
  119316. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  119317. * @param impostor imposter to match
  119318. */
  119319. private _softbodyOrClothStep;
  119320. private _tmpVector;
  119321. private _tmpMatrix;
  119322. /**
  119323. * Applies an impulse on the imposter
  119324. * @param impostor imposter to apply impulse to
  119325. * @param force amount of force to be applied to the imposter
  119326. * @param contactPoint the location to apply the impulse on the imposter
  119327. */
  119328. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119329. /**
  119330. * Applies a force on the imposter
  119331. * @param impostor imposter to apply force
  119332. * @param force amount of force to be applied to the imposter
  119333. * @param contactPoint the location to apply the force on the imposter
  119334. */
  119335. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119336. /**
  119337. * Creates a physics body using the plugin
  119338. * @param impostor the imposter to create the physics body on
  119339. */
  119340. generatePhysicsBody(impostor: PhysicsImpostor): void;
  119341. /**
  119342. * Removes the physics body from the imposter and disposes of the body's memory
  119343. * @param impostor imposter to remove the physics body from
  119344. */
  119345. removePhysicsBody(impostor: PhysicsImpostor): void;
  119346. /**
  119347. * Generates a joint
  119348. * @param impostorJoint the imposter joint to create the joint with
  119349. */
  119350. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  119351. /**
  119352. * Removes a joint
  119353. * @param impostorJoint the imposter joint to remove the joint from
  119354. */
  119355. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  119356. private _addMeshVerts;
  119357. /**
  119358. * Initialise the soft body vertices to match its object's (mesh) vertices
  119359. * Softbody vertices (nodes) are in world space and to match this
  119360. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  119361. * @param impostor to create the softbody for
  119362. */
  119363. private _softVertexData;
  119364. /**
  119365. * Create an impostor's soft body
  119366. * @param impostor to create the softbody for
  119367. */
  119368. private _createSoftbody;
  119369. /**
  119370. * Create cloth for an impostor
  119371. * @param impostor to create the softbody for
  119372. */
  119373. private _createCloth;
  119374. /**
  119375. * Create rope for an impostor
  119376. * @param impostor to create the softbody for
  119377. */
  119378. private _createRope;
  119379. private _addHullVerts;
  119380. private _createShape;
  119381. /**
  119382. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  119383. * @param impostor imposter containing the physics body and babylon object
  119384. */
  119385. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  119386. /**
  119387. * Sets the babylon object's position/rotation from the physics body's position/rotation
  119388. * @param impostor imposter containing the physics body and babylon object
  119389. * @param newPosition new position
  119390. * @param newRotation new rotation
  119391. */
  119392. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  119393. /**
  119394. * If this plugin is supported
  119395. * @returns true if its supported
  119396. */
  119397. isSupported(): boolean;
  119398. /**
  119399. * Sets the linear velocity of the physics body
  119400. * @param impostor imposter to set the velocity on
  119401. * @param velocity velocity to set
  119402. */
  119403. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119404. /**
  119405. * Sets the angular velocity of the physics body
  119406. * @param impostor imposter to set the velocity on
  119407. * @param velocity velocity to set
  119408. */
  119409. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119410. /**
  119411. * gets the linear velocity
  119412. * @param impostor imposter to get linear velocity from
  119413. * @returns linear velocity
  119414. */
  119415. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119416. /**
  119417. * gets the angular velocity
  119418. * @param impostor imposter to get angular velocity from
  119419. * @returns angular velocity
  119420. */
  119421. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119422. /**
  119423. * Sets the mass of physics body
  119424. * @param impostor imposter to set the mass on
  119425. * @param mass mass to set
  119426. */
  119427. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  119428. /**
  119429. * Gets the mass of the physics body
  119430. * @param impostor imposter to get the mass from
  119431. * @returns mass
  119432. */
  119433. getBodyMass(impostor: PhysicsImpostor): number;
  119434. /**
  119435. * Gets friction of the impostor
  119436. * @param impostor impostor to get friction from
  119437. * @returns friction value
  119438. */
  119439. getBodyFriction(impostor: PhysicsImpostor): number;
  119440. /**
  119441. * Sets friction of the impostor
  119442. * @param impostor impostor to set friction on
  119443. * @param friction friction value
  119444. */
  119445. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  119446. /**
  119447. * Gets restitution of the impostor
  119448. * @param impostor impostor to get restitution from
  119449. * @returns restitution value
  119450. */
  119451. getBodyRestitution(impostor: PhysicsImpostor): number;
  119452. /**
  119453. * Sets resitution of the impostor
  119454. * @param impostor impostor to set resitution on
  119455. * @param restitution resitution value
  119456. */
  119457. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  119458. /**
  119459. * Gets pressure inside the impostor
  119460. * @param impostor impostor to get pressure from
  119461. * @returns pressure value
  119462. */
  119463. getBodyPressure(impostor: PhysicsImpostor): number;
  119464. /**
  119465. * Sets pressure inside a soft body impostor
  119466. * Cloth and rope must remain 0 pressure
  119467. * @param impostor impostor to set pressure on
  119468. * @param pressure pressure value
  119469. */
  119470. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  119471. /**
  119472. * Gets stiffness of the impostor
  119473. * @param impostor impostor to get stiffness from
  119474. * @returns pressure value
  119475. */
  119476. getBodyStiffness(impostor: PhysicsImpostor): number;
  119477. /**
  119478. * Sets stiffness of the impostor
  119479. * @param impostor impostor to set stiffness on
  119480. * @param stiffness stiffness value from 0 to 1
  119481. */
  119482. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  119483. /**
  119484. * Gets velocityIterations of the impostor
  119485. * @param impostor impostor to get velocity iterations from
  119486. * @returns velocityIterations value
  119487. */
  119488. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  119489. /**
  119490. * Sets velocityIterations of the impostor
  119491. * @param impostor impostor to set velocity iterations on
  119492. * @param velocityIterations velocityIterations value
  119493. */
  119494. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  119495. /**
  119496. * Gets positionIterations of the impostor
  119497. * @param impostor impostor to get position iterations from
  119498. * @returns positionIterations value
  119499. */
  119500. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  119501. /**
  119502. * Sets positionIterations of the impostor
  119503. * @param impostor impostor to set position on
  119504. * @param positionIterations positionIterations value
  119505. */
  119506. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  119507. /**
  119508. * Append an anchor to a cloth object
  119509. * @param impostor is the cloth impostor to add anchor to
  119510. * @param otherImpostor is the rigid impostor to anchor to
  119511. * @param width ratio across width from 0 to 1
  119512. * @param height ratio up height from 0 to 1
  119513. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  119514. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  119515. */
  119516. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  119517. /**
  119518. * Append an hook to a rope object
  119519. * @param impostor is the rope impostor to add hook to
  119520. * @param otherImpostor is the rigid impostor to hook to
  119521. * @param length ratio along the rope from 0 to 1
  119522. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  119523. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  119524. */
  119525. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  119526. /**
  119527. * Sleeps the physics body and stops it from being active
  119528. * @param impostor impostor to sleep
  119529. */
  119530. sleepBody(impostor: PhysicsImpostor): void;
  119531. /**
  119532. * Activates the physics body
  119533. * @param impostor impostor to activate
  119534. */
  119535. wakeUpBody(impostor: PhysicsImpostor): void;
  119536. /**
  119537. * Updates the distance parameters of the joint
  119538. * @param joint joint to update
  119539. * @param maxDistance maximum distance of the joint
  119540. * @param minDistance minimum distance of the joint
  119541. */
  119542. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  119543. /**
  119544. * Sets a motor on the joint
  119545. * @param joint joint to set motor on
  119546. * @param speed speed of the motor
  119547. * @param maxForce maximum force of the motor
  119548. * @param motorIndex index of the motor
  119549. */
  119550. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  119551. /**
  119552. * Sets the motors limit
  119553. * @param joint joint to set limit on
  119554. * @param upperLimit upper limit
  119555. * @param lowerLimit lower limit
  119556. */
  119557. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  119558. /**
  119559. * Syncs the position and rotation of a mesh with the impostor
  119560. * @param mesh mesh to sync
  119561. * @param impostor impostor to update the mesh with
  119562. */
  119563. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  119564. /**
  119565. * Gets the radius of the impostor
  119566. * @param impostor impostor to get radius from
  119567. * @returns the radius
  119568. */
  119569. getRadius(impostor: PhysicsImpostor): number;
  119570. /**
  119571. * Gets the box size of the impostor
  119572. * @param impostor impostor to get box size from
  119573. * @param result the resulting box size
  119574. */
  119575. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  119576. /**
  119577. * Disposes of the impostor
  119578. */
  119579. dispose(): void;
  119580. /**
  119581. * Does a raycast in the physics world
  119582. * @param from when should the ray start?
  119583. * @param to when should the ray end?
  119584. * @returns PhysicsRaycastResult
  119585. */
  119586. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  119587. }
  119588. }
  119589. declare module BABYLON {
  119590. interface AbstractScene {
  119591. /**
  119592. * The list of reflection probes added to the scene
  119593. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  119594. */
  119595. reflectionProbes: Array<ReflectionProbe>;
  119596. /**
  119597. * Removes the given reflection probe from this scene.
  119598. * @param toRemove The reflection probe to remove
  119599. * @returns The index of the removed reflection probe
  119600. */
  119601. removeReflectionProbe(toRemove: ReflectionProbe): number;
  119602. /**
  119603. * Adds the given reflection probe to this scene.
  119604. * @param newReflectionProbe The reflection probe to add
  119605. */
  119606. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  119607. }
  119608. /**
  119609. * Class used to generate realtime reflection / refraction cube textures
  119610. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  119611. */
  119612. export class ReflectionProbe {
  119613. /** defines the name of the probe */
  119614. name: string;
  119615. private _scene;
  119616. private _renderTargetTexture;
  119617. private _projectionMatrix;
  119618. private _viewMatrix;
  119619. private _target;
  119620. private _add;
  119621. private _attachedMesh;
  119622. private _invertYAxis;
  119623. /** Gets or sets probe position (center of the cube map) */
  119624. position: Vector3;
  119625. /**
  119626. * Creates a new reflection probe
  119627. * @param name defines the name of the probe
  119628. * @param size defines the texture resolution (for each face)
  119629. * @param scene defines the hosting scene
  119630. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  119631. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  119632. */
  119633. constructor(
  119634. /** defines the name of the probe */
  119635. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  119636. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  119637. samples: number;
  119638. /** Gets or sets the refresh rate to use (on every frame by default) */
  119639. refreshRate: number;
  119640. /**
  119641. * Gets the hosting scene
  119642. * @returns a Scene
  119643. */
  119644. getScene(): Scene;
  119645. /** Gets the internal CubeTexture used to render to */
  119646. readonly cubeTexture: RenderTargetTexture;
  119647. /** Gets the list of meshes to render */
  119648. readonly renderList: Nullable<AbstractMesh[]>;
  119649. /**
  119650. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  119651. * @param mesh defines the mesh to attach to
  119652. */
  119653. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  119654. /**
  119655. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  119656. * @param renderingGroupId The rendering group id corresponding to its index
  119657. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  119658. */
  119659. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  119660. /**
  119661. * Clean all associated resources
  119662. */
  119663. dispose(): void;
  119664. /**
  119665. * Converts the reflection probe information to a readable string for debug purpose.
  119666. * @param fullDetails Supports for multiple levels of logging within scene loading
  119667. * @returns the human readable reflection probe info
  119668. */
  119669. toString(fullDetails?: boolean): string;
  119670. /**
  119671. * Get the class name of the relfection probe.
  119672. * @returns "ReflectionProbe"
  119673. */
  119674. getClassName(): string;
  119675. /**
  119676. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  119677. * @returns The JSON representation of the texture
  119678. */
  119679. serialize(): any;
  119680. /**
  119681. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  119682. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  119683. * @param scene Define the scene the parsed reflection probe should be instantiated in
  119684. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  119685. * @returns The parsed reflection probe if successful
  119686. */
  119687. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  119688. }
  119689. }
  119690. declare module BABYLON {
  119691. /** @hidden */
  119692. export var _BabylonLoaderRegistered: boolean;
  119693. /**
  119694. * Helps setting up some configuration for the babylon file loader.
  119695. */
  119696. export class BabylonFileLoaderConfiguration {
  119697. /**
  119698. * The loader does not allow injecting custom physix engine into the plugins.
  119699. * Unfortunately in ES6, we need to manually inject them into the plugin.
  119700. * So you could set this variable to your engine import to make it work.
  119701. */
  119702. static LoaderInjectedPhysicsEngine: any;
  119703. }
  119704. }
  119705. declare module BABYLON {
  119706. /**
  119707. * The Physically based simple base material of BJS.
  119708. *
  119709. * This enables better naming and convention enforcements on top of the pbrMaterial.
  119710. * It is used as the base class for both the specGloss and metalRough conventions.
  119711. */
  119712. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  119713. /**
  119714. * Number of Simultaneous lights allowed on the material.
  119715. */
  119716. maxSimultaneousLights: number;
  119717. /**
  119718. * If sets to true, disables all the lights affecting the material.
  119719. */
  119720. disableLighting: boolean;
  119721. /**
  119722. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  119723. */
  119724. environmentTexture: BaseTexture;
  119725. /**
  119726. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  119727. */
  119728. invertNormalMapX: boolean;
  119729. /**
  119730. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  119731. */
  119732. invertNormalMapY: boolean;
  119733. /**
  119734. * Normal map used in the model.
  119735. */
  119736. normalTexture: BaseTexture;
  119737. /**
  119738. * Emissivie color used to self-illuminate the model.
  119739. */
  119740. emissiveColor: Color3;
  119741. /**
  119742. * Emissivie texture used to self-illuminate the model.
  119743. */
  119744. emissiveTexture: BaseTexture;
  119745. /**
  119746. * Occlusion Channel Strenght.
  119747. */
  119748. occlusionStrength: number;
  119749. /**
  119750. * Occlusion Texture of the material (adding extra occlusion effects).
  119751. */
  119752. occlusionTexture: BaseTexture;
  119753. /**
  119754. * Defines the alpha limits in alpha test mode.
  119755. */
  119756. alphaCutOff: number;
  119757. /**
  119758. * Gets the current double sided mode.
  119759. */
  119760. /**
  119761. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  119762. */
  119763. doubleSided: boolean;
  119764. /**
  119765. * Stores the pre-calculated light information of a mesh in a texture.
  119766. */
  119767. lightmapTexture: BaseTexture;
  119768. /**
  119769. * If true, the light map contains occlusion information instead of lighting info.
  119770. */
  119771. useLightmapAsShadowmap: boolean;
  119772. /**
  119773. * Instantiates a new PBRMaterial instance.
  119774. *
  119775. * @param name The material name
  119776. * @param scene The scene the material will be use in.
  119777. */
  119778. constructor(name: string, scene: Scene);
  119779. getClassName(): string;
  119780. }
  119781. }
  119782. declare module BABYLON {
  119783. /**
  119784. * The PBR material of BJS following the metal roughness convention.
  119785. *
  119786. * This fits to the PBR convention in the GLTF definition:
  119787. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  119788. */
  119789. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  119790. /**
  119791. * The base color has two different interpretations depending on the value of metalness.
  119792. * When the material is a metal, the base color is the specific measured reflectance value
  119793. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  119794. * of the material.
  119795. */
  119796. baseColor: Color3;
  119797. /**
  119798. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  119799. * well as opacity information in the alpha channel.
  119800. */
  119801. baseTexture: BaseTexture;
  119802. /**
  119803. * Specifies the metallic scalar value of the material.
  119804. * Can also be used to scale the metalness values of the metallic texture.
  119805. */
  119806. metallic: number;
  119807. /**
  119808. * Specifies the roughness scalar value of the material.
  119809. * Can also be used to scale the roughness values of the metallic texture.
  119810. */
  119811. roughness: number;
  119812. /**
  119813. * Texture containing both the metallic value in the B channel and the
  119814. * roughness value in the G channel to keep better precision.
  119815. */
  119816. metallicRoughnessTexture: BaseTexture;
  119817. /**
  119818. * Instantiates a new PBRMetalRoughnessMaterial instance.
  119819. *
  119820. * @param name The material name
  119821. * @param scene The scene the material will be use in.
  119822. */
  119823. constructor(name: string, scene: Scene);
  119824. /**
  119825. * Return the currrent class name of the material.
  119826. */
  119827. getClassName(): string;
  119828. /**
  119829. * Makes a duplicate of the current material.
  119830. * @param name - name to use for the new material.
  119831. */
  119832. clone(name: string): PBRMetallicRoughnessMaterial;
  119833. /**
  119834. * Serialize the material to a parsable JSON object.
  119835. */
  119836. serialize(): any;
  119837. /**
  119838. * Parses a JSON object correponding to the serialize function.
  119839. */
  119840. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  119841. }
  119842. }
  119843. declare module BABYLON {
  119844. /**
  119845. * The PBR material of BJS following the specular glossiness convention.
  119846. *
  119847. * This fits to the PBR convention in the GLTF definition:
  119848. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  119849. */
  119850. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  119851. /**
  119852. * Specifies the diffuse color of the material.
  119853. */
  119854. diffuseColor: Color3;
  119855. /**
  119856. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  119857. * channel.
  119858. */
  119859. diffuseTexture: BaseTexture;
  119860. /**
  119861. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  119862. */
  119863. specularColor: Color3;
  119864. /**
  119865. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  119866. */
  119867. glossiness: number;
  119868. /**
  119869. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  119870. */
  119871. specularGlossinessTexture: BaseTexture;
  119872. /**
  119873. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  119874. *
  119875. * @param name The material name
  119876. * @param scene The scene the material will be use in.
  119877. */
  119878. constructor(name: string, scene: Scene);
  119879. /**
  119880. * Return the currrent class name of the material.
  119881. */
  119882. getClassName(): string;
  119883. /**
  119884. * Makes a duplicate of the current material.
  119885. * @param name - name to use for the new material.
  119886. */
  119887. clone(name: string): PBRSpecularGlossinessMaterial;
  119888. /**
  119889. * Serialize the material to a parsable JSON object.
  119890. */
  119891. serialize(): any;
  119892. /**
  119893. * Parses a JSON object correponding to the serialize function.
  119894. */
  119895. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  119896. }
  119897. }
  119898. declare module BABYLON {
  119899. /**
  119900. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  119901. * It can help converting any input color in a desired output one. This can then be used to create effects
  119902. * from sepia, black and white to sixties or futuristic rendering...
  119903. *
  119904. * The only supported format is currently 3dl.
  119905. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  119906. */
  119907. export class ColorGradingTexture extends BaseTexture {
  119908. /**
  119909. * The current texture matrix. (will always be identity in color grading texture)
  119910. */
  119911. private _textureMatrix;
  119912. /**
  119913. * The texture URL.
  119914. */
  119915. url: string;
  119916. /**
  119917. * Empty line regex stored for GC.
  119918. */
  119919. private static _noneEmptyLineRegex;
  119920. private _engine;
  119921. /**
  119922. * Instantiates a ColorGradingTexture from the following parameters.
  119923. *
  119924. * @param url The location of the color gradind data (currently only supporting 3dl)
  119925. * @param scene The scene the texture will be used in
  119926. */
  119927. constructor(url: string, scene: Scene);
  119928. /**
  119929. * Returns the texture matrix used in most of the material.
  119930. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  119931. */
  119932. getTextureMatrix(): Matrix;
  119933. /**
  119934. * Occurs when the file being loaded is a .3dl LUT file.
  119935. */
  119936. private load3dlTexture;
  119937. /**
  119938. * Starts the loading process of the texture.
  119939. */
  119940. private loadTexture;
  119941. /**
  119942. * Clones the color gradind texture.
  119943. */
  119944. clone(): ColorGradingTexture;
  119945. /**
  119946. * Called during delayed load for textures.
  119947. */
  119948. delayLoad(): void;
  119949. /**
  119950. * Parses a color grading texture serialized by Babylon.
  119951. * @param parsedTexture The texture information being parsedTexture
  119952. * @param scene The scene to load the texture in
  119953. * @param rootUrl The root url of the data assets to load
  119954. * @return A color gradind texture
  119955. */
  119956. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  119957. /**
  119958. * Serializes the LUT texture to json format.
  119959. */
  119960. serialize(): any;
  119961. }
  119962. }
  119963. declare module BABYLON {
  119964. /**
  119965. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  119966. */
  119967. export class EquiRectangularCubeTexture extends BaseTexture {
  119968. /** The six faces of the cube. */
  119969. private static _FacesMapping;
  119970. private _noMipmap;
  119971. private _onLoad;
  119972. private _onError;
  119973. /** The size of the cubemap. */
  119974. private _size;
  119975. /** The buffer of the image. */
  119976. private _buffer;
  119977. /** The width of the input image. */
  119978. private _width;
  119979. /** The height of the input image. */
  119980. private _height;
  119981. /** The URL to the image. */
  119982. url: string;
  119983. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  119984. coordinatesMode: number;
  119985. /**
  119986. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  119987. * @param url The location of the image
  119988. * @param scene The scene the texture will be used in
  119989. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  119990. * @param noMipmap Forces to not generate the mipmap if true
  119991. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  119992. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  119993. * @param onLoad — defines a callback called when texture is loaded
  119994. * @param onError — defines a callback called if there is an error
  119995. */
  119996. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  119997. /**
  119998. * Load the image data, by putting the image on a canvas and extracting its buffer.
  119999. */
  120000. private loadImage;
  120001. /**
  120002. * Convert the image buffer into a cubemap and create a CubeTexture.
  120003. */
  120004. private loadTexture;
  120005. /**
  120006. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  120007. * @param buffer The ArrayBuffer that should be converted.
  120008. * @returns The buffer as Float32Array.
  120009. */
  120010. private getFloat32ArrayFromArrayBuffer;
  120011. /**
  120012. * Get the current class name of the texture useful for serialization or dynamic coding.
  120013. * @returns "EquiRectangularCubeTexture"
  120014. */
  120015. getClassName(): string;
  120016. /**
  120017. * Create a clone of the current EquiRectangularCubeTexture and return it.
  120018. * @returns A clone of the current EquiRectangularCubeTexture.
  120019. */
  120020. clone(): EquiRectangularCubeTexture;
  120021. }
  120022. }
  120023. declare module BABYLON {
  120024. /**
  120025. * Based on jsTGALoader - Javascript loader for TGA file
  120026. * By Vincent Thibault
  120027. * @see http://blog.robrowser.com/javascript-tga-loader.html
  120028. */
  120029. export class TGATools {
  120030. private static _TYPE_INDEXED;
  120031. private static _TYPE_RGB;
  120032. private static _TYPE_GREY;
  120033. private static _TYPE_RLE_INDEXED;
  120034. private static _TYPE_RLE_RGB;
  120035. private static _TYPE_RLE_GREY;
  120036. private static _ORIGIN_MASK;
  120037. private static _ORIGIN_SHIFT;
  120038. private static _ORIGIN_BL;
  120039. private static _ORIGIN_BR;
  120040. private static _ORIGIN_UL;
  120041. private static _ORIGIN_UR;
  120042. /**
  120043. * Gets the header of a TGA file
  120044. * @param data defines the TGA data
  120045. * @returns the header
  120046. */
  120047. static GetTGAHeader(data: Uint8Array): any;
  120048. /**
  120049. * Uploads TGA content to a Babylon Texture
  120050. * @hidden
  120051. */
  120052. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  120053. /** @hidden */
  120054. 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;
  120055. /** @hidden */
  120056. 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;
  120057. /** @hidden */
  120058. 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;
  120059. /** @hidden */
  120060. 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;
  120061. /** @hidden */
  120062. 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;
  120063. /** @hidden */
  120064. 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;
  120065. }
  120066. }
  120067. declare module BABYLON {
  120068. /**
  120069. * Implementation of the TGA Texture Loader.
  120070. * @hidden
  120071. */
  120072. export class _TGATextureLoader implements IInternalTextureLoader {
  120073. /**
  120074. * Defines wether the loader supports cascade loading the different faces.
  120075. */
  120076. readonly supportCascades: boolean;
  120077. /**
  120078. * This returns if the loader support the current file information.
  120079. * @param extension defines the file extension of the file being loaded
  120080. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120081. * @param fallback defines the fallback internal texture if any
  120082. * @param isBase64 defines whether the texture is encoded as a base64
  120083. * @param isBuffer defines whether the texture data are stored as a buffer
  120084. * @returns true if the loader can load the specified file
  120085. */
  120086. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  120087. /**
  120088. * Transform the url before loading if required.
  120089. * @param rootUrl the url of the texture
  120090. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120091. * @returns the transformed texture
  120092. */
  120093. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  120094. /**
  120095. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  120096. * @param rootUrl the url of the texture
  120097. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120098. * @returns the fallback texture
  120099. */
  120100. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  120101. /**
  120102. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  120103. * @param data contains the texture data
  120104. * @param texture defines the BabylonJS internal texture
  120105. * @param createPolynomials will be true if polynomials have been requested
  120106. * @param onLoad defines the callback to trigger once the texture is ready
  120107. * @param onError defines the callback to trigger in case of error
  120108. */
  120109. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  120110. /**
  120111. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  120112. * @param data contains the texture data
  120113. * @param texture defines the BabylonJS internal texture
  120114. * @param callback defines the method to call once ready to upload
  120115. */
  120116. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  120117. }
  120118. }
  120119. declare module BABYLON {
  120120. /**
  120121. * Info about the .basis files
  120122. */
  120123. class BasisFileInfo {
  120124. /**
  120125. * If the file has alpha
  120126. */
  120127. hasAlpha: boolean;
  120128. /**
  120129. * Info about each image of the basis file
  120130. */
  120131. images: Array<{
  120132. levels: Array<{
  120133. width: number;
  120134. height: number;
  120135. transcodedPixels: ArrayBufferView;
  120136. }>;
  120137. }>;
  120138. }
  120139. /**
  120140. * Result of transcoding a basis file
  120141. */
  120142. class TranscodeResult {
  120143. /**
  120144. * Info about the .basis file
  120145. */
  120146. fileInfo: BasisFileInfo;
  120147. /**
  120148. * Format to use when loading the file
  120149. */
  120150. format: number;
  120151. }
  120152. /**
  120153. * Configuration options for the Basis transcoder
  120154. */
  120155. export class BasisTranscodeConfiguration {
  120156. /**
  120157. * Supported compression formats used to determine the supported output format of the transcoder
  120158. */
  120159. supportedCompressionFormats?: {
  120160. /**
  120161. * etc1 compression format
  120162. */
  120163. etc1?: boolean;
  120164. /**
  120165. * s3tc compression format
  120166. */
  120167. s3tc?: boolean;
  120168. /**
  120169. * pvrtc compression format
  120170. */
  120171. pvrtc?: boolean;
  120172. /**
  120173. * etc2 compression format
  120174. */
  120175. etc2?: boolean;
  120176. };
  120177. /**
  120178. * If mipmap levels should be loaded for transcoded images (Default: true)
  120179. */
  120180. loadMipmapLevels?: boolean;
  120181. /**
  120182. * Index of a single image to load (Default: all images)
  120183. */
  120184. loadSingleImage?: number;
  120185. }
  120186. /**
  120187. * Used to load .Basis files
  120188. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  120189. */
  120190. export class BasisTools {
  120191. private static _IgnoreSupportedFormats;
  120192. /**
  120193. * URL to use when loading the basis transcoder
  120194. */
  120195. static JSModuleURL: string;
  120196. /**
  120197. * URL to use when loading the wasm module for the transcoder
  120198. */
  120199. static WasmModuleURL: string;
  120200. /**
  120201. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  120202. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  120203. * @returns internal format corresponding to the Basis format
  120204. */
  120205. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  120206. private static _WorkerPromise;
  120207. private static _Worker;
  120208. private static _actionId;
  120209. private static _CreateWorkerAsync;
  120210. /**
  120211. * Transcodes a loaded image file to compressed pixel data
  120212. * @param imageData image data to transcode
  120213. * @param config configuration options for the transcoding
  120214. * @returns a promise resulting in the transcoded image
  120215. */
  120216. static TranscodeAsync(imageData: ArrayBuffer, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  120217. /**
  120218. * Loads a texture from the transcode result
  120219. * @param texture texture load to
  120220. * @param transcodeResult the result of transcoding the basis file to load from
  120221. */
  120222. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  120223. }
  120224. }
  120225. declare module BABYLON {
  120226. /**
  120227. * Loader for .basis file format
  120228. */
  120229. export class _BasisTextureLoader implements IInternalTextureLoader {
  120230. /**
  120231. * Defines whether the loader supports cascade loading the different faces.
  120232. */
  120233. readonly supportCascades: boolean;
  120234. /**
  120235. * This returns if the loader support the current file information.
  120236. * @param extension defines the file extension of the file being loaded
  120237. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120238. * @param fallback defines the fallback internal texture if any
  120239. * @param isBase64 defines whether the texture is encoded as a base64
  120240. * @param isBuffer defines whether the texture data are stored as a buffer
  120241. * @returns true if the loader can load the specified file
  120242. */
  120243. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  120244. /**
  120245. * Transform the url before loading if required.
  120246. * @param rootUrl the url of the texture
  120247. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120248. * @returns the transformed texture
  120249. */
  120250. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  120251. /**
  120252. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  120253. * @param rootUrl the url of the texture
  120254. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120255. * @returns the fallback texture
  120256. */
  120257. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  120258. /**
  120259. * Uploads the cube texture data to the WebGl Texture. It has already been bound.
  120260. * @param data contains the texture data
  120261. * @param texture defines the BabylonJS internal texture
  120262. * @param createPolynomials will be true if polynomials have been requested
  120263. * @param onLoad defines the callback to trigger once the texture is ready
  120264. * @param onError defines the callback to trigger in case of error
  120265. */
  120266. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  120267. /**
  120268. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  120269. * @param data contains the texture data
  120270. * @param texture defines the BabylonJS internal texture
  120271. * @param callback defines the method to call once ready to upload
  120272. */
  120273. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  120274. }
  120275. }
  120276. declare module BABYLON {
  120277. /**
  120278. * 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.
  120279. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  120280. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  120281. */
  120282. export class CustomProceduralTexture extends ProceduralTexture {
  120283. private _animate;
  120284. private _time;
  120285. private _config;
  120286. private _texturePath;
  120287. /**
  120288. * Instantiates a new Custom Procedural Texture.
  120289. * 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.
  120290. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  120291. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  120292. * @param name Define the name of the texture
  120293. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  120294. * @param size Define the size of the texture to create
  120295. * @param scene Define the scene the texture belongs to
  120296. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  120297. * @param generateMipMaps Define if the texture should creates mip maps or not
  120298. */
  120299. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  120300. private _loadJson;
  120301. /**
  120302. * Is the texture ready to be used ? (rendered at least once)
  120303. * @returns true if ready, otherwise, false.
  120304. */
  120305. isReady(): boolean;
  120306. /**
  120307. * Render the texture to its associated render target.
  120308. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  120309. */
  120310. render(useCameraPostProcess?: boolean): void;
  120311. /**
  120312. * Update the list of dependant textures samplers in the shader.
  120313. */
  120314. updateTextures(): void;
  120315. /**
  120316. * Update the uniform values of the procedural texture in the shader.
  120317. */
  120318. updateShaderUniforms(): void;
  120319. /**
  120320. * Define if the texture animates or not.
  120321. */
  120322. animate: boolean;
  120323. }
  120324. }
  120325. declare module BABYLON {
  120326. /** @hidden */
  120327. export var noisePixelShader: {
  120328. name: string;
  120329. shader: string;
  120330. };
  120331. }
  120332. declare module BABYLON {
  120333. /**
  120334. * Class used to generate noise procedural textures
  120335. */
  120336. export class NoiseProceduralTexture extends ProceduralTexture {
  120337. private _time;
  120338. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  120339. brightness: number;
  120340. /** Defines the number of octaves to process */
  120341. octaves: number;
  120342. /** Defines the level of persistence (0.8 by default) */
  120343. persistence: number;
  120344. /** Gets or sets animation speed factor (default is 1) */
  120345. animationSpeedFactor: number;
  120346. /**
  120347. * Creates a new NoiseProceduralTexture
  120348. * @param name defines the name fo the texture
  120349. * @param size defines the size of the texture (default is 256)
  120350. * @param scene defines the hosting scene
  120351. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  120352. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  120353. */
  120354. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  120355. private _updateShaderUniforms;
  120356. protected _getDefines(): string;
  120357. /** Generate the current state of the procedural texture */
  120358. render(useCameraPostProcess?: boolean): void;
  120359. /**
  120360. * Serializes this noise procedural texture
  120361. * @returns a serialized noise procedural texture object
  120362. */
  120363. serialize(): any;
  120364. /**
  120365. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  120366. * @param parsedTexture defines parsed texture data
  120367. * @param scene defines the current scene
  120368. * @param rootUrl defines the root URL containing noise procedural texture information
  120369. * @returns a parsed NoiseProceduralTexture
  120370. */
  120371. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  120372. }
  120373. }
  120374. declare module BABYLON {
  120375. /**
  120376. * Raw cube texture where the raw buffers are passed in
  120377. */
  120378. export class RawCubeTexture extends CubeTexture {
  120379. /**
  120380. * Creates a cube texture where the raw buffers are passed in.
  120381. * @param scene defines the scene the texture is attached to
  120382. * @param data defines the array of data to use to create each face
  120383. * @param size defines the size of the textures
  120384. * @param format defines the format of the data
  120385. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  120386. * @param generateMipMaps defines if the engine should generate the mip levels
  120387. * @param invertY defines if data must be stored with Y axis inverted
  120388. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  120389. * @param compression defines the compression used (null by default)
  120390. */
  120391. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  120392. /**
  120393. * Updates the raw cube texture.
  120394. * @param data defines the data to store
  120395. * @param format defines the data format
  120396. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  120397. * @param invertY defines if data must be stored with Y axis inverted
  120398. * @param compression defines the compression used (null by default)
  120399. * @param level defines which level of the texture to update
  120400. */
  120401. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  120402. /**
  120403. * Updates a raw cube texture with RGBD encoded data.
  120404. * @param data defines the array of data [mipmap][face] to use to create each face
  120405. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  120406. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  120407. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  120408. * @returns a promsie that resolves when the operation is complete
  120409. */
  120410. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  120411. /**
  120412. * Clones the raw cube texture.
  120413. * @return a new cube texture
  120414. */
  120415. clone(): CubeTexture;
  120416. /** @hidden */
  120417. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  120418. }
  120419. }
  120420. declare module BABYLON {
  120421. /**
  120422. * Class used to store 3D textures containing user data
  120423. */
  120424. export class RawTexture3D extends Texture {
  120425. /** Gets or sets the texture format to use */
  120426. format: number;
  120427. private _engine;
  120428. /**
  120429. * Create a new RawTexture3D
  120430. * @param data defines the data of the texture
  120431. * @param width defines the width of the texture
  120432. * @param height defines the height of the texture
  120433. * @param depth defines the depth of the texture
  120434. * @param format defines the texture format to use
  120435. * @param scene defines the hosting scene
  120436. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  120437. * @param invertY defines if texture must be stored with Y axis inverted
  120438. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  120439. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  120440. */
  120441. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  120442. /** Gets or sets the texture format to use */
  120443. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  120444. /**
  120445. * Update the texture with new data
  120446. * @param data defines the data to store in the texture
  120447. */
  120448. update(data: ArrayBufferView): void;
  120449. }
  120450. }
  120451. declare module BABYLON {
  120452. /**
  120453. * Creates a refraction texture used by refraction channel of the standard material.
  120454. * It is like a mirror but to see through a material.
  120455. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  120456. */
  120457. export class RefractionTexture extends RenderTargetTexture {
  120458. /**
  120459. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  120460. * 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.
  120461. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  120462. */
  120463. refractionPlane: Plane;
  120464. /**
  120465. * Define how deep under the surface we should see.
  120466. */
  120467. depth: number;
  120468. /**
  120469. * Creates a refraction texture used by refraction channel of the standard material.
  120470. * It is like a mirror but to see through a material.
  120471. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  120472. * @param name Define the texture name
  120473. * @param size Define the size of the underlying texture
  120474. * @param scene Define the scene the refraction belongs to
  120475. * @param generateMipMaps Define if we need to generate mips level for the refraction
  120476. */
  120477. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  120478. /**
  120479. * Clone the refraction texture.
  120480. * @returns the cloned texture
  120481. */
  120482. clone(): RefractionTexture;
  120483. /**
  120484. * Serialize the texture to a JSON representation you could use in Parse later on
  120485. * @returns the serialized JSON representation
  120486. */
  120487. serialize(): any;
  120488. }
  120489. }
  120490. declare module BABYLON {
  120491. /**
  120492. * Defines the options related to the creation of an HtmlElementTexture
  120493. */
  120494. export interface IHtmlElementTextureOptions {
  120495. /**
  120496. * Defines wether mip maps should be created or not.
  120497. */
  120498. generateMipMaps?: boolean;
  120499. /**
  120500. * Defines the sampling mode of the texture.
  120501. */
  120502. samplingMode?: number;
  120503. /**
  120504. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  120505. */
  120506. engine: Nullable<ThinEngine>;
  120507. /**
  120508. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  120509. */
  120510. scene: Nullable<Scene>;
  120511. }
  120512. /**
  120513. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  120514. * To be as efficient as possible depending on your constraints nothing aside the first upload
  120515. * is automatically managed.
  120516. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  120517. * in your application.
  120518. *
  120519. * As the update is not automatic, you need to call them manually.
  120520. */
  120521. export class HtmlElementTexture extends BaseTexture {
  120522. /**
  120523. * The texture URL.
  120524. */
  120525. element: HTMLVideoElement | HTMLCanvasElement;
  120526. private static readonly DefaultOptions;
  120527. private _textureMatrix;
  120528. private _engine;
  120529. private _isVideo;
  120530. private _generateMipMaps;
  120531. private _samplingMode;
  120532. /**
  120533. * Instantiates a HtmlElementTexture from the following parameters.
  120534. *
  120535. * @param name Defines the name of the texture
  120536. * @param element Defines the video or canvas the texture is filled with
  120537. * @param options Defines the other none mandatory texture creation options
  120538. */
  120539. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  120540. private _createInternalTexture;
  120541. /**
  120542. * Returns the texture matrix used in most of the material.
  120543. */
  120544. getTextureMatrix(): Matrix;
  120545. /**
  120546. * Updates the content of the texture.
  120547. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  120548. */
  120549. update(invertY?: Nullable<boolean>): void;
  120550. }
  120551. }
  120552. declare module BABYLON {
  120553. /**
  120554. * Enum used to define the target of a block
  120555. */
  120556. export enum NodeMaterialBlockTargets {
  120557. /** Vertex shader */
  120558. Vertex = 1,
  120559. /** Fragment shader */
  120560. Fragment = 2,
  120561. /** Neutral */
  120562. Neutral = 4,
  120563. /** Vertex and Fragment */
  120564. VertexAndFragment = 3
  120565. }
  120566. }
  120567. declare module BABYLON {
  120568. /**
  120569. * Defines the kind of connection point for node based material
  120570. */
  120571. export enum NodeMaterialBlockConnectionPointTypes {
  120572. /** Float */
  120573. Float = 1,
  120574. /** Int */
  120575. Int = 2,
  120576. /** Vector2 */
  120577. Vector2 = 4,
  120578. /** Vector3 */
  120579. Vector3 = 8,
  120580. /** Vector4 */
  120581. Vector4 = 16,
  120582. /** Color3 */
  120583. Color3 = 32,
  120584. /** Color4 */
  120585. Color4 = 64,
  120586. /** Matrix */
  120587. Matrix = 128,
  120588. /** Detect type based on connection */
  120589. AutoDetect = 1024,
  120590. /** Output type that will be defined by input type */
  120591. BasedOnInput = 2048
  120592. }
  120593. }
  120594. declare module BABYLON {
  120595. /**
  120596. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  120597. */
  120598. export enum NodeMaterialBlockConnectionPointMode {
  120599. /** Value is an uniform */
  120600. Uniform = 0,
  120601. /** Value is a mesh attribute */
  120602. Attribute = 1,
  120603. /** Value is a varying between vertex and fragment shaders */
  120604. Varying = 2,
  120605. /** Mode is undefined */
  120606. Undefined = 3
  120607. }
  120608. }
  120609. declare module BABYLON {
  120610. /**
  120611. * Enum used to define system values e.g. values automatically provided by the system
  120612. */
  120613. export enum NodeMaterialSystemValues {
  120614. /** World */
  120615. World = 1,
  120616. /** View */
  120617. View = 2,
  120618. /** Projection */
  120619. Projection = 3,
  120620. /** ViewProjection */
  120621. ViewProjection = 4,
  120622. /** WorldView */
  120623. WorldView = 5,
  120624. /** WorldViewProjection */
  120625. WorldViewProjection = 6,
  120626. /** CameraPosition */
  120627. CameraPosition = 7,
  120628. /** Fog Color */
  120629. FogColor = 8,
  120630. /** Delta time */
  120631. DeltaTime = 9
  120632. }
  120633. }
  120634. declare module BABYLON {
  120635. /**
  120636. * Root class for all node material optimizers
  120637. */
  120638. export class NodeMaterialOptimizer {
  120639. /**
  120640. * Function used to optimize a NodeMaterial graph
  120641. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  120642. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  120643. */
  120644. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  120645. }
  120646. }
  120647. declare module BABYLON {
  120648. /**
  120649. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  120650. */
  120651. export class TransformBlock extends NodeMaterialBlock {
  120652. /**
  120653. * Defines the value to use to complement W value to transform it to a Vector4
  120654. */
  120655. complementW: number;
  120656. /**
  120657. * Defines the value to use to complement z value to transform it to a Vector4
  120658. */
  120659. complementZ: number;
  120660. /**
  120661. * Creates a new TransformBlock
  120662. * @param name defines the block name
  120663. */
  120664. constructor(name: string);
  120665. /**
  120666. * Gets the current class name
  120667. * @returns the class name
  120668. */
  120669. getClassName(): string;
  120670. /**
  120671. * Gets the vector input
  120672. */
  120673. readonly vector: NodeMaterialConnectionPoint;
  120674. /**
  120675. * Gets the output component
  120676. */
  120677. readonly output: NodeMaterialConnectionPoint;
  120678. /**
  120679. * Gets the matrix transform input
  120680. */
  120681. readonly transform: NodeMaterialConnectionPoint;
  120682. protected _buildBlock(state: NodeMaterialBuildState): this;
  120683. serialize(): any;
  120684. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  120685. protected _dumpPropertiesCode(): string;
  120686. }
  120687. }
  120688. declare module BABYLON {
  120689. /**
  120690. * Block used to output the vertex position
  120691. */
  120692. export class VertexOutputBlock extends NodeMaterialBlock {
  120693. /**
  120694. * Creates a new VertexOutputBlock
  120695. * @param name defines the block name
  120696. */
  120697. constructor(name: string);
  120698. /**
  120699. * Gets the current class name
  120700. * @returns the class name
  120701. */
  120702. getClassName(): string;
  120703. /**
  120704. * Gets the vector input component
  120705. */
  120706. readonly vector: NodeMaterialConnectionPoint;
  120707. protected _buildBlock(state: NodeMaterialBuildState): this;
  120708. }
  120709. }
  120710. declare module BABYLON {
  120711. /**
  120712. * Block used to output the final color
  120713. */
  120714. export class FragmentOutputBlock extends NodeMaterialBlock {
  120715. /**
  120716. * Create a new FragmentOutputBlock
  120717. * @param name defines the block name
  120718. */
  120719. constructor(name: string);
  120720. /**
  120721. * Gets the current class name
  120722. * @returns the class name
  120723. */
  120724. getClassName(): string;
  120725. /**
  120726. * Gets the rgba input component
  120727. */
  120728. readonly rgba: NodeMaterialConnectionPoint;
  120729. /**
  120730. * Gets the rgb input component
  120731. */
  120732. readonly rgb: NodeMaterialConnectionPoint;
  120733. /**
  120734. * Gets the a input component
  120735. */
  120736. readonly a: NodeMaterialConnectionPoint;
  120737. protected _buildBlock(state: NodeMaterialBuildState): this;
  120738. }
  120739. }
  120740. declare module BABYLON {
  120741. /**
  120742. * Block used to read a reflection texture from a sampler
  120743. */
  120744. export class ReflectionTextureBlock extends NodeMaterialBlock {
  120745. private _define3DName;
  120746. private _defineCubicName;
  120747. private _defineExplicitName;
  120748. private _defineProjectionName;
  120749. private _defineLocalCubicName;
  120750. private _defineSphericalName;
  120751. private _definePlanarName;
  120752. private _defineEquirectangularName;
  120753. private _defineMirroredEquirectangularFixedName;
  120754. private _defineEquirectangularFixedName;
  120755. private _defineSkyboxName;
  120756. private _cubeSamplerName;
  120757. private _2DSamplerName;
  120758. private _positionUVWName;
  120759. private _directionWName;
  120760. private _reflectionCoordsName;
  120761. private _reflection2DCoordsName;
  120762. private _reflectionColorName;
  120763. private _reflectionMatrixName;
  120764. /**
  120765. * Gets or sets the texture associated with the node
  120766. */
  120767. texture: Nullable<BaseTexture>;
  120768. /**
  120769. * Create a new TextureBlock
  120770. * @param name defines the block name
  120771. */
  120772. constructor(name: string);
  120773. /**
  120774. * Gets the current class name
  120775. * @returns the class name
  120776. */
  120777. getClassName(): string;
  120778. /**
  120779. * Gets the world position input component
  120780. */
  120781. readonly position: NodeMaterialConnectionPoint;
  120782. /**
  120783. * Gets the world position input component
  120784. */
  120785. readonly worldPosition: NodeMaterialConnectionPoint;
  120786. /**
  120787. * Gets the world normal input component
  120788. */
  120789. readonly worldNormal: NodeMaterialConnectionPoint;
  120790. /**
  120791. * Gets the world input component
  120792. */
  120793. readonly world: NodeMaterialConnectionPoint;
  120794. /**
  120795. * Gets the camera (or eye) position component
  120796. */
  120797. readonly cameraPosition: NodeMaterialConnectionPoint;
  120798. /**
  120799. * Gets the view input component
  120800. */
  120801. readonly view: NodeMaterialConnectionPoint;
  120802. /**
  120803. * Gets the rgb output component
  120804. */
  120805. readonly rgb: NodeMaterialConnectionPoint;
  120806. /**
  120807. * Gets the r output component
  120808. */
  120809. readonly r: NodeMaterialConnectionPoint;
  120810. /**
  120811. * Gets the g output component
  120812. */
  120813. readonly g: NodeMaterialConnectionPoint;
  120814. /**
  120815. * Gets the b output component
  120816. */
  120817. readonly b: NodeMaterialConnectionPoint;
  120818. autoConfigure(material: NodeMaterial): void;
  120819. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  120820. isReady(): boolean;
  120821. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  120822. private _injectVertexCode;
  120823. private _writeOutput;
  120824. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  120825. protected _dumpPropertiesCode(): string;
  120826. serialize(): any;
  120827. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  120828. }
  120829. }
  120830. declare module BABYLON {
  120831. /**
  120832. * Interface used to configure the node material editor
  120833. */
  120834. export interface INodeMaterialEditorOptions {
  120835. /** Define the URl to load node editor script */
  120836. editorURL?: string;
  120837. }
  120838. /** @hidden */
  120839. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  120840. /** BONES */
  120841. NUM_BONE_INFLUENCERS: number;
  120842. BonesPerMesh: number;
  120843. BONETEXTURE: boolean;
  120844. /** MORPH TARGETS */
  120845. MORPHTARGETS: boolean;
  120846. MORPHTARGETS_NORMAL: boolean;
  120847. MORPHTARGETS_TANGENT: boolean;
  120848. MORPHTARGETS_UV: boolean;
  120849. NUM_MORPH_INFLUENCERS: number;
  120850. /** IMAGE PROCESSING */
  120851. IMAGEPROCESSING: boolean;
  120852. VIGNETTE: boolean;
  120853. VIGNETTEBLENDMODEMULTIPLY: boolean;
  120854. VIGNETTEBLENDMODEOPAQUE: boolean;
  120855. TONEMAPPING: boolean;
  120856. TONEMAPPING_ACES: boolean;
  120857. CONTRAST: boolean;
  120858. EXPOSURE: boolean;
  120859. COLORCURVES: boolean;
  120860. COLORGRADING: boolean;
  120861. COLORGRADING3D: boolean;
  120862. SAMPLER3DGREENDEPTH: boolean;
  120863. SAMPLER3DBGRMAP: boolean;
  120864. IMAGEPROCESSINGPOSTPROCESS: boolean;
  120865. /** MISC. */
  120866. BUMPDIRECTUV: number;
  120867. constructor();
  120868. setValue(name: string, value: boolean): void;
  120869. }
  120870. /**
  120871. * Class used to configure NodeMaterial
  120872. */
  120873. export interface INodeMaterialOptions {
  120874. /**
  120875. * Defines if blocks should emit comments
  120876. */
  120877. emitComments: boolean;
  120878. }
  120879. /**
  120880. * Class used to create a node based material built by assembling shader blocks
  120881. */
  120882. export class NodeMaterial extends PushMaterial {
  120883. private static _BuildIdGenerator;
  120884. private _options;
  120885. private _vertexCompilationState;
  120886. private _fragmentCompilationState;
  120887. private _sharedData;
  120888. private _buildId;
  120889. private _buildWasSuccessful;
  120890. private _cachedWorldViewMatrix;
  120891. private _cachedWorldViewProjectionMatrix;
  120892. private _optimizers;
  120893. private _animationFrame;
  120894. /** Define the URl to load node editor script */
  120895. static EditorURL: string;
  120896. private BJSNODEMATERIALEDITOR;
  120897. /** Get the inspector from bundle or global */
  120898. private _getGlobalNodeMaterialEditor;
  120899. /**
  120900. * 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)
  120901. */
  120902. ignoreAlpha: boolean;
  120903. /**
  120904. * Defines the maximum number of lights that can be used in the material
  120905. */
  120906. maxSimultaneousLights: number;
  120907. /**
  120908. * Observable raised when the material is built
  120909. */
  120910. onBuildObservable: Observable<NodeMaterial>;
  120911. /**
  120912. * Gets or sets the root nodes of the material vertex shader
  120913. */
  120914. _vertexOutputNodes: NodeMaterialBlock[];
  120915. /**
  120916. * Gets or sets the root nodes of the material fragment (pixel) shader
  120917. */
  120918. _fragmentOutputNodes: NodeMaterialBlock[];
  120919. /** Gets or sets options to control the node material overall behavior */
  120920. options: INodeMaterialOptions;
  120921. /**
  120922. * Default configuration related to image processing available in the standard Material.
  120923. */
  120924. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  120925. /**
  120926. * Gets the image processing configuration used either in this material.
  120927. */
  120928. /**
  120929. * Sets the Default image processing configuration used either in the this material.
  120930. *
  120931. * If sets to null, the scene one is in use.
  120932. */
  120933. imageProcessingConfiguration: ImageProcessingConfiguration;
  120934. /**
  120935. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  120936. */
  120937. attachedBlocks: NodeMaterialBlock[];
  120938. /**
  120939. * Create a new node based material
  120940. * @param name defines the material name
  120941. * @param scene defines the hosting scene
  120942. * @param options defines creation option
  120943. */
  120944. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  120945. /**
  120946. * Gets the current class name of the material e.g. "NodeMaterial"
  120947. * @returns the class name
  120948. */
  120949. getClassName(): string;
  120950. /**
  120951. * Keep track of the image processing observer to allow dispose and replace.
  120952. */
  120953. private _imageProcessingObserver;
  120954. /**
  120955. * Attaches a new image processing configuration to the Standard Material.
  120956. * @param configuration
  120957. */
  120958. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  120959. /**
  120960. * Get a block by its name
  120961. * @param name defines the name of the block to retrieve
  120962. * @returns the required block or null if not found
  120963. */
  120964. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  120965. /**
  120966. * Get a block by its name
  120967. * @param predicate defines the predicate used to find the good candidate
  120968. * @returns the required block or null if not found
  120969. */
  120970. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  120971. /**
  120972. * Get an input block by its name
  120973. * @param predicate defines the predicate used to find the good candidate
  120974. * @returns the required input block or null if not found
  120975. */
  120976. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  120977. /**
  120978. * Gets the list of input blocks attached to this material
  120979. * @returns an array of InputBlocks
  120980. */
  120981. getInputBlocks(): InputBlock[];
  120982. /**
  120983. * Adds a new optimizer to the list of optimizers
  120984. * @param optimizer defines the optimizers to add
  120985. * @returns the current material
  120986. */
  120987. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  120988. /**
  120989. * Remove an optimizer from the list of optimizers
  120990. * @param optimizer defines the optimizers to remove
  120991. * @returns the current material
  120992. */
  120993. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  120994. /**
  120995. * Add a new block to the list of output nodes
  120996. * @param node defines the node to add
  120997. * @returns the current material
  120998. */
  120999. addOutputNode(node: NodeMaterialBlock): this;
  121000. /**
  121001. * Remove a block from the list of root nodes
  121002. * @param node defines the node to remove
  121003. * @returns the current material
  121004. */
  121005. removeOutputNode(node: NodeMaterialBlock): this;
  121006. private _addVertexOutputNode;
  121007. private _removeVertexOutputNode;
  121008. private _addFragmentOutputNode;
  121009. private _removeFragmentOutputNode;
  121010. /**
  121011. * Specifies if the material will require alpha blending
  121012. * @returns a boolean specifying if alpha blending is needed
  121013. */
  121014. needAlphaBlending(): boolean;
  121015. /**
  121016. * Specifies if this material should be rendered in alpha test mode
  121017. * @returns a boolean specifying if an alpha test is needed.
  121018. */
  121019. needAlphaTesting(): boolean;
  121020. private _initializeBlock;
  121021. private _resetDualBlocks;
  121022. /**
  121023. * Build the material and generates the inner effect
  121024. * @param verbose defines if the build should log activity
  121025. */
  121026. build(verbose?: boolean): void;
  121027. /**
  121028. * Runs an otpimization phase to try to improve the shader code
  121029. */
  121030. optimize(): void;
  121031. private _prepareDefinesForAttributes;
  121032. /**
  121033. * Get if the submesh is ready to be used and all its information available.
  121034. * Child classes can use it to update shaders
  121035. * @param mesh defines the mesh to check
  121036. * @param subMesh defines which submesh to check
  121037. * @param useInstances specifies that instances should be used
  121038. * @returns a boolean indicating that the submesh is ready or not
  121039. */
  121040. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  121041. /**
  121042. * Get a string representing the shaders built by the current node graph
  121043. */
  121044. readonly compiledShaders: string;
  121045. /**
  121046. * Binds the world matrix to the material
  121047. * @param world defines the world transformation matrix
  121048. */
  121049. bindOnlyWorldMatrix(world: Matrix): void;
  121050. /**
  121051. * Binds the submesh to this material by preparing the effect and shader to draw
  121052. * @param world defines the world transformation matrix
  121053. * @param mesh defines the mesh containing the submesh
  121054. * @param subMesh defines the submesh to bind the material to
  121055. */
  121056. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  121057. /**
  121058. * Gets the active textures from the material
  121059. * @returns an array of textures
  121060. */
  121061. getActiveTextures(): BaseTexture[];
  121062. /**
  121063. * Gets the list of texture blocks
  121064. * @returns an array of texture blocks
  121065. */
  121066. getTextureBlocks(): (TextureBlock | ReflectionTextureBlock)[];
  121067. /**
  121068. * Specifies if the material uses a texture
  121069. * @param texture defines the texture to check against the material
  121070. * @returns a boolean specifying if the material uses the texture
  121071. */
  121072. hasTexture(texture: BaseTexture): boolean;
  121073. /**
  121074. * Disposes the material
  121075. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  121076. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  121077. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  121078. */
  121079. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  121080. /** Creates the node editor window. */
  121081. private _createNodeEditor;
  121082. /**
  121083. * Launch the node material editor
  121084. * @param config Define the configuration of the editor
  121085. * @return a promise fulfilled when the node editor is visible
  121086. */
  121087. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  121088. /**
  121089. * Clear the current material
  121090. */
  121091. clear(): void;
  121092. /**
  121093. * Clear the current material and set it to a default state
  121094. */
  121095. setToDefault(): void;
  121096. /**
  121097. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  121098. * @param url defines the url to load from
  121099. * @returns a promise that will fullfil when the material is fully loaded
  121100. */
  121101. loadAsync(url: string): Promise<void>;
  121102. private _gatherBlocks;
  121103. /**
  121104. * Generate a string containing the code declaration required to create an equivalent of this material
  121105. * @returns a string
  121106. */
  121107. generateCode(): string;
  121108. /**
  121109. * Serializes this material in a JSON representation
  121110. * @returns the serialized material object
  121111. */
  121112. serialize(): any;
  121113. private _restoreConnections;
  121114. /**
  121115. * Clear the current graph and load a new one from a serialization object
  121116. * @param source defines the JSON representation of the material
  121117. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  121118. */
  121119. loadFromSerialization(source: any, rootUrl?: string): void;
  121120. /**
  121121. * Creates a node material from parsed material data
  121122. * @param source defines the JSON representation of the material
  121123. * @param scene defines the hosting scene
  121124. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  121125. * @returns a new node material
  121126. */
  121127. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  121128. /**
  121129. * Creates a new node material set to default basic configuration
  121130. * @param name defines the name of the material
  121131. * @param scene defines the hosting scene
  121132. * @returns a new NodeMaterial
  121133. */
  121134. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  121135. }
  121136. }
  121137. declare module BABYLON {
  121138. /**
  121139. * Block used to read a texture from a sampler
  121140. */
  121141. export class TextureBlock extends NodeMaterialBlock {
  121142. private _defineName;
  121143. private _linearDefineName;
  121144. private _samplerName;
  121145. private _transformedUVName;
  121146. private _textureTransformName;
  121147. private _textureInfoName;
  121148. private _mainUVName;
  121149. private _mainUVDefineName;
  121150. /**
  121151. * Gets or sets the texture associated with the node
  121152. */
  121153. texture: Nullable<Texture>;
  121154. /**
  121155. * Create a new TextureBlock
  121156. * @param name defines the block name
  121157. */
  121158. constructor(name: string);
  121159. /**
  121160. * Gets the current class name
  121161. * @returns the class name
  121162. */
  121163. getClassName(): string;
  121164. /**
  121165. * Gets the uv input component
  121166. */
  121167. readonly uv: NodeMaterialConnectionPoint;
  121168. /**
  121169. * Gets the rgba output component
  121170. */
  121171. readonly rgba: NodeMaterialConnectionPoint;
  121172. /**
  121173. * Gets the rgb output component
  121174. */
  121175. readonly rgb: NodeMaterialConnectionPoint;
  121176. /**
  121177. * Gets the r output component
  121178. */
  121179. readonly r: NodeMaterialConnectionPoint;
  121180. /**
  121181. * Gets the g output component
  121182. */
  121183. readonly g: NodeMaterialConnectionPoint;
  121184. /**
  121185. * Gets the b output component
  121186. */
  121187. readonly b: NodeMaterialConnectionPoint;
  121188. /**
  121189. * Gets the a output component
  121190. */
  121191. readonly a: NodeMaterialConnectionPoint;
  121192. readonly target: NodeMaterialBlockTargets;
  121193. autoConfigure(material: NodeMaterial): void;
  121194. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  121195. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  121196. isReady(): boolean;
  121197. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  121198. private readonly _isMixed;
  121199. private _injectVertexCode;
  121200. private _writeOutput;
  121201. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  121202. protected _dumpPropertiesCode(): string;
  121203. serialize(): any;
  121204. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  121205. }
  121206. }
  121207. declare module BABYLON {
  121208. /**
  121209. * Class used to store shared data between 2 NodeMaterialBuildState
  121210. */
  121211. export class NodeMaterialBuildStateSharedData {
  121212. /**
  121213. * Gets the list of emitted varyings
  121214. */
  121215. temps: string[];
  121216. /**
  121217. * Gets the list of emitted varyings
  121218. */
  121219. varyings: string[];
  121220. /**
  121221. * Gets the varying declaration string
  121222. */
  121223. varyingDeclaration: string;
  121224. /**
  121225. * Input blocks
  121226. */
  121227. inputBlocks: InputBlock[];
  121228. /**
  121229. * Input blocks
  121230. */
  121231. textureBlocks: (ReflectionTextureBlock | TextureBlock)[];
  121232. /**
  121233. * Bindable blocks (Blocks that need to set data to the effect)
  121234. */
  121235. bindableBlocks: NodeMaterialBlock[];
  121236. /**
  121237. * List of blocks that can provide a compilation fallback
  121238. */
  121239. blocksWithFallbacks: NodeMaterialBlock[];
  121240. /**
  121241. * List of blocks that can provide a define update
  121242. */
  121243. blocksWithDefines: NodeMaterialBlock[];
  121244. /**
  121245. * List of blocks that can provide a repeatable content
  121246. */
  121247. repeatableContentBlocks: NodeMaterialBlock[];
  121248. /**
  121249. * List of blocks that can provide a dynamic list of uniforms
  121250. */
  121251. dynamicUniformBlocks: NodeMaterialBlock[];
  121252. /**
  121253. * List of blocks that can block the isReady function for the material
  121254. */
  121255. blockingBlocks: NodeMaterialBlock[];
  121256. /**
  121257. * Gets the list of animated inputs
  121258. */
  121259. animatedInputs: InputBlock[];
  121260. /**
  121261. * Build Id used to avoid multiple recompilations
  121262. */
  121263. buildId: number;
  121264. /** List of emitted variables */
  121265. variableNames: {
  121266. [key: string]: number;
  121267. };
  121268. /** List of emitted defines */
  121269. defineNames: {
  121270. [key: string]: number;
  121271. };
  121272. /** Should emit comments? */
  121273. emitComments: boolean;
  121274. /** Emit build activity */
  121275. verbose: boolean;
  121276. /** Gets or sets the hosting scene */
  121277. scene: Scene;
  121278. /**
  121279. * Gets the compilation hints emitted at compilation time
  121280. */
  121281. hints: {
  121282. needWorldViewMatrix: boolean;
  121283. needWorldViewProjectionMatrix: boolean;
  121284. needAlphaBlending: boolean;
  121285. needAlphaTesting: boolean;
  121286. };
  121287. /**
  121288. * List of compilation checks
  121289. */
  121290. checks: {
  121291. emitVertex: boolean;
  121292. emitFragment: boolean;
  121293. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  121294. };
  121295. /** Creates a new shared data */
  121296. constructor();
  121297. /**
  121298. * Emits console errors and exceptions if there is a failing check
  121299. */
  121300. emitErrors(): void;
  121301. }
  121302. }
  121303. declare module BABYLON {
  121304. /**
  121305. * Class used to store node based material build state
  121306. */
  121307. export class NodeMaterialBuildState {
  121308. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  121309. supportUniformBuffers: boolean;
  121310. /**
  121311. * Gets the list of emitted attributes
  121312. */
  121313. attributes: string[];
  121314. /**
  121315. * Gets the list of emitted uniforms
  121316. */
  121317. uniforms: string[];
  121318. /**
  121319. * Gets the list of emitted constants
  121320. */
  121321. constants: string[];
  121322. /**
  121323. * Gets the list of emitted samplers
  121324. */
  121325. samplers: string[];
  121326. /**
  121327. * Gets the list of emitted functions
  121328. */
  121329. functions: {
  121330. [key: string]: string;
  121331. };
  121332. /**
  121333. * Gets the list of emitted extensions
  121334. */
  121335. extensions: {
  121336. [key: string]: string;
  121337. };
  121338. /**
  121339. * Gets the target of the compilation state
  121340. */
  121341. target: NodeMaterialBlockTargets;
  121342. /**
  121343. * Gets the list of emitted counters
  121344. */
  121345. counters: {
  121346. [key: string]: number;
  121347. };
  121348. /**
  121349. * Shared data between multiple NodeMaterialBuildState instances
  121350. */
  121351. sharedData: NodeMaterialBuildStateSharedData;
  121352. /** @hidden */
  121353. _vertexState: NodeMaterialBuildState;
  121354. /** @hidden */
  121355. _attributeDeclaration: string;
  121356. /** @hidden */
  121357. _uniformDeclaration: string;
  121358. /** @hidden */
  121359. _constantDeclaration: string;
  121360. /** @hidden */
  121361. _samplerDeclaration: string;
  121362. /** @hidden */
  121363. _varyingTransfer: string;
  121364. private _repeatableContentAnchorIndex;
  121365. /** @hidden */
  121366. _builtCompilationString: string;
  121367. /**
  121368. * Gets the emitted compilation strings
  121369. */
  121370. compilationString: string;
  121371. /**
  121372. * Finalize the compilation strings
  121373. * @param state defines the current compilation state
  121374. */
  121375. finalize(state: NodeMaterialBuildState): void;
  121376. /** @hidden */
  121377. readonly _repeatableContentAnchor: string;
  121378. /** @hidden */
  121379. _getFreeVariableName(prefix: string): string;
  121380. /** @hidden */
  121381. _getFreeDefineName(prefix: string): string;
  121382. /** @hidden */
  121383. _excludeVariableName(name: string): void;
  121384. /** @hidden */
  121385. _emit2DSampler(name: string): void;
  121386. /** @hidden */
  121387. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  121388. /** @hidden */
  121389. _emitExtension(name: string, extension: string): void;
  121390. /** @hidden */
  121391. _emitFunction(name: string, code: string, comments: string): void;
  121392. /** @hidden */
  121393. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  121394. replaceStrings?: {
  121395. search: RegExp;
  121396. replace: string;
  121397. }[];
  121398. repeatKey?: string;
  121399. }): string;
  121400. /** @hidden */
  121401. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  121402. repeatKey?: string;
  121403. removeAttributes?: boolean;
  121404. removeUniforms?: boolean;
  121405. removeVaryings?: boolean;
  121406. removeIfDef?: boolean;
  121407. replaceStrings?: {
  121408. search: RegExp;
  121409. replace: string;
  121410. }[];
  121411. }, storeKey?: string): void;
  121412. /** @hidden */
  121413. _registerTempVariable(name: string): boolean;
  121414. /** @hidden */
  121415. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  121416. /** @hidden */
  121417. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  121418. /** @hidden */
  121419. _emitFloat(value: number): string;
  121420. }
  121421. }
  121422. declare module BABYLON {
  121423. /**
  121424. * Defines a block that can be used inside a node based material
  121425. */
  121426. export class NodeMaterialBlock {
  121427. private _buildId;
  121428. private _buildTarget;
  121429. private _target;
  121430. private _isFinalMerger;
  121431. private _isInput;
  121432. /** @hidden */
  121433. _codeVariableName: string;
  121434. /** @hidden */
  121435. _inputs: NodeMaterialConnectionPoint[];
  121436. /** @hidden */
  121437. _outputs: NodeMaterialConnectionPoint[];
  121438. /** @hidden */
  121439. _preparationId: number;
  121440. /**
  121441. * Gets or sets the name of the block
  121442. */
  121443. name: string;
  121444. /**
  121445. * Gets or sets the unique id of the node
  121446. */
  121447. uniqueId: number;
  121448. /**
  121449. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  121450. */
  121451. readonly isFinalMerger: boolean;
  121452. /**
  121453. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  121454. */
  121455. readonly isInput: boolean;
  121456. /**
  121457. * Gets or sets the build Id
  121458. */
  121459. buildId: number;
  121460. /**
  121461. * Gets or sets the target of the block
  121462. */
  121463. target: NodeMaterialBlockTargets;
  121464. /**
  121465. * Gets the list of input points
  121466. */
  121467. readonly inputs: NodeMaterialConnectionPoint[];
  121468. /** Gets the list of output points */
  121469. readonly outputs: NodeMaterialConnectionPoint[];
  121470. /**
  121471. * Find an input by its name
  121472. * @param name defines the name of the input to look for
  121473. * @returns the input or null if not found
  121474. */
  121475. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  121476. /**
  121477. * Find an output by its name
  121478. * @param name defines the name of the outputto look for
  121479. * @returns the output or null if not found
  121480. */
  121481. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  121482. /**
  121483. * Creates a new NodeMaterialBlock
  121484. * @param name defines the block name
  121485. * @param target defines the target of that block (Vertex by default)
  121486. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  121487. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  121488. */
  121489. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  121490. /**
  121491. * Initialize the block and prepare the context for build
  121492. * @param state defines the state that will be used for the build
  121493. */
  121494. initialize(state: NodeMaterialBuildState): void;
  121495. /**
  121496. * Bind data to effect. Will only be called for blocks with isBindable === true
  121497. * @param effect defines the effect to bind data to
  121498. * @param nodeMaterial defines the hosting NodeMaterial
  121499. * @param mesh defines the mesh that will be rendered
  121500. */
  121501. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  121502. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  121503. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  121504. protected _writeFloat(value: number): string;
  121505. /**
  121506. * Gets the current class name e.g. "NodeMaterialBlock"
  121507. * @returns the class name
  121508. */
  121509. getClassName(): string;
  121510. /**
  121511. * Register a new input. Must be called inside a block constructor
  121512. * @param name defines the connection point name
  121513. * @param type defines the connection point type
  121514. * @param isOptional defines a boolean indicating that this input can be omitted
  121515. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  121516. * @returns the current block
  121517. */
  121518. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets): this;
  121519. /**
  121520. * Register a new output. Must be called inside a block constructor
  121521. * @param name defines the connection point name
  121522. * @param type defines the connection point type
  121523. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  121524. * @returns the current block
  121525. */
  121526. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets): this;
  121527. /**
  121528. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  121529. * @param forOutput defines an optional connection point to check compatibility with
  121530. * @returns the first available input or null
  121531. */
  121532. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  121533. /**
  121534. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  121535. * @param forBlock defines an optional block to check compatibility with
  121536. * @returns the first available input or null
  121537. */
  121538. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  121539. /**
  121540. * Gets the sibling of the given output
  121541. * @param current defines the current output
  121542. * @returns the next output in the list or null
  121543. */
  121544. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  121545. /**
  121546. * Connect current block with another block
  121547. * @param other defines the block to connect with
  121548. * @param options define the various options to help pick the right connections
  121549. * @returns the current block
  121550. */
  121551. connectTo(other: NodeMaterialBlock, options?: {
  121552. input?: string;
  121553. output?: string;
  121554. outputSwizzle?: string;
  121555. }): this | undefined;
  121556. protected _buildBlock(state: NodeMaterialBuildState): void;
  121557. /**
  121558. * Add uniforms, samplers and uniform buffers at compilation time
  121559. * @param state defines the state to update
  121560. * @param nodeMaterial defines the node material requesting the update
  121561. * @param defines defines the material defines to update
  121562. * @param uniformBuffers defines the list of uniform buffer names
  121563. */
  121564. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  121565. /**
  121566. * Add potential fallbacks if shader compilation fails
  121567. * @param mesh defines the mesh to be rendered
  121568. * @param fallbacks defines the current prioritized list of fallbacks
  121569. */
  121570. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  121571. /**
  121572. * Initialize defines for shader compilation
  121573. * @param mesh defines the mesh to be rendered
  121574. * @param nodeMaterial defines the node material requesting the update
  121575. * @param defines defines the material defines to update
  121576. * @param useInstances specifies that instances should be used
  121577. */
  121578. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  121579. /**
  121580. * Update defines for shader compilation
  121581. * @param mesh defines the mesh to be rendered
  121582. * @param nodeMaterial defines the node material requesting the update
  121583. * @param defines defines the material defines to update
  121584. * @param useInstances specifies that instances should be used
  121585. */
  121586. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  121587. /**
  121588. * Lets the block try to connect some inputs automatically
  121589. * @param material defines the hosting NodeMaterial
  121590. */
  121591. autoConfigure(material: NodeMaterial): void;
  121592. /**
  121593. * Function called when a block is declared as repeatable content generator
  121594. * @param vertexShaderState defines the current compilation state for the vertex shader
  121595. * @param fragmentShaderState defines the current compilation state for the fragment shader
  121596. * @param mesh defines the mesh to be rendered
  121597. * @param defines defines the material defines to update
  121598. */
  121599. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  121600. /**
  121601. * Checks if the block is ready
  121602. * @param mesh defines the mesh to be rendered
  121603. * @param nodeMaterial defines the node material requesting the update
  121604. * @param defines defines the material defines to update
  121605. * @param useInstances specifies that instances should be used
  121606. * @returns true if the block is ready
  121607. */
  121608. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  121609. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  121610. private _processBuild;
  121611. /**
  121612. * Compile the current node and generate the shader code
  121613. * @param state defines the current compilation state (uniforms, samplers, current string)
  121614. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  121615. * @returns true if already built
  121616. */
  121617. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  121618. protected _inputRename(name: string): string;
  121619. protected _outputRename(name: string): string;
  121620. protected _dumpPropertiesCode(): string;
  121621. /** @hidden */
  121622. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  121623. /**
  121624. * Clone the current block to a new identical block
  121625. * @param scene defines the hosting scene
  121626. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  121627. * @returns a copy of the current block
  121628. */
  121629. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  121630. /**
  121631. * Serializes this block in a JSON representation
  121632. * @returns the serialized block object
  121633. */
  121634. serialize(): any;
  121635. /** @hidden */
  121636. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  121637. /**
  121638. * Release resources
  121639. */
  121640. dispose(): void;
  121641. }
  121642. }
  121643. declare module BABYLON {
  121644. /**
  121645. * Enum defining the type of animations supported by InputBlock
  121646. */
  121647. export enum AnimatedInputBlockTypes {
  121648. /** No animation */
  121649. None = 0,
  121650. /** Time based animation. Will only work for floats */
  121651. Time = 1
  121652. }
  121653. }
  121654. declare module BABYLON {
  121655. /**
  121656. * Block used to expose an input value
  121657. */
  121658. export class InputBlock extends NodeMaterialBlock {
  121659. private _mode;
  121660. private _associatedVariableName;
  121661. private _storedValue;
  121662. private _valueCallback;
  121663. private _type;
  121664. private _animationType;
  121665. /** Gets or set a value used to limit the range of float values */
  121666. min: number;
  121667. /** Gets or set a value used to limit the range of float values */
  121668. max: number;
  121669. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  121670. matrixMode: number;
  121671. /** @hidden */
  121672. _systemValue: Nullable<NodeMaterialSystemValues>;
  121673. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  121674. visibleInInspector: boolean;
  121675. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  121676. isConstant: boolean;
  121677. /**
  121678. * Gets or sets the connection point type (default is float)
  121679. */
  121680. readonly type: NodeMaterialBlockConnectionPointTypes;
  121681. /**
  121682. * Creates a new InputBlock
  121683. * @param name defines the block name
  121684. * @param target defines the target of that block (Vertex by default)
  121685. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  121686. */
  121687. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  121688. /**
  121689. * Gets the output component
  121690. */
  121691. readonly output: NodeMaterialConnectionPoint;
  121692. /**
  121693. * Set the source of this connection point to a vertex attribute
  121694. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  121695. * @returns the current connection point
  121696. */
  121697. setAsAttribute(attributeName?: string): InputBlock;
  121698. /**
  121699. * Set the source of this connection point to a system value
  121700. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  121701. * @returns the current connection point
  121702. */
  121703. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  121704. /**
  121705. * Gets or sets the value of that point.
  121706. * Please note that this value will be ignored if valueCallback is defined
  121707. */
  121708. value: any;
  121709. /**
  121710. * Gets or sets a callback used to get the value of that point.
  121711. * Please note that setting this value will force the connection point to ignore the value property
  121712. */
  121713. valueCallback: () => any;
  121714. /**
  121715. * Gets or sets the associated variable name in the shader
  121716. */
  121717. associatedVariableName: string;
  121718. /** Gets or sets the type of animation applied to the input */
  121719. animationType: AnimatedInputBlockTypes;
  121720. /**
  121721. * Gets a boolean indicating that this connection point not defined yet
  121722. */
  121723. readonly isUndefined: boolean;
  121724. /**
  121725. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  121726. * In this case the connection point name must be the name of the uniform to use.
  121727. * Can only be set on inputs
  121728. */
  121729. isUniform: boolean;
  121730. /**
  121731. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  121732. * In this case the connection point name must be the name of the attribute to use
  121733. * Can only be set on inputs
  121734. */
  121735. isAttribute: boolean;
  121736. /**
  121737. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  121738. * Can only be set on exit points
  121739. */
  121740. isVarying: boolean;
  121741. /**
  121742. * Gets a boolean indicating that the current connection point is a system value
  121743. */
  121744. readonly isSystemValue: boolean;
  121745. /**
  121746. * Gets or sets the current well known value or null if not defined as a system value
  121747. */
  121748. systemValue: Nullable<NodeMaterialSystemValues>;
  121749. /**
  121750. * Gets the current class name
  121751. * @returns the class name
  121752. */
  121753. getClassName(): string;
  121754. /**
  121755. * Animate the input if animationType !== None
  121756. * @param scene defines the rendering scene
  121757. */
  121758. animate(scene: Scene): void;
  121759. private _emitDefine;
  121760. initialize(state: NodeMaterialBuildState): void;
  121761. /**
  121762. * Set the input block to its default value (based on its type)
  121763. */
  121764. setDefaultValue(): void;
  121765. private _emitConstant;
  121766. private _emit;
  121767. /** @hidden */
  121768. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  121769. /** @hidden */
  121770. _transmit(effect: Effect, scene: Scene): void;
  121771. protected _buildBlock(state: NodeMaterialBuildState): void;
  121772. protected _dumpPropertiesCode(): string;
  121773. serialize(): any;
  121774. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  121775. }
  121776. }
  121777. declare module BABYLON {
  121778. /**
  121779. * Defines a connection point for a block
  121780. */
  121781. export class NodeMaterialConnectionPoint {
  121782. /** @hidden */
  121783. _ownerBlock: NodeMaterialBlock;
  121784. /** @hidden */
  121785. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  121786. private _endpoints;
  121787. private _associatedVariableName;
  121788. /** @hidden */
  121789. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  121790. /** @hidden */
  121791. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  121792. private _type;
  121793. /** @hidden */
  121794. _enforceAssociatedVariableName: boolean;
  121795. /**
  121796. * Gets or sets the additional types supported by this connection point
  121797. */
  121798. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  121799. /**
  121800. * Gets or sets the additional types excluded by this connection point
  121801. */
  121802. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  121803. /**
  121804. * Observable triggered when this point is connected
  121805. */
  121806. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  121807. /**
  121808. * Gets or sets the associated variable name in the shader
  121809. */
  121810. associatedVariableName: string;
  121811. /**
  121812. * Gets or sets the connection point type (default is float)
  121813. */
  121814. type: NodeMaterialBlockConnectionPointTypes;
  121815. /**
  121816. * Gets or sets the connection point name
  121817. */
  121818. name: string;
  121819. /**
  121820. * Gets or sets a boolean indicating that this connection point can be omitted
  121821. */
  121822. isOptional: boolean;
  121823. /**
  121824. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  121825. */
  121826. define: string;
  121827. /** @hidden */
  121828. _prioritizeVertex: boolean;
  121829. private _target;
  121830. /** Gets or sets the target of that connection point */
  121831. target: NodeMaterialBlockTargets;
  121832. /**
  121833. * Gets a boolean indicating that the current point is connected
  121834. */
  121835. readonly isConnected: boolean;
  121836. /**
  121837. * Gets a boolean indicating that the current point is connected to an input block
  121838. */
  121839. readonly isConnectedToInputBlock: boolean;
  121840. /**
  121841. * Gets a the connected input block (if any)
  121842. */
  121843. readonly connectInputBlock: Nullable<InputBlock>;
  121844. /** Get the other side of the connection (if any) */
  121845. readonly connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  121846. /** Get the block that owns this connection point */
  121847. readonly ownerBlock: NodeMaterialBlock;
  121848. /** Get the block connected on the other side of this connection (if any) */
  121849. readonly sourceBlock: Nullable<NodeMaterialBlock>;
  121850. /** Get the block connected on the endpoints of this connection (if any) */
  121851. readonly connectedBlocks: Array<NodeMaterialBlock>;
  121852. /** Gets the list of connected endpoints */
  121853. readonly endpoints: NodeMaterialConnectionPoint[];
  121854. /** Gets a boolean indicating if that output point is connected to at least one input */
  121855. readonly hasEndpoints: boolean;
  121856. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  121857. readonly isConnectedInVertexShader: boolean;
  121858. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  121859. readonly isConnectedInFragmentShader: boolean;
  121860. /**
  121861. * Creates a new connection point
  121862. * @param name defines the connection point name
  121863. * @param ownerBlock defines the block hosting this connection point
  121864. */
  121865. constructor(name: string, ownerBlock: NodeMaterialBlock);
  121866. /**
  121867. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  121868. * @returns the class name
  121869. */
  121870. getClassName(): string;
  121871. /**
  121872. * Gets an boolean indicating if the current point can be connected to another point
  121873. * @param connectionPoint defines the other connection point
  121874. * @returns true if the connection is possible
  121875. */
  121876. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  121877. /**
  121878. * Connect this point to another connection point
  121879. * @param connectionPoint defines the other connection point
  121880. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  121881. * @returns the current connection point
  121882. */
  121883. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  121884. /**
  121885. * Disconnect this point from one of his endpoint
  121886. * @param endpoint defines the other connection point
  121887. * @returns the current connection point
  121888. */
  121889. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  121890. /**
  121891. * Serializes this point in a JSON representation
  121892. * @returns the serialized point object
  121893. */
  121894. serialize(): any;
  121895. /**
  121896. * Release resources
  121897. */
  121898. dispose(): void;
  121899. }
  121900. }
  121901. declare module BABYLON {
  121902. /**
  121903. * Block used to add support for vertex skinning (bones)
  121904. */
  121905. export class BonesBlock extends NodeMaterialBlock {
  121906. /**
  121907. * Creates a new BonesBlock
  121908. * @param name defines the block name
  121909. */
  121910. constructor(name: string);
  121911. /**
  121912. * Initialize the block and prepare the context for build
  121913. * @param state defines the state that will be used for the build
  121914. */
  121915. initialize(state: NodeMaterialBuildState): void;
  121916. /**
  121917. * Gets the current class name
  121918. * @returns the class name
  121919. */
  121920. getClassName(): string;
  121921. /**
  121922. * Gets the matrix indices input component
  121923. */
  121924. readonly matricesIndices: NodeMaterialConnectionPoint;
  121925. /**
  121926. * Gets the matrix weights input component
  121927. */
  121928. readonly matricesWeights: NodeMaterialConnectionPoint;
  121929. /**
  121930. * Gets the extra matrix indices input component
  121931. */
  121932. readonly matricesIndicesExtra: NodeMaterialConnectionPoint;
  121933. /**
  121934. * Gets the extra matrix weights input component
  121935. */
  121936. readonly matricesWeightsExtra: NodeMaterialConnectionPoint;
  121937. /**
  121938. * Gets the world input component
  121939. */
  121940. readonly world: NodeMaterialConnectionPoint;
  121941. /**
  121942. * Gets the output component
  121943. */
  121944. readonly output: NodeMaterialConnectionPoint;
  121945. autoConfigure(material: NodeMaterial): void;
  121946. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  121947. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  121948. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  121949. protected _buildBlock(state: NodeMaterialBuildState): this;
  121950. }
  121951. }
  121952. declare module BABYLON {
  121953. /**
  121954. * Block used to add support for instances
  121955. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  121956. */
  121957. export class InstancesBlock extends NodeMaterialBlock {
  121958. /**
  121959. * Creates a new InstancesBlock
  121960. * @param name defines the block name
  121961. */
  121962. constructor(name: string);
  121963. /**
  121964. * Gets the current class name
  121965. * @returns the class name
  121966. */
  121967. getClassName(): string;
  121968. /**
  121969. * Gets the first world row input component
  121970. */
  121971. readonly world0: NodeMaterialConnectionPoint;
  121972. /**
  121973. * Gets the second world row input component
  121974. */
  121975. readonly world1: NodeMaterialConnectionPoint;
  121976. /**
  121977. * Gets the third world row input component
  121978. */
  121979. readonly world2: NodeMaterialConnectionPoint;
  121980. /**
  121981. * Gets the forth world row input component
  121982. */
  121983. readonly world3: NodeMaterialConnectionPoint;
  121984. /**
  121985. * Gets the world input component
  121986. */
  121987. readonly world: NodeMaterialConnectionPoint;
  121988. /**
  121989. * Gets the output component
  121990. */
  121991. readonly output: NodeMaterialConnectionPoint;
  121992. autoConfigure(material: NodeMaterial): void;
  121993. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  121994. protected _buildBlock(state: NodeMaterialBuildState): this;
  121995. }
  121996. }
  121997. declare module BABYLON {
  121998. /**
  121999. * Block used to add morph targets support to vertex shader
  122000. */
  122001. export class MorphTargetsBlock extends NodeMaterialBlock {
  122002. private _repeatableContentAnchor;
  122003. private _repeatebleContentGenerated;
  122004. /**
  122005. * Create a new MorphTargetsBlock
  122006. * @param name defines the block name
  122007. */
  122008. constructor(name: string);
  122009. /**
  122010. * Gets the current class name
  122011. * @returns the class name
  122012. */
  122013. getClassName(): string;
  122014. /**
  122015. * Gets the position input component
  122016. */
  122017. readonly position: NodeMaterialConnectionPoint;
  122018. /**
  122019. * Gets the normal input component
  122020. */
  122021. readonly normal: NodeMaterialConnectionPoint;
  122022. /**
  122023. * Gets the tangent input component
  122024. */
  122025. readonly tangent: NodeMaterialConnectionPoint;
  122026. /**
  122027. * Gets the tangent input component
  122028. */
  122029. readonly uv: NodeMaterialConnectionPoint;
  122030. /**
  122031. * Gets the position output component
  122032. */
  122033. readonly positionOutput: NodeMaterialConnectionPoint;
  122034. /**
  122035. * Gets the normal output component
  122036. */
  122037. readonly normalOutput: NodeMaterialConnectionPoint;
  122038. /**
  122039. * Gets the tangent output component
  122040. */
  122041. readonly tangentOutput: NodeMaterialConnectionPoint;
  122042. /**
  122043. * Gets the tangent output component
  122044. */
  122045. readonly uvOutput: NodeMaterialConnectionPoint;
  122046. initialize(state: NodeMaterialBuildState): void;
  122047. autoConfigure(material: NodeMaterial): void;
  122048. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122049. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122050. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  122051. protected _buildBlock(state: NodeMaterialBuildState): this;
  122052. }
  122053. }
  122054. declare module BABYLON {
  122055. /**
  122056. * Block used to get data information from a light
  122057. */
  122058. export class LightInformationBlock extends NodeMaterialBlock {
  122059. private _lightDataUniformName;
  122060. private _lightColorUniformName;
  122061. private _lightTypeDefineName;
  122062. /**
  122063. * Gets or sets the light associated with this block
  122064. */
  122065. light: Nullable<Light>;
  122066. /**
  122067. * Creates a new LightInformationBlock
  122068. * @param name defines the block name
  122069. */
  122070. constructor(name: string);
  122071. /**
  122072. * Gets the current class name
  122073. * @returns the class name
  122074. */
  122075. getClassName(): string;
  122076. /**
  122077. * Gets the world position input component
  122078. */
  122079. readonly worldPosition: NodeMaterialConnectionPoint;
  122080. /**
  122081. * Gets the direction output component
  122082. */
  122083. readonly direction: NodeMaterialConnectionPoint;
  122084. /**
  122085. * Gets the direction output component
  122086. */
  122087. readonly color: NodeMaterialConnectionPoint;
  122088. /**
  122089. * Gets the direction output component
  122090. */
  122091. readonly intensity: NodeMaterialConnectionPoint;
  122092. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122093. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122094. protected _buildBlock(state: NodeMaterialBuildState): this;
  122095. serialize(): any;
  122096. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122097. }
  122098. }
  122099. declare module BABYLON {
  122100. /**
  122101. * Block used to add image processing support to fragment shader
  122102. */
  122103. export class ImageProcessingBlock extends NodeMaterialBlock {
  122104. /**
  122105. * Create a new ImageProcessingBlock
  122106. * @param name defines the block name
  122107. */
  122108. constructor(name: string);
  122109. /**
  122110. * Gets the current class name
  122111. * @returns the class name
  122112. */
  122113. getClassName(): string;
  122114. /**
  122115. * Gets the color input component
  122116. */
  122117. readonly color: NodeMaterialConnectionPoint;
  122118. /**
  122119. * Gets the output component
  122120. */
  122121. readonly output: NodeMaterialConnectionPoint;
  122122. /**
  122123. * Initialize the block and prepare the context for build
  122124. * @param state defines the state that will be used for the build
  122125. */
  122126. initialize(state: NodeMaterialBuildState): void;
  122127. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  122128. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122129. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122130. protected _buildBlock(state: NodeMaterialBuildState): this;
  122131. }
  122132. }
  122133. declare module BABYLON {
  122134. /**
  122135. * Block used to pertub normals based on a normal map
  122136. */
  122137. export class PerturbNormalBlock extends NodeMaterialBlock {
  122138. private _tangentSpaceParameterName;
  122139. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  122140. invertX: boolean;
  122141. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  122142. invertY: boolean;
  122143. /**
  122144. * Create a new PerturbNormalBlock
  122145. * @param name defines the block name
  122146. */
  122147. constructor(name: string);
  122148. /**
  122149. * Gets the current class name
  122150. * @returns the class name
  122151. */
  122152. getClassName(): string;
  122153. /**
  122154. * Gets the world position input component
  122155. */
  122156. readonly worldPosition: NodeMaterialConnectionPoint;
  122157. /**
  122158. * Gets the world normal input component
  122159. */
  122160. readonly worldNormal: NodeMaterialConnectionPoint;
  122161. /**
  122162. * Gets the uv input component
  122163. */
  122164. readonly uv: NodeMaterialConnectionPoint;
  122165. /**
  122166. * Gets the normal map color input component
  122167. */
  122168. readonly normalMapColor: NodeMaterialConnectionPoint;
  122169. /**
  122170. * Gets the strength input component
  122171. */
  122172. readonly strength: NodeMaterialConnectionPoint;
  122173. /**
  122174. * Gets the output component
  122175. */
  122176. readonly output: NodeMaterialConnectionPoint;
  122177. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122178. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122179. autoConfigure(material: NodeMaterial): void;
  122180. protected _buildBlock(state: NodeMaterialBuildState): this;
  122181. protected _dumpPropertiesCode(): string;
  122182. serialize(): any;
  122183. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122184. }
  122185. }
  122186. declare module BABYLON {
  122187. /**
  122188. * Block used to discard a pixel if a value is smaller than a cutoff
  122189. */
  122190. export class DiscardBlock extends NodeMaterialBlock {
  122191. /**
  122192. * Create a new DiscardBlock
  122193. * @param name defines the block name
  122194. */
  122195. constructor(name: string);
  122196. /**
  122197. * Gets the current class name
  122198. * @returns the class name
  122199. */
  122200. getClassName(): string;
  122201. /**
  122202. * Gets the color input component
  122203. */
  122204. readonly value: NodeMaterialConnectionPoint;
  122205. /**
  122206. * Gets the cutoff input component
  122207. */
  122208. readonly cutoff: NodeMaterialConnectionPoint;
  122209. protected _buildBlock(state: NodeMaterialBuildState): this;
  122210. }
  122211. }
  122212. declare module BABYLON {
  122213. /**
  122214. * Block used to add support for scene fog
  122215. */
  122216. export class FogBlock extends NodeMaterialBlock {
  122217. private _fogDistanceName;
  122218. private _fogParameters;
  122219. /**
  122220. * Create a new FogBlock
  122221. * @param name defines the block name
  122222. */
  122223. constructor(name: string);
  122224. /**
  122225. * Gets the current class name
  122226. * @returns the class name
  122227. */
  122228. getClassName(): string;
  122229. /**
  122230. * Gets the world position input component
  122231. */
  122232. readonly worldPosition: NodeMaterialConnectionPoint;
  122233. /**
  122234. * Gets the view input component
  122235. */
  122236. readonly view: NodeMaterialConnectionPoint;
  122237. /**
  122238. * Gets the color input component
  122239. */
  122240. readonly input: NodeMaterialConnectionPoint;
  122241. /**
  122242. * Gets the fog color input component
  122243. */
  122244. readonly fogColor: NodeMaterialConnectionPoint;
  122245. /**
  122246. * Gets the output component
  122247. */
  122248. readonly output: NodeMaterialConnectionPoint;
  122249. autoConfigure(material: NodeMaterial): void;
  122250. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122251. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122252. protected _buildBlock(state: NodeMaterialBuildState): this;
  122253. }
  122254. }
  122255. declare module BABYLON {
  122256. /**
  122257. * Block used to add light in the fragment shader
  122258. */
  122259. export class LightBlock extends NodeMaterialBlock {
  122260. private _lightId;
  122261. /**
  122262. * Gets or sets the light associated with this block
  122263. */
  122264. light: Nullable<Light>;
  122265. /**
  122266. * Create a new LightBlock
  122267. * @param name defines the block name
  122268. */
  122269. constructor(name: string);
  122270. /**
  122271. * Gets the current class name
  122272. * @returns the class name
  122273. */
  122274. getClassName(): string;
  122275. /**
  122276. * Gets the world position input component
  122277. */
  122278. readonly worldPosition: NodeMaterialConnectionPoint;
  122279. /**
  122280. * Gets the world normal input component
  122281. */
  122282. readonly worldNormal: NodeMaterialConnectionPoint;
  122283. /**
  122284. * Gets the camera (or eye) position component
  122285. */
  122286. readonly cameraPosition: NodeMaterialConnectionPoint;
  122287. /**
  122288. * Gets the glossiness component
  122289. */
  122290. readonly glossiness: NodeMaterialConnectionPoint;
  122291. /**
  122292. * Gets the glossinness power component
  122293. */
  122294. readonly glossPower: NodeMaterialConnectionPoint;
  122295. /**
  122296. * Gets the diffuse color component
  122297. */
  122298. readonly diffuseColor: NodeMaterialConnectionPoint;
  122299. /**
  122300. * Gets the specular color component
  122301. */
  122302. readonly specularColor: NodeMaterialConnectionPoint;
  122303. /**
  122304. * Gets the diffuse output component
  122305. */
  122306. readonly diffuseOutput: NodeMaterialConnectionPoint;
  122307. /**
  122308. * Gets the specular output component
  122309. */
  122310. readonly specularOutput: NodeMaterialConnectionPoint;
  122311. autoConfigure(material: NodeMaterial): void;
  122312. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122313. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  122314. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122315. private _injectVertexCode;
  122316. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  122317. serialize(): any;
  122318. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122319. }
  122320. }
  122321. declare module BABYLON {
  122322. /**
  122323. * Block used to multiply 2 values
  122324. */
  122325. export class MultiplyBlock extends NodeMaterialBlock {
  122326. /**
  122327. * Creates a new MultiplyBlock
  122328. * @param name defines the block name
  122329. */
  122330. constructor(name: string);
  122331. /**
  122332. * Gets the current class name
  122333. * @returns the class name
  122334. */
  122335. getClassName(): string;
  122336. /**
  122337. * Gets the left operand input component
  122338. */
  122339. readonly left: NodeMaterialConnectionPoint;
  122340. /**
  122341. * Gets the right operand input component
  122342. */
  122343. readonly right: NodeMaterialConnectionPoint;
  122344. /**
  122345. * Gets the output component
  122346. */
  122347. readonly output: NodeMaterialConnectionPoint;
  122348. protected _buildBlock(state: NodeMaterialBuildState): this;
  122349. }
  122350. }
  122351. declare module BABYLON {
  122352. /**
  122353. * Block used to add 2 vectors
  122354. */
  122355. export class AddBlock extends NodeMaterialBlock {
  122356. /**
  122357. * Creates a new AddBlock
  122358. * @param name defines the block name
  122359. */
  122360. constructor(name: string);
  122361. /**
  122362. * Gets the current class name
  122363. * @returns the class name
  122364. */
  122365. getClassName(): string;
  122366. /**
  122367. * Gets the left operand input component
  122368. */
  122369. readonly left: NodeMaterialConnectionPoint;
  122370. /**
  122371. * Gets the right operand input component
  122372. */
  122373. readonly right: NodeMaterialConnectionPoint;
  122374. /**
  122375. * Gets the output component
  122376. */
  122377. readonly output: NodeMaterialConnectionPoint;
  122378. protected _buildBlock(state: NodeMaterialBuildState): this;
  122379. }
  122380. }
  122381. declare module BABYLON {
  122382. /**
  122383. * Block used to scale a vector by a float
  122384. */
  122385. export class ScaleBlock extends NodeMaterialBlock {
  122386. /**
  122387. * Creates a new ScaleBlock
  122388. * @param name defines the block name
  122389. */
  122390. constructor(name: string);
  122391. /**
  122392. * Gets the current class name
  122393. * @returns the class name
  122394. */
  122395. getClassName(): string;
  122396. /**
  122397. * Gets the input component
  122398. */
  122399. readonly input: NodeMaterialConnectionPoint;
  122400. /**
  122401. * Gets the factor input component
  122402. */
  122403. readonly factor: NodeMaterialConnectionPoint;
  122404. /**
  122405. * Gets the output component
  122406. */
  122407. readonly output: NodeMaterialConnectionPoint;
  122408. protected _buildBlock(state: NodeMaterialBuildState): this;
  122409. }
  122410. }
  122411. declare module BABYLON {
  122412. /**
  122413. * Block used to clamp a float
  122414. */
  122415. export class ClampBlock extends NodeMaterialBlock {
  122416. /** Gets or sets the minimum range */
  122417. minimum: number;
  122418. /** Gets or sets the maximum range */
  122419. maximum: number;
  122420. /**
  122421. * Creates a new ClampBlock
  122422. * @param name defines the block name
  122423. */
  122424. constructor(name: string);
  122425. /**
  122426. * Gets the current class name
  122427. * @returns the class name
  122428. */
  122429. getClassName(): string;
  122430. /**
  122431. * Gets the value input component
  122432. */
  122433. readonly value: NodeMaterialConnectionPoint;
  122434. /**
  122435. * Gets the output component
  122436. */
  122437. readonly output: NodeMaterialConnectionPoint;
  122438. protected _buildBlock(state: NodeMaterialBuildState): this;
  122439. protected _dumpPropertiesCode(): string;
  122440. serialize(): any;
  122441. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122442. }
  122443. }
  122444. declare module BABYLON {
  122445. /**
  122446. * Block used to apply a cross product between 2 vectors
  122447. */
  122448. export class CrossBlock extends NodeMaterialBlock {
  122449. /**
  122450. * Creates a new CrossBlock
  122451. * @param name defines the block name
  122452. */
  122453. constructor(name: string);
  122454. /**
  122455. * Gets the current class name
  122456. * @returns the class name
  122457. */
  122458. getClassName(): string;
  122459. /**
  122460. * Gets the left operand input component
  122461. */
  122462. readonly left: NodeMaterialConnectionPoint;
  122463. /**
  122464. * Gets the right operand input component
  122465. */
  122466. readonly right: NodeMaterialConnectionPoint;
  122467. /**
  122468. * Gets the output component
  122469. */
  122470. readonly output: NodeMaterialConnectionPoint;
  122471. protected _buildBlock(state: NodeMaterialBuildState): this;
  122472. }
  122473. }
  122474. declare module BABYLON {
  122475. /**
  122476. * Block used to apply a dot product between 2 vectors
  122477. */
  122478. export class DotBlock extends NodeMaterialBlock {
  122479. /**
  122480. * Creates a new DotBlock
  122481. * @param name defines the block name
  122482. */
  122483. constructor(name: string);
  122484. /**
  122485. * Gets the current class name
  122486. * @returns the class name
  122487. */
  122488. getClassName(): string;
  122489. /**
  122490. * Gets the left operand input component
  122491. */
  122492. readonly left: NodeMaterialConnectionPoint;
  122493. /**
  122494. * Gets the right operand input component
  122495. */
  122496. readonly right: NodeMaterialConnectionPoint;
  122497. /**
  122498. * Gets the output component
  122499. */
  122500. readonly output: NodeMaterialConnectionPoint;
  122501. protected _buildBlock(state: NodeMaterialBuildState): this;
  122502. }
  122503. }
  122504. declare module BABYLON {
  122505. /**
  122506. * Block used to remap a float from a range to a new one
  122507. */
  122508. export class RemapBlock extends NodeMaterialBlock {
  122509. /**
  122510. * Gets or sets the source range
  122511. */
  122512. sourceRange: Vector2;
  122513. /**
  122514. * Gets or sets the target range
  122515. */
  122516. targetRange: Vector2;
  122517. /**
  122518. * Creates a new RemapBlock
  122519. * @param name defines the block name
  122520. */
  122521. constructor(name: string);
  122522. /**
  122523. * Gets the current class name
  122524. * @returns the class name
  122525. */
  122526. getClassName(): string;
  122527. /**
  122528. * Gets the input component
  122529. */
  122530. readonly input: NodeMaterialConnectionPoint;
  122531. /**
  122532. * Gets the source min input component
  122533. */
  122534. readonly sourceMin: NodeMaterialConnectionPoint;
  122535. /**
  122536. * Gets the source max input component
  122537. */
  122538. readonly sourceMax: NodeMaterialConnectionPoint;
  122539. /**
  122540. * Gets the target min input component
  122541. */
  122542. readonly targetMin: NodeMaterialConnectionPoint;
  122543. /**
  122544. * Gets the target max input component
  122545. */
  122546. readonly targetMax: NodeMaterialConnectionPoint;
  122547. /**
  122548. * Gets the output component
  122549. */
  122550. readonly output: NodeMaterialConnectionPoint;
  122551. protected _buildBlock(state: NodeMaterialBuildState): this;
  122552. protected _dumpPropertiesCode(): string;
  122553. serialize(): any;
  122554. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122555. }
  122556. }
  122557. declare module BABYLON {
  122558. /**
  122559. * Block used to normalize a vector
  122560. */
  122561. export class NormalizeBlock extends NodeMaterialBlock {
  122562. /**
  122563. * Creates a new NormalizeBlock
  122564. * @param name defines the block name
  122565. */
  122566. constructor(name: string);
  122567. /**
  122568. * Gets the current class name
  122569. * @returns the class name
  122570. */
  122571. getClassName(): string;
  122572. /**
  122573. * Gets the input component
  122574. */
  122575. readonly input: NodeMaterialConnectionPoint;
  122576. /**
  122577. * Gets the output component
  122578. */
  122579. readonly output: NodeMaterialConnectionPoint;
  122580. protected _buildBlock(state: NodeMaterialBuildState): this;
  122581. }
  122582. }
  122583. declare module BABYLON {
  122584. /**
  122585. * Operations supported by the Trigonometry block
  122586. */
  122587. export enum TrigonometryBlockOperations {
  122588. /** Cos */
  122589. Cos = 0,
  122590. /** Sin */
  122591. Sin = 1,
  122592. /** Abs */
  122593. Abs = 2,
  122594. /** Exp */
  122595. Exp = 3,
  122596. /** Exp2 */
  122597. Exp2 = 4,
  122598. /** Round */
  122599. Round = 5,
  122600. /** Floor */
  122601. Floor = 6,
  122602. /** Ceiling */
  122603. Ceiling = 7,
  122604. /** Square root */
  122605. Sqrt = 8,
  122606. /** Log */
  122607. Log = 9,
  122608. /** Tangent */
  122609. Tan = 10,
  122610. /** Arc tangent */
  122611. ArcTan = 11,
  122612. /** Arc cosinus */
  122613. ArcCos = 12,
  122614. /** Arc sinus */
  122615. ArcSin = 13,
  122616. /** Fraction */
  122617. Fract = 14,
  122618. /** Sign */
  122619. Sign = 15,
  122620. /** To radians (from degrees) */
  122621. Radians = 16,
  122622. /** To degrees (from radians) */
  122623. Degrees = 17
  122624. }
  122625. /**
  122626. * Block used to apply trigonometry operation to floats
  122627. */
  122628. export class TrigonometryBlock extends NodeMaterialBlock {
  122629. /**
  122630. * Gets or sets the operation applied by the block
  122631. */
  122632. operation: TrigonometryBlockOperations;
  122633. /**
  122634. * Creates a new TrigonometryBlock
  122635. * @param name defines the block name
  122636. */
  122637. constructor(name: string);
  122638. /**
  122639. * Gets the current class name
  122640. * @returns the class name
  122641. */
  122642. getClassName(): string;
  122643. /**
  122644. * Gets the input component
  122645. */
  122646. readonly input: NodeMaterialConnectionPoint;
  122647. /**
  122648. * Gets the output component
  122649. */
  122650. readonly output: NodeMaterialConnectionPoint;
  122651. protected _buildBlock(state: NodeMaterialBuildState): this;
  122652. serialize(): any;
  122653. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122654. }
  122655. }
  122656. declare module BABYLON {
  122657. /**
  122658. * Block used to create a Color3/4 out of individual inputs (one for each component)
  122659. */
  122660. export class ColorMergerBlock extends NodeMaterialBlock {
  122661. /**
  122662. * Create a new ColorMergerBlock
  122663. * @param name defines the block name
  122664. */
  122665. constructor(name: string);
  122666. /**
  122667. * Gets the current class name
  122668. * @returns the class name
  122669. */
  122670. getClassName(): string;
  122671. /**
  122672. * Gets the r component (input)
  122673. */
  122674. readonly r: NodeMaterialConnectionPoint;
  122675. /**
  122676. * Gets the g component (input)
  122677. */
  122678. readonly g: NodeMaterialConnectionPoint;
  122679. /**
  122680. * Gets the b component (input)
  122681. */
  122682. readonly b: NodeMaterialConnectionPoint;
  122683. /**
  122684. * Gets the a component (input)
  122685. */
  122686. readonly a: NodeMaterialConnectionPoint;
  122687. /**
  122688. * Gets the rgba component (output)
  122689. */
  122690. readonly rgba: NodeMaterialConnectionPoint;
  122691. /**
  122692. * Gets the rgb component (output)
  122693. */
  122694. readonly rgb: NodeMaterialConnectionPoint;
  122695. protected _buildBlock(state: NodeMaterialBuildState): this;
  122696. }
  122697. }
  122698. declare module BABYLON {
  122699. /**
  122700. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  122701. */
  122702. export class VectorMergerBlock extends NodeMaterialBlock {
  122703. /**
  122704. * Create a new VectorMergerBlock
  122705. * @param name defines the block name
  122706. */
  122707. constructor(name: string);
  122708. /**
  122709. * Gets the current class name
  122710. * @returns the class name
  122711. */
  122712. getClassName(): string;
  122713. /**
  122714. * Gets the x component (input)
  122715. */
  122716. readonly x: NodeMaterialConnectionPoint;
  122717. /**
  122718. * Gets the y component (input)
  122719. */
  122720. readonly y: NodeMaterialConnectionPoint;
  122721. /**
  122722. * Gets the z component (input)
  122723. */
  122724. readonly z: NodeMaterialConnectionPoint;
  122725. /**
  122726. * Gets the w component (input)
  122727. */
  122728. readonly w: NodeMaterialConnectionPoint;
  122729. /**
  122730. * Gets the xyzw component (output)
  122731. */
  122732. readonly xyzw: NodeMaterialConnectionPoint;
  122733. /**
  122734. * Gets the xyz component (output)
  122735. */
  122736. readonly xyz: NodeMaterialConnectionPoint;
  122737. /**
  122738. * Gets the xy component (output)
  122739. */
  122740. readonly xy: NodeMaterialConnectionPoint;
  122741. protected _buildBlock(state: NodeMaterialBuildState): this;
  122742. }
  122743. }
  122744. declare module BABYLON {
  122745. /**
  122746. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  122747. */
  122748. export class ColorSplitterBlock extends NodeMaterialBlock {
  122749. /**
  122750. * Create a new ColorSplitterBlock
  122751. * @param name defines the block name
  122752. */
  122753. constructor(name: string);
  122754. /**
  122755. * Gets the current class name
  122756. * @returns the class name
  122757. */
  122758. getClassName(): string;
  122759. /**
  122760. * Gets the rgba component (input)
  122761. */
  122762. readonly rgba: NodeMaterialConnectionPoint;
  122763. /**
  122764. * Gets the rgb component (input)
  122765. */
  122766. readonly rgbIn: NodeMaterialConnectionPoint;
  122767. /**
  122768. * Gets the rgb component (output)
  122769. */
  122770. readonly rgbOut: NodeMaterialConnectionPoint;
  122771. /**
  122772. * Gets the r component (output)
  122773. */
  122774. readonly r: NodeMaterialConnectionPoint;
  122775. /**
  122776. * Gets the g component (output)
  122777. */
  122778. readonly g: NodeMaterialConnectionPoint;
  122779. /**
  122780. * Gets the b component (output)
  122781. */
  122782. readonly b: NodeMaterialConnectionPoint;
  122783. /**
  122784. * Gets the a component (output)
  122785. */
  122786. readonly a: NodeMaterialConnectionPoint;
  122787. protected _inputRename(name: string): string;
  122788. protected _outputRename(name: string): string;
  122789. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  122790. }
  122791. }
  122792. declare module BABYLON {
  122793. /**
  122794. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  122795. */
  122796. export class VectorSplitterBlock extends NodeMaterialBlock {
  122797. /**
  122798. * Create a new VectorSplitterBlock
  122799. * @param name defines the block name
  122800. */
  122801. constructor(name: string);
  122802. /**
  122803. * Gets the current class name
  122804. * @returns the class name
  122805. */
  122806. getClassName(): string;
  122807. /**
  122808. * Gets the xyzw component (input)
  122809. */
  122810. readonly xyzw: NodeMaterialConnectionPoint;
  122811. /**
  122812. * Gets the xyz component (input)
  122813. */
  122814. readonly xyzIn: NodeMaterialConnectionPoint;
  122815. /**
  122816. * Gets the xy component (input)
  122817. */
  122818. readonly xyIn: NodeMaterialConnectionPoint;
  122819. /**
  122820. * Gets the xyz component (output)
  122821. */
  122822. readonly xyzOut: NodeMaterialConnectionPoint;
  122823. /**
  122824. * Gets the xy component (output)
  122825. */
  122826. readonly xyOut: NodeMaterialConnectionPoint;
  122827. /**
  122828. * Gets the x component (output)
  122829. */
  122830. readonly x: NodeMaterialConnectionPoint;
  122831. /**
  122832. * Gets the y component (output)
  122833. */
  122834. readonly y: NodeMaterialConnectionPoint;
  122835. /**
  122836. * Gets the z component (output)
  122837. */
  122838. readonly z: NodeMaterialConnectionPoint;
  122839. /**
  122840. * Gets the w component (output)
  122841. */
  122842. readonly w: NodeMaterialConnectionPoint;
  122843. protected _inputRename(name: string): string;
  122844. protected _outputRename(name: string): string;
  122845. protected _buildBlock(state: NodeMaterialBuildState): this;
  122846. }
  122847. }
  122848. declare module BABYLON {
  122849. /**
  122850. * Block used to lerp between 2 values
  122851. */
  122852. export class LerpBlock extends NodeMaterialBlock {
  122853. /**
  122854. * Creates a new LerpBlock
  122855. * @param name defines the block name
  122856. */
  122857. constructor(name: string);
  122858. /**
  122859. * Gets the current class name
  122860. * @returns the class name
  122861. */
  122862. getClassName(): string;
  122863. /**
  122864. * Gets the left operand input component
  122865. */
  122866. readonly left: NodeMaterialConnectionPoint;
  122867. /**
  122868. * Gets the right operand input component
  122869. */
  122870. readonly right: NodeMaterialConnectionPoint;
  122871. /**
  122872. * Gets the gradient operand input component
  122873. */
  122874. readonly gradient: NodeMaterialConnectionPoint;
  122875. /**
  122876. * Gets the output component
  122877. */
  122878. readonly output: NodeMaterialConnectionPoint;
  122879. protected _buildBlock(state: NodeMaterialBuildState): this;
  122880. }
  122881. }
  122882. declare module BABYLON {
  122883. /**
  122884. * Block used to divide 2 vectors
  122885. */
  122886. export class DivideBlock extends NodeMaterialBlock {
  122887. /**
  122888. * Creates a new DivideBlock
  122889. * @param name defines the block name
  122890. */
  122891. constructor(name: string);
  122892. /**
  122893. * Gets the current class name
  122894. * @returns the class name
  122895. */
  122896. getClassName(): string;
  122897. /**
  122898. * Gets the left operand input component
  122899. */
  122900. readonly left: NodeMaterialConnectionPoint;
  122901. /**
  122902. * Gets the right operand input component
  122903. */
  122904. readonly right: NodeMaterialConnectionPoint;
  122905. /**
  122906. * Gets the output component
  122907. */
  122908. readonly output: NodeMaterialConnectionPoint;
  122909. protected _buildBlock(state: NodeMaterialBuildState): this;
  122910. }
  122911. }
  122912. declare module BABYLON {
  122913. /**
  122914. * Block used to subtract 2 vectors
  122915. */
  122916. export class SubtractBlock extends NodeMaterialBlock {
  122917. /**
  122918. * Creates a new SubtractBlock
  122919. * @param name defines the block name
  122920. */
  122921. constructor(name: string);
  122922. /**
  122923. * Gets the current class name
  122924. * @returns the class name
  122925. */
  122926. getClassName(): string;
  122927. /**
  122928. * Gets the left operand input component
  122929. */
  122930. readonly left: NodeMaterialConnectionPoint;
  122931. /**
  122932. * Gets the right operand input component
  122933. */
  122934. readonly right: NodeMaterialConnectionPoint;
  122935. /**
  122936. * Gets the output component
  122937. */
  122938. readonly output: NodeMaterialConnectionPoint;
  122939. protected _buildBlock(state: NodeMaterialBuildState): this;
  122940. }
  122941. }
  122942. declare module BABYLON {
  122943. /**
  122944. * Block used to step a value
  122945. */
  122946. export class StepBlock extends NodeMaterialBlock {
  122947. /**
  122948. * Creates a new StepBlock
  122949. * @param name defines the block name
  122950. */
  122951. constructor(name: string);
  122952. /**
  122953. * Gets the current class name
  122954. * @returns the class name
  122955. */
  122956. getClassName(): string;
  122957. /**
  122958. * Gets the value operand input component
  122959. */
  122960. readonly value: NodeMaterialConnectionPoint;
  122961. /**
  122962. * Gets the edge operand input component
  122963. */
  122964. readonly edge: NodeMaterialConnectionPoint;
  122965. /**
  122966. * Gets the output component
  122967. */
  122968. readonly output: NodeMaterialConnectionPoint;
  122969. protected _buildBlock(state: NodeMaterialBuildState): this;
  122970. }
  122971. }
  122972. declare module BABYLON {
  122973. /**
  122974. * Block used to get the opposite (1 - x) of a value
  122975. */
  122976. export class OneMinusBlock extends NodeMaterialBlock {
  122977. /**
  122978. * Creates a new OneMinusBlock
  122979. * @param name defines the block name
  122980. */
  122981. constructor(name: string);
  122982. /**
  122983. * Gets the current class name
  122984. * @returns the class name
  122985. */
  122986. getClassName(): string;
  122987. /**
  122988. * Gets the input component
  122989. */
  122990. readonly input: NodeMaterialConnectionPoint;
  122991. /**
  122992. * Gets the output component
  122993. */
  122994. readonly output: NodeMaterialConnectionPoint;
  122995. protected _buildBlock(state: NodeMaterialBuildState): this;
  122996. }
  122997. }
  122998. declare module BABYLON {
  122999. /**
  123000. * Block used to get the view direction
  123001. */
  123002. export class ViewDirectionBlock extends NodeMaterialBlock {
  123003. /**
  123004. * Creates a new ViewDirectionBlock
  123005. * @param name defines the block name
  123006. */
  123007. constructor(name: string);
  123008. /**
  123009. * Gets the current class name
  123010. * @returns the class name
  123011. */
  123012. getClassName(): string;
  123013. /**
  123014. * Gets the world position component
  123015. */
  123016. readonly worldPosition: NodeMaterialConnectionPoint;
  123017. /**
  123018. * Gets the camera position component
  123019. */
  123020. readonly cameraPosition: NodeMaterialConnectionPoint;
  123021. /**
  123022. * Gets the output component
  123023. */
  123024. readonly output: NodeMaterialConnectionPoint;
  123025. autoConfigure(material: NodeMaterial): void;
  123026. protected _buildBlock(state: NodeMaterialBuildState): this;
  123027. }
  123028. }
  123029. declare module BABYLON {
  123030. /**
  123031. * Block used to compute fresnel value
  123032. */
  123033. export class FresnelBlock extends NodeMaterialBlock {
  123034. /**
  123035. * Create a new FresnelBlock
  123036. * @param name defines the block name
  123037. */
  123038. constructor(name: string);
  123039. /**
  123040. * Gets the current class name
  123041. * @returns the class name
  123042. */
  123043. getClassName(): string;
  123044. /**
  123045. * Gets the world normal input component
  123046. */
  123047. readonly worldNormal: NodeMaterialConnectionPoint;
  123048. /**
  123049. * Gets the view direction input component
  123050. */
  123051. readonly viewDirection: NodeMaterialConnectionPoint;
  123052. /**
  123053. * Gets the bias input component
  123054. */
  123055. readonly bias: NodeMaterialConnectionPoint;
  123056. /**
  123057. * Gets the camera (or eye) position component
  123058. */
  123059. readonly power: NodeMaterialConnectionPoint;
  123060. /**
  123061. * Gets the fresnel output component
  123062. */
  123063. readonly fresnel: NodeMaterialConnectionPoint;
  123064. autoConfigure(material: NodeMaterial): void;
  123065. protected _buildBlock(state: NodeMaterialBuildState): this;
  123066. }
  123067. }
  123068. declare module BABYLON {
  123069. /**
  123070. * Block used to get the max of 2 values
  123071. */
  123072. export class MaxBlock extends NodeMaterialBlock {
  123073. /**
  123074. * Creates a new MaxBlock
  123075. * @param name defines the block name
  123076. */
  123077. constructor(name: string);
  123078. /**
  123079. * Gets the current class name
  123080. * @returns the class name
  123081. */
  123082. getClassName(): string;
  123083. /**
  123084. * Gets the left operand input component
  123085. */
  123086. readonly left: NodeMaterialConnectionPoint;
  123087. /**
  123088. * Gets the right operand input component
  123089. */
  123090. readonly right: NodeMaterialConnectionPoint;
  123091. /**
  123092. * Gets the output component
  123093. */
  123094. readonly output: NodeMaterialConnectionPoint;
  123095. protected _buildBlock(state: NodeMaterialBuildState): this;
  123096. }
  123097. }
  123098. declare module BABYLON {
  123099. /**
  123100. * Block used to get the min of 2 values
  123101. */
  123102. export class MinBlock extends NodeMaterialBlock {
  123103. /**
  123104. * Creates a new MinBlock
  123105. * @param name defines the block name
  123106. */
  123107. constructor(name: string);
  123108. /**
  123109. * Gets the current class name
  123110. * @returns the class name
  123111. */
  123112. getClassName(): string;
  123113. /**
  123114. * Gets the left operand input component
  123115. */
  123116. readonly left: NodeMaterialConnectionPoint;
  123117. /**
  123118. * Gets the right operand input component
  123119. */
  123120. readonly right: NodeMaterialConnectionPoint;
  123121. /**
  123122. * Gets the output component
  123123. */
  123124. readonly output: NodeMaterialConnectionPoint;
  123125. protected _buildBlock(state: NodeMaterialBuildState): this;
  123126. }
  123127. }
  123128. declare module BABYLON {
  123129. /**
  123130. * Block used to get the distance between 2 values
  123131. */
  123132. export class DistanceBlock extends NodeMaterialBlock {
  123133. /**
  123134. * Creates a new DistanceBlock
  123135. * @param name defines the block name
  123136. */
  123137. constructor(name: string);
  123138. /**
  123139. * Gets the current class name
  123140. * @returns the class name
  123141. */
  123142. getClassName(): string;
  123143. /**
  123144. * Gets the left operand input component
  123145. */
  123146. readonly left: NodeMaterialConnectionPoint;
  123147. /**
  123148. * Gets the right operand input component
  123149. */
  123150. readonly right: NodeMaterialConnectionPoint;
  123151. /**
  123152. * Gets the output component
  123153. */
  123154. readonly output: NodeMaterialConnectionPoint;
  123155. protected _buildBlock(state: NodeMaterialBuildState): this;
  123156. }
  123157. }
  123158. declare module BABYLON {
  123159. /**
  123160. * Block used to get the length of a vector
  123161. */
  123162. export class LengthBlock extends NodeMaterialBlock {
  123163. /**
  123164. * Creates a new LengthBlock
  123165. * @param name defines the block name
  123166. */
  123167. constructor(name: string);
  123168. /**
  123169. * Gets the current class name
  123170. * @returns the class name
  123171. */
  123172. getClassName(): string;
  123173. /**
  123174. * Gets the value input component
  123175. */
  123176. readonly value: NodeMaterialConnectionPoint;
  123177. /**
  123178. * Gets the output component
  123179. */
  123180. readonly output: NodeMaterialConnectionPoint;
  123181. protected _buildBlock(state: NodeMaterialBuildState): this;
  123182. }
  123183. }
  123184. declare module BABYLON {
  123185. /**
  123186. * Block used to get negative version of a value (i.e. x * -1)
  123187. */
  123188. export class NegateBlock extends NodeMaterialBlock {
  123189. /**
  123190. * Creates a new NegateBlock
  123191. * @param name defines the block name
  123192. */
  123193. constructor(name: string);
  123194. /**
  123195. * Gets the current class name
  123196. * @returns the class name
  123197. */
  123198. getClassName(): string;
  123199. /**
  123200. * Gets the value input component
  123201. */
  123202. readonly value: NodeMaterialConnectionPoint;
  123203. /**
  123204. * Gets the output component
  123205. */
  123206. readonly output: NodeMaterialConnectionPoint;
  123207. protected _buildBlock(state: NodeMaterialBuildState): this;
  123208. }
  123209. }
  123210. declare module BABYLON {
  123211. /**
  123212. * Block used to get the value of the first parameter raised to the power of the second
  123213. */
  123214. export class PowBlock extends NodeMaterialBlock {
  123215. /**
  123216. * Creates a new PowBlock
  123217. * @param name defines the block name
  123218. */
  123219. constructor(name: string);
  123220. /**
  123221. * Gets the current class name
  123222. * @returns the class name
  123223. */
  123224. getClassName(): string;
  123225. /**
  123226. * Gets the value operand input component
  123227. */
  123228. readonly value: NodeMaterialConnectionPoint;
  123229. /**
  123230. * Gets the power operand input component
  123231. */
  123232. readonly power: NodeMaterialConnectionPoint;
  123233. /**
  123234. * Gets the output component
  123235. */
  123236. readonly output: NodeMaterialConnectionPoint;
  123237. protected _buildBlock(state: NodeMaterialBuildState): this;
  123238. }
  123239. }
  123240. declare module BABYLON {
  123241. /**
  123242. * Block used to get a random number
  123243. */
  123244. export class RandomNumberBlock extends NodeMaterialBlock {
  123245. /**
  123246. * Creates a new RandomNumberBlock
  123247. * @param name defines the block name
  123248. */
  123249. constructor(name: string);
  123250. /**
  123251. * Gets the current class name
  123252. * @returns the class name
  123253. */
  123254. getClassName(): string;
  123255. /**
  123256. * Gets the seed input component
  123257. */
  123258. readonly seed: NodeMaterialConnectionPoint;
  123259. /**
  123260. * Gets the output component
  123261. */
  123262. readonly output: NodeMaterialConnectionPoint;
  123263. protected _buildBlock(state: NodeMaterialBuildState): this;
  123264. }
  123265. }
  123266. declare module BABYLON {
  123267. /**
  123268. * Block used to compute arc tangent of 2 values
  123269. */
  123270. export class ArcTan2Block extends NodeMaterialBlock {
  123271. /**
  123272. * Creates a new ArcTan2Block
  123273. * @param name defines the block name
  123274. */
  123275. constructor(name: string);
  123276. /**
  123277. * Gets the current class name
  123278. * @returns the class name
  123279. */
  123280. getClassName(): string;
  123281. /**
  123282. * Gets the x operand input component
  123283. */
  123284. readonly x: NodeMaterialConnectionPoint;
  123285. /**
  123286. * Gets the y operand input component
  123287. */
  123288. readonly y: NodeMaterialConnectionPoint;
  123289. /**
  123290. * Gets the output component
  123291. */
  123292. readonly output: NodeMaterialConnectionPoint;
  123293. protected _buildBlock(state: NodeMaterialBuildState): this;
  123294. }
  123295. }
  123296. declare module BABYLON {
  123297. /**
  123298. * Block used to smooth step a value
  123299. */
  123300. export class SmoothStepBlock extends NodeMaterialBlock {
  123301. /**
  123302. * Creates a new SmoothStepBlock
  123303. * @param name defines the block name
  123304. */
  123305. constructor(name: string);
  123306. /**
  123307. * Gets the current class name
  123308. * @returns the class name
  123309. */
  123310. getClassName(): string;
  123311. /**
  123312. * Gets the value operand input component
  123313. */
  123314. readonly value: NodeMaterialConnectionPoint;
  123315. /**
  123316. * Gets the first edge operand input component
  123317. */
  123318. readonly edge0: NodeMaterialConnectionPoint;
  123319. /**
  123320. * Gets the second edge operand input component
  123321. */
  123322. readonly edge1: NodeMaterialConnectionPoint;
  123323. /**
  123324. * Gets the output component
  123325. */
  123326. readonly output: NodeMaterialConnectionPoint;
  123327. protected _buildBlock(state: NodeMaterialBuildState): this;
  123328. }
  123329. }
  123330. declare module BABYLON {
  123331. /**
  123332. * Block used to get the reciprocal (1 / x) of a value
  123333. */
  123334. export class ReciprocalBlock extends NodeMaterialBlock {
  123335. /**
  123336. * Creates a new ReciprocalBlock
  123337. * @param name defines the block name
  123338. */
  123339. constructor(name: string);
  123340. /**
  123341. * Gets the current class name
  123342. * @returns the class name
  123343. */
  123344. getClassName(): string;
  123345. /**
  123346. * Gets the input component
  123347. */
  123348. readonly input: NodeMaterialConnectionPoint;
  123349. /**
  123350. * Gets the output component
  123351. */
  123352. readonly output: NodeMaterialConnectionPoint;
  123353. protected _buildBlock(state: NodeMaterialBuildState): this;
  123354. }
  123355. }
  123356. declare module BABYLON {
  123357. /**
  123358. * Block used to replace a color by another one
  123359. */
  123360. export class ReplaceColorBlock extends NodeMaterialBlock {
  123361. /**
  123362. * Creates a new ReplaceColorBlock
  123363. * @param name defines the block name
  123364. */
  123365. constructor(name: string);
  123366. /**
  123367. * Gets the current class name
  123368. * @returns the class name
  123369. */
  123370. getClassName(): string;
  123371. /**
  123372. * Gets the value input component
  123373. */
  123374. readonly value: NodeMaterialConnectionPoint;
  123375. /**
  123376. * Gets the reference input component
  123377. */
  123378. readonly reference: NodeMaterialConnectionPoint;
  123379. /**
  123380. * Gets the distance input component
  123381. */
  123382. readonly distance: NodeMaterialConnectionPoint;
  123383. /**
  123384. * Gets the replacement input component
  123385. */
  123386. readonly replacement: NodeMaterialConnectionPoint;
  123387. /**
  123388. * Gets the output component
  123389. */
  123390. readonly output: NodeMaterialConnectionPoint;
  123391. protected _buildBlock(state: NodeMaterialBuildState): this;
  123392. }
  123393. }
  123394. declare module BABYLON {
  123395. /**
  123396. * Block used to posterize a value
  123397. * @see https://en.wikipedia.org/wiki/Posterization
  123398. */
  123399. export class PosterizeBlock extends NodeMaterialBlock {
  123400. /**
  123401. * Creates a new PosterizeBlock
  123402. * @param name defines the block name
  123403. */
  123404. constructor(name: string);
  123405. /**
  123406. * Gets the current class name
  123407. * @returns the class name
  123408. */
  123409. getClassName(): string;
  123410. /**
  123411. * Gets the value input component
  123412. */
  123413. readonly value: NodeMaterialConnectionPoint;
  123414. /**
  123415. * Gets the steps input component
  123416. */
  123417. readonly steps: NodeMaterialConnectionPoint;
  123418. /**
  123419. * Gets the output component
  123420. */
  123421. readonly output: NodeMaterialConnectionPoint;
  123422. protected _buildBlock(state: NodeMaterialBuildState): this;
  123423. }
  123424. }
  123425. declare module BABYLON {
  123426. /**
  123427. * Operations supported by the Wave block
  123428. */
  123429. export enum WaveBlockKind {
  123430. /** SawTooth */
  123431. SawTooth = 0,
  123432. /** Square */
  123433. Square = 1,
  123434. /** Triangle */
  123435. Triangle = 2
  123436. }
  123437. /**
  123438. * Block used to apply wave operation to floats
  123439. */
  123440. export class WaveBlock extends NodeMaterialBlock {
  123441. /**
  123442. * Gets or sets the kibnd of wave to be applied by the block
  123443. */
  123444. kind: WaveBlockKind;
  123445. /**
  123446. * Creates a new WaveBlock
  123447. * @param name defines the block name
  123448. */
  123449. constructor(name: string);
  123450. /**
  123451. * Gets the current class name
  123452. * @returns the class name
  123453. */
  123454. getClassName(): string;
  123455. /**
  123456. * Gets the input component
  123457. */
  123458. readonly input: NodeMaterialConnectionPoint;
  123459. /**
  123460. * Gets the output component
  123461. */
  123462. readonly output: NodeMaterialConnectionPoint;
  123463. protected _buildBlock(state: NodeMaterialBuildState): this;
  123464. serialize(): any;
  123465. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123466. }
  123467. }
  123468. declare module BABYLON {
  123469. /**
  123470. * Class used to store a color step for the GradientBlock
  123471. */
  123472. export class GradientBlockColorStep {
  123473. /**
  123474. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  123475. */
  123476. step: number;
  123477. /**
  123478. * Gets or sets the color associated with this step
  123479. */
  123480. color: Color3;
  123481. /**
  123482. * Creates a new GradientBlockColorStep
  123483. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  123484. * @param color defines the color associated with this step
  123485. */
  123486. constructor(
  123487. /**
  123488. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  123489. */
  123490. step: number,
  123491. /**
  123492. * Gets or sets the color associated with this step
  123493. */
  123494. color: Color3);
  123495. }
  123496. /**
  123497. * Block used to return a color from a gradient based on an input value between 0 and 1
  123498. */
  123499. export class GradientBlock extends NodeMaterialBlock {
  123500. /**
  123501. * Gets or sets the list of color steps
  123502. */
  123503. colorSteps: GradientBlockColorStep[];
  123504. /**
  123505. * Creates a new GradientBlock
  123506. * @param name defines the block name
  123507. */
  123508. constructor(name: string);
  123509. /**
  123510. * Gets the current class name
  123511. * @returns the class name
  123512. */
  123513. getClassName(): string;
  123514. /**
  123515. * Gets the gradient input component
  123516. */
  123517. readonly gradient: NodeMaterialConnectionPoint;
  123518. /**
  123519. * Gets the output component
  123520. */
  123521. readonly output: NodeMaterialConnectionPoint;
  123522. private _writeColorConstant;
  123523. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  123524. serialize(): any;
  123525. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123526. protected _dumpPropertiesCode(): string;
  123527. }
  123528. }
  123529. declare module BABYLON {
  123530. /**
  123531. * Block used to normalize lerp between 2 values
  123532. */
  123533. export class NLerpBlock extends NodeMaterialBlock {
  123534. /**
  123535. * Creates a new NLerpBlock
  123536. * @param name defines the block name
  123537. */
  123538. constructor(name: string);
  123539. /**
  123540. * Gets the current class name
  123541. * @returns the class name
  123542. */
  123543. getClassName(): string;
  123544. /**
  123545. * Gets the left operand input component
  123546. */
  123547. readonly left: NodeMaterialConnectionPoint;
  123548. /**
  123549. * Gets the right operand input component
  123550. */
  123551. readonly right: NodeMaterialConnectionPoint;
  123552. /**
  123553. * Gets the gradient operand input component
  123554. */
  123555. readonly gradient: NodeMaterialConnectionPoint;
  123556. /**
  123557. * Gets the output component
  123558. */
  123559. readonly output: NodeMaterialConnectionPoint;
  123560. protected _buildBlock(state: NodeMaterialBuildState): this;
  123561. }
  123562. }
  123563. declare module BABYLON {
  123564. /**
  123565. * Block used to test if the fragment shader is front facing
  123566. */
  123567. export class FrontFacingBlock extends NodeMaterialBlock {
  123568. /**
  123569. * Creates a new FrontFacingBlock
  123570. * @param name defines the block name
  123571. */
  123572. constructor(name: string);
  123573. /**
  123574. * Gets the current class name
  123575. * @returns the class name
  123576. */
  123577. getClassName(): string;
  123578. /**
  123579. * Gets the world normal component
  123580. */
  123581. readonly worldNormal: NodeMaterialConnectionPoint;
  123582. /**
  123583. * Gets the view direction input component
  123584. */
  123585. readonly viewDirection: NodeMaterialConnectionPoint;
  123586. /**
  123587. * Gets the output component
  123588. */
  123589. readonly output: NodeMaterialConnectionPoint;
  123590. autoConfigure(material: NodeMaterial): void;
  123591. protected _buildBlock(state: NodeMaterialBuildState): this;
  123592. }
  123593. }
  123594. declare module BABYLON {
  123595. /**
  123596. * Effect Render Options
  123597. */
  123598. export interface IEffectRendererOptions {
  123599. /**
  123600. * Defines the vertices positions.
  123601. */
  123602. positions?: number[];
  123603. /**
  123604. * Defines the indices.
  123605. */
  123606. indices?: number[];
  123607. }
  123608. /**
  123609. * Helper class to render one or more effects
  123610. */
  123611. export class EffectRenderer {
  123612. private engine;
  123613. private static _DefaultOptions;
  123614. private _vertexBuffers;
  123615. private _indexBuffer;
  123616. private _ringBufferIndex;
  123617. private _ringScreenBuffer;
  123618. private _fullscreenViewport;
  123619. private _getNextFrameBuffer;
  123620. /**
  123621. * Creates an effect renderer
  123622. * @param engine the engine to use for rendering
  123623. * @param options defines the options of the effect renderer
  123624. */
  123625. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  123626. /**
  123627. * Sets the current viewport in normalized coordinates 0-1
  123628. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  123629. */
  123630. setViewport(viewport?: Viewport): void;
  123631. /**
  123632. * Binds the embedded attributes buffer to the effect.
  123633. * @param effect Defines the effect to bind the attributes for
  123634. */
  123635. bindBuffers(effect: Effect): void;
  123636. /**
  123637. * Sets the current effect wrapper to use during draw.
  123638. * The effect needs to be ready before calling this api.
  123639. * This also sets the default full screen position attribute.
  123640. * @param effectWrapper Defines the effect to draw with
  123641. */
  123642. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  123643. /**
  123644. * Draws a full screen quad.
  123645. */
  123646. draw(): void;
  123647. /**
  123648. * renders one or more effects to a specified texture
  123649. * @param effectWrappers list of effects to renderer
  123650. * @param outputTexture texture to draw to, if null it will render to the screen
  123651. */
  123652. render(effectWrappers: Array<EffectWrapper> | EffectWrapper, outputTexture?: Nullable<Texture>): void;
  123653. /**
  123654. * Disposes of the effect renderer
  123655. */
  123656. dispose(): void;
  123657. }
  123658. /**
  123659. * Options to create an EffectWrapper
  123660. */
  123661. interface EffectWrapperCreationOptions {
  123662. /**
  123663. * Engine to use to create the effect
  123664. */
  123665. engine: ThinEngine;
  123666. /**
  123667. * Fragment shader for the effect
  123668. */
  123669. fragmentShader: string;
  123670. /**
  123671. * Vertex shader for the effect
  123672. */
  123673. vertexShader?: string;
  123674. /**
  123675. * Attributes to use in the shader
  123676. */
  123677. attributeNames?: Array<string>;
  123678. /**
  123679. * Uniforms to use in the shader
  123680. */
  123681. uniformNames?: Array<string>;
  123682. /**
  123683. * Texture sampler names to use in the shader
  123684. */
  123685. samplerNames?: Array<string>;
  123686. /**
  123687. * The friendly name of the effect displayed in Spector.
  123688. */
  123689. name?: string;
  123690. }
  123691. /**
  123692. * Wraps an effect to be used for rendering
  123693. */
  123694. export class EffectWrapper {
  123695. /**
  123696. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  123697. */
  123698. onApplyObservable: Observable<{}>;
  123699. /**
  123700. * The underlying effect
  123701. */
  123702. effect: Effect;
  123703. /**
  123704. * Creates an effect to be renderer
  123705. * @param creationOptions options to create the effect
  123706. */
  123707. constructor(creationOptions: EffectWrapperCreationOptions);
  123708. /**
  123709. * Disposes of the effect wrapper
  123710. */
  123711. dispose(): void;
  123712. }
  123713. }
  123714. declare module BABYLON {
  123715. /**
  123716. * Helper class to push actions to a pool of workers.
  123717. */
  123718. export class WorkerPool implements IDisposable {
  123719. private _workerInfos;
  123720. private _pendingActions;
  123721. /**
  123722. * Constructor
  123723. * @param workers Array of workers to use for actions
  123724. */
  123725. constructor(workers: Array<Worker>);
  123726. /**
  123727. * Terminates all workers and clears any pending actions.
  123728. */
  123729. dispose(): void;
  123730. /**
  123731. * Pushes an action to the worker pool. If all the workers are active, the action will be
  123732. * pended until a worker has completed its action.
  123733. * @param action The action to perform. Call onComplete when the action is complete.
  123734. */
  123735. push(action: (worker: Worker, onComplete: () => void) => void): void;
  123736. private _execute;
  123737. }
  123738. }
  123739. declare module BABYLON {
  123740. /**
  123741. * Configuration for Draco compression
  123742. */
  123743. export interface IDracoCompressionConfiguration {
  123744. /**
  123745. * Configuration for the decoder.
  123746. */
  123747. decoder: {
  123748. /**
  123749. * The url to the WebAssembly module.
  123750. */
  123751. wasmUrl?: string;
  123752. /**
  123753. * The url to the WebAssembly binary.
  123754. */
  123755. wasmBinaryUrl?: string;
  123756. /**
  123757. * The url to the fallback JavaScript module.
  123758. */
  123759. fallbackUrl?: string;
  123760. };
  123761. }
  123762. /**
  123763. * Draco compression (https://google.github.io/draco/)
  123764. *
  123765. * This class wraps the Draco module.
  123766. *
  123767. * **Encoder**
  123768. *
  123769. * The encoder is not currently implemented.
  123770. *
  123771. * **Decoder**
  123772. *
  123773. * 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.
  123774. *
  123775. * To update the configuration, use the following code:
  123776. * ```javascript
  123777. * DracoCompression.Configuration = {
  123778. * decoder: {
  123779. * wasmUrl: "<url to the WebAssembly library>",
  123780. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  123781. * fallbackUrl: "<url to the fallback JavaScript library>",
  123782. * }
  123783. * };
  123784. * ```
  123785. *
  123786. * 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.
  123787. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  123788. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  123789. *
  123790. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  123791. * ```javascript
  123792. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  123793. * ```
  123794. *
  123795. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  123796. */
  123797. export class DracoCompression implements IDisposable {
  123798. private _workerPoolPromise?;
  123799. private _decoderModulePromise?;
  123800. /**
  123801. * The configuration. Defaults to the following urls:
  123802. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  123803. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  123804. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  123805. */
  123806. static Configuration: IDracoCompressionConfiguration;
  123807. /**
  123808. * Returns true if the decoder configuration is available.
  123809. */
  123810. static readonly DecoderAvailable: boolean;
  123811. /**
  123812. * Default number of workers to create when creating the draco compression object.
  123813. */
  123814. static DefaultNumWorkers: number;
  123815. private static GetDefaultNumWorkers;
  123816. private static _Default;
  123817. /**
  123818. * Default instance for the draco compression object.
  123819. */
  123820. static readonly Default: DracoCompression;
  123821. /**
  123822. * Constructor
  123823. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  123824. */
  123825. constructor(numWorkers?: number);
  123826. /**
  123827. * Stop all async operations and release resources.
  123828. */
  123829. dispose(): void;
  123830. /**
  123831. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  123832. * @returns a promise that resolves when ready
  123833. */
  123834. whenReadyAsync(): Promise<void>;
  123835. /**
  123836. * Decode Draco compressed mesh data to vertex data.
  123837. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  123838. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  123839. * @returns A promise that resolves with the decoded vertex data
  123840. */
  123841. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  123842. [kind: string]: number;
  123843. }): Promise<VertexData>;
  123844. }
  123845. }
  123846. declare module BABYLON {
  123847. /**
  123848. * Class for building Constructive Solid Geometry
  123849. */
  123850. export class CSG {
  123851. private polygons;
  123852. /**
  123853. * The world matrix
  123854. */
  123855. matrix: Matrix;
  123856. /**
  123857. * Stores the position
  123858. */
  123859. position: Vector3;
  123860. /**
  123861. * Stores the rotation
  123862. */
  123863. rotation: Vector3;
  123864. /**
  123865. * Stores the rotation quaternion
  123866. */
  123867. rotationQuaternion: Nullable<Quaternion>;
  123868. /**
  123869. * Stores the scaling vector
  123870. */
  123871. scaling: Vector3;
  123872. /**
  123873. * Convert the Mesh to CSG
  123874. * @param mesh The Mesh to convert to CSG
  123875. * @returns A new CSG from the Mesh
  123876. */
  123877. static FromMesh(mesh: Mesh): CSG;
  123878. /**
  123879. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  123880. * @param polygons Polygons used to construct a CSG solid
  123881. */
  123882. private static FromPolygons;
  123883. /**
  123884. * Clones, or makes a deep copy, of the CSG
  123885. * @returns A new CSG
  123886. */
  123887. clone(): CSG;
  123888. /**
  123889. * Unions this CSG with another CSG
  123890. * @param csg The CSG to union against this CSG
  123891. * @returns The unioned CSG
  123892. */
  123893. union(csg: CSG): CSG;
  123894. /**
  123895. * Unions this CSG with another CSG in place
  123896. * @param csg The CSG to union against this CSG
  123897. */
  123898. unionInPlace(csg: CSG): void;
  123899. /**
  123900. * Subtracts this CSG with another CSG
  123901. * @param csg The CSG to subtract against this CSG
  123902. * @returns A new CSG
  123903. */
  123904. subtract(csg: CSG): CSG;
  123905. /**
  123906. * Subtracts this CSG with another CSG in place
  123907. * @param csg The CSG to subtact against this CSG
  123908. */
  123909. subtractInPlace(csg: CSG): void;
  123910. /**
  123911. * Intersect this CSG with another CSG
  123912. * @param csg The CSG to intersect against this CSG
  123913. * @returns A new CSG
  123914. */
  123915. intersect(csg: CSG): CSG;
  123916. /**
  123917. * Intersects this CSG with another CSG in place
  123918. * @param csg The CSG to intersect against this CSG
  123919. */
  123920. intersectInPlace(csg: CSG): void;
  123921. /**
  123922. * Return a new CSG solid with solid and empty space switched. This solid is
  123923. * not modified.
  123924. * @returns A new CSG solid with solid and empty space switched
  123925. */
  123926. inverse(): CSG;
  123927. /**
  123928. * Inverses the CSG in place
  123929. */
  123930. inverseInPlace(): void;
  123931. /**
  123932. * This is used to keep meshes transformations so they can be restored
  123933. * when we build back a Babylon Mesh
  123934. * NB : All CSG operations are performed in world coordinates
  123935. * @param csg The CSG to copy the transform attributes from
  123936. * @returns This CSG
  123937. */
  123938. copyTransformAttributes(csg: CSG): CSG;
  123939. /**
  123940. * Build Raw mesh from CSG
  123941. * Coordinates here are in world space
  123942. * @param name The name of the mesh geometry
  123943. * @param scene The Scene
  123944. * @param keepSubMeshes Specifies if the submeshes should be kept
  123945. * @returns A new Mesh
  123946. */
  123947. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  123948. /**
  123949. * Build Mesh from CSG taking material and transforms into account
  123950. * @param name The name of the Mesh
  123951. * @param material The material of the Mesh
  123952. * @param scene The Scene
  123953. * @param keepSubMeshes Specifies if submeshes should be kept
  123954. * @returns The new Mesh
  123955. */
  123956. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  123957. }
  123958. }
  123959. declare module BABYLON {
  123960. /**
  123961. * Class used to create a trail following a mesh
  123962. */
  123963. export class TrailMesh extends Mesh {
  123964. private _generator;
  123965. private _autoStart;
  123966. private _running;
  123967. private _diameter;
  123968. private _length;
  123969. private _sectionPolygonPointsCount;
  123970. private _sectionVectors;
  123971. private _sectionNormalVectors;
  123972. private _beforeRenderObserver;
  123973. /**
  123974. * @constructor
  123975. * @param name The value used by scene.getMeshByName() to do a lookup.
  123976. * @param generator The mesh to generate a trail.
  123977. * @param scene The scene to add this mesh to.
  123978. * @param diameter Diameter of trailing mesh. Default is 1.
  123979. * @param length Length of trailing mesh. Default is 60.
  123980. * @param autoStart Automatically start trailing mesh. Default true.
  123981. */
  123982. constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  123983. /**
  123984. * "TrailMesh"
  123985. * @returns "TrailMesh"
  123986. */
  123987. getClassName(): string;
  123988. private _createMesh;
  123989. /**
  123990. * Start trailing mesh.
  123991. */
  123992. start(): void;
  123993. /**
  123994. * Stop trailing mesh.
  123995. */
  123996. stop(): void;
  123997. /**
  123998. * Update trailing mesh geometry.
  123999. */
  124000. update(): void;
  124001. /**
  124002. * Returns a new TrailMesh object.
  124003. * @param name is a string, the name given to the new mesh
  124004. * @param newGenerator use new generator object for cloned trail mesh
  124005. * @returns a new mesh
  124006. */
  124007. clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
  124008. /**
  124009. * Serializes this trail mesh
  124010. * @param serializationObject object to write serialization to
  124011. */
  124012. serialize(serializationObject: any): void;
  124013. /**
  124014. * Parses a serialized trail mesh
  124015. * @param parsedMesh the serialized mesh
  124016. * @param scene the scene to create the trail mesh in
  124017. * @returns the created trail mesh
  124018. */
  124019. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  124020. }
  124021. }
  124022. declare module BABYLON {
  124023. /**
  124024. * Class containing static functions to help procedurally build meshes
  124025. */
  124026. export class TiledBoxBuilder {
  124027. /**
  124028. * Creates a box mesh
  124029. * 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)
  124030. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  124031. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124032. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124033. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124034. * @param name defines the name of the mesh
  124035. * @param options defines the options used to create the mesh
  124036. * @param scene defines the hosting scene
  124037. * @returns the box mesh
  124038. */
  124039. static CreateTiledBox(name: string, options: {
  124040. pattern?: number;
  124041. width?: number;
  124042. height?: number;
  124043. depth?: number;
  124044. tileSize?: number;
  124045. tileWidth?: number;
  124046. tileHeight?: number;
  124047. alignHorizontal?: number;
  124048. alignVertical?: number;
  124049. faceUV?: Vector4[];
  124050. faceColors?: Color4[];
  124051. sideOrientation?: number;
  124052. updatable?: boolean;
  124053. }, scene?: Nullable<Scene>): Mesh;
  124054. }
  124055. }
  124056. declare module BABYLON {
  124057. /**
  124058. * Class containing static functions to help procedurally build meshes
  124059. */
  124060. export class TorusKnotBuilder {
  124061. /**
  124062. * Creates a torus knot mesh
  124063. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  124064. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  124065. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  124066. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  124067. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124068. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124069. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124070. * @param name defines the name of the mesh
  124071. * @param options defines the options used to create the mesh
  124072. * @param scene defines the hosting scene
  124073. * @returns the torus knot mesh
  124074. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  124075. */
  124076. static CreateTorusKnot(name: string, options: {
  124077. radius?: number;
  124078. tube?: number;
  124079. radialSegments?: number;
  124080. tubularSegments?: number;
  124081. p?: number;
  124082. q?: number;
  124083. updatable?: boolean;
  124084. sideOrientation?: number;
  124085. frontUVs?: Vector4;
  124086. backUVs?: Vector4;
  124087. }, scene: any): Mesh;
  124088. }
  124089. }
  124090. declare module BABYLON {
  124091. /**
  124092. * Polygon
  124093. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  124094. */
  124095. export class Polygon {
  124096. /**
  124097. * Creates a rectangle
  124098. * @param xmin bottom X coord
  124099. * @param ymin bottom Y coord
  124100. * @param xmax top X coord
  124101. * @param ymax top Y coord
  124102. * @returns points that make the resulting rectation
  124103. */
  124104. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  124105. /**
  124106. * Creates a circle
  124107. * @param radius radius of circle
  124108. * @param cx scale in x
  124109. * @param cy scale in y
  124110. * @param numberOfSides number of sides that make up the circle
  124111. * @returns points that make the resulting circle
  124112. */
  124113. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  124114. /**
  124115. * Creates a polygon from input string
  124116. * @param input Input polygon data
  124117. * @returns the parsed points
  124118. */
  124119. static Parse(input: string): Vector2[];
  124120. /**
  124121. * Starts building a polygon from x and y coordinates
  124122. * @param x x coordinate
  124123. * @param y y coordinate
  124124. * @returns the started path2
  124125. */
  124126. static StartingAt(x: number, y: number): Path2;
  124127. }
  124128. /**
  124129. * Builds a polygon
  124130. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  124131. */
  124132. export class PolygonMeshBuilder {
  124133. private _points;
  124134. private _outlinepoints;
  124135. private _holes;
  124136. private _name;
  124137. private _scene;
  124138. private _epoints;
  124139. private _eholes;
  124140. private _addToepoint;
  124141. /**
  124142. * Babylon reference to the earcut plugin.
  124143. */
  124144. bjsEarcut: any;
  124145. /**
  124146. * Creates a PolygonMeshBuilder
  124147. * @param name name of the builder
  124148. * @param contours Path of the polygon
  124149. * @param scene scene to add to when creating the mesh
  124150. * @param earcutInjection can be used to inject your own earcut reference
  124151. */
  124152. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  124153. /**
  124154. * Adds a whole within the polygon
  124155. * @param hole Array of points defining the hole
  124156. * @returns this
  124157. */
  124158. addHole(hole: Vector2[]): PolygonMeshBuilder;
  124159. /**
  124160. * Creates the polygon
  124161. * @param updatable If the mesh should be updatable
  124162. * @param depth The depth of the mesh created
  124163. * @returns the created mesh
  124164. */
  124165. build(updatable?: boolean, depth?: number): Mesh;
  124166. /**
  124167. * Creates the polygon
  124168. * @param depth The depth of the mesh created
  124169. * @returns the created VertexData
  124170. */
  124171. buildVertexData(depth?: number): VertexData;
  124172. /**
  124173. * Adds a side to the polygon
  124174. * @param positions points that make the polygon
  124175. * @param normals normals of the polygon
  124176. * @param uvs uvs of the polygon
  124177. * @param indices indices of the polygon
  124178. * @param bounds bounds of the polygon
  124179. * @param points points of the polygon
  124180. * @param depth depth of the polygon
  124181. * @param flip flip of the polygon
  124182. */
  124183. private addSide;
  124184. }
  124185. }
  124186. declare module BABYLON {
  124187. /**
  124188. * Class containing static functions to help procedurally build meshes
  124189. */
  124190. export class PolygonBuilder {
  124191. /**
  124192. * Creates a polygon mesh
  124193. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  124194. * * 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
  124195. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  124196. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124197. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  124198. * * Remember you can only change the shape positions, not their number when updating a polygon
  124199. * @param name defines the name of the mesh
  124200. * @param options defines the options used to create the mesh
  124201. * @param scene defines the hosting scene
  124202. * @param earcutInjection can be used to inject your own earcut reference
  124203. * @returns the polygon mesh
  124204. */
  124205. static CreatePolygon(name: string, options: {
  124206. shape: Vector3[];
  124207. holes?: Vector3[][];
  124208. depth?: number;
  124209. faceUV?: Vector4[];
  124210. faceColors?: Color4[];
  124211. updatable?: boolean;
  124212. sideOrientation?: number;
  124213. frontUVs?: Vector4;
  124214. backUVs?: Vector4;
  124215. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  124216. /**
  124217. * Creates an extruded polygon mesh, with depth in the Y direction.
  124218. * * 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)
  124219. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  124220. * @param name defines the name of the mesh
  124221. * @param options defines the options used to create the mesh
  124222. * @param scene defines the hosting scene
  124223. * @param earcutInjection can be used to inject your own earcut reference
  124224. * @returns the polygon mesh
  124225. */
  124226. static ExtrudePolygon(name: string, options: {
  124227. shape: Vector3[];
  124228. holes?: Vector3[][];
  124229. depth?: number;
  124230. faceUV?: Vector4[];
  124231. faceColors?: Color4[];
  124232. updatable?: boolean;
  124233. sideOrientation?: number;
  124234. frontUVs?: Vector4;
  124235. backUVs?: Vector4;
  124236. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  124237. }
  124238. }
  124239. declare module BABYLON {
  124240. /**
  124241. * Class containing static functions to help procedurally build meshes
  124242. */
  124243. export class LatheBuilder {
  124244. /**
  124245. * Creates lathe mesh.
  124246. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  124247. * * 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
  124248. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  124249. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  124250. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  124251. * * 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
  124252. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  124253. * * 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
  124254. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124255. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124256. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  124257. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124258. * @param name defines the name of the mesh
  124259. * @param options defines the options used to create the mesh
  124260. * @param scene defines the hosting scene
  124261. * @returns the lathe mesh
  124262. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  124263. */
  124264. static CreateLathe(name: string, options: {
  124265. shape: Vector3[];
  124266. radius?: number;
  124267. tessellation?: number;
  124268. clip?: number;
  124269. arc?: number;
  124270. closed?: boolean;
  124271. updatable?: boolean;
  124272. sideOrientation?: number;
  124273. frontUVs?: Vector4;
  124274. backUVs?: Vector4;
  124275. cap?: number;
  124276. invertUV?: boolean;
  124277. }, scene?: Nullable<Scene>): Mesh;
  124278. }
  124279. }
  124280. declare module BABYLON {
  124281. /**
  124282. * Class containing static functions to help procedurally build meshes
  124283. */
  124284. export class TiledPlaneBuilder {
  124285. /**
  124286. * Creates a tiled plane mesh
  124287. * * The parameter `pattern` will, depending on value, do nothing or
  124288. * * * flip (reflect about central vertical) alternate tiles across and up
  124289. * * * flip every tile on alternate rows
  124290. * * * rotate (180 degs) alternate tiles across and up
  124291. * * * rotate every tile on alternate rows
  124292. * * * flip and rotate alternate tiles across and up
  124293. * * * flip and rotate every tile on alternate rows
  124294. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  124295. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  124296. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124297. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  124298. * * 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)
  124299. * * 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)
  124300. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  124301. * @param name defines the name of the mesh
  124302. * @param options defines the options used to create the mesh
  124303. * @param scene defines the hosting scene
  124304. * @returns the box mesh
  124305. */
  124306. static CreateTiledPlane(name: string, options: {
  124307. pattern?: number;
  124308. tileSize?: number;
  124309. tileWidth?: number;
  124310. tileHeight?: number;
  124311. size?: number;
  124312. width?: number;
  124313. height?: number;
  124314. alignHorizontal?: number;
  124315. alignVertical?: number;
  124316. sideOrientation?: number;
  124317. frontUVs?: Vector4;
  124318. backUVs?: Vector4;
  124319. updatable?: boolean;
  124320. }, scene?: Nullable<Scene>): Mesh;
  124321. }
  124322. }
  124323. declare module BABYLON {
  124324. /**
  124325. * Class containing static functions to help procedurally build meshes
  124326. */
  124327. export class TubeBuilder {
  124328. /**
  124329. * Creates a tube mesh.
  124330. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  124331. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  124332. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  124333. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  124334. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  124335. * * 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)
  124336. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  124337. * * 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
  124338. * * 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
  124339. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124340. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124341. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  124342. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124343. * @param name defines the name of the mesh
  124344. * @param options defines the options used to create the mesh
  124345. * @param scene defines the hosting scene
  124346. * @returns the tube mesh
  124347. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  124348. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  124349. */
  124350. static CreateTube(name: string, options: {
  124351. path: Vector3[];
  124352. radius?: number;
  124353. tessellation?: number;
  124354. radiusFunction?: {
  124355. (i: number, distance: number): number;
  124356. };
  124357. cap?: number;
  124358. arc?: number;
  124359. updatable?: boolean;
  124360. sideOrientation?: number;
  124361. frontUVs?: Vector4;
  124362. backUVs?: Vector4;
  124363. instance?: Mesh;
  124364. invertUV?: boolean;
  124365. }, scene?: Nullable<Scene>): Mesh;
  124366. }
  124367. }
  124368. declare module BABYLON {
  124369. /**
  124370. * Class containing static functions to help procedurally build meshes
  124371. */
  124372. export class IcoSphereBuilder {
  124373. /**
  124374. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  124375. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  124376. * * 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`)
  124377. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  124378. * * 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
  124379. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124380. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124381. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124382. * @param name defines the name of the mesh
  124383. * @param options defines the options used to create the mesh
  124384. * @param scene defines the hosting scene
  124385. * @returns the icosahedron mesh
  124386. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  124387. */
  124388. static CreateIcoSphere(name: string, options: {
  124389. radius?: number;
  124390. radiusX?: number;
  124391. radiusY?: number;
  124392. radiusZ?: number;
  124393. flat?: boolean;
  124394. subdivisions?: number;
  124395. sideOrientation?: number;
  124396. frontUVs?: Vector4;
  124397. backUVs?: Vector4;
  124398. updatable?: boolean;
  124399. }, scene?: Nullable<Scene>): Mesh;
  124400. }
  124401. }
  124402. declare module BABYLON {
  124403. /**
  124404. * Class containing static functions to help procedurally build meshes
  124405. */
  124406. export class DecalBuilder {
  124407. /**
  124408. * Creates a decal mesh.
  124409. * 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
  124410. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  124411. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  124412. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  124413. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  124414. * @param name defines the name of the mesh
  124415. * @param sourceMesh defines the mesh where the decal must be applied
  124416. * @param options defines the options used to create the mesh
  124417. * @param scene defines the hosting scene
  124418. * @returns the decal mesh
  124419. * @see https://doc.babylonjs.com/how_to/decals
  124420. */
  124421. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  124422. position?: Vector3;
  124423. normal?: Vector3;
  124424. size?: Vector3;
  124425. angle?: number;
  124426. }): Mesh;
  124427. }
  124428. }
  124429. declare module BABYLON {
  124430. /**
  124431. * Class containing static functions to help procedurally build meshes
  124432. */
  124433. export class MeshBuilder {
  124434. /**
  124435. * Creates a box mesh
  124436. * * The parameter `size` sets the size (float) of each box side (default 1)
  124437. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  124438. * * 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)
  124439. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  124440. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124441. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124442. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124443. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  124444. * @param name defines the name of the mesh
  124445. * @param options defines the options used to create the mesh
  124446. * @param scene defines the hosting scene
  124447. * @returns the box mesh
  124448. */
  124449. static CreateBox(name: string, options: {
  124450. size?: number;
  124451. width?: number;
  124452. height?: number;
  124453. depth?: number;
  124454. faceUV?: Vector4[];
  124455. faceColors?: Color4[];
  124456. sideOrientation?: number;
  124457. frontUVs?: Vector4;
  124458. backUVs?: Vector4;
  124459. updatable?: boolean;
  124460. }, scene?: Nullable<Scene>): Mesh;
  124461. /**
  124462. * Creates a tiled box mesh
  124463. * * faceTiles sets the pattern, tile size and number of tiles for a face
  124464. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124465. * @param name defines the name of the mesh
  124466. * @param options defines the options used to create the mesh
  124467. * @param scene defines the hosting scene
  124468. * @returns the tiled box mesh
  124469. */
  124470. static CreateTiledBox(name: string, options: {
  124471. pattern?: number;
  124472. size?: number;
  124473. width?: number;
  124474. height?: number;
  124475. depth: number;
  124476. tileSize?: number;
  124477. tileWidth?: number;
  124478. tileHeight?: number;
  124479. faceUV?: Vector4[];
  124480. faceColors?: Color4[];
  124481. alignHorizontal?: number;
  124482. alignVertical?: number;
  124483. sideOrientation?: number;
  124484. updatable?: boolean;
  124485. }, scene?: Nullable<Scene>): Mesh;
  124486. /**
  124487. * Creates a sphere mesh
  124488. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  124489. * * 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`)
  124490. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  124491. * * 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
  124492. * * 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)
  124493. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124494. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124495. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124496. * @param name defines the name of the mesh
  124497. * @param options defines the options used to create the mesh
  124498. * @param scene defines the hosting scene
  124499. * @returns the sphere mesh
  124500. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  124501. */
  124502. static CreateSphere(name: string, options: {
  124503. segments?: number;
  124504. diameter?: number;
  124505. diameterX?: number;
  124506. diameterY?: number;
  124507. diameterZ?: number;
  124508. arc?: number;
  124509. slice?: number;
  124510. sideOrientation?: number;
  124511. frontUVs?: Vector4;
  124512. backUVs?: Vector4;
  124513. updatable?: boolean;
  124514. }, scene?: Nullable<Scene>): Mesh;
  124515. /**
  124516. * Creates a plane polygonal mesh. By default, this is a disc
  124517. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  124518. * * 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
  124519. * * 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
  124520. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124521. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124522. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124523. * @param name defines the name of the mesh
  124524. * @param options defines the options used to create the mesh
  124525. * @param scene defines the hosting scene
  124526. * @returns the plane polygonal mesh
  124527. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  124528. */
  124529. static CreateDisc(name: string, options: {
  124530. radius?: number;
  124531. tessellation?: number;
  124532. arc?: number;
  124533. updatable?: boolean;
  124534. sideOrientation?: number;
  124535. frontUVs?: Vector4;
  124536. backUVs?: Vector4;
  124537. }, scene?: Nullable<Scene>): Mesh;
  124538. /**
  124539. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  124540. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  124541. * * 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`)
  124542. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  124543. * * 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
  124544. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124545. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124546. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124547. * @param name defines the name of the mesh
  124548. * @param options defines the options used to create the mesh
  124549. * @param scene defines the hosting scene
  124550. * @returns the icosahedron mesh
  124551. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  124552. */
  124553. static CreateIcoSphere(name: string, options: {
  124554. radius?: number;
  124555. radiusX?: number;
  124556. radiusY?: number;
  124557. radiusZ?: number;
  124558. flat?: boolean;
  124559. subdivisions?: number;
  124560. sideOrientation?: number;
  124561. frontUVs?: Vector4;
  124562. backUVs?: Vector4;
  124563. updatable?: boolean;
  124564. }, scene?: Nullable<Scene>): Mesh;
  124565. /**
  124566. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  124567. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  124568. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  124569. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  124570. * * 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
  124571. * * 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
  124572. * * 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
  124573. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124574. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124575. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  124576. * * 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
  124577. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  124578. * * 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
  124579. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  124580. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124581. * @param name defines the name of the mesh
  124582. * @param options defines the options used to create the mesh
  124583. * @param scene defines the hosting scene
  124584. * @returns the ribbon mesh
  124585. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  124586. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  124587. */
  124588. static CreateRibbon(name: string, options: {
  124589. pathArray: Vector3[][];
  124590. closeArray?: boolean;
  124591. closePath?: boolean;
  124592. offset?: number;
  124593. updatable?: boolean;
  124594. sideOrientation?: number;
  124595. frontUVs?: Vector4;
  124596. backUVs?: Vector4;
  124597. instance?: Mesh;
  124598. invertUV?: boolean;
  124599. uvs?: Vector2[];
  124600. colors?: Color4[];
  124601. }, scene?: Nullable<Scene>): Mesh;
  124602. /**
  124603. * Creates a cylinder or a cone mesh
  124604. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  124605. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  124606. * * 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.
  124607. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  124608. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  124609. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  124610. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  124611. * * 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).
  124612. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  124613. * * 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).
  124614. * * 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
  124615. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  124616. * * 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
  124617. * * 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.
  124618. * * If `enclose` is false, a ring surface is one element.
  124619. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  124620. * * 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
  124621. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124622. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124623. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124624. * @param name defines the name of the mesh
  124625. * @param options defines the options used to create the mesh
  124626. * @param scene defines the hosting scene
  124627. * @returns the cylinder mesh
  124628. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  124629. */
  124630. static CreateCylinder(name: string, options: {
  124631. height?: number;
  124632. diameterTop?: number;
  124633. diameterBottom?: number;
  124634. diameter?: number;
  124635. tessellation?: number;
  124636. subdivisions?: number;
  124637. arc?: number;
  124638. faceColors?: Color4[];
  124639. faceUV?: Vector4[];
  124640. updatable?: boolean;
  124641. hasRings?: boolean;
  124642. enclose?: boolean;
  124643. cap?: number;
  124644. sideOrientation?: number;
  124645. frontUVs?: Vector4;
  124646. backUVs?: Vector4;
  124647. }, scene?: Nullable<Scene>): Mesh;
  124648. /**
  124649. * Creates a torus mesh
  124650. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  124651. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  124652. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  124653. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124654. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124655. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124656. * @param name defines the name of the mesh
  124657. * @param options defines the options used to create the mesh
  124658. * @param scene defines the hosting scene
  124659. * @returns the torus mesh
  124660. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  124661. */
  124662. static CreateTorus(name: string, options: {
  124663. diameter?: number;
  124664. thickness?: number;
  124665. tessellation?: number;
  124666. updatable?: boolean;
  124667. sideOrientation?: number;
  124668. frontUVs?: Vector4;
  124669. backUVs?: Vector4;
  124670. }, scene?: Nullable<Scene>): Mesh;
  124671. /**
  124672. * Creates a torus knot mesh
  124673. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  124674. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  124675. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  124676. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  124677. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124678. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124679. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124680. * @param name defines the name of the mesh
  124681. * @param options defines the options used to create the mesh
  124682. * @param scene defines the hosting scene
  124683. * @returns the torus knot mesh
  124684. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  124685. */
  124686. static CreateTorusKnot(name: string, options: {
  124687. radius?: number;
  124688. tube?: number;
  124689. radialSegments?: number;
  124690. tubularSegments?: number;
  124691. p?: number;
  124692. q?: number;
  124693. updatable?: boolean;
  124694. sideOrientation?: number;
  124695. frontUVs?: Vector4;
  124696. backUVs?: Vector4;
  124697. }, scene?: Nullable<Scene>): Mesh;
  124698. /**
  124699. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  124700. * * 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
  124701. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  124702. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  124703. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  124704. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  124705. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  124706. * * 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
  124707. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  124708. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124709. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  124710. * @param name defines the name of the new line system
  124711. * @param options defines the options used to create the line system
  124712. * @param scene defines the hosting scene
  124713. * @returns a new line system mesh
  124714. */
  124715. static CreateLineSystem(name: string, options: {
  124716. lines: Vector3[][];
  124717. updatable?: boolean;
  124718. instance?: Nullable<LinesMesh>;
  124719. colors?: Nullable<Color4[][]>;
  124720. useVertexAlpha?: boolean;
  124721. }, scene: Nullable<Scene>): LinesMesh;
  124722. /**
  124723. * Creates a line mesh
  124724. * 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
  124725. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  124726. * * The parameter `points` is an array successive Vector3
  124727. * * 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
  124728. * * The optional parameter `colors` is an array of successive Color4, one per line point
  124729. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  124730. * * When updating an instance, remember that only point positions can change, not the number of points
  124731. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124732. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  124733. * @param name defines the name of the new line system
  124734. * @param options defines the options used to create the line system
  124735. * @param scene defines the hosting scene
  124736. * @returns a new line mesh
  124737. */
  124738. static CreateLines(name: string, options: {
  124739. points: Vector3[];
  124740. updatable?: boolean;
  124741. instance?: Nullable<LinesMesh>;
  124742. colors?: Color4[];
  124743. useVertexAlpha?: boolean;
  124744. }, scene?: Nullable<Scene>): LinesMesh;
  124745. /**
  124746. * Creates a dashed line mesh
  124747. * * 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
  124748. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  124749. * * The parameter `points` is an array successive Vector3
  124750. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  124751. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  124752. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  124753. * * 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
  124754. * * When updating an instance, remember that only point positions can change, not the number of points
  124755. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124756. * @param name defines the name of the mesh
  124757. * @param options defines the options used to create the mesh
  124758. * @param scene defines the hosting scene
  124759. * @returns the dashed line mesh
  124760. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  124761. */
  124762. static CreateDashedLines(name: string, options: {
  124763. points: Vector3[];
  124764. dashSize?: number;
  124765. gapSize?: number;
  124766. dashNb?: number;
  124767. updatable?: boolean;
  124768. instance?: LinesMesh;
  124769. }, scene?: Nullable<Scene>): LinesMesh;
  124770. /**
  124771. * 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.
  124772. * * 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.
  124773. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  124774. * * 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.
  124775. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  124776. * * 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
  124777. * * 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
  124778. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  124779. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124780. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124781. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  124782. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124783. * @param name defines the name of the mesh
  124784. * @param options defines the options used to create the mesh
  124785. * @param scene defines the hosting scene
  124786. * @returns the extruded shape mesh
  124787. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  124788. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  124789. */
  124790. static ExtrudeShape(name: string, options: {
  124791. shape: Vector3[];
  124792. path: Vector3[];
  124793. scale?: number;
  124794. rotation?: number;
  124795. cap?: number;
  124796. updatable?: boolean;
  124797. sideOrientation?: number;
  124798. frontUVs?: Vector4;
  124799. backUVs?: Vector4;
  124800. instance?: Mesh;
  124801. invertUV?: boolean;
  124802. }, scene?: Nullable<Scene>): Mesh;
  124803. /**
  124804. * Creates an custom extruded shape mesh.
  124805. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  124806. * * 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.
  124807. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  124808. * * 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
  124809. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  124810. * * 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
  124811. * * It must returns a float value that will be the scale value applied to the shape on each path point
  124812. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  124813. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  124814. * * 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
  124815. * * 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
  124816. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  124817. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124818. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124819. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  124820. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124821. * @param name defines the name of the mesh
  124822. * @param options defines the options used to create the mesh
  124823. * @param scene defines the hosting scene
  124824. * @returns the custom extruded shape mesh
  124825. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  124826. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  124827. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  124828. */
  124829. static ExtrudeShapeCustom(name: string, options: {
  124830. shape: Vector3[];
  124831. path: Vector3[];
  124832. scaleFunction?: any;
  124833. rotationFunction?: any;
  124834. ribbonCloseArray?: boolean;
  124835. ribbonClosePath?: boolean;
  124836. cap?: number;
  124837. updatable?: boolean;
  124838. sideOrientation?: number;
  124839. frontUVs?: Vector4;
  124840. backUVs?: Vector4;
  124841. instance?: Mesh;
  124842. invertUV?: boolean;
  124843. }, scene?: Nullable<Scene>): Mesh;
  124844. /**
  124845. * Creates lathe mesh.
  124846. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  124847. * * 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
  124848. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  124849. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  124850. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  124851. * * 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
  124852. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  124853. * * 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
  124854. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124855. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124856. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  124857. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124858. * @param name defines the name of the mesh
  124859. * @param options defines the options used to create the mesh
  124860. * @param scene defines the hosting scene
  124861. * @returns the lathe mesh
  124862. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  124863. */
  124864. static CreateLathe(name: string, options: {
  124865. shape: Vector3[];
  124866. radius?: number;
  124867. tessellation?: number;
  124868. clip?: number;
  124869. arc?: number;
  124870. closed?: boolean;
  124871. updatable?: boolean;
  124872. sideOrientation?: number;
  124873. frontUVs?: Vector4;
  124874. backUVs?: Vector4;
  124875. cap?: number;
  124876. invertUV?: boolean;
  124877. }, scene?: Nullable<Scene>): Mesh;
  124878. /**
  124879. * Creates a tiled plane mesh
  124880. * * You can set a limited pattern arrangement with the tiles
  124881. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124882. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124883. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124884. * @param name defines the name of the mesh
  124885. * @param options defines the options used to create the mesh
  124886. * @param scene defines the hosting scene
  124887. * @returns the plane mesh
  124888. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  124889. */
  124890. static CreateTiledPlane(name: string, options: {
  124891. pattern?: number;
  124892. tileSize?: number;
  124893. tileWidth?: number;
  124894. tileHeight?: number;
  124895. size?: number;
  124896. width?: number;
  124897. height?: number;
  124898. alignHorizontal?: number;
  124899. alignVertical?: number;
  124900. sideOrientation?: number;
  124901. frontUVs?: Vector4;
  124902. backUVs?: Vector4;
  124903. updatable?: boolean;
  124904. }, scene?: Nullable<Scene>): Mesh;
  124905. /**
  124906. * Creates a plane mesh
  124907. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  124908. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  124909. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  124910. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124911. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124912. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124913. * @param name defines the name of the mesh
  124914. * @param options defines the options used to create the mesh
  124915. * @param scene defines the hosting scene
  124916. * @returns the plane mesh
  124917. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  124918. */
  124919. static CreatePlane(name: string, options: {
  124920. size?: number;
  124921. width?: number;
  124922. height?: number;
  124923. sideOrientation?: number;
  124924. frontUVs?: Vector4;
  124925. backUVs?: Vector4;
  124926. updatable?: boolean;
  124927. sourcePlane?: Plane;
  124928. }, scene?: Nullable<Scene>): Mesh;
  124929. /**
  124930. * Creates a ground mesh
  124931. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  124932. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  124933. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124934. * @param name defines the name of the mesh
  124935. * @param options defines the options used to create the mesh
  124936. * @param scene defines the hosting scene
  124937. * @returns the ground mesh
  124938. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  124939. */
  124940. static CreateGround(name: string, options: {
  124941. width?: number;
  124942. height?: number;
  124943. subdivisions?: number;
  124944. subdivisionsX?: number;
  124945. subdivisionsY?: number;
  124946. updatable?: boolean;
  124947. }, scene?: Nullable<Scene>): Mesh;
  124948. /**
  124949. * Creates a tiled ground mesh
  124950. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  124951. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  124952. * * 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
  124953. * * 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
  124954. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124955. * @param name defines the name of the mesh
  124956. * @param options defines the options used to create the mesh
  124957. * @param scene defines the hosting scene
  124958. * @returns the tiled ground mesh
  124959. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  124960. */
  124961. static CreateTiledGround(name: string, options: {
  124962. xmin: number;
  124963. zmin: number;
  124964. xmax: number;
  124965. zmax: number;
  124966. subdivisions?: {
  124967. w: number;
  124968. h: number;
  124969. };
  124970. precision?: {
  124971. w: number;
  124972. h: number;
  124973. };
  124974. updatable?: boolean;
  124975. }, scene?: Nullable<Scene>): Mesh;
  124976. /**
  124977. * Creates a ground mesh from a height map
  124978. * * The parameter `url` sets the URL of the height map image resource.
  124979. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  124980. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  124981. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  124982. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  124983. * * 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.
  124984. * * 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).
  124985. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  124986. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124987. * @param name defines the name of the mesh
  124988. * @param url defines the url to the height map
  124989. * @param options defines the options used to create the mesh
  124990. * @param scene defines the hosting scene
  124991. * @returns the ground mesh
  124992. * @see https://doc.babylonjs.com/babylon101/height_map
  124993. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  124994. */
  124995. static CreateGroundFromHeightMap(name: string, url: string, options: {
  124996. width?: number;
  124997. height?: number;
  124998. subdivisions?: number;
  124999. minHeight?: number;
  125000. maxHeight?: number;
  125001. colorFilter?: Color3;
  125002. alphaFilter?: number;
  125003. updatable?: boolean;
  125004. onReady?: (mesh: GroundMesh) => void;
  125005. }, scene?: Nullable<Scene>): GroundMesh;
  125006. /**
  125007. * Creates a polygon mesh
  125008. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  125009. * * 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
  125010. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  125011. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125012. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  125013. * * Remember you can only change the shape positions, not their number when updating a polygon
  125014. * @param name defines the name of the mesh
  125015. * @param options defines the options used to create the mesh
  125016. * @param scene defines the hosting scene
  125017. * @param earcutInjection can be used to inject your own earcut reference
  125018. * @returns the polygon mesh
  125019. */
  125020. static CreatePolygon(name: string, options: {
  125021. shape: Vector3[];
  125022. holes?: Vector3[][];
  125023. depth?: number;
  125024. faceUV?: Vector4[];
  125025. faceColors?: Color4[];
  125026. updatable?: boolean;
  125027. sideOrientation?: number;
  125028. frontUVs?: Vector4;
  125029. backUVs?: Vector4;
  125030. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  125031. /**
  125032. * Creates an extruded polygon mesh, with depth in the Y direction.
  125033. * * 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)
  125034. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  125035. * @param name defines the name of the mesh
  125036. * @param options defines the options used to create the mesh
  125037. * @param scene defines the hosting scene
  125038. * @param earcutInjection can be used to inject your own earcut reference
  125039. * @returns the polygon mesh
  125040. */
  125041. static ExtrudePolygon(name: string, options: {
  125042. shape: Vector3[];
  125043. holes?: Vector3[][];
  125044. depth?: number;
  125045. faceUV?: Vector4[];
  125046. faceColors?: Color4[];
  125047. updatable?: boolean;
  125048. sideOrientation?: number;
  125049. frontUVs?: Vector4;
  125050. backUVs?: Vector4;
  125051. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  125052. /**
  125053. * Creates a tube mesh.
  125054. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  125055. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  125056. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  125057. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  125058. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  125059. * * 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)
  125060. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  125061. * * 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
  125062. * * 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
  125063. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125064. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125065. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  125066. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125067. * @param name defines the name of the mesh
  125068. * @param options defines the options used to create the mesh
  125069. * @param scene defines the hosting scene
  125070. * @returns the tube mesh
  125071. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  125072. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  125073. */
  125074. static CreateTube(name: string, options: {
  125075. path: Vector3[];
  125076. radius?: number;
  125077. tessellation?: number;
  125078. radiusFunction?: {
  125079. (i: number, distance: number): number;
  125080. };
  125081. cap?: number;
  125082. arc?: number;
  125083. updatable?: boolean;
  125084. sideOrientation?: number;
  125085. frontUVs?: Vector4;
  125086. backUVs?: Vector4;
  125087. instance?: Mesh;
  125088. invertUV?: boolean;
  125089. }, scene?: Nullable<Scene>): Mesh;
  125090. /**
  125091. * Creates a polyhedron mesh
  125092. * * 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
  125093. * * The parameter `size` (positive float, default 1) sets the polygon size
  125094. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  125095. * * 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`
  125096. * * 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
  125097. * * 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)`)
  125098. * * 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
  125099. * * 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
  125100. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125101. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125102. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125103. * @param name defines the name of the mesh
  125104. * @param options defines the options used to create the mesh
  125105. * @param scene defines the hosting scene
  125106. * @returns the polyhedron mesh
  125107. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  125108. */
  125109. static CreatePolyhedron(name: string, options: {
  125110. type?: number;
  125111. size?: number;
  125112. sizeX?: number;
  125113. sizeY?: number;
  125114. sizeZ?: number;
  125115. custom?: any;
  125116. faceUV?: Vector4[];
  125117. faceColors?: Color4[];
  125118. flat?: boolean;
  125119. updatable?: boolean;
  125120. sideOrientation?: number;
  125121. frontUVs?: Vector4;
  125122. backUVs?: Vector4;
  125123. }, scene?: Nullable<Scene>): Mesh;
  125124. /**
  125125. * Creates a decal mesh.
  125126. * 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
  125127. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  125128. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  125129. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  125130. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  125131. * @param name defines the name of the mesh
  125132. * @param sourceMesh defines the mesh where the decal must be applied
  125133. * @param options defines the options used to create the mesh
  125134. * @param scene defines the hosting scene
  125135. * @returns the decal mesh
  125136. * @see https://doc.babylonjs.com/how_to/decals
  125137. */
  125138. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  125139. position?: Vector3;
  125140. normal?: Vector3;
  125141. size?: Vector3;
  125142. angle?: number;
  125143. }): Mesh;
  125144. }
  125145. }
  125146. declare module BABYLON {
  125147. /**
  125148. * A simplifier interface for future simplification implementations
  125149. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125150. */
  125151. export interface ISimplifier {
  125152. /**
  125153. * Simplification of a given mesh according to the given settings.
  125154. * Since this requires computation, it is assumed that the function runs async.
  125155. * @param settings The settings of the simplification, including quality and distance
  125156. * @param successCallback A callback that will be called after the mesh was simplified.
  125157. * @param errorCallback in case of an error, this callback will be called. optional.
  125158. */
  125159. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  125160. }
  125161. /**
  125162. * Expected simplification settings.
  125163. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  125164. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125165. */
  125166. export interface ISimplificationSettings {
  125167. /**
  125168. * Gets or sets the expected quality
  125169. */
  125170. quality: number;
  125171. /**
  125172. * Gets or sets the distance when this optimized version should be used
  125173. */
  125174. distance: number;
  125175. /**
  125176. * Gets an already optimized mesh
  125177. */
  125178. optimizeMesh?: boolean;
  125179. }
  125180. /**
  125181. * Class used to specify simplification options
  125182. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125183. */
  125184. export class SimplificationSettings implements ISimplificationSettings {
  125185. /** expected quality */
  125186. quality: number;
  125187. /** distance when this optimized version should be used */
  125188. distance: number;
  125189. /** already optimized mesh */
  125190. optimizeMesh?: boolean | undefined;
  125191. /**
  125192. * Creates a SimplificationSettings
  125193. * @param quality expected quality
  125194. * @param distance distance when this optimized version should be used
  125195. * @param optimizeMesh already optimized mesh
  125196. */
  125197. constructor(
  125198. /** expected quality */
  125199. quality: number,
  125200. /** distance when this optimized version should be used */
  125201. distance: number,
  125202. /** already optimized mesh */
  125203. optimizeMesh?: boolean | undefined);
  125204. }
  125205. /**
  125206. * Interface used to define a simplification task
  125207. */
  125208. export interface ISimplificationTask {
  125209. /**
  125210. * Array of settings
  125211. */
  125212. settings: Array<ISimplificationSettings>;
  125213. /**
  125214. * Simplification type
  125215. */
  125216. simplificationType: SimplificationType;
  125217. /**
  125218. * Mesh to simplify
  125219. */
  125220. mesh: Mesh;
  125221. /**
  125222. * Callback called on success
  125223. */
  125224. successCallback?: () => void;
  125225. /**
  125226. * Defines if parallel processing can be used
  125227. */
  125228. parallelProcessing: boolean;
  125229. }
  125230. /**
  125231. * Queue used to order the simplification tasks
  125232. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125233. */
  125234. export class SimplificationQueue {
  125235. private _simplificationArray;
  125236. /**
  125237. * Gets a boolean indicating that the process is still running
  125238. */
  125239. running: boolean;
  125240. /**
  125241. * Creates a new queue
  125242. */
  125243. constructor();
  125244. /**
  125245. * Adds a new simplification task
  125246. * @param task defines a task to add
  125247. */
  125248. addTask(task: ISimplificationTask): void;
  125249. /**
  125250. * Execute next task
  125251. */
  125252. executeNext(): void;
  125253. /**
  125254. * Execute a simplification task
  125255. * @param task defines the task to run
  125256. */
  125257. runSimplification(task: ISimplificationTask): void;
  125258. private getSimplifier;
  125259. }
  125260. /**
  125261. * The implemented types of simplification
  125262. * At the moment only Quadratic Error Decimation is implemented
  125263. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125264. */
  125265. export enum SimplificationType {
  125266. /** Quadratic error decimation */
  125267. QUADRATIC = 0
  125268. }
  125269. }
  125270. declare module BABYLON {
  125271. interface Scene {
  125272. /** @hidden (Backing field) */
  125273. _simplificationQueue: SimplificationQueue;
  125274. /**
  125275. * Gets or sets the simplification queue attached to the scene
  125276. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125277. */
  125278. simplificationQueue: SimplificationQueue;
  125279. }
  125280. interface Mesh {
  125281. /**
  125282. * Simplify the mesh according to the given array of settings.
  125283. * Function will return immediately and will simplify async
  125284. * @param settings a collection of simplification settings
  125285. * @param parallelProcessing should all levels calculate parallel or one after the other
  125286. * @param simplificationType the type of simplification to run
  125287. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  125288. * @returns the current mesh
  125289. */
  125290. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  125291. }
  125292. /**
  125293. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  125294. * created in a scene
  125295. */
  125296. export class SimplicationQueueSceneComponent implements ISceneComponent {
  125297. /**
  125298. * The component name helpfull to identify the component in the list of scene components.
  125299. */
  125300. readonly name: string;
  125301. /**
  125302. * The scene the component belongs to.
  125303. */
  125304. scene: Scene;
  125305. /**
  125306. * Creates a new instance of the component for the given scene
  125307. * @param scene Defines the scene to register the component in
  125308. */
  125309. constructor(scene: Scene);
  125310. /**
  125311. * Registers the component in a given scene
  125312. */
  125313. register(): void;
  125314. /**
  125315. * Rebuilds the elements related to this component in case of
  125316. * context lost for instance.
  125317. */
  125318. rebuild(): void;
  125319. /**
  125320. * Disposes the component and the associated ressources
  125321. */
  125322. dispose(): void;
  125323. private _beforeCameraUpdate;
  125324. }
  125325. }
  125326. declare module BABYLON {
  125327. /**
  125328. * Navigation plugin interface to add navigation constrained by a navigation mesh
  125329. */
  125330. export interface INavigationEnginePlugin {
  125331. /**
  125332. * plugin name
  125333. */
  125334. name: string;
  125335. /**
  125336. * Creates a navigation mesh
  125337. * @param meshes array of all the geometry used to compute the navigatio mesh
  125338. * @param parameters bunch of parameters used to filter geometry
  125339. */
  125340. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  125341. /**
  125342. * Create a navigation mesh debug mesh
  125343. * @param scene is where the mesh will be added
  125344. * @returns debug display mesh
  125345. */
  125346. createDebugNavMesh(scene: Scene): Mesh;
  125347. /**
  125348. * Get a navigation mesh constrained position, closest to the parameter position
  125349. * @param position world position
  125350. * @returns the closest point to position constrained by the navigation mesh
  125351. */
  125352. getClosestPoint(position: Vector3): Vector3;
  125353. /**
  125354. * Get a navigation mesh constrained position, within a particular radius
  125355. * @param position world position
  125356. * @param maxRadius the maximum distance to the constrained world position
  125357. * @returns the closest point to position constrained by the navigation mesh
  125358. */
  125359. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  125360. /**
  125361. * Compute the final position from a segment made of destination-position
  125362. * @param position world position
  125363. * @param destination world position
  125364. * @returns the resulting point along the navmesh
  125365. */
  125366. moveAlong(position: Vector3, destination: Vector3): Vector3;
  125367. /**
  125368. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  125369. * @param start world position
  125370. * @param end world position
  125371. * @returns array containing world position composing the path
  125372. */
  125373. computePath(start: Vector3, end: Vector3): Vector3[];
  125374. /**
  125375. * If this plugin is supported
  125376. * @returns true if plugin is supported
  125377. */
  125378. isSupported(): boolean;
  125379. /**
  125380. * Create a new Crowd so you can add agents
  125381. * @param maxAgents the maximum agent count in the crowd
  125382. * @param maxAgentRadius the maximum radius an agent can have
  125383. * @param scene to attach the crowd to
  125384. * @returns the crowd you can add agents to
  125385. */
  125386. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  125387. /**
  125388. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  125389. * The queries will try to find a solution within those bounds
  125390. * default is (1,1,1)
  125391. * @param extent x,y,z value that define the extent around the queries point of reference
  125392. */
  125393. setDefaultQueryExtent(extent: Vector3): void;
  125394. /**
  125395. * Get the Bounding box extent specified by setDefaultQueryExtent
  125396. * @returns the box extent values
  125397. */
  125398. getDefaultQueryExtent(): Vector3;
  125399. /**
  125400. * Release all resources
  125401. */
  125402. dispose(): void;
  125403. }
  125404. /**
  125405. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  125406. */
  125407. export interface ICrowd {
  125408. /**
  125409. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  125410. * You can attach anything to that node. The node position is updated in the scene update tick.
  125411. * @param pos world position that will be constrained by the navigation mesh
  125412. * @param parameters agent parameters
  125413. * @param transform hooked to the agent that will be update by the scene
  125414. * @returns agent index
  125415. */
  125416. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  125417. /**
  125418. * Returns the agent position in world space
  125419. * @param index agent index returned by addAgent
  125420. * @returns world space position
  125421. */
  125422. getAgentPosition(index: number): Vector3;
  125423. /**
  125424. * Gets the agent velocity in world space
  125425. * @param index agent index returned by addAgent
  125426. * @returns world space velocity
  125427. */
  125428. getAgentVelocity(index: number): Vector3;
  125429. /**
  125430. * remove a particular agent previously created
  125431. * @param index agent index returned by addAgent
  125432. */
  125433. removeAgent(index: number): void;
  125434. /**
  125435. * get the list of all agents attached to this crowd
  125436. * @returns list of agent indices
  125437. */
  125438. getAgents(): number[];
  125439. /**
  125440. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  125441. * @param deltaTime in seconds
  125442. */
  125443. update(deltaTime: number): void;
  125444. /**
  125445. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  125446. * @param index agent index returned by addAgent
  125447. * @param destination targeted world position
  125448. */
  125449. agentGoto(index: number, destination: Vector3): void;
  125450. /**
  125451. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  125452. * The queries will try to find a solution within those bounds
  125453. * default is (1,1,1)
  125454. * @param extent x,y,z value that define the extent around the queries point of reference
  125455. */
  125456. setDefaultQueryExtent(extent: Vector3): void;
  125457. /**
  125458. * Get the Bounding box extent specified by setDefaultQueryExtent
  125459. * @returns the box extent values
  125460. */
  125461. getDefaultQueryExtent(): Vector3;
  125462. /**
  125463. * Release all resources
  125464. */
  125465. dispose(): void;
  125466. }
  125467. /**
  125468. * Configures an agent
  125469. */
  125470. export interface IAgentParameters {
  125471. /**
  125472. * Agent radius. [Limit: >= 0]
  125473. */
  125474. radius: number;
  125475. /**
  125476. * Agent height. [Limit: > 0]
  125477. */
  125478. height: number;
  125479. /**
  125480. * Maximum allowed acceleration. [Limit: >= 0]
  125481. */
  125482. maxAcceleration: number;
  125483. /**
  125484. * Maximum allowed speed. [Limit: >= 0]
  125485. */
  125486. maxSpeed: number;
  125487. /**
  125488. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  125489. */
  125490. collisionQueryRange: number;
  125491. /**
  125492. * The path visibility optimization range. [Limit: > 0]
  125493. */
  125494. pathOptimizationRange: number;
  125495. /**
  125496. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  125497. */
  125498. separationWeight: number;
  125499. }
  125500. /**
  125501. * Configures the navigation mesh creation
  125502. */
  125503. export interface INavMeshParameters {
  125504. /**
  125505. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  125506. */
  125507. cs: number;
  125508. /**
  125509. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  125510. */
  125511. ch: number;
  125512. /**
  125513. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  125514. */
  125515. walkableSlopeAngle: number;
  125516. /**
  125517. * Minimum floor to 'ceiling' height that will still allow the floor area to
  125518. * be considered walkable. [Limit: >= 3] [Units: vx]
  125519. */
  125520. walkableHeight: number;
  125521. /**
  125522. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  125523. */
  125524. walkableClimb: number;
  125525. /**
  125526. * The distance to erode/shrink the walkable area of the heightfield away from
  125527. * obstructions. [Limit: >=0] [Units: vx]
  125528. */
  125529. walkableRadius: number;
  125530. /**
  125531. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  125532. */
  125533. maxEdgeLen: number;
  125534. /**
  125535. * The maximum distance a simplfied contour's border edges should deviate
  125536. * the original raw contour. [Limit: >=0] [Units: vx]
  125537. */
  125538. maxSimplificationError: number;
  125539. /**
  125540. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  125541. */
  125542. minRegionArea: number;
  125543. /**
  125544. * Any regions with a span count smaller than this value will, if possible,
  125545. * be merged with larger regions. [Limit: >=0] [Units: vx]
  125546. */
  125547. mergeRegionArea: number;
  125548. /**
  125549. * The maximum number of vertices allowed for polygons generated during the
  125550. * contour to polygon conversion process. [Limit: >= 3]
  125551. */
  125552. maxVertsPerPoly: number;
  125553. /**
  125554. * Sets the sampling distance to use when generating the detail mesh.
  125555. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  125556. */
  125557. detailSampleDist: number;
  125558. /**
  125559. * The maximum distance the detail mesh surface should deviate from heightfield
  125560. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  125561. */
  125562. detailSampleMaxError: number;
  125563. }
  125564. }
  125565. declare module BABYLON {
  125566. /**
  125567. * RecastJS navigation plugin
  125568. */
  125569. export class RecastJSPlugin implements INavigationEnginePlugin {
  125570. /**
  125571. * Reference to the Recast library
  125572. */
  125573. bjsRECAST: any;
  125574. /**
  125575. * plugin name
  125576. */
  125577. name: string;
  125578. /**
  125579. * the first navmesh created. We might extend this to support multiple navmeshes
  125580. */
  125581. navMesh: any;
  125582. /**
  125583. * Initializes the recastJS plugin
  125584. * @param recastInjection can be used to inject your own recast reference
  125585. */
  125586. constructor(recastInjection?: any);
  125587. /**
  125588. * Creates a navigation mesh
  125589. * @param meshes array of all the geometry used to compute the navigatio mesh
  125590. * @param parameters bunch of parameters used to filter geometry
  125591. */
  125592. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  125593. /**
  125594. * Create a navigation mesh debug mesh
  125595. * @param scene is where the mesh will be added
  125596. * @returns debug display mesh
  125597. */
  125598. createDebugNavMesh(scene: Scene): Mesh;
  125599. /**
  125600. * Get a navigation mesh constrained position, closest to the parameter position
  125601. * @param position world position
  125602. * @returns the closest point to position constrained by the navigation mesh
  125603. */
  125604. getClosestPoint(position: Vector3): Vector3;
  125605. /**
  125606. * Get a navigation mesh constrained position, within a particular radius
  125607. * @param position world position
  125608. * @param maxRadius the maximum distance to the constrained world position
  125609. * @returns the closest point to position constrained by the navigation mesh
  125610. */
  125611. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  125612. /**
  125613. * Compute the final position from a segment made of destination-position
  125614. * @param position world position
  125615. * @param destination world position
  125616. * @returns the resulting point along the navmesh
  125617. */
  125618. moveAlong(position: Vector3, destination: Vector3): Vector3;
  125619. /**
  125620. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  125621. * @param start world position
  125622. * @param end world position
  125623. * @returns array containing world position composing the path
  125624. */
  125625. computePath(start: Vector3, end: Vector3): Vector3[];
  125626. /**
  125627. * Create a new Crowd so you can add agents
  125628. * @param maxAgents the maximum agent count in the crowd
  125629. * @param maxAgentRadius the maximum radius an agent can have
  125630. * @param scene to attach the crowd to
  125631. * @returns the crowd you can add agents to
  125632. */
  125633. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  125634. /**
  125635. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  125636. * The queries will try to find a solution within those bounds
  125637. * default is (1,1,1)
  125638. * @param extent x,y,z value that define the extent around the queries point of reference
  125639. */
  125640. setDefaultQueryExtent(extent: Vector3): void;
  125641. /**
  125642. * Get the Bounding box extent specified by setDefaultQueryExtent
  125643. * @returns the box extent values
  125644. */
  125645. getDefaultQueryExtent(): Vector3;
  125646. /**
  125647. * Disposes
  125648. */
  125649. dispose(): void;
  125650. /**
  125651. * If this plugin is supported
  125652. * @returns true if plugin is supported
  125653. */
  125654. isSupported(): boolean;
  125655. }
  125656. /**
  125657. * Recast detour crowd implementation
  125658. */
  125659. export class RecastJSCrowd implements ICrowd {
  125660. /**
  125661. * Recast/detour plugin
  125662. */
  125663. bjsRECASTPlugin: RecastJSPlugin;
  125664. /**
  125665. * Link to the detour crowd
  125666. */
  125667. recastCrowd: any;
  125668. /**
  125669. * One transform per agent
  125670. */
  125671. transforms: TransformNode[];
  125672. /**
  125673. * All agents created
  125674. */
  125675. agents: number[];
  125676. /**
  125677. * Link to the scene is kept to unregister the crowd from the scene
  125678. */
  125679. private _scene;
  125680. /**
  125681. * Observer for crowd updates
  125682. */
  125683. private _onBeforeAnimationsObserver;
  125684. /**
  125685. * Constructor
  125686. * @param plugin recastJS plugin
  125687. * @param maxAgents the maximum agent count in the crowd
  125688. * @param maxAgentRadius the maximum radius an agent can have
  125689. * @param scene to attach the crowd to
  125690. * @returns the crowd you can add agents to
  125691. */
  125692. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  125693. /**
  125694. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  125695. * You can attach anything to that node. The node position is updated in the scene update tick.
  125696. * @param pos world position that will be constrained by the navigation mesh
  125697. * @param parameters agent parameters
  125698. * @param transform hooked to the agent that will be update by the scene
  125699. * @returns agent index
  125700. */
  125701. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  125702. /**
  125703. * Returns the agent position in world space
  125704. * @param index agent index returned by addAgent
  125705. * @returns world space position
  125706. */
  125707. getAgentPosition(index: number): Vector3;
  125708. /**
  125709. * Returns the agent velocity in world space
  125710. * @param index agent index returned by addAgent
  125711. * @returns world space velocity
  125712. */
  125713. getAgentVelocity(index: number): Vector3;
  125714. /**
  125715. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  125716. * @param index agent index returned by addAgent
  125717. * @param destination targeted world position
  125718. */
  125719. agentGoto(index: number, destination: Vector3): void;
  125720. /**
  125721. * remove a particular agent previously created
  125722. * @param index agent index returned by addAgent
  125723. */
  125724. removeAgent(index: number): void;
  125725. /**
  125726. * get the list of all agents attached to this crowd
  125727. * @returns list of agent indices
  125728. */
  125729. getAgents(): number[];
  125730. /**
  125731. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  125732. * @param deltaTime in seconds
  125733. */
  125734. update(deltaTime: number): void;
  125735. /**
  125736. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  125737. * The queries will try to find a solution within those bounds
  125738. * default is (1,1,1)
  125739. * @param extent x,y,z value that define the extent around the queries point of reference
  125740. */
  125741. setDefaultQueryExtent(extent: Vector3): void;
  125742. /**
  125743. * Get the Bounding box extent specified by setDefaultQueryExtent
  125744. * @returns the box extent values
  125745. */
  125746. getDefaultQueryExtent(): Vector3;
  125747. /**
  125748. * Release all resources
  125749. */
  125750. dispose(): void;
  125751. }
  125752. }
  125753. declare module BABYLON {
  125754. /**
  125755. * Class used to enable access to IndexedDB
  125756. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  125757. */
  125758. export class Database implements IOfflineProvider {
  125759. private _callbackManifestChecked;
  125760. private _currentSceneUrl;
  125761. private _db;
  125762. private _enableSceneOffline;
  125763. private _enableTexturesOffline;
  125764. private _manifestVersionFound;
  125765. private _mustUpdateRessources;
  125766. private _hasReachedQuota;
  125767. private _isSupported;
  125768. private _idbFactory;
  125769. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  125770. private static IsUASupportingBlobStorage;
  125771. /**
  125772. * Gets a boolean indicating if Database storate is enabled (off by default)
  125773. */
  125774. static IDBStorageEnabled: boolean;
  125775. /**
  125776. * Gets a boolean indicating if scene must be saved in the database
  125777. */
  125778. readonly enableSceneOffline: boolean;
  125779. /**
  125780. * Gets a boolean indicating if textures must be saved in the database
  125781. */
  125782. readonly enableTexturesOffline: boolean;
  125783. /**
  125784. * Creates a new Database
  125785. * @param urlToScene defines the url to load the scene
  125786. * @param callbackManifestChecked defines the callback to use when manifest is checked
  125787. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  125788. */
  125789. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  125790. private static _ParseURL;
  125791. private static _ReturnFullUrlLocation;
  125792. private _checkManifestFile;
  125793. /**
  125794. * Open the database and make it available
  125795. * @param successCallback defines the callback to call on success
  125796. * @param errorCallback defines the callback to call on error
  125797. */
  125798. open(successCallback: () => void, errorCallback: () => void): void;
  125799. /**
  125800. * Loads an image from the database
  125801. * @param url defines the url to load from
  125802. * @param image defines the target DOM image
  125803. */
  125804. loadImage(url: string, image: HTMLImageElement): void;
  125805. private _loadImageFromDBAsync;
  125806. private _saveImageIntoDBAsync;
  125807. private _checkVersionFromDB;
  125808. private _loadVersionFromDBAsync;
  125809. private _saveVersionIntoDBAsync;
  125810. /**
  125811. * Loads a file from database
  125812. * @param url defines the URL to load from
  125813. * @param sceneLoaded defines a callback to call on success
  125814. * @param progressCallBack defines a callback to call when progress changed
  125815. * @param errorCallback defines a callback to call on error
  125816. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  125817. */
  125818. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  125819. private _loadFileAsync;
  125820. private _saveFileAsync;
  125821. /**
  125822. * Validates if xhr data is correct
  125823. * @param xhr defines the request to validate
  125824. * @param dataType defines the expected data type
  125825. * @returns true if data is correct
  125826. */
  125827. private static _ValidateXHRData;
  125828. }
  125829. }
  125830. declare module BABYLON {
  125831. /** @hidden */
  125832. export var gpuUpdateParticlesPixelShader: {
  125833. name: string;
  125834. shader: string;
  125835. };
  125836. }
  125837. declare module BABYLON {
  125838. /** @hidden */
  125839. export var gpuUpdateParticlesVertexShader: {
  125840. name: string;
  125841. shader: string;
  125842. };
  125843. }
  125844. declare module BABYLON {
  125845. /** @hidden */
  125846. export var clipPlaneFragmentDeclaration2: {
  125847. name: string;
  125848. shader: string;
  125849. };
  125850. }
  125851. declare module BABYLON {
  125852. /** @hidden */
  125853. export var gpuRenderParticlesPixelShader: {
  125854. name: string;
  125855. shader: string;
  125856. };
  125857. }
  125858. declare module BABYLON {
  125859. /** @hidden */
  125860. export var clipPlaneVertexDeclaration2: {
  125861. name: string;
  125862. shader: string;
  125863. };
  125864. }
  125865. declare module BABYLON {
  125866. /** @hidden */
  125867. export var gpuRenderParticlesVertexShader: {
  125868. name: string;
  125869. shader: string;
  125870. };
  125871. }
  125872. declare module BABYLON {
  125873. /**
  125874. * This represents a GPU particle system in Babylon
  125875. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  125876. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  125877. */
  125878. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  125879. /**
  125880. * The layer mask we are rendering the particles through.
  125881. */
  125882. layerMask: number;
  125883. private _capacity;
  125884. private _activeCount;
  125885. private _currentActiveCount;
  125886. private _accumulatedCount;
  125887. private _renderEffect;
  125888. private _updateEffect;
  125889. private _buffer0;
  125890. private _buffer1;
  125891. private _spriteBuffer;
  125892. private _updateVAO;
  125893. private _renderVAO;
  125894. private _targetIndex;
  125895. private _sourceBuffer;
  125896. private _targetBuffer;
  125897. private _engine;
  125898. private _currentRenderId;
  125899. private _started;
  125900. private _stopped;
  125901. private _timeDelta;
  125902. private _randomTexture;
  125903. private _randomTexture2;
  125904. private _attributesStrideSize;
  125905. private _updateEffectOptions;
  125906. private _randomTextureSize;
  125907. private _actualFrame;
  125908. private readonly _rawTextureWidth;
  125909. /**
  125910. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  125911. */
  125912. static readonly IsSupported: boolean;
  125913. /**
  125914. * An event triggered when the system is disposed.
  125915. */
  125916. onDisposeObservable: Observable<GPUParticleSystem>;
  125917. /**
  125918. * Gets the maximum number of particles active at the same time.
  125919. * @returns The max number of active particles.
  125920. */
  125921. getCapacity(): number;
  125922. /**
  125923. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  125924. * to override the particles.
  125925. */
  125926. forceDepthWrite: boolean;
  125927. /**
  125928. * Gets or set the number of active particles
  125929. */
  125930. activeParticleCount: number;
  125931. private _preWarmDone;
  125932. /**
  125933. * Is this system ready to be used/rendered
  125934. * @return true if the system is ready
  125935. */
  125936. isReady(): boolean;
  125937. /**
  125938. * Gets if the system has been started. (Note: this will still be true after stop is called)
  125939. * @returns True if it has been started, otherwise false.
  125940. */
  125941. isStarted(): boolean;
  125942. /**
  125943. * Starts the particle system and begins to emit
  125944. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  125945. */
  125946. start(delay?: number): void;
  125947. /**
  125948. * Stops the particle system.
  125949. */
  125950. stop(): void;
  125951. /**
  125952. * Remove all active particles
  125953. */
  125954. reset(): void;
  125955. /**
  125956. * Returns the string "GPUParticleSystem"
  125957. * @returns a string containing the class name
  125958. */
  125959. getClassName(): string;
  125960. private _colorGradientsTexture;
  125961. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  125962. /**
  125963. * Adds a new color gradient
  125964. * @param gradient defines the gradient to use (between 0 and 1)
  125965. * @param color1 defines the color to affect to the specified gradient
  125966. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  125967. * @returns the current particle system
  125968. */
  125969. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  125970. /**
  125971. * Remove a specific color gradient
  125972. * @param gradient defines the gradient to remove
  125973. * @returns the current particle system
  125974. */
  125975. removeColorGradient(gradient: number): GPUParticleSystem;
  125976. private _angularSpeedGradientsTexture;
  125977. private _sizeGradientsTexture;
  125978. private _velocityGradientsTexture;
  125979. private _limitVelocityGradientsTexture;
  125980. private _dragGradientsTexture;
  125981. private _addFactorGradient;
  125982. /**
  125983. * Adds a new size gradient
  125984. * @param gradient defines the gradient to use (between 0 and 1)
  125985. * @param factor defines the size factor to affect to the specified gradient
  125986. * @returns the current particle system
  125987. */
  125988. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  125989. /**
  125990. * Remove a specific size gradient
  125991. * @param gradient defines the gradient to remove
  125992. * @returns the current particle system
  125993. */
  125994. removeSizeGradient(gradient: number): GPUParticleSystem;
  125995. /**
  125996. * Adds a new angular speed gradient
  125997. * @param gradient defines the gradient to use (between 0 and 1)
  125998. * @param factor defines the angular speed to affect to the specified gradient
  125999. * @returns the current particle system
  126000. */
  126001. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  126002. /**
  126003. * Remove a specific angular speed gradient
  126004. * @param gradient defines the gradient to remove
  126005. * @returns the current particle system
  126006. */
  126007. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  126008. /**
  126009. * Adds a new velocity gradient
  126010. * @param gradient defines the gradient to use (between 0 and 1)
  126011. * @param factor defines the velocity to affect to the specified gradient
  126012. * @returns the current particle system
  126013. */
  126014. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  126015. /**
  126016. * Remove a specific velocity gradient
  126017. * @param gradient defines the gradient to remove
  126018. * @returns the current particle system
  126019. */
  126020. removeVelocityGradient(gradient: number): GPUParticleSystem;
  126021. /**
  126022. * Adds a new limit velocity gradient
  126023. * @param gradient defines the gradient to use (between 0 and 1)
  126024. * @param factor defines the limit velocity value to affect to the specified gradient
  126025. * @returns the current particle system
  126026. */
  126027. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  126028. /**
  126029. * Remove a specific limit velocity gradient
  126030. * @param gradient defines the gradient to remove
  126031. * @returns the current particle system
  126032. */
  126033. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  126034. /**
  126035. * Adds a new drag gradient
  126036. * @param gradient defines the gradient to use (between 0 and 1)
  126037. * @param factor defines the drag value to affect to the specified gradient
  126038. * @returns the current particle system
  126039. */
  126040. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  126041. /**
  126042. * Remove a specific drag gradient
  126043. * @param gradient defines the gradient to remove
  126044. * @returns the current particle system
  126045. */
  126046. removeDragGradient(gradient: number): GPUParticleSystem;
  126047. /**
  126048. * Not supported by GPUParticleSystem
  126049. * @param gradient defines the gradient to use (between 0 and 1)
  126050. * @param factor defines the emit rate value to affect to the specified gradient
  126051. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  126052. * @returns the current particle system
  126053. */
  126054. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  126055. /**
  126056. * Not supported by GPUParticleSystem
  126057. * @param gradient defines the gradient to remove
  126058. * @returns the current particle system
  126059. */
  126060. removeEmitRateGradient(gradient: number): IParticleSystem;
  126061. /**
  126062. * Not supported by GPUParticleSystem
  126063. * @param gradient defines the gradient to use (between 0 and 1)
  126064. * @param factor defines the start size value to affect to the specified gradient
  126065. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  126066. * @returns the current particle system
  126067. */
  126068. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  126069. /**
  126070. * Not supported by GPUParticleSystem
  126071. * @param gradient defines the gradient to remove
  126072. * @returns the current particle system
  126073. */
  126074. removeStartSizeGradient(gradient: number): IParticleSystem;
  126075. /**
  126076. * Not supported by GPUParticleSystem
  126077. * @param gradient defines the gradient to use (between 0 and 1)
  126078. * @param min defines the color remap minimal range
  126079. * @param max defines the color remap maximal range
  126080. * @returns the current particle system
  126081. */
  126082. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  126083. /**
  126084. * Not supported by GPUParticleSystem
  126085. * @param gradient defines the gradient to remove
  126086. * @returns the current particle system
  126087. */
  126088. removeColorRemapGradient(): IParticleSystem;
  126089. /**
  126090. * Not supported by GPUParticleSystem
  126091. * @param gradient defines the gradient to use (between 0 and 1)
  126092. * @param min defines the alpha remap minimal range
  126093. * @param max defines the alpha remap maximal range
  126094. * @returns the current particle system
  126095. */
  126096. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  126097. /**
  126098. * Not supported by GPUParticleSystem
  126099. * @param gradient defines the gradient to remove
  126100. * @returns the current particle system
  126101. */
  126102. removeAlphaRemapGradient(): IParticleSystem;
  126103. /**
  126104. * Not supported by GPUParticleSystem
  126105. * @param gradient defines the gradient to use (between 0 and 1)
  126106. * @param color defines the color to affect to the specified gradient
  126107. * @returns the current particle system
  126108. */
  126109. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  126110. /**
  126111. * Not supported by GPUParticleSystem
  126112. * @param gradient defines the gradient to remove
  126113. * @returns the current particle system
  126114. */
  126115. removeRampGradient(): IParticleSystem;
  126116. /**
  126117. * Not supported by GPUParticleSystem
  126118. * @returns the list of ramp gradients
  126119. */
  126120. getRampGradients(): Nullable<Array<Color3Gradient>>;
  126121. /**
  126122. * Not supported by GPUParticleSystem
  126123. * Gets or sets a boolean indicating that ramp gradients must be used
  126124. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  126125. */
  126126. useRampGradients: boolean;
  126127. /**
  126128. * Not supported by GPUParticleSystem
  126129. * @param gradient defines the gradient to use (between 0 and 1)
  126130. * @param factor defines the life time factor to affect to the specified gradient
  126131. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  126132. * @returns the current particle system
  126133. */
  126134. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  126135. /**
  126136. * Not supported by GPUParticleSystem
  126137. * @param gradient defines the gradient to remove
  126138. * @returns the current particle system
  126139. */
  126140. removeLifeTimeGradient(gradient: number): IParticleSystem;
  126141. /**
  126142. * Instantiates a GPU particle system.
  126143. * 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.
  126144. * @param name The name of the particle system
  126145. * @param options The options used to create the system
  126146. * @param scene The scene the particle system belongs to
  126147. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  126148. */
  126149. constructor(name: string, options: Partial<{
  126150. capacity: number;
  126151. randomTextureSize: number;
  126152. }>, scene: Scene, isAnimationSheetEnabled?: boolean);
  126153. protected _reset(): void;
  126154. private _createUpdateVAO;
  126155. private _createRenderVAO;
  126156. private _initialize;
  126157. /** @hidden */
  126158. _recreateUpdateEffect(): void;
  126159. /** @hidden */
  126160. _recreateRenderEffect(): void;
  126161. /**
  126162. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  126163. * @param preWarm defines if we are in the pre-warmimg phase
  126164. */
  126165. animate(preWarm?: boolean): void;
  126166. private _createFactorGradientTexture;
  126167. private _createSizeGradientTexture;
  126168. private _createAngularSpeedGradientTexture;
  126169. private _createVelocityGradientTexture;
  126170. private _createLimitVelocityGradientTexture;
  126171. private _createDragGradientTexture;
  126172. private _createColorGradientTexture;
  126173. /**
  126174. * Renders the particle system in its current state
  126175. * @param preWarm defines if the system should only update the particles but not render them
  126176. * @returns the current number of particles
  126177. */
  126178. render(preWarm?: boolean): number;
  126179. /**
  126180. * Rebuilds the particle system
  126181. */
  126182. rebuild(): void;
  126183. private _releaseBuffers;
  126184. private _releaseVAOs;
  126185. /**
  126186. * Disposes the particle system and free the associated resources
  126187. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  126188. */
  126189. dispose(disposeTexture?: boolean): void;
  126190. /**
  126191. * Clones the particle system.
  126192. * @param name The name of the cloned object
  126193. * @param newEmitter The new emitter to use
  126194. * @returns the cloned particle system
  126195. */
  126196. clone(name: string, newEmitter: any): GPUParticleSystem;
  126197. /**
  126198. * Serializes the particle system to a JSON object.
  126199. * @returns the JSON object
  126200. */
  126201. serialize(): any;
  126202. /**
  126203. * Parses a JSON object to create a GPU particle system.
  126204. * @param parsedParticleSystem The JSON object to parse
  126205. * @param scene The scene to create the particle system in
  126206. * @param rootUrl The root url to use to load external dependencies like texture
  126207. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  126208. * @returns the parsed GPU particle system
  126209. */
  126210. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  126211. }
  126212. }
  126213. declare module BABYLON {
  126214. /**
  126215. * Represents a set of particle systems working together to create a specific effect
  126216. */
  126217. export class ParticleSystemSet implements IDisposable {
  126218. /**
  126219. * Gets or sets base Assets URL
  126220. */
  126221. static BaseAssetsUrl: string;
  126222. private _emitterCreationOptions;
  126223. private _emitterNode;
  126224. /**
  126225. * Gets the particle system list
  126226. */
  126227. systems: IParticleSystem[];
  126228. /**
  126229. * Gets the emitter node used with this set
  126230. */
  126231. readonly emitterNode: Nullable<TransformNode>;
  126232. /**
  126233. * Creates a new emitter mesh as a sphere
  126234. * @param options defines the options used to create the sphere
  126235. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  126236. * @param scene defines the hosting scene
  126237. */
  126238. setEmitterAsSphere(options: {
  126239. diameter: number;
  126240. segments: number;
  126241. color: Color3;
  126242. }, renderingGroupId: number, scene: Scene): void;
  126243. /**
  126244. * Starts all particle systems of the set
  126245. * @param emitter defines an optional mesh to use as emitter for the particle systems
  126246. */
  126247. start(emitter?: AbstractMesh): void;
  126248. /**
  126249. * Release all associated resources
  126250. */
  126251. dispose(): void;
  126252. /**
  126253. * Serialize the set into a JSON compatible object
  126254. * @returns a JSON compatible representation of the set
  126255. */
  126256. serialize(): any;
  126257. /**
  126258. * Parse a new ParticleSystemSet from a serialized source
  126259. * @param data defines a JSON compatible representation of the set
  126260. * @param scene defines the hosting scene
  126261. * @param gpu defines if we want GPU particles or CPU particles
  126262. * @returns a new ParticleSystemSet
  126263. */
  126264. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  126265. }
  126266. }
  126267. declare module BABYLON {
  126268. /**
  126269. * This class is made for on one-liner static method to help creating particle system set.
  126270. */
  126271. export class ParticleHelper {
  126272. /**
  126273. * Gets or sets base Assets URL
  126274. */
  126275. static BaseAssetsUrl: string;
  126276. /**
  126277. * Create a default particle system that you can tweak
  126278. * @param emitter defines the emitter to use
  126279. * @param capacity defines the system capacity (default is 500 particles)
  126280. * @param scene defines the hosting scene
  126281. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  126282. * @returns the new Particle system
  126283. */
  126284. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  126285. /**
  126286. * This is the main static method (one-liner) of this helper to create different particle systems
  126287. * @param type This string represents the type to the particle system to create
  126288. * @param scene The scene where the particle system should live
  126289. * @param gpu If the system will use gpu
  126290. * @returns the ParticleSystemSet created
  126291. */
  126292. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  126293. /**
  126294. * Static function used to export a particle system to a ParticleSystemSet variable.
  126295. * Please note that the emitter shape is not exported
  126296. * @param systems defines the particle systems to export
  126297. * @returns the created particle system set
  126298. */
  126299. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  126300. }
  126301. }
  126302. declare module BABYLON {
  126303. interface Engine {
  126304. /**
  126305. * Create an effect to use with particle systems.
  126306. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration
  126307. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  126308. * @param uniformsNames defines a list of attribute names
  126309. * @param samplers defines an array of string used to represent textures
  126310. * @param defines defines the string containing the defines to use to compile the shaders
  126311. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  126312. * @param onCompiled defines a function to call when the effect creation is successful
  126313. * @param onError defines a function to call when the effect creation has failed
  126314. * @returns the new Effect
  126315. */
  126316. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): Effect;
  126317. }
  126318. interface Mesh {
  126319. /**
  126320. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  126321. * @returns an array of IParticleSystem
  126322. */
  126323. getEmittedParticleSystems(): IParticleSystem[];
  126324. /**
  126325. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  126326. * @returns an array of IParticleSystem
  126327. */
  126328. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  126329. }
  126330. /**
  126331. * @hidden
  126332. */
  126333. export var _IDoNeedToBeInTheBuild: number;
  126334. }
  126335. declare module BABYLON {
  126336. /** Defines the 4 color options */
  126337. export enum PointColor {
  126338. /** color value */
  126339. Color = 2,
  126340. /** uv value */
  126341. UV = 1,
  126342. /** random value */
  126343. Random = 0,
  126344. /** stated value */
  126345. Stated = 3
  126346. }
  126347. /**
  126348. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  126349. * 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.
  126350. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  126351. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  126352. *
  126353. * Full documentation here : TO BE ENTERED
  126354. */
  126355. export class PointsCloudSystem implements IDisposable {
  126356. /**
  126357. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  126358. * Example : var p = SPS.particles[i];
  126359. */
  126360. particles: CloudPoint[];
  126361. /**
  126362. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  126363. */
  126364. nbParticles: number;
  126365. /**
  126366. * This a counter for your own usage. It's not set by any SPS functions.
  126367. */
  126368. counter: number;
  126369. /**
  126370. * The PCS name. This name is also given to the underlying mesh.
  126371. */
  126372. name: string;
  126373. /**
  126374. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  126375. */
  126376. mesh: Mesh;
  126377. /**
  126378. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  126379. * Please read :
  126380. */
  126381. vars: any;
  126382. /**
  126383. * @hidden
  126384. */
  126385. _size: number;
  126386. private _scene;
  126387. private _promises;
  126388. private _positions;
  126389. private _indices;
  126390. private _normals;
  126391. private _colors;
  126392. private _uvs;
  126393. private _indices32;
  126394. private _positions32;
  126395. private _colors32;
  126396. private _uvs32;
  126397. private _updatable;
  126398. private _isVisibilityBoxLocked;
  126399. private _alwaysVisible;
  126400. private _groups;
  126401. private _groupCounter;
  126402. private _computeParticleColor;
  126403. private _computeParticleTexture;
  126404. private _computeParticleRotation;
  126405. private _computeBoundingBox;
  126406. private _isReady;
  126407. /**
  126408. * Creates a PCS (Points Cloud System) object
  126409. * @param name (String) is the PCS name, this will be the underlying mesh name
  126410. * @param pointSize (number) is the size for each point
  126411. * @param scene (Scene) is the scene in which the PCS is added
  126412. * @param options defines the options of the PCS e.g.
  126413. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  126414. */
  126415. constructor(name: string, pointSize: number, scene: Scene, options?: {
  126416. updatable?: boolean;
  126417. });
  126418. /**
  126419. * Builds the PCS underlying mesh. Returns a standard Mesh.
  126420. * If no points were added to the PCS, the returned mesh is just a single point.
  126421. * @returns a promise for the created mesh
  126422. */
  126423. buildMeshAsync(): Promise<Mesh>;
  126424. /**
  126425. * @hidden
  126426. */
  126427. private _buildMesh;
  126428. private _addParticle;
  126429. private _randomUnitVector;
  126430. private _getColorIndicesForCoord;
  126431. private _setPointsColorOrUV;
  126432. private _colorFromTexture;
  126433. private _calculateDensity;
  126434. /**
  126435. * Adds points to the PCS in random positions within a unit sphere
  126436. * @param nb (positive integer) the number of particles to be created from this model
  126437. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  126438. * @returns the number of groups in the system
  126439. */
  126440. addPoints(nb: number, pointFunction?: any): number;
  126441. /**
  126442. * Adds points to the PCS from the surface of the model shape
  126443. * @param mesh is any Mesh object that will be used as a surface model for the points
  126444. * @param nb (positive integer) the number of particles to be created from this model
  126445. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  126446. * @param color (color3) to be used when colorWith is stated
  126447. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  126448. * @returns the number of groups in the system
  126449. */
  126450. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4, range?: number): number;
  126451. /**
  126452. * Adds points to the PCS inside the model shape
  126453. * @param mesh is any Mesh object that will be used as a surface model for the points
  126454. * @param nb (positive integer) the number of particles to be created from this model
  126455. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible),
  126456. * @param color (color4) to be used when colorWith is stated
  126457. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  126458. * @returns the number of groups in the system
  126459. */
  126460. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4, range?: number): number;
  126461. /**
  126462. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  126463. * This method calls `updateParticle()` for each particle of the SPS.
  126464. * For an animated SPS, it is usually called within the render loop.
  126465. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  126466. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  126467. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  126468. * @returns the PCS.
  126469. */
  126470. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  126471. /**
  126472. * Disposes the PCS.
  126473. */
  126474. dispose(): void;
  126475. /**
  126476. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  126477. * doc :
  126478. * @returns the PCS.
  126479. */
  126480. refreshVisibleSize(): PointsCloudSystem;
  126481. /**
  126482. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  126483. * @param size the size (float) of the visibility box
  126484. * note : this doesn't lock the PCS mesh bounding box.
  126485. * doc :
  126486. */
  126487. setVisibilityBox(size: number): void;
  126488. /**
  126489. * Gets whether the PCS is always visible or not
  126490. * doc :
  126491. */
  126492. /**
  126493. * Sets the PCS as always visible or not
  126494. * doc :
  126495. */
  126496. isAlwaysVisible: boolean;
  126497. /**
  126498. * Tells to `setParticles()` to compute the particle rotations or not
  126499. * Default value : false. The PCS is faster when it's set to false
  126500. * Note : particle rotations are only applied to parent particles
  126501. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  126502. */
  126503. computeParticleRotation: boolean;
  126504. /**
  126505. * Tells to `setParticles()` to compute the particle colors or not.
  126506. * Default value : true. The PCS is faster when it's set to false.
  126507. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  126508. */
  126509. /**
  126510. * Gets if `setParticles()` computes the particle colors or not.
  126511. * Default value : false. The PCS is faster when it's set to false.
  126512. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  126513. */
  126514. computeParticleColor: boolean;
  126515. /**
  126516. * Gets if `setParticles()` computes the particle textures or not.
  126517. * Default value : false. The PCS is faster when it's set to false.
  126518. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  126519. */
  126520. computeParticleTexture: boolean;
  126521. /**
  126522. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  126523. */
  126524. /**
  126525. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  126526. */
  126527. computeBoundingBox: boolean;
  126528. /**
  126529. * This function does nothing. It may be overwritten to set all the particle first values.
  126530. * The PCS doesn't call this function, you may have to call it by your own.
  126531. * doc :
  126532. */
  126533. initParticles(): void;
  126534. /**
  126535. * This function does nothing. It may be overwritten to recycle a particle
  126536. * The PCS doesn't call this function, you can to call it
  126537. * doc :
  126538. * @param particle The particle to recycle
  126539. * @returns the recycled particle
  126540. */
  126541. recycleParticle(particle: CloudPoint): CloudPoint;
  126542. /**
  126543. * Updates a particle : this function should be overwritten by the user.
  126544. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  126545. * doc :
  126546. * @example : just set a particle position or velocity and recycle conditions
  126547. * @param particle The particle to update
  126548. * @returns the updated particle
  126549. */
  126550. updateParticle(particle: CloudPoint): CloudPoint;
  126551. /**
  126552. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  126553. * This does nothing and may be overwritten by the user.
  126554. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  126555. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  126556. * @param update the boolean update value actually passed to setParticles()
  126557. */
  126558. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  126559. /**
  126560. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  126561. * This will be passed three parameters.
  126562. * This does nothing and may be overwritten by the user.
  126563. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  126564. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  126565. * @param update the boolean update value actually passed to setParticles()
  126566. */
  126567. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  126568. }
  126569. }
  126570. declare module BABYLON {
  126571. /**
  126572. * Represents one particle of a points cloud system.
  126573. */
  126574. export class CloudPoint {
  126575. /**
  126576. * particle global index
  126577. */
  126578. idx: number;
  126579. /**
  126580. * The color of the particle
  126581. */
  126582. color: Nullable<Color4>;
  126583. /**
  126584. * The world space position of the particle.
  126585. */
  126586. position: Vector3;
  126587. /**
  126588. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  126589. */
  126590. rotation: Vector3;
  126591. /**
  126592. * The world space rotation quaternion of the particle.
  126593. */
  126594. rotationQuaternion: Nullable<Quaternion>;
  126595. /**
  126596. * The uv of the particle.
  126597. */
  126598. uv: Nullable<Vector2>;
  126599. /**
  126600. * The current speed of the particle.
  126601. */
  126602. velocity: Vector3;
  126603. /**
  126604. * The pivot point in the particle local space.
  126605. */
  126606. pivot: Vector3;
  126607. /**
  126608. * Must the particle be translated from its pivot point in its local space ?
  126609. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  126610. * Default : false
  126611. */
  126612. translateFromPivot: boolean;
  126613. /**
  126614. * Index of this particle in the global "positions" array (Internal use)
  126615. * @hidden
  126616. */
  126617. _pos: number;
  126618. /**
  126619. * @hidden Index of this particle in the global "indices" array (Internal use)
  126620. */
  126621. _ind: number;
  126622. /**
  126623. * Group this particle belongs to
  126624. */
  126625. _group: PointsGroup;
  126626. /**
  126627. * Group id of this particle
  126628. */
  126629. groupId: number;
  126630. /**
  126631. * Index of the particle in its group id (Internal use)
  126632. */
  126633. idxInGroup: number;
  126634. /**
  126635. * @hidden Particle BoundingInfo object (Internal use)
  126636. */
  126637. _boundingInfo: BoundingInfo;
  126638. /**
  126639. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  126640. */
  126641. _pcs: PointsCloudSystem;
  126642. /**
  126643. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  126644. */
  126645. _stillInvisible: boolean;
  126646. /**
  126647. * @hidden Last computed particle rotation matrix
  126648. */
  126649. _rotationMatrix: number[];
  126650. /**
  126651. * Parent particle Id, if any.
  126652. * Default null.
  126653. */
  126654. parentId: Nullable<number>;
  126655. /**
  126656. * @hidden Internal global position in the PCS.
  126657. */
  126658. _globalPosition: Vector3;
  126659. /**
  126660. * Creates a Point Cloud object.
  126661. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  126662. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  126663. * @param group (PointsGroup) is the group the particle belongs to
  126664. * @param groupId (integer) is the group identifier in the PCS.
  126665. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  126666. * @param pcs defines the PCS it is associated to
  126667. */
  126668. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  126669. /**
  126670. * get point size
  126671. */
  126672. /**
  126673. * Set point size
  126674. */
  126675. size: Vector3;
  126676. /**
  126677. * Legacy support, changed quaternion to rotationQuaternion
  126678. */
  126679. /**
  126680. * Legacy support, changed quaternion to rotationQuaternion
  126681. */
  126682. quaternion: Nullable<Quaternion>;
  126683. /**
  126684. * Returns a boolean. True if the particle intersects a mesh, else false
  126685. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  126686. * @param target is the object (point or mesh) what the intersection is computed against
  126687. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  126688. * @returns true if it intersects
  126689. */
  126690. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  126691. /**
  126692. * get the rotation matrix of the particle
  126693. * @hidden
  126694. */
  126695. getRotationMatrix(m: Matrix): void;
  126696. }
  126697. /**
  126698. * Represents a group of points in a points cloud system
  126699. * * PCS internal tool, don't use it manually.
  126700. */
  126701. export class PointsGroup {
  126702. /**
  126703. * The group id
  126704. * @hidden
  126705. */
  126706. groupID: number;
  126707. /**
  126708. * image data for group (internal use)
  126709. * @hidden
  126710. */
  126711. _groupImageData: Nullable<ArrayBufferView>;
  126712. /**
  126713. * Image Width (internal use)
  126714. * @hidden
  126715. */
  126716. _groupImgWidth: number;
  126717. /**
  126718. * Image Height (internal use)
  126719. * @hidden
  126720. */
  126721. _groupImgHeight: number;
  126722. /**
  126723. * Custom position function (internal use)
  126724. * @hidden
  126725. */
  126726. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  126727. /**
  126728. * density per facet for surface points
  126729. * @hidden
  126730. */
  126731. _groupDensity: number[];
  126732. /**
  126733. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  126734. * PCS internal tool, don't use it manually.
  126735. * @hidden
  126736. */
  126737. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  126738. }
  126739. }
  126740. declare module BABYLON {
  126741. interface Scene {
  126742. /** @hidden (Backing field) */
  126743. _physicsEngine: Nullable<IPhysicsEngine>;
  126744. /**
  126745. * Gets the current physics engine
  126746. * @returns a IPhysicsEngine or null if none attached
  126747. */
  126748. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  126749. /**
  126750. * Enables physics to the current scene
  126751. * @param gravity defines the scene's gravity for the physics engine
  126752. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  126753. * @return a boolean indicating if the physics engine was initialized
  126754. */
  126755. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  126756. /**
  126757. * Disables and disposes the physics engine associated with the scene
  126758. */
  126759. disablePhysicsEngine(): void;
  126760. /**
  126761. * Gets a boolean indicating if there is an active physics engine
  126762. * @returns a boolean indicating if there is an active physics engine
  126763. */
  126764. isPhysicsEnabled(): boolean;
  126765. /**
  126766. * Deletes a physics compound impostor
  126767. * @param compound defines the compound to delete
  126768. */
  126769. deleteCompoundImpostor(compound: any): void;
  126770. /**
  126771. * An event triggered when physic simulation is about to be run
  126772. */
  126773. onBeforePhysicsObservable: Observable<Scene>;
  126774. /**
  126775. * An event triggered when physic simulation has been done
  126776. */
  126777. onAfterPhysicsObservable: Observable<Scene>;
  126778. }
  126779. interface AbstractMesh {
  126780. /** @hidden */
  126781. _physicsImpostor: Nullable<PhysicsImpostor>;
  126782. /**
  126783. * Gets or sets impostor used for physic simulation
  126784. * @see http://doc.babylonjs.com/features/physics_engine
  126785. */
  126786. physicsImpostor: Nullable<PhysicsImpostor>;
  126787. /**
  126788. * Gets the current physics impostor
  126789. * @see http://doc.babylonjs.com/features/physics_engine
  126790. * @returns a physics impostor or null
  126791. */
  126792. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  126793. /** Apply a physic impulse to the mesh
  126794. * @param force defines the force to apply
  126795. * @param contactPoint defines where to apply the force
  126796. * @returns the current mesh
  126797. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  126798. */
  126799. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  126800. /**
  126801. * Creates a physic joint between two meshes
  126802. * @param otherMesh defines the other mesh to use
  126803. * @param pivot1 defines the pivot to use on this mesh
  126804. * @param pivot2 defines the pivot to use on the other mesh
  126805. * @param options defines additional options (can be plugin dependent)
  126806. * @returns the current mesh
  126807. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  126808. */
  126809. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  126810. /** @hidden */
  126811. _disposePhysicsObserver: Nullable<Observer<Node>>;
  126812. }
  126813. /**
  126814. * Defines the physics engine scene component responsible to manage a physics engine
  126815. */
  126816. export class PhysicsEngineSceneComponent implements ISceneComponent {
  126817. /**
  126818. * The component name helpful to identify the component in the list of scene components.
  126819. */
  126820. readonly name: string;
  126821. /**
  126822. * The scene the component belongs to.
  126823. */
  126824. scene: Scene;
  126825. /**
  126826. * Creates a new instance of the component for the given scene
  126827. * @param scene Defines the scene to register the component in
  126828. */
  126829. constructor(scene: Scene);
  126830. /**
  126831. * Registers the component in a given scene
  126832. */
  126833. register(): void;
  126834. /**
  126835. * Rebuilds the elements related to this component in case of
  126836. * context lost for instance.
  126837. */
  126838. rebuild(): void;
  126839. /**
  126840. * Disposes the component and the associated ressources
  126841. */
  126842. dispose(): void;
  126843. }
  126844. }
  126845. declare module BABYLON {
  126846. /**
  126847. * A helper for physics simulations
  126848. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  126849. */
  126850. export class PhysicsHelper {
  126851. private _scene;
  126852. private _physicsEngine;
  126853. /**
  126854. * Initializes the Physics helper
  126855. * @param scene Babylon.js scene
  126856. */
  126857. constructor(scene: Scene);
  126858. /**
  126859. * Applies a radial explosion impulse
  126860. * @param origin the origin of the explosion
  126861. * @param radiusOrEventOptions the radius or the options of radial explosion
  126862. * @param strength the explosion strength
  126863. * @param falloff possible options: Constant & Linear. Defaults to Constant
  126864. * @returns A physics radial explosion event, or null
  126865. */
  126866. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  126867. /**
  126868. * Applies a radial explosion force
  126869. * @param origin the origin of the explosion
  126870. * @param radiusOrEventOptions the radius or the options of radial explosion
  126871. * @param strength the explosion strength
  126872. * @param falloff possible options: Constant & Linear. Defaults to Constant
  126873. * @returns A physics radial explosion event, or null
  126874. */
  126875. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  126876. /**
  126877. * Creates a gravitational field
  126878. * @param origin the origin of the explosion
  126879. * @param radiusOrEventOptions the radius or the options of radial explosion
  126880. * @param strength the explosion strength
  126881. * @param falloff possible options: Constant & Linear. Defaults to Constant
  126882. * @returns A physics gravitational field event, or null
  126883. */
  126884. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  126885. /**
  126886. * Creates a physics updraft event
  126887. * @param origin the origin of the updraft
  126888. * @param radiusOrEventOptions the radius or the options of the updraft
  126889. * @param strength the strength of the updraft
  126890. * @param height the height of the updraft
  126891. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  126892. * @returns A physics updraft event, or null
  126893. */
  126894. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  126895. /**
  126896. * Creates a physics vortex event
  126897. * @param origin the of the vortex
  126898. * @param radiusOrEventOptions the radius or the options of the vortex
  126899. * @param strength the strength of the vortex
  126900. * @param height the height of the vortex
  126901. * @returns a Physics vortex event, or null
  126902. * A physics vortex event or null
  126903. */
  126904. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  126905. }
  126906. /**
  126907. * Represents a physics radial explosion event
  126908. */
  126909. class PhysicsRadialExplosionEvent {
  126910. private _scene;
  126911. private _options;
  126912. private _sphere;
  126913. private _dataFetched;
  126914. /**
  126915. * Initializes a radial explosioin event
  126916. * @param _scene BabylonJS scene
  126917. * @param _options The options for the vortex event
  126918. */
  126919. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  126920. /**
  126921. * Returns the data related to the radial explosion event (sphere).
  126922. * @returns The radial explosion event data
  126923. */
  126924. getData(): PhysicsRadialExplosionEventData;
  126925. /**
  126926. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  126927. * @param impostor A physics imposter
  126928. * @param origin the origin of the explosion
  126929. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  126930. */
  126931. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  126932. /**
  126933. * Triggers affecterd impostors callbacks
  126934. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  126935. */
  126936. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  126937. /**
  126938. * Disposes the sphere.
  126939. * @param force Specifies if the sphere should be disposed by force
  126940. */
  126941. dispose(force?: boolean): void;
  126942. /*** Helpers ***/
  126943. private _prepareSphere;
  126944. private _intersectsWithSphere;
  126945. }
  126946. /**
  126947. * Represents a gravitational field event
  126948. */
  126949. class PhysicsGravitationalFieldEvent {
  126950. private _physicsHelper;
  126951. private _scene;
  126952. private _origin;
  126953. private _options;
  126954. private _tickCallback;
  126955. private _sphere;
  126956. private _dataFetched;
  126957. /**
  126958. * Initializes the physics gravitational field event
  126959. * @param _physicsHelper A physics helper
  126960. * @param _scene BabylonJS scene
  126961. * @param _origin The origin position of the gravitational field event
  126962. * @param _options The options for the vortex event
  126963. */
  126964. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  126965. /**
  126966. * Returns the data related to the gravitational field event (sphere).
  126967. * @returns A gravitational field event
  126968. */
  126969. getData(): PhysicsGravitationalFieldEventData;
  126970. /**
  126971. * Enables the gravitational field.
  126972. */
  126973. enable(): void;
  126974. /**
  126975. * Disables the gravitational field.
  126976. */
  126977. disable(): void;
  126978. /**
  126979. * Disposes the sphere.
  126980. * @param force The force to dispose from the gravitational field event
  126981. */
  126982. dispose(force?: boolean): void;
  126983. private _tick;
  126984. }
  126985. /**
  126986. * Represents a physics updraft event
  126987. */
  126988. class PhysicsUpdraftEvent {
  126989. private _scene;
  126990. private _origin;
  126991. private _options;
  126992. private _physicsEngine;
  126993. private _originTop;
  126994. private _originDirection;
  126995. private _tickCallback;
  126996. private _cylinder;
  126997. private _cylinderPosition;
  126998. private _dataFetched;
  126999. /**
  127000. * Initializes the physics updraft event
  127001. * @param _scene BabylonJS scene
  127002. * @param _origin The origin position of the updraft
  127003. * @param _options The options for the updraft event
  127004. */
  127005. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  127006. /**
  127007. * Returns the data related to the updraft event (cylinder).
  127008. * @returns A physics updraft event
  127009. */
  127010. getData(): PhysicsUpdraftEventData;
  127011. /**
  127012. * Enables the updraft.
  127013. */
  127014. enable(): void;
  127015. /**
  127016. * Disables the updraft.
  127017. */
  127018. disable(): void;
  127019. /**
  127020. * Disposes the cylinder.
  127021. * @param force Specifies if the updraft should be disposed by force
  127022. */
  127023. dispose(force?: boolean): void;
  127024. private getImpostorHitData;
  127025. private _tick;
  127026. /*** Helpers ***/
  127027. private _prepareCylinder;
  127028. private _intersectsWithCylinder;
  127029. }
  127030. /**
  127031. * Represents a physics vortex event
  127032. */
  127033. class PhysicsVortexEvent {
  127034. private _scene;
  127035. private _origin;
  127036. private _options;
  127037. private _physicsEngine;
  127038. private _originTop;
  127039. private _tickCallback;
  127040. private _cylinder;
  127041. private _cylinderPosition;
  127042. private _dataFetched;
  127043. /**
  127044. * Initializes the physics vortex event
  127045. * @param _scene The BabylonJS scene
  127046. * @param _origin The origin position of the vortex
  127047. * @param _options The options for the vortex event
  127048. */
  127049. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  127050. /**
  127051. * Returns the data related to the vortex event (cylinder).
  127052. * @returns The physics vortex event data
  127053. */
  127054. getData(): PhysicsVortexEventData;
  127055. /**
  127056. * Enables the vortex.
  127057. */
  127058. enable(): void;
  127059. /**
  127060. * Disables the cortex.
  127061. */
  127062. disable(): void;
  127063. /**
  127064. * Disposes the sphere.
  127065. * @param force
  127066. */
  127067. dispose(force?: boolean): void;
  127068. private getImpostorHitData;
  127069. private _tick;
  127070. /*** Helpers ***/
  127071. private _prepareCylinder;
  127072. private _intersectsWithCylinder;
  127073. }
  127074. /**
  127075. * Options fot the radial explosion event
  127076. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127077. */
  127078. export class PhysicsRadialExplosionEventOptions {
  127079. /**
  127080. * The radius of the sphere for the radial explosion.
  127081. */
  127082. radius: number;
  127083. /**
  127084. * The strenth of the explosion.
  127085. */
  127086. strength: number;
  127087. /**
  127088. * The strenght of the force in correspondence to the distance of the affected object
  127089. */
  127090. falloff: PhysicsRadialImpulseFalloff;
  127091. /**
  127092. * Sphere options for the radial explosion.
  127093. */
  127094. sphere: {
  127095. segments: number;
  127096. diameter: number;
  127097. };
  127098. /**
  127099. * Sphere options for the radial explosion.
  127100. */
  127101. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  127102. }
  127103. /**
  127104. * Options fot the updraft event
  127105. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127106. */
  127107. export class PhysicsUpdraftEventOptions {
  127108. /**
  127109. * The radius of the cylinder for the vortex
  127110. */
  127111. radius: number;
  127112. /**
  127113. * The strenth of the updraft.
  127114. */
  127115. strength: number;
  127116. /**
  127117. * The height of the cylinder for the updraft.
  127118. */
  127119. height: number;
  127120. /**
  127121. * The mode for the the updraft.
  127122. */
  127123. updraftMode: PhysicsUpdraftMode;
  127124. }
  127125. /**
  127126. * Options fot the vortex event
  127127. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127128. */
  127129. export class PhysicsVortexEventOptions {
  127130. /**
  127131. * The radius of the cylinder for the vortex
  127132. */
  127133. radius: number;
  127134. /**
  127135. * The strenth of the vortex.
  127136. */
  127137. strength: number;
  127138. /**
  127139. * The height of the cylinder for the vortex.
  127140. */
  127141. height: number;
  127142. /**
  127143. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  127144. */
  127145. centripetalForceThreshold: number;
  127146. /**
  127147. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  127148. */
  127149. centripetalForceMultiplier: number;
  127150. /**
  127151. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  127152. */
  127153. centrifugalForceMultiplier: number;
  127154. /**
  127155. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  127156. */
  127157. updraftForceMultiplier: number;
  127158. }
  127159. /**
  127160. * The strenght of the force in correspondence to the distance of the affected object
  127161. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127162. */
  127163. export enum PhysicsRadialImpulseFalloff {
  127164. /** Defines that impulse is constant in strength across it's whole radius */
  127165. Constant = 0,
  127166. /** Defines that impulse gets weaker if it's further from the origin */
  127167. Linear = 1
  127168. }
  127169. /**
  127170. * The strength of the force in correspondence to the distance of the affected object
  127171. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127172. */
  127173. export enum PhysicsUpdraftMode {
  127174. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  127175. Center = 0,
  127176. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  127177. Perpendicular = 1
  127178. }
  127179. /**
  127180. * Interface for a physics hit data
  127181. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127182. */
  127183. export interface PhysicsHitData {
  127184. /**
  127185. * The force applied at the contact point
  127186. */
  127187. force: Vector3;
  127188. /**
  127189. * The contact point
  127190. */
  127191. contactPoint: Vector3;
  127192. /**
  127193. * The distance from the origin to the contact point
  127194. */
  127195. distanceFromOrigin: number;
  127196. }
  127197. /**
  127198. * Interface for radial explosion event data
  127199. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127200. */
  127201. export interface PhysicsRadialExplosionEventData {
  127202. /**
  127203. * A sphere used for the radial explosion event
  127204. */
  127205. sphere: Mesh;
  127206. }
  127207. /**
  127208. * Interface for gravitational field event data
  127209. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127210. */
  127211. export interface PhysicsGravitationalFieldEventData {
  127212. /**
  127213. * A sphere mesh used for the gravitational field event
  127214. */
  127215. sphere: Mesh;
  127216. }
  127217. /**
  127218. * Interface for updraft event data
  127219. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127220. */
  127221. export interface PhysicsUpdraftEventData {
  127222. /**
  127223. * A cylinder used for the updraft event
  127224. */
  127225. cylinder: Mesh;
  127226. }
  127227. /**
  127228. * Interface for vortex event data
  127229. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127230. */
  127231. export interface PhysicsVortexEventData {
  127232. /**
  127233. * A cylinder used for the vortex event
  127234. */
  127235. cylinder: Mesh;
  127236. }
  127237. /**
  127238. * Interface for an affected physics impostor
  127239. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127240. */
  127241. export interface PhysicsAffectedImpostorWithData {
  127242. /**
  127243. * The impostor affected by the effect
  127244. */
  127245. impostor: PhysicsImpostor;
  127246. /**
  127247. * The data about the hit/horce from the explosion
  127248. */
  127249. hitData: PhysicsHitData;
  127250. }
  127251. }
  127252. declare module BABYLON {
  127253. /** @hidden */
  127254. export var blackAndWhitePixelShader: {
  127255. name: string;
  127256. shader: string;
  127257. };
  127258. }
  127259. declare module BABYLON {
  127260. /**
  127261. * Post process used to render in black and white
  127262. */
  127263. export class BlackAndWhitePostProcess extends PostProcess {
  127264. /**
  127265. * Linear about to convert he result to black and white (default: 1)
  127266. */
  127267. degree: number;
  127268. /**
  127269. * Creates a black and white post process
  127270. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  127271. * @param name The name of the effect.
  127272. * @param options The required width/height ratio to downsize to before computing the render pass.
  127273. * @param camera The camera to apply the render pass to.
  127274. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127275. * @param engine The engine which the post process will be applied. (default: current engine)
  127276. * @param reusable If the post process can be reused on the same frame. (default: false)
  127277. */
  127278. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  127279. }
  127280. }
  127281. declare module BABYLON {
  127282. /**
  127283. * This represents a set of one or more post processes in Babylon.
  127284. * A post process can be used to apply a shader to a texture after it is rendered.
  127285. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  127286. */
  127287. export class PostProcessRenderEffect {
  127288. private _postProcesses;
  127289. private _getPostProcesses;
  127290. private _singleInstance;
  127291. private _cameras;
  127292. private _indicesForCamera;
  127293. /**
  127294. * Name of the effect
  127295. * @hidden
  127296. */
  127297. _name: string;
  127298. /**
  127299. * Instantiates a post process render effect.
  127300. * A post process can be used to apply a shader to a texture after it is rendered.
  127301. * @param engine The engine the effect is tied to
  127302. * @param name The name of the effect
  127303. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  127304. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  127305. */
  127306. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  127307. /**
  127308. * Checks if all the post processes in the effect are supported.
  127309. */
  127310. readonly isSupported: boolean;
  127311. /**
  127312. * Updates the current state of the effect
  127313. * @hidden
  127314. */
  127315. _update(): void;
  127316. /**
  127317. * Attaches the effect on cameras
  127318. * @param cameras The camera to attach to.
  127319. * @hidden
  127320. */
  127321. _attachCameras(cameras: Camera): void;
  127322. /**
  127323. * Attaches the effect on cameras
  127324. * @param cameras The camera to attach to.
  127325. * @hidden
  127326. */
  127327. _attachCameras(cameras: Camera[]): void;
  127328. /**
  127329. * Detaches the effect on cameras
  127330. * @param cameras The camera to detatch from.
  127331. * @hidden
  127332. */
  127333. _detachCameras(cameras: Camera): void;
  127334. /**
  127335. * Detatches the effect on cameras
  127336. * @param cameras The camera to detatch from.
  127337. * @hidden
  127338. */
  127339. _detachCameras(cameras: Camera[]): void;
  127340. /**
  127341. * Enables the effect on given cameras
  127342. * @param cameras The camera to enable.
  127343. * @hidden
  127344. */
  127345. _enable(cameras: Camera): void;
  127346. /**
  127347. * Enables the effect on given cameras
  127348. * @param cameras The camera to enable.
  127349. * @hidden
  127350. */
  127351. _enable(cameras: Nullable<Camera[]>): void;
  127352. /**
  127353. * Disables the effect on the given cameras
  127354. * @param cameras The camera to disable.
  127355. * @hidden
  127356. */
  127357. _disable(cameras: Camera): void;
  127358. /**
  127359. * Disables the effect on the given cameras
  127360. * @param cameras The camera to disable.
  127361. * @hidden
  127362. */
  127363. _disable(cameras: Nullable<Camera[]>): void;
  127364. /**
  127365. * Gets a list of the post processes contained in the effect.
  127366. * @param camera The camera to get the post processes on.
  127367. * @returns The list of the post processes in the effect.
  127368. */
  127369. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  127370. }
  127371. }
  127372. declare module BABYLON {
  127373. /** @hidden */
  127374. export var extractHighlightsPixelShader: {
  127375. name: string;
  127376. shader: string;
  127377. };
  127378. }
  127379. declare module BABYLON {
  127380. /**
  127381. * 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.
  127382. */
  127383. export class ExtractHighlightsPostProcess extends PostProcess {
  127384. /**
  127385. * The luminance threshold, pixels below this value will be set to black.
  127386. */
  127387. threshold: number;
  127388. /** @hidden */
  127389. _exposure: number;
  127390. /**
  127391. * Post process which has the input texture to be used when performing highlight extraction
  127392. * @hidden
  127393. */
  127394. _inputPostProcess: Nullable<PostProcess>;
  127395. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  127396. }
  127397. }
  127398. declare module BABYLON {
  127399. /** @hidden */
  127400. export var bloomMergePixelShader: {
  127401. name: string;
  127402. shader: string;
  127403. };
  127404. }
  127405. declare module BABYLON {
  127406. /**
  127407. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  127408. */
  127409. export class BloomMergePostProcess extends PostProcess {
  127410. /** Weight of the bloom to be added to the original input. */
  127411. weight: number;
  127412. /**
  127413. * Creates a new instance of @see BloomMergePostProcess
  127414. * @param name The name of the effect.
  127415. * @param originalFromInput Post process which's input will be used for the merge.
  127416. * @param blurred Blurred highlights post process which's output will be used.
  127417. * @param weight Weight of the bloom to be added to the original input.
  127418. * @param options The required width/height ratio to downsize to before computing the render pass.
  127419. * @param camera The camera to apply the render pass to.
  127420. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127421. * @param engine The engine which the post process will be applied. (default: current engine)
  127422. * @param reusable If the post process can be reused on the same frame. (default: false)
  127423. * @param textureType Type of textures used when performing the post process. (default: 0)
  127424. * @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)
  127425. */
  127426. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  127427. /** Weight of the bloom to be added to the original input. */
  127428. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  127429. }
  127430. }
  127431. declare module BABYLON {
  127432. /**
  127433. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  127434. */
  127435. export class BloomEffect extends PostProcessRenderEffect {
  127436. private bloomScale;
  127437. /**
  127438. * @hidden Internal
  127439. */
  127440. _effects: Array<PostProcess>;
  127441. /**
  127442. * @hidden Internal
  127443. */
  127444. _downscale: ExtractHighlightsPostProcess;
  127445. private _blurX;
  127446. private _blurY;
  127447. private _merge;
  127448. /**
  127449. * The luminance threshold to find bright areas of the image to bloom.
  127450. */
  127451. threshold: number;
  127452. /**
  127453. * The strength of the bloom.
  127454. */
  127455. weight: number;
  127456. /**
  127457. * Specifies the size of the bloom blur kernel, relative to the final output size
  127458. */
  127459. kernel: number;
  127460. /**
  127461. * Creates a new instance of @see BloomEffect
  127462. * @param scene The scene the effect belongs to.
  127463. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  127464. * @param bloomKernel The size of the kernel to be used when applying the blur.
  127465. * @param bloomWeight The the strength of bloom.
  127466. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  127467. * @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)
  127468. */
  127469. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  127470. /**
  127471. * Disposes each of the internal effects for a given camera.
  127472. * @param camera The camera to dispose the effect on.
  127473. */
  127474. disposeEffects(camera: Camera): void;
  127475. /**
  127476. * @hidden Internal
  127477. */
  127478. _updateEffects(): void;
  127479. /**
  127480. * Internal
  127481. * @returns if all the contained post processes are ready.
  127482. * @hidden
  127483. */
  127484. _isReady(): boolean;
  127485. }
  127486. }
  127487. declare module BABYLON {
  127488. /** @hidden */
  127489. export var chromaticAberrationPixelShader: {
  127490. name: string;
  127491. shader: string;
  127492. };
  127493. }
  127494. declare module BABYLON {
  127495. /**
  127496. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  127497. */
  127498. export class ChromaticAberrationPostProcess extends PostProcess {
  127499. /**
  127500. * The amount of seperation of rgb channels (default: 30)
  127501. */
  127502. aberrationAmount: number;
  127503. /**
  127504. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  127505. */
  127506. radialIntensity: number;
  127507. /**
  127508. * 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))
  127509. */
  127510. direction: Vector2;
  127511. /**
  127512. * 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))
  127513. */
  127514. centerPosition: Vector2;
  127515. /**
  127516. * Creates a new instance ChromaticAberrationPostProcess
  127517. * @param name The name of the effect.
  127518. * @param screenWidth The width of the screen to apply the effect on.
  127519. * @param screenHeight The height of the screen to apply the effect on.
  127520. * @param options The required width/height ratio to downsize to before computing the render pass.
  127521. * @param camera The camera to apply the render pass to.
  127522. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127523. * @param engine The engine which the post process will be applied. (default: current engine)
  127524. * @param reusable If the post process can be reused on the same frame. (default: false)
  127525. * @param textureType Type of textures used when performing the post process. (default: 0)
  127526. * @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)
  127527. */
  127528. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  127529. }
  127530. }
  127531. declare module BABYLON {
  127532. /** @hidden */
  127533. export var circleOfConfusionPixelShader: {
  127534. name: string;
  127535. shader: string;
  127536. };
  127537. }
  127538. declare module BABYLON {
  127539. /**
  127540. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  127541. */
  127542. export class CircleOfConfusionPostProcess extends PostProcess {
  127543. /**
  127544. * 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.
  127545. */
  127546. lensSize: number;
  127547. /**
  127548. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  127549. */
  127550. fStop: number;
  127551. /**
  127552. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  127553. */
  127554. focusDistance: number;
  127555. /**
  127556. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  127557. */
  127558. focalLength: number;
  127559. private _depthTexture;
  127560. /**
  127561. * Creates a new instance CircleOfConfusionPostProcess
  127562. * @param name The name of the effect.
  127563. * @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.
  127564. * @param options The required width/height ratio to downsize to before computing the render pass.
  127565. * @param camera The camera to apply the render pass to.
  127566. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127567. * @param engine The engine which the post process will be applied. (default: current engine)
  127568. * @param reusable If the post process can be reused on the same frame. (default: false)
  127569. * @param textureType Type of textures used when performing the post process. (default: 0)
  127570. * @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)
  127571. */
  127572. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  127573. /**
  127574. * 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.
  127575. */
  127576. depthTexture: RenderTargetTexture;
  127577. }
  127578. }
  127579. declare module BABYLON {
  127580. /** @hidden */
  127581. export var colorCorrectionPixelShader: {
  127582. name: string;
  127583. shader: string;
  127584. };
  127585. }
  127586. declare module BABYLON {
  127587. /**
  127588. *
  127589. * This post-process allows the modification of rendered colors by using
  127590. * a 'look-up table' (LUT). This effect is also called Color Grading.
  127591. *
  127592. * The object needs to be provided an url to a texture containing the color
  127593. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  127594. * Use an image editing software to tweak the LUT to match your needs.
  127595. *
  127596. * For an example of a color LUT, see here:
  127597. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  127598. * For explanations on color grading, see here:
  127599. * @see http://udn.epicgames.com/Three/ColorGrading.html
  127600. *
  127601. */
  127602. export class ColorCorrectionPostProcess extends PostProcess {
  127603. private _colorTableTexture;
  127604. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  127605. }
  127606. }
  127607. declare module BABYLON {
  127608. /** @hidden */
  127609. export var convolutionPixelShader: {
  127610. name: string;
  127611. shader: string;
  127612. };
  127613. }
  127614. declare module BABYLON {
  127615. /**
  127616. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  127617. * input texture to perform effects such as edge detection or sharpening
  127618. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  127619. */
  127620. export class ConvolutionPostProcess extends PostProcess {
  127621. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  127622. kernel: number[];
  127623. /**
  127624. * Creates a new instance ConvolutionPostProcess
  127625. * @param name The name of the effect.
  127626. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  127627. * @param options The required width/height ratio to downsize to before computing the render pass.
  127628. * @param camera The camera to apply the render pass to.
  127629. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127630. * @param engine The engine which the post process will be applied. (default: current engine)
  127631. * @param reusable If the post process can be reused on the same frame. (default: false)
  127632. * @param textureType Type of textures used when performing the post process. (default: 0)
  127633. */
  127634. constructor(name: string,
  127635. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  127636. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  127637. /**
  127638. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  127639. */
  127640. static EdgeDetect0Kernel: number[];
  127641. /**
  127642. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  127643. */
  127644. static EdgeDetect1Kernel: number[];
  127645. /**
  127646. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  127647. */
  127648. static EdgeDetect2Kernel: number[];
  127649. /**
  127650. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  127651. */
  127652. static SharpenKernel: number[];
  127653. /**
  127654. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  127655. */
  127656. static EmbossKernel: number[];
  127657. /**
  127658. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  127659. */
  127660. static GaussianKernel: number[];
  127661. }
  127662. }
  127663. declare module BABYLON {
  127664. /**
  127665. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  127666. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  127667. * based on samples that have a large difference in distance than the center pixel.
  127668. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  127669. */
  127670. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  127671. direction: Vector2;
  127672. /**
  127673. * Creates a new instance CircleOfConfusionPostProcess
  127674. * @param name The name of the effect.
  127675. * @param scene The scene the effect belongs to.
  127676. * @param direction The direction the blur should be applied.
  127677. * @param kernel The size of the kernel used to blur.
  127678. * @param options The required width/height ratio to downsize to before computing the render pass.
  127679. * @param camera The camera to apply the render pass to.
  127680. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  127681. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  127682. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127683. * @param engine The engine which the post process will be applied. (default: current engine)
  127684. * @param reusable If the post process can be reused on the same frame. (default: false)
  127685. * @param textureType Type of textures used when performing the post process. (default: 0)
  127686. * @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)
  127687. */
  127688. 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);
  127689. }
  127690. }
  127691. declare module BABYLON {
  127692. /** @hidden */
  127693. export var depthOfFieldMergePixelShader: {
  127694. name: string;
  127695. shader: string;
  127696. };
  127697. }
  127698. declare module BABYLON {
  127699. /**
  127700. * Options to be set when merging outputs from the default pipeline.
  127701. */
  127702. export class DepthOfFieldMergePostProcessOptions {
  127703. /**
  127704. * The original image to merge on top of
  127705. */
  127706. originalFromInput: PostProcess;
  127707. /**
  127708. * Parameters to perform the merge of the depth of field effect
  127709. */
  127710. depthOfField?: {
  127711. circleOfConfusion: PostProcess;
  127712. blurSteps: Array<PostProcess>;
  127713. };
  127714. /**
  127715. * Parameters to perform the merge of bloom effect
  127716. */
  127717. bloom?: {
  127718. blurred: PostProcess;
  127719. weight: number;
  127720. };
  127721. }
  127722. /**
  127723. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  127724. */
  127725. export class DepthOfFieldMergePostProcess extends PostProcess {
  127726. private blurSteps;
  127727. /**
  127728. * Creates a new instance of DepthOfFieldMergePostProcess
  127729. * @param name The name of the effect.
  127730. * @param originalFromInput Post process which's input will be used for the merge.
  127731. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  127732. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  127733. * @param options The required width/height ratio to downsize to before computing the render pass.
  127734. * @param camera The camera to apply the render pass to.
  127735. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127736. * @param engine The engine which the post process will be applied. (default: current engine)
  127737. * @param reusable If the post process can be reused on the same frame. (default: false)
  127738. * @param textureType Type of textures used when performing the post process. (default: 0)
  127739. * @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)
  127740. */
  127741. 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);
  127742. /**
  127743. * Updates the effect with the current post process compile time values and recompiles the shader.
  127744. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  127745. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  127746. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  127747. * @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
  127748. * @param onCompiled Called when the shader has been compiled.
  127749. * @param onError Called if there is an error when compiling a shader.
  127750. */
  127751. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  127752. }
  127753. }
  127754. declare module BABYLON {
  127755. /**
  127756. * Specifies the level of max blur that should be applied when using the depth of field effect
  127757. */
  127758. export enum DepthOfFieldEffectBlurLevel {
  127759. /**
  127760. * Subtle blur
  127761. */
  127762. Low = 0,
  127763. /**
  127764. * Medium blur
  127765. */
  127766. Medium = 1,
  127767. /**
  127768. * Large blur
  127769. */
  127770. High = 2
  127771. }
  127772. /**
  127773. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  127774. */
  127775. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  127776. private _circleOfConfusion;
  127777. /**
  127778. * @hidden Internal, blurs from high to low
  127779. */
  127780. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  127781. private _depthOfFieldBlurY;
  127782. private _dofMerge;
  127783. /**
  127784. * @hidden Internal post processes in depth of field effect
  127785. */
  127786. _effects: Array<PostProcess>;
  127787. /**
  127788. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  127789. */
  127790. focalLength: number;
  127791. /**
  127792. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  127793. */
  127794. fStop: number;
  127795. /**
  127796. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  127797. */
  127798. focusDistance: number;
  127799. /**
  127800. * 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.
  127801. */
  127802. lensSize: number;
  127803. /**
  127804. * Creates a new instance DepthOfFieldEffect
  127805. * @param scene The scene the effect belongs to.
  127806. * @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.
  127807. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  127808. * @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)
  127809. */
  127810. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  127811. /**
  127812. * Get the current class name of the current effet
  127813. * @returns "DepthOfFieldEffect"
  127814. */
  127815. getClassName(): string;
  127816. /**
  127817. * 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.
  127818. */
  127819. depthTexture: RenderTargetTexture;
  127820. /**
  127821. * Disposes each of the internal effects for a given camera.
  127822. * @param camera The camera to dispose the effect on.
  127823. */
  127824. disposeEffects(camera: Camera): void;
  127825. /**
  127826. * @hidden Internal
  127827. */
  127828. _updateEffects(): void;
  127829. /**
  127830. * Internal
  127831. * @returns if all the contained post processes are ready.
  127832. * @hidden
  127833. */
  127834. _isReady(): boolean;
  127835. }
  127836. }
  127837. declare module BABYLON {
  127838. /** @hidden */
  127839. export var displayPassPixelShader: {
  127840. name: string;
  127841. shader: string;
  127842. };
  127843. }
  127844. declare module BABYLON {
  127845. /**
  127846. * DisplayPassPostProcess which produces an output the same as it's input
  127847. */
  127848. export class DisplayPassPostProcess extends PostProcess {
  127849. /**
  127850. * Creates the DisplayPassPostProcess
  127851. * @param name The name of the effect.
  127852. * @param options The required width/height ratio to downsize to before computing the render pass.
  127853. * @param camera The camera to apply the render pass to.
  127854. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127855. * @param engine The engine which the post process will be applied. (default: current engine)
  127856. * @param reusable If the post process can be reused on the same frame. (default: false)
  127857. */
  127858. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  127859. }
  127860. }
  127861. declare module BABYLON {
  127862. /** @hidden */
  127863. export var filterPixelShader: {
  127864. name: string;
  127865. shader: string;
  127866. };
  127867. }
  127868. declare module BABYLON {
  127869. /**
  127870. * Applies a kernel filter to the image
  127871. */
  127872. export class FilterPostProcess extends PostProcess {
  127873. /** The matrix to be applied to the image */
  127874. kernelMatrix: Matrix;
  127875. /**
  127876. *
  127877. * @param name The name of the effect.
  127878. * @param kernelMatrix The matrix to be applied to the image
  127879. * @param options The required width/height ratio to downsize to before computing the render pass.
  127880. * @param camera The camera to apply the render pass to.
  127881. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127882. * @param engine The engine which the post process will be applied. (default: current engine)
  127883. * @param reusable If the post process can be reused on the same frame. (default: false)
  127884. */
  127885. constructor(name: string,
  127886. /** The matrix to be applied to the image */
  127887. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  127888. }
  127889. }
  127890. declare module BABYLON {
  127891. /** @hidden */
  127892. export var fxaaPixelShader: {
  127893. name: string;
  127894. shader: string;
  127895. };
  127896. }
  127897. declare module BABYLON {
  127898. /** @hidden */
  127899. export var fxaaVertexShader: {
  127900. name: string;
  127901. shader: string;
  127902. };
  127903. }
  127904. declare module BABYLON {
  127905. /**
  127906. * Fxaa post process
  127907. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  127908. */
  127909. export class FxaaPostProcess extends PostProcess {
  127910. /** @hidden */
  127911. texelWidth: number;
  127912. /** @hidden */
  127913. texelHeight: number;
  127914. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  127915. private _getDefines;
  127916. }
  127917. }
  127918. declare module BABYLON {
  127919. /** @hidden */
  127920. export var grainPixelShader: {
  127921. name: string;
  127922. shader: string;
  127923. };
  127924. }
  127925. declare module BABYLON {
  127926. /**
  127927. * The GrainPostProcess adds noise to the image at mid luminance levels
  127928. */
  127929. export class GrainPostProcess extends PostProcess {
  127930. /**
  127931. * The intensity of the grain added (default: 30)
  127932. */
  127933. intensity: number;
  127934. /**
  127935. * If the grain should be randomized on every frame
  127936. */
  127937. animated: boolean;
  127938. /**
  127939. * Creates a new instance of @see GrainPostProcess
  127940. * @param name The name of the effect.
  127941. * @param options The required width/height ratio to downsize to before computing the render pass.
  127942. * @param camera The camera to apply the render pass to.
  127943. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127944. * @param engine The engine which the post process will be applied. (default: current engine)
  127945. * @param reusable If the post process can be reused on the same frame. (default: false)
  127946. * @param textureType Type of textures used when performing the post process. (default: 0)
  127947. * @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)
  127948. */
  127949. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  127950. }
  127951. }
  127952. declare module BABYLON {
  127953. /** @hidden */
  127954. export var highlightsPixelShader: {
  127955. name: string;
  127956. shader: string;
  127957. };
  127958. }
  127959. declare module BABYLON {
  127960. /**
  127961. * Extracts highlights from the image
  127962. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  127963. */
  127964. export class HighlightsPostProcess extends PostProcess {
  127965. /**
  127966. * Extracts highlights from the image
  127967. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  127968. * @param name The name of the effect.
  127969. * @param options The required width/height ratio to downsize to before computing the render pass.
  127970. * @param camera The camera to apply the render pass to.
  127971. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127972. * @param engine The engine which the post process will be applied. (default: current engine)
  127973. * @param reusable If the post process can be reused on the same frame. (default: false)
  127974. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  127975. */
  127976. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  127977. }
  127978. }
  127979. declare module BABYLON {
  127980. /** @hidden */
  127981. export var mrtFragmentDeclaration: {
  127982. name: string;
  127983. shader: string;
  127984. };
  127985. }
  127986. declare module BABYLON {
  127987. /** @hidden */
  127988. export var geometryPixelShader: {
  127989. name: string;
  127990. shader: string;
  127991. };
  127992. }
  127993. declare module BABYLON {
  127994. /** @hidden */
  127995. export var geometryVertexShader: {
  127996. name: string;
  127997. shader: string;
  127998. };
  127999. }
  128000. declare module BABYLON {
  128001. /** @hidden */
  128002. interface ISavedTransformationMatrix {
  128003. world: Matrix;
  128004. viewProjection: Matrix;
  128005. }
  128006. /**
  128007. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  128008. */
  128009. export class GeometryBufferRenderer {
  128010. /**
  128011. * Constant used to retrieve the position texture index in the G-Buffer textures array
  128012. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  128013. */
  128014. static readonly POSITION_TEXTURE_TYPE: number;
  128015. /**
  128016. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  128017. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  128018. */
  128019. static readonly VELOCITY_TEXTURE_TYPE: number;
  128020. /**
  128021. * Dictionary used to store the previous transformation matrices of each rendered mesh
  128022. * in order to compute objects velocities when enableVelocity is set to "true"
  128023. * @hidden
  128024. */
  128025. _previousTransformationMatrices: {
  128026. [index: number]: ISavedTransformationMatrix;
  128027. };
  128028. /**
  128029. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  128030. * in order to compute objects velocities when enableVelocity is set to "true"
  128031. * @hidden
  128032. */
  128033. _previousBonesTransformationMatrices: {
  128034. [index: number]: Float32Array;
  128035. };
  128036. /**
  128037. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  128038. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  128039. */
  128040. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  128041. private _scene;
  128042. private _multiRenderTarget;
  128043. private _ratio;
  128044. private _enablePosition;
  128045. private _enableVelocity;
  128046. private _positionIndex;
  128047. private _velocityIndex;
  128048. protected _effect: Effect;
  128049. protected _cachedDefines: string;
  128050. /**
  128051. * Set the render list (meshes to be rendered) used in the G buffer.
  128052. */
  128053. renderList: Mesh[];
  128054. /**
  128055. * Gets wether or not G buffer are supported by the running hardware.
  128056. * This requires draw buffer supports
  128057. */
  128058. readonly isSupported: boolean;
  128059. /**
  128060. * Returns the index of the given texture type in the G-Buffer textures array
  128061. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  128062. * @returns the index of the given texture type in the G-Buffer textures array
  128063. */
  128064. getTextureIndex(textureType: number): number;
  128065. /**
  128066. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  128067. */
  128068. /**
  128069. * Sets whether or not objects positions are enabled for the G buffer.
  128070. */
  128071. enablePosition: boolean;
  128072. /**
  128073. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  128074. */
  128075. /**
  128076. * Sets wether or not objects velocities are enabled for the G buffer.
  128077. */
  128078. enableVelocity: boolean;
  128079. /**
  128080. * Gets the scene associated with the buffer.
  128081. */
  128082. readonly scene: Scene;
  128083. /**
  128084. * Gets the ratio used by the buffer during its creation.
  128085. * How big is the buffer related to the main canvas.
  128086. */
  128087. readonly ratio: number;
  128088. /** @hidden */
  128089. static _SceneComponentInitialization: (scene: Scene) => void;
  128090. /**
  128091. * Creates a new G Buffer for the scene
  128092. * @param scene The scene the buffer belongs to
  128093. * @param ratio How big is the buffer related to the main canvas.
  128094. */
  128095. constructor(scene: Scene, ratio?: number);
  128096. /**
  128097. * Checks wether everything is ready to render a submesh to the G buffer.
  128098. * @param subMesh the submesh to check readiness for
  128099. * @param useInstances is the mesh drawn using instance or not
  128100. * @returns true if ready otherwise false
  128101. */
  128102. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  128103. /**
  128104. * Gets the current underlying G Buffer.
  128105. * @returns the buffer
  128106. */
  128107. getGBuffer(): MultiRenderTarget;
  128108. /**
  128109. * Gets the number of samples used to render the buffer (anti aliasing).
  128110. */
  128111. /**
  128112. * Sets the number of samples used to render the buffer (anti aliasing).
  128113. */
  128114. samples: number;
  128115. /**
  128116. * Disposes the renderer and frees up associated resources.
  128117. */
  128118. dispose(): void;
  128119. protected _createRenderTargets(): void;
  128120. private _copyBonesTransformationMatrices;
  128121. }
  128122. }
  128123. declare module BABYLON {
  128124. interface Scene {
  128125. /** @hidden (Backing field) */
  128126. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  128127. /**
  128128. * Gets or Sets the current geometry buffer associated to the scene.
  128129. */
  128130. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  128131. /**
  128132. * Enables a GeometryBufferRender and associates it with the scene
  128133. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  128134. * @returns the GeometryBufferRenderer
  128135. */
  128136. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  128137. /**
  128138. * Disables the GeometryBufferRender associated with the scene
  128139. */
  128140. disableGeometryBufferRenderer(): void;
  128141. }
  128142. /**
  128143. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  128144. * in several rendering techniques.
  128145. */
  128146. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  128147. /**
  128148. * The component name helpful to identify the component in the list of scene components.
  128149. */
  128150. readonly name: string;
  128151. /**
  128152. * The scene the component belongs to.
  128153. */
  128154. scene: Scene;
  128155. /**
  128156. * Creates a new instance of the component for the given scene
  128157. * @param scene Defines the scene to register the component in
  128158. */
  128159. constructor(scene: Scene);
  128160. /**
  128161. * Registers the component in a given scene
  128162. */
  128163. register(): void;
  128164. /**
  128165. * Rebuilds the elements related to this component in case of
  128166. * context lost for instance.
  128167. */
  128168. rebuild(): void;
  128169. /**
  128170. * Disposes the component and the associated ressources
  128171. */
  128172. dispose(): void;
  128173. private _gatherRenderTargets;
  128174. }
  128175. }
  128176. declare module BABYLON {
  128177. /** @hidden */
  128178. export var motionBlurPixelShader: {
  128179. name: string;
  128180. shader: string;
  128181. };
  128182. }
  128183. declare module BABYLON {
  128184. /**
  128185. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  128186. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  128187. * As an example, all you have to do is to create the post-process:
  128188. * var mb = new BABYLON.MotionBlurPostProcess(
  128189. * 'mb', // The name of the effect.
  128190. * scene, // The scene containing the objects to blur according to their velocity.
  128191. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  128192. * camera // The camera to apply the render pass to.
  128193. * );
  128194. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  128195. */
  128196. export class MotionBlurPostProcess extends PostProcess {
  128197. /**
  128198. * Defines how much the image is blurred by the movement. Default value is equal to 1
  128199. */
  128200. motionStrength: number;
  128201. /**
  128202. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  128203. */
  128204. /**
  128205. * Sets the number of iterations to be used for motion blur quality
  128206. */
  128207. motionBlurSamples: number;
  128208. private _motionBlurSamples;
  128209. private _geometryBufferRenderer;
  128210. /**
  128211. * Creates a new instance MotionBlurPostProcess
  128212. * @param name The name of the effect.
  128213. * @param scene The scene containing the objects to blur according to their velocity.
  128214. * @param options The required width/height ratio to downsize to before computing the render pass.
  128215. * @param camera The camera to apply the render pass to.
  128216. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128217. * @param engine The engine which the post process will be applied. (default: current engine)
  128218. * @param reusable If the post process can be reused on the same frame. (default: false)
  128219. * @param textureType Type of textures used when performing the post process. (default: 0)
  128220. * @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)
  128221. */
  128222. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128223. /**
  128224. * Excludes the given skinned mesh from computing bones velocities.
  128225. * 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.
  128226. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  128227. */
  128228. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  128229. /**
  128230. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  128231. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  128232. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  128233. */
  128234. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  128235. /**
  128236. * Disposes the post process.
  128237. * @param camera The camera to dispose the post process on.
  128238. */
  128239. dispose(camera?: Camera): void;
  128240. }
  128241. }
  128242. declare module BABYLON {
  128243. /** @hidden */
  128244. export var refractionPixelShader: {
  128245. name: string;
  128246. shader: string;
  128247. };
  128248. }
  128249. declare module BABYLON {
  128250. /**
  128251. * Post process which applies a refractin texture
  128252. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  128253. */
  128254. export class RefractionPostProcess extends PostProcess {
  128255. /** the base color of the refraction (used to taint the rendering) */
  128256. color: Color3;
  128257. /** simulated refraction depth */
  128258. depth: number;
  128259. /** the coefficient of the base color (0 to remove base color tainting) */
  128260. colorLevel: number;
  128261. private _refTexture;
  128262. private _ownRefractionTexture;
  128263. /**
  128264. * Gets or sets the refraction texture
  128265. * Please note that you are responsible for disposing the texture if you set it manually
  128266. */
  128267. refractionTexture: Texture;
  128268. /**
  128269. * Initializes the RefractionPostProcess
  128270. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  128271. * @param name The name of the effect.
  128272. * @param refractionTextureUrl Url of the refraction texture to use
  128273. * @param color the base color of the refraction (used to taint the rendering)
  128274. * @param depth simulated refraction depth
  128275. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  128276. * @param camera The camera to apply the render pass to.
  128277. * @param options The required width/height ratio to downsize to before computing the render pass.
  128278. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128279. * @param engine The engine which the post process will be applied. (default: current engine)
  128280. * @param reusable If the post process can be reused on the same frame. (default: false)
  128281. */
  128282. constructor(name: string, refractionTextureUrl: string,
  128283. /** the base color of the refraction (used to taint the rendering) */
  128284. color: Color3,
  128285. /** simulated refraction depth */
  128286. depth: number,
  128287. /** the coefficient of the base color (0 to remove base color tainting) */
  128288. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  128289. /**
  128290. * Disposes of the post process
  128291. * @param camera Camera to dispose post process on
  128292. */
  128293. dispose(camera: Camera): void;
  128294. }
  128295. }
  128296. declare module BABYLON {
  128297. /** @hidden */
  128298. export var sharpenPixelShader: {
  128299. name: string;
  128300. shader: string;
  128301. };
  128302. }
  128303. declare module BABYLON {
  128304. /**
  128305. * The SharpenPostProcess applies a sharpen kernel to every pixel
  128306. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  128307. */
  128308. export class SharpenPostProcess extends PostProcess {
  128309. /**
  128310. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  128311. */
  128312. colorAmount: number;
  128313. /**
  128314. * How much sharpness should be applied (default: 0.3)
  128315. */
  128316. edgeAmount: number;
  128317. /**
  128318. * Creates a new instance ConvolutionPostProcess
  128319. * @param name The name of the effect.
  128320. * @param options The required width/height ratio to downsize to before computing the render pass.
  128321. * @param camera The camera to apply the render pass to.
  128322. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128323. * @param engine The engine which the post process will be applied. (default: current engine)
  128324. * @param reusable If the post process can be reused on the same frame. (default: false)
  128325. * @param textureType Type of textures used when performing the post process. (default: 0)
  128326. * @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)
  128327. */
  128328. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128329. }
  128330. }
  128331. declare module BABYLON {
  128332. /**
  128333. * PostProcessRenderPipeline
  128334. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  128335. */
  128336. export class PostProcessRenderPipeline {
  128337. private engine;
  128338. private _renderEffects;
  128339. private _renderEffectsForIsolatedPass;
  128340. /**
  128341. * List of inspectable custom properties (used by the Inspector)
  128342. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  128343. */
  128344. inspectableCustomProperties: IInspectable[];
  128345. /**
  128346. * @hidden
  128347. */
  128348. protected _cameras: Camera[];
  128349. /** @hidden */
  128350. _name: string;
  128351. /**
  128352. * Gets pipeline name
  128353. */
  128354. readonly name: string;
  128355. /**
  128356. * Initializes a PostProcessRenderPipeline
  128357. * @param engine engine to add the pipeline to
  128358. * @param name name of the pipeline
  128359. */
  128360. constructor(engine: Engine, name: string);
  128361. /**
  128362. * Gets the class name
  128363. * @returns "PostProcessRenderPipeline"
  128364. */
  128365. getClassName(): string;
  128366. /**
  128367. * If all the render effects in the pipeline are supported
  128368. */
  128369. readonly isSupported: boolean;
  128370. /**
  128371. * Adds an effect to the pipeline
  128372. * @param renderEffect the effect to add
  128373. */
  128374. addEffect(renderEffect: PostProcessRenderEffect): void;
  128375. /** @hidden */
  128376. _rebuild(): void;
  128377. /** @hidden */
  128378. _enableEffect(renderEffectName: string, cameras: Camera): void;
  128379. /** @hidden */
  128380. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  128381. /** @hidden */
  128382. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  128383. /** @hidden */
  128384. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  128385. /** @hidden */
  128386. _attachCameras(cameras: Camera, unique: boolean): void;
  128387. /** @hidden */
  128388. _attachCameras(cameras: Camera[], unique: boolean): void;
  128389. /** @hidden */
  128390. _detachCameras(cameras: Camera): void;
  128391. /** @hidden */
  128392. _detachCameras(cameras: Nullable<Camera[]>): void;
  128393. /** @hidden */
  128394. _update(): void;
  128395. /** @hidden */
  128396. _reset(): void;
  128397. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  128398. /**
  128399. * Disposes of the pipeline
  128400. */
  128401. dispose(): void;
  128402. }
  128403. }
  128404. declare module BABYLON {
  128405. /**
  128406. * PostProcessRenderPipelineManager class
  128407. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  128408. */
  128409. export class PostProcessRenderPipelineManager {
  128410. private _renderPipelines;
  128411. /**
  128412. * Initializes a PostProcessRenderPipelineManager
  128413. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  128414. */
  128415. constructor();
  128416. /**
  128417. * Gets the list of supported render pipelines
  128418. */
  128419. readonly supportedPipelines: PostProcessRenderPipeline[];
  128420. /**
  128421. * Adds a pipeline to the manager
  128422. * @param renderPipeline The pipeline to add
  128423. */
  128424. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  128425. /**
  128426. * Attaches a camera to the pipeline
  128427. * @param renderPipelineName The name of the pipeline to attach to
  128428. * @param cameras the camera to attach
  128429. * @param unique if the camera can be attached multiple times to the pipeline
  128430. */
  128431. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  128432. /**
  128433. * Detaches a camera from the pipeline
  128434. * @param renderPipelineName The name of the pipeline to detach from
  128435. * @param cameras the camera to detach
  128436. */
  128437. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  128438. /**
  128439. * Enables an effect by name on a pipeline
  128440. * @param renderPipelineName the name of the pipeline to enable the effect in
  128441. * @param renderEffectName the name of the effect to enable
  128442. * @param cameras the cameras that the effect should be enabled on
  128443. */
  128444. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  128445. /**
  128446. * Disables an effect by name on a pipeline
  128447. * @param renderPipelineName the name of the pipeline to disable the effect in
  128448. * @param renderEffectName the name of the effect to disable
  128449. * @param cameras the cameras that the effect should be disabled on
  128450. */
  128451. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  128452. /**
  128453. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  128454. */
  128455. update(): void;
  128456. /** @hidden */
  128457. _rebuild(): void;
  128458. /**
  128459. * Disposes of the manager and pipelines
  128460. */
  128461. dispose(): void;
  128462. }
  128463. }
  128464. declare module BABYLON {
  128465. interface Scene {
  128466. /** @hidden (Backing field) */
  128467. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  128468. /**
  128469. * Gets the postprocess render pipeline manager
  128470. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  128471. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  128472. */
  128473. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  128474. }
  128475. /**
  128476. * Defines the Render Pipeline scene component responsible to rendering pipelines
  128477. */
  128478. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  128479. /**
  128480. * The component name helpfull to identify the component in the list of scene components.
  128481. */
  128482. readonly name: string;
  128483. /**
  128484. * The scene the component belongs to.
  128485. */
  128486. scene: Scene;
  128487. /**
  128488. * Creates a new instance of the component for the given scene
  128489. * @param scene Defines the scene to register the component in
  128490. */
  128491. constructor(scene: Scene);
  128492. /**
  128493. * Registers the component in a given scene
  128494. */
  128495. register(): void;
  128496. /**
  128497. * Rebuilds the elements related to this component in case of
  128498. * context lost for instance.
  128499. */
  128500. rebuild(): void;
  128501. /**
  128502. * Disposes the component and the associated ressources
  128503. */
  128504. dispose(): void;
  128505. private _gatherRenderTargets;
  128506. }
  128507. }
  128508. declare module BABYLON {
  128509. /**
  128510. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  128511. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  128512. */
  128513. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  128514. private _scene;
  128515. private _camerasToBeAttached;
  128516. /**
  128517. * ID of the sharpen post process,
  128518. */
  128519. private readonly SharpenPostProcessId;
  128520. /**
  128521. * @ignore
  128522. * ID of the image processing post process;
  128523. */
  128524. readonly ImageProcessingPostProcessId: string;
  128525. /**
  128526. * @ignore
  128527. * ID of the Fast Approximate Anti-Aliasing post process;
  128528. */
  128529. readonly FxaaPostProcessId: string;
  128530. /**
  128531. * ID of the chromatic aberration post process,
  128532. */
  128533. private readonly ChromaticAberrationPostProcessId;
  128534. /**
  128535. * ID of the grain post process
  128536. */
  128537. private readonly GrainPostProcessId;
  128538. /**
  128539. * Sharpen post process which will apply a sharpen convolution to enhance edges
  128540. */
  128541. sharpen: SharpenPostProcess;
  128542. private _sharpenEffect;
  128543. private bloom;
  128544. /**
  128545. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  128546. */
  128547. depthOfField: DepthOfFieldEffect;
  128548. /**
  128549. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  128550. */
  128551. fxaa: FxaaPostProcess;
  128552. /**
  128553. * Image post processing pass used to perform operations such as tone mapping or color grading.
  128554. */
  128555. imageProcessing: ImageProcessingPostProcess;
  128556. /**
  128557. * Chromatic aberration post process which will shift rgb colors in the image
  128558. */
  128559. chromaticAberration: ChromaticAberrationPostProcess;
  128560. private _chromaticAberrationEffect;
  128561. /**
  128562. * Grain post process which add noise to the image
  128563. */
  128564. grain: GrainPostProcess;
  128565. private _grainEffect;
  128566. /**
  128567. * Glow post process which adds a glow to emissive areas of the image
  128568. */
  128569. private _glowLayer;
  128570. /**
  128571. * Animations which can be used to tweak settings over a period of time
  128572. */
  128573. animations: Animation[];
  128574. private _imageProcessingConfigurationObserver;
  128575. private _sharpenEnabled;
  128576. private _bloomEnabled;
  128577. private _depthOfFieldEnabled;
  128578. private _depthOfFieldBlurLevel;
  128579. private _fxaaEnabled;
  128580. private _imageProcessingEnabled;
  128581. private _defaultPipelineTextureType;
  128582. private _bloomScale;
  128583. private _chromaticAberrationEnabled;
  128584. private _grainEnabled;
  128585. private _buildAllowed;
  128586. /**
  128587. * Gets active scene
  128588. */
  128589. readonly scene: Scene;
  128590. /**
  128591. * Enable or disable the sharpen process from the pipeline
  128592. */
  128593. sharpenEnabled: boolean;
  128594. private _resizeObserver;
  128595. private _hardwareScaleLevel;
  128596. private _bloomKernel;
  128597. /**
  128598. * Specifies the size of the bloom blur kernel, relative to the final output size
  128599. */
  128600. bloomKernel: number;
  128601. /**
  128602. * Specifies the weight of the bloom in the final rendering
  128603. */
  128604. private _bloomWeight;
  128605. /**
  128606. * Specifies the luma threshold for the area that will be blurred by the bloom
  128607. */
  128608. private _bloomThreshold;
  128609. private _hdr;
  128610. /**
  128611. * The strength of the bloom.
  128612. */
  128613. bloomWeight: number;
  128614. /**
  128615. * The strength of the bloom.
  128616. */
  128617. bloomThreshold: number;
  128618. /**
  128619. * The scale of the bloom, lower value will provide better performance.
  128620. */
  128621. bloomScale: number;
  128622. /**
  128623. * Enable or disable the bloom from the pipeline
  128624. */
  128625. bloomEnabled: boolean;
  128626. private _rebuildBloom;
  128627. /**
  128628. * If the depth of field is enabled.
  128629. */
  128630. depthOfFieldEnabled: boolean;
  128631. /**
  128632. * Blur level of the depth of field effect. (Higher blur will effect performance)
  128633. */
  128634. depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel;
  128635. /**
  128636. * If the anti aliasing is enabled.
  128637. */
  128638. fxaaEnabled: boolean;
  128639. private _samples;
  128640. /**
  128641. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  128642. */
  128643. samples: number;
  128644. /**
  128645. * If image processing is enabled.
  128646. */
  128647. imageProcessingEnabled: boolean;
  128648. /**
  128649. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  128650. */
  128651. glowLayerEnabled: boolean;
  128652. /**
  128653. * Gets the glow layer (or null if not defined)
  128654. */
  128655. readonly glowLayer: Nullable<GlowLayer>;
  128656. /**
  128657. * Enable or disable the chromaticAberration process from the pipeline
  128658. */
  128659. chromaticAberrationEnabled: boolean;
  128660. /**
  128661. * Enable or disable the grain process from the pipeline
  128662. */
  128663. grainEnabled: boolean;
  128664. /**
  128665. * @constructor
  128666. * @param name - The rendering pipeline name (default: "")
  128667. * @param hdr - If high dynamic range textures should be used (default: true)
  128668. * @param scene - The scene linked to this pipeline (default: the last created scene)
  128669. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  128670. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  128671. */
  128672. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  128673. /**
  128674. * Get the class name
  128675. * @returns "DefaultRenderingPipeline"
  128676. */
  128677. getClassName(): string;
  128678. /**
  128679. * Force the compilation of the entire pipeline.
  128680. */
  128681. prepare(): void;
  128682. private _hasCleared;
  128683. private _prevPostProcess;
  128684. private _prevPrevPostProcess;
  128685. private _setAutoClearAndTextureSharing;
  128686. private _depthOfFieldSceneObserver;
  128687. private _buildPipeline;
  128688. private _disposePostProcesses;
  128689. /**
  128690. * Adds a camera to the pipeline
  128691. * @param camera the camera to be added
  128692. */
  128693. addCamera(camera: Camera): void;
  128694. /**
  128695. * Removes a camera from the pipeline
  128696. * @param camera the camera to remove
  128697. */
  128698. removeCamera(camera: Camera): void;
  128699. /**
  128700. * Dispose of the pipeline and stop all post processes
  128701. */
  128702. dispose(): void;
  128703. /**
  128704. * Serialize the rendering pipeline (Used when exporting)
  128705. * @returns the serialized object
  128706. */
  128707. serialize(): any;
  128708. /**
  128709. * Parse the serialized pipeline
  128710. * @param source Source pipeline.
  128711. * @param scene The scene to load the pipeline to.
  128712. * @param rootUrl The URL of the serialized pipeline.
  128713. * @returns An instantiated pipeline from the serialized object.
  128714. */
  128715. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  128716. }
  128717. }
  128718. declare module BABYLON {
  128719. /** @hidden */
  128720. export var lensHighlightsPixelShader: {
  128721. name: string;
  128722. shader: string;
  128723. };
  128724. }
  128725. declare module BABYLON {
  128726. /** @hidden */
  128727. export var depthOfFieldPixelShader: {
  128728. name: string;
  128729. shader: string;
  128730. };
  128731. }
  128732. declare module BABYLON {
  128733. /**
  128734. * BABYLON.JS Chromatic Aberration GLSL Shader
  128735. * Author: Olivier Guyot
  128736. * Separates very slightly R, G and B colors on the edges of the screen
  128737. * Inspired by Francois Tarlier & Martins Upitis
  128738. */
  128739. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  128740. /**
  128741. * @ignore
  128742. * The chromatic aberration PostProcess id in the pipeline
  128743. */
  128744. LensChromaticAberrationEffect: string;
  128745. /**
  128746. * @ignore
  128747. * The highlights enhancing PostProcess id in the pipeline
  128748. */
  128749. HighlightsEnhancingEffect: string;
  128750. /**
  128751. * @ignore
  128752. * The depth-of-field PostProcess id in the pipeline
  128753. */
  128754. LensDepthOfFieldEffect: string;
  128755. private _scene;
  128756. private _depthTexture;
  128757. private _grainTexture;
  128758. private _chromaticAberrationPostProcess;
  128759. private _highlightsPostProcess;
  128760. private _depthOfFieldPostProcess;
  128761. private _edgeBlur;
  128762. private _grainAmount;
  128763. private _chromaticAberration;
  128764. private _distortion;
  128765. private _highlightsGain;
  128766. private _highlightsThreshold;
  128767. private _dofDistance;
  128768. private _dofAperture;
  128769. private _dofDarken;
  128770. private _dofPentagon;
  128771. private _blurNoise;
  128772. /**
  128773. * @constructor
  128774. *
  128775. * Effect parameters are as follow:
  128776. * {
  128777. * chromatic_aberration: number; // from 0 to x (1 for realism)
  128778. * edge_blur: number; // from 0 to x (1 for realism)
  128779. * distortion: number; // from 0 to x (1 for realism)
  128780. * grain_amount: number; // from 0 to 1
  128781. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  128782. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  128783. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  128784. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  128785. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  128786. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  128787. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  128788. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  128789. * }
  128790. * Note: if an effect parameter is unset, effect is disabled
  128791. *
  128792. * @param name The rendering pipeline name
  128793. * @param parameters - An object containing all parameters (see above)
  128794. * @param scene The scene linked to this pipeline
  128795. * @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)
  128796. * @param cameras The array of cameras that the rendering pipeline will be attached to
  128797. */
  128798. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  128799. /**
  128800. * Get the class name
  128801. * @returns "LensRenderingPipeline"
  128802. */
  128803. getClassName(): string;
  128804. /**
  128805. * Gets associated scene
  128806. */
  128807. readonly scene: Scene;
  128808. /**
  128809. * Gets or sets the edge blur
  128810. */
  128811. edgeBlur: number;
  128812. /**
  128813. * Gets or sets the grain amount
  128814. */
  128815. grainAmount: number;
  128816. /**
  128817. * Gets or sets the chromatic aberration amount
  128818. */
  128819. chromaticAberration: number;
  128820. /**
  128821. * Gets or sets the depth of field aperture
  128822. */
  128823. dofAperture: number;
  128824. /**
  128825. * Gets or sets the edge distortion
  128826. */
  128827. edgeDistortion: number;
  128828. /**
  128829. * Gets or sets the depth of field distortion
  128830. */
  128831. dofDistortion: number;
  128832. /**
  128833. * Gets or sets the darken out of focus amount
  128834. */
  128835. darkenOutOfFocus: number;
  128836. /**
  128837. * Gets or sets a boolean indicating if blur noise is enabled
  128838. */
  128839. blurNoise: boolean;
  128840. /**
  128841. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  128842. */
  128843. pentagonBokeh: boolean;
  128844. /**
  128845. * Gets or sets the highlight grain amount
  128846. */
  128847. highlightsGain: number;
  128848. /**
  128849. * Gets or sets the highlight threshold
  128850. */
  128851. highlightsThreshold: number;
  128852. /**
  128853. * Sets the amount of blur at the edges
  128854. * @param amount blur amount
  128855. */
  128856. setEdgeBlur(amount: number): void;
  128857. /**
  128858. * Sets edge blur to 0
  128859. */
  128860. disableEdgeBlur(): void;
  128861. /**
  128862. * Sets the amout of grain
  128863. * @param amount Amount of grain
  128864. */
  128865. setGrainAmount(amount: number): void;
  128866. /**
  128867. * Set grain amount to 0
  128868. */
  128869. disableGrain(): void;
  128870. /**
  128871. * Sets the chromatic aberration amount
  128872. * @param amount amount of chromatic aberration
  128873. */
  128874. setChromaticAberration(amount: number): void;
  128875. /**
  128876. * Sets chromatic aberration amount to 0
  128877. */
  128878. disableChromaticAberration(): void;
  128879. /**
  128880. * Sets the EdgeDistortion amount
  128881. * @param amount amount of EdgeDistortion
  128882. */
  128883. setEdgeDistortion(amount: number): void;
  128884. /**
  128885. * Sets edge distortion to 0
  128886. */
  128887. disableEdgeDistortion(): void;
  128888. /**
  128889. * Sets the FocusDistance amount
  128890. * @param amount amount of FocusDistance
  128891. */
  128892. setFocusDistance(amount: number): void;
  128893. /**
  128894. * Disables depth of field
  128895. */
  128896. disableDepthOfField(): void;
  128897. /**
  128898. * Sets the Aperture amount
  128899. * @param amount amount of Aperture
  128900. */
  128901. setAperture(amount: number): void;
  128902. /**
  128903. * Sets the DarkenOutOfFocus amount
  128904. * @param amount amount of DarkenOutOfFocus
  128905. */
  128906. setDarkenOutOfFocus(amount: number): void;
  128907. private _pentagonBokehIsEnabled;
  128908. /**
  128909. * Creates a pentagon bokeh effect
  128910. */
  128911. enablePentagonBokeh(): void;
  128912. /**
  128913. * Disables the pentagon bokeh effect
  128914. */
  128915. disablePentagonBokeh(): void;
  128916. /**
  128917. * Enables noise blur
  128918. */
  128919. enableNoiseBlur(): void;
  128920. /**
  128921. * Disables noise blur
  128922. */
  128923. disableNoiseBlur(): void;
  128924. /**
  128925. * Sets the HighlightsGain amount
  128926. * @param amount amount of HighlightsGain
  128927. */
  128928. setHighlightsGain(amount: number): void;
  128929. /**
  128930. * Sets the HighlightsThreshold amount
  128931. * @param amount amount of HighlightsThreshold
  128932. */
  128933. setHighlightsThreshold(amount: number): void;
  128934. /**
  128935. * Disables highlights
  128936. */
  128937. disableHighlights(): void;
  128938. /**
  128939. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  128940. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  128941. */
  128942. dispose(disableDepthRender?: boolean): void;
  128943. private _createChromaticAberrationPostProcess;
  128944. private _createHighlightsPostProcess;
  128945. private _createDepthOfFieldPostProcess;
  128946. private _createGrainTexture;
  128947. }
  128948. }
  128949. declare module BABYLON {
  128950. /** @hidden */
  128951. export var ssao2PixelShader: {
  128952. name: string;
  128953. shader: string;
  128954. };
  128955. }
  128956. declare module BABYLON {
  128957. /** @hidden */
  128958. export var ssaoCombinePixelShader: {
  128959. name: string;
  128960. shader: string;
  128961. };
  128962. }
  128963. declare module BABYLON {
  128964. /**
  128965. * Render pipeline to produce ssao effect
  128966. */
  128967. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  128968. /**
  128969. * @ignore
  128970. * The PassPostProcess id in the pipeline that contains the original scene color
  128971. */
  128972. SSAOOriginalSceneColorEffect: string;
  128973. /**
  128974. * @ignore
  128975. * The SSAO PostProcess id in the pipeline
  128976. */
  128977. SSAORenderEffect: string;
  128978. /**
  128979. * @ignore
  128980. * The horizontal blur PostProcess id in the pipeline
  128981. */
  128982. SSAOBlurHRenderEffect: string;
  128983. /**
  128984. * @ignore
  128985. * The vertical blur PostProcess id in the pipeline
  128986. */
  128987. SSAOBlurVRenderEffect: string;
  128988. /**
  128989. * @ignore
  128990. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  128991. */
  128992. SSAOCombineRenderEffect: string;
  128993. /**
  128994. * The output strength of the SSAO post-process. Default value is 1.0.
  128995. */
  128996. totalStrength: number;
  128997. /**
  128998. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  128999. */
  129000. maxZ: number;
  129001. /**
  129002. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  129003. */
  129004. minZAspect: number;
  129005. private _samples;
  129006. /**
  129007. * Number of samples used for the SSAO calculations. Default value is 8
  129008. */
  129009. samples: number;
  129010. private _textureSamples;
  129011. /**
  129012. * Number of samples to use for antialiasing
  129013. */
  129014. textureSamples: number;
  129015. /**
  129016. * Ratio object used for SSAO ratio and blur ratio
  129017. */
  129018. private _ratio;
  129019. /**
  129020. * Dynamically generated sphere sampler.
  129021. */
  129022. private _sampleSphere;
  129023. /**
  129024. * Blur filter offsets
  129025. */
  129026. private _samplerOffsets;
  129027. private _expensiveBlur;
  129028. /**
  129029. * If bilateral blur should be used
  129030. */
  129031. expensiveBlur: boolean;
  129032. /**
  129033. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  129034. */
  129035. radius: number;
  129036. /**
  129037. * The base color of the SSAO post-process
  129038. * The final result is "base + ssao" between [0, 1]
  129039. */
  129040. base: number;
  129041. /**
  129042. * Support test.
  129043. */
  129044. static readonly IsSupported: boolean;
  129045. private _scene;
  129046. private _depthTexture;
  129047. private _normalTexture;
  129048. private _randomTexture;
  129049. private _originalColorPostProcess;
  129050. private _ssaoPostProcess;
  129051. private _blurHPostProcess;
  129052. private _blurVPostProcess;
  129053. private _ssaoCombinePostProcess;
  129054. private _firstUpdate;
  129055. /**
  129056. * Gets active scene
  129057. */
  129058. readonly scene: Scene;
  129059. /**
  129060. * @constructor
  129061. * @param name The rendering pipeline name
  129062. * @param scene The scene linked to this pipeline
  129063. * @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 }
  129064. * @param cameras The array of cameras that the rendering pipeline will be attached to
  129065. */
  129066. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  129067. /**
  129068. * Get the class name
  129069. * @returns "SSAO2RenderingPipeline"
  129070. */
  129071. getClassName(): string;
  129072. /**
  129073. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  129074. */
  129075. dispose(disableGeometryBufferRenderer?: boolean): void;
  129076. private _createBlurPostProcess;
  129077. /** @hidden */
  129078. _rebuild(): void;
  129079. private _bits;
  129080. private _radicalInverse_VdC;
  129081. private _hammersley;
  129082. private _hemisphereSample_uniform;
  129083. private _generateHemisphere;
  129084. private _createSSAOPostProcess;
  129085. private _createSSAOCombinePostProcess;
  129086. private _createRandomTexture;
  129087. /**
  129088. * Serialize the rendering pipeline (Used when exporting)
  129089. * @returns the serialized object
  129090. */
  129091. serialize(): any;
  129092. /**
  129093. * Parse the serialized pipeline
  129094. * @param source Source pipeline.
  129095. * @param scene The scene to load the pipeline to.
  129096. * @param rootUrl The URL of the serialized pipeline.
  129097. * @returns An instantiated pipeline from the serialized object.
  129098. */
  129099. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  129100. }
  129101. }
  129102. declare module BABYLON {
  129103. /** @hidden */
  129104. export var ssaoPixelShader: {
  129105. name: string;
  129106. shader: string;
  129107. };
  129108. }
  129109. declare module BABYLON {
  129110. /**
  129111. * Render pipeline to produce ssao effect
  129112. */
  129113. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  129114. /**
  129115. * @ignore
  129116. * The PassPostProcess id in the pipeline that contains the original scene color
  129117. */
  129118. SSAOOriginalSceneColorEffect: string;
  129119. /**
  129120. * @ignore
  129121. * The SSAO PostProcess id in the pipeline
  129122. */
  129123. SSAORenderEffect: string;
  129124. /**
  129125. * @ignore
  129126. * The horizontal blur PostProcess id in the pipeline
  129127. */
  129128. SSAOBlurHRenderEffect: string;
  129129. /**
  129130. * @ignore
  129131. * The vertical blur PostProcess id in the pipeline
  129132. */
  129133. SSAOBlurVRenderEffect: string;
  129134. /**
  129135. * @ignore
  129136. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  129137. */
  129138. SSAOCombineRenderEffect: string;
  129139. /**
  129140. * The output strength of the SSAO post-process. Default value is 1.0.
  129141. */
  129142. totalStrength: number;
  129143. /**
  129144. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  129145. */
  129146. radius: number;
  129147. /**
  129148. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  129149. * Must not be equal to fallOff and superior to fallOff.
  129150. * Default value is 0.0075
  129151. */
  129152. area: number;
  129153. /**
  129154. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  129155. * Must not be equal to area and inferior to area.
  129156. * Default value is 0.000001
  129157. */
  129158. fallOff: number;
  129159. /**
  129160. * The base color of the SSAO post-process
  129161. * The final result is "base + ssao" between [0, 1]
  129162. */
  129163. base: number;
  129164. private _scene;
  129165. private _depthTexture;
  129166. private _randomTexture;
  129167. private _originalColorPostProcess;
  129168. private _ssaoPostProcess;
  129169. private _blurHPostProcess;
  129170. private _blurVPostProcess;
  129171. private _ssaoCombinePostProcess;
  129172. private _firstUpdate;
  129173. /**
  129174. * Gets active scene
  129175. */
  129176. readonly scene: Scene;
  129177. /**
  129178. * @constructor
  129179. * @param name - The rendering pipeline name
  129180. * @param scene - The scene linked to this pipeline
  129181. * @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 }
  129182. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  129183. */
  129184. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  129185. /**
  129186. * Get the class name
  129187. * @returns "SSAORenderingPipeline"
  129188. */
  129189. getClassName(): string;
  129190. /**
  129191. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  129192. */
  129193. dispose(disableDepthRender?: boolean): void;
  129194. private _createBlurPostProcess;
  129195. /** @hidden */
  129196. _rebuild(): void;
  129197. private _createSSAOPostProcess;
  129198. private _createSSAOCombinePostProcess;
  129199. private _createRandomTexture;
  129200. }
  129201. }
  129202. declare module BABYLON {
  129203. /** @hidden */
  129204. export var standardPixelShader: {
  129205. name: string;
  129206. shader: string;
  129207. };
  129208. }
  129209. declare module BABYLON {
  129210. /**
  129211. * Standard rendering pipeline
  129212. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  129213. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  129214. */
  129215. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  129216. /**
  129217. * Public members
  129218. */
  129219. /**
  129220. * Post-process which contains the original scene color before the pipeline applies all the effects
  129221. */
  129222. originalPostProcess: Nullable<PostProcess>;
  129223. /**
  129224. * Post-process used to down scale an image x4
  129225. */
  129226. downSampleX4PostProcess: Nullable<PostProcess>;
  129227. /**
  129228. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  129229. */
  129230. brightPassPostProcess: Nullable<PostProcess>;
  129231. /**
  129232. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  129233. */
  129234. blurHPostProcesses: PostProcess[];
  129235. /**
  129236. * Post-process array storing all the vertical blur post-processes used by the pipeline
  129237. */
  129238. blurVPostProcesses: PostProcess[];
  129239. /**
  129240. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  129241. */
  129242. textureAdderPostProcess: Nullable<PostProcess>;
  129243. /**
  129244. * Post-process used to create volumetric lighting effect
  129245. */
  129246. volumetricLightPostProcess: Nullable<PostProcess>;
  129247. /**
  129248. * Post-process used to smooth the previous volumetric light post-process on the X axis
  129249. */
  129250. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  129251. /**
  129252. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  129253. */
  129254. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  129255. /**
  129256. * Post-process used to merge the volumetric light effect and the real scene color
  129257. */
  129258. volumetricLightMergePostProces: Nullable<PostProcess>;
  129259. /**
  129260. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  129261. */
  129262. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  129263. /**
  129264. * Base post-process used to calculate the average luminance of the final image for HDR
  129265. */
  129266. luminancePostProcess: Nullable<PostProcess>;
  129267. /**
  129268. * Post-processes used to create down sample post-processes in order to get
  129269. * the average luminance of the final image for HDR
  129270. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  129271. */
  129272. luminanceDownSamplePostProcesses: PostProcess[];
  129273. /**
  129274. * Post-process used to create a HDR effect (light adaptation)
  129275. */
  129276. hdrPostProcess: Nullable<PostProcess>;
  129277. /**
  129278. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  129279. */
  129280. textureAdderFinalPostProcess: Nullable<PostProcess>;
  129281. /**
  129282. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  129283. */
  129284. lensFlareFinalPostProcess: Nullable<PostProcess>;
  129285. /**
  129286. * Post-process used to merge the final HDR post-process and the real scene color
  129287. */
  129288. hdrFinalPostProcess: Nullable<PostProcess>;
  129289. /**
  129290. * Post-process used to create a lens flare effect
  129291. */
  129292. lensFlarePostProcess: Nullable<PostProcess>;
  129293. /**
  129294. * Post-process that merges the result of the lens flare post-process and the real scene color
  129295. */
  129296. lensFlareComposePostProcess: Nullable<PostProcess>;
  129297. /**
  129298. * Post-process used to create a motion blur effect
  129299. */
  129300. motionBlurPostProcess: Nullable<PostProcess>;
  129301. /**
  129302. * Post-process used to create a depth of field effect
  129303. */
  129304. depthOfFieldPostProcess: Nullable<PostProcess>;
  129305. /**
  129306. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  129307. */
  129308. fxaaPostProcess: Nullable<FxaaPostProcess>;
  129309. /**
  129310. * Represents the brightness threshold in order to configure the illuminated surfaces
  129311. */
  129312. brightThreshold: number;
  129313. /**
  129314. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  129315. */
  129316. blurWidth: number;
  129317. /**
  129318. * Sets if the blur for highlighted surfaces must be only horizontal
  129319. */
  129320. horizontalBlur: boolean;
  129321. /**
  129322. * Gets the overall exposure used by the pipeline
  129323. */
  129324. /**
  129325. * Sets the overall exposure used by the pipeline
  129326. */
  129327. exposure: number;
  129328. /**
  129329. * Texture used typically to simulate "dirty" on camera lens
  129330. */
  129331. lensTexture: Nullable<Texture>;
  129332. /**
  129333. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  129334. */
  129335. volumetricLightCoefficient: number;
  129336. /**
  129337. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  129338. */
  129339. volumetricLightPower: number;
  129340. /**
  129341. * Used the set the blur intensity to smooth the volumetric lights
  129342. */
  129343. volumetricLightBlurScale: number;
  129344. /**
  129345. * Light (spot or directional) used to generate the volumetric lights rays
  129346. * The source light must have a shadow generate so the pipeline can get its
  129347. * depth map
  129348. */
  129349. sourceLight: Nullable<SpotLight | DirectionalLight>;
  129350. /**
  129351. * For eye adaptation, represents the minimum luminance the eye can see
  129352. */
  129353. hdrMinimumLuminance: number;
  129354. /**
  129355. * For eye adaptation, represents the decrease luminance speed
  129356. */
  129357. hdrDecreaseRate: number;
  129358. /**
  129359. * For eye adaptation, represents the increase luminance speed
  129360. */
  129361. hdrIncreaseRate: number;
  129362. /**
  129363. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  129364. */
  129365. /**
  129366. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  129367. */
  129368. hdrAutoExposure: boolean;
  129369. /**
  129370. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  129371. */
  129372. lensColorTexture: Nullable<Texture>;
  129373. /**
  129374. * The overall strengh for the lens flare effect
  129375. */
  129376. lensFlareStrength: number;
  129377. /**
  129378. * Dispersion coefficient for lens flare ghosts
  129379. */
  129380. lensFlareGhostDispersal: number;
  129381. /**
  129382. * Main lens flare halo width
  129383. */
  129384. lensFlareHaloWidth: number;
  129385. /**
  129386. * Based on the lens distortion effect, defines how much the lens flare result
  129387. * is distorted
  129388. */
  129389. lensFlareDistortionStrength: number;
  129390. /**
  129391. * Configures the blur intensity used for for lens flare (halo)
  129392. */
  129393. lensFlareBlurWidth: number;
  129394. /**
  129395. * Lens star texture must be used to simulate rays on the flares and is available
  129396. * in the documentation
  129397. */
  129398. lensStarTexture: Nullable<Texture>;
  129399. /**
  129400. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  129401. * flare effect by taking account of the dirt texture
  129402. */
  129403. lensFlareDirtTexture: Nullable<Texture>;
  129404. /**
  129405. * Represents the focal length for the depth of field effect
  129406. */
  129407. depthOfFieldDistance: number;
  129408. /**
  129409. * Represents the blur intensity for the blurred part of the depth of field effect
  129410. */
  129411. depthOfFieldBlurWidth: number;
  129412. /**
  129413. * Gets how much the image is blurred by the movement while using the motion blur post-process
  129414. */
  129415. /**
  129416. * Sets how much the image is blurred by the movement while using the motion blur post-process
  129417. */
  129418. motionStrength: number;
  129419. /**
  129420. * Gets wether or not the motion blur post-process is object based or screen based.
  129421. */
  129422. /**
  129423. * Sets wether or not the motion blur post-process should be object based or screen based
  129424. */
  129425. objectBasedMotionBlur: boolean;
  129426. /**
  129427. * List of animations for the pipeline (IAnimatable implementation)
  129428. */
  129429. animations: Animation[];
  129430. /**
  129431. * Private members
  129432. */
  129433. private _scene;
  129434. private _currentDepthOfFieldSource;
  129435. private _basePostProcess;
  129436. private _fixedExposure;
  129437. private _currentExposure;
  129438. private _hdrAutoExposure;
  129439. private _hdrCurrentLuminance;
  129440. private _motionStrength;
  129441. private _isObjectBasedMotionBlur;
  129442. private _floatTextureType;
  129443. private _camerasToBeAttached;
  129444. private _ratio;
  129445. private _bloomEnabled;
  129446. private _depthOfFieldEnabled;
  129447. private _vlsEnabled;
  129448. private _lensFlareEnabled;
  129449. private _hdrEnabled;
  129450. private _motionBlurEnabled;
  129451. private _fxaaEnabled;
  129452. private _motionBlurSamples;
  129453. private _volumetricLightStepsCount;
  129454. private _samples;
  129455. /**
  129456. * @ignore
  129457. * Specifies if the bloom pipeline is enabled
  129458. */
  129459. BloomEnabled: boolean;
  129460. /**
  129461. * @ignore
  129462. * Specifies if the depth of field pipeline is enabed
  129463. */
  129464. DepthOfFieldEnabled: boolean;
  129465. /**
  129466. * @ignore
  129467. * Specifies if the lens flare pipeline is enabed
  129468. */
  129469. LensFlareEnabled: boolean;
  129470. /**
  129471. * @ignore
  129472. * Specifies if the HDR pipeline is enabled
  129473. */
  129474. HDREnabled: boolean;
  129475. /**
  129476. * @ignore
  129477. * Specifies if the volumetric lights scattering effect is enabled
  129478. */
  129479. VLSEnabled: boolean;
  129480. /**
  129481. * @ignore
  129482. * Specifies if the motion blur effect is enabled
  129483. */
  129484. MotionBlurEnabled: boolean;
  129485. /**
  129486. * Specifies if anti-aliasing is enabled
  129487. */
  129488. fxaaEnabled: boolean;
  129489. /**
  129490. * Specifies the number of steps used to calculate the volumetric lights
  129491. * Typically in interval [50, 200]
  129492. */
  129493. volumetricLightStepsCount: number;
  129494. /**
  129495. * Specifies the number of samples used for the motion blur effect
  129496. * Typically in interval [16, 64]
  129497. */
  129498. motionBlurSamples: number;
  129499. /**
  129500. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  129501. */
  129502. samples: number;
  129503. /**
  129504. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  129505. * @constructor
  129506. * @param name The rendering pipeline name
  129507. * @param scene The scene linked to this pipeline
  129508. * @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)
  129509. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  129510. * @param cameras The array of cameras that the rendering pipeline will be attached to
  129511. */
  129512. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  129513. private _buildPipeline;
  129514. private _createDownSampleX4PostProcess;
  129515. private _createBrightPassPostProcess;
  129516. private _createBlurPostProcesses;
  129517. private _createTextureAdderPostProcess;
  129518. private _createVolumetricLightPostProcess;
  129519. private _createLuminancePostProcesses;
  129520. private _createHdrPostProcess;
  129521. private _createLensFlarePostProcess;
  129522. private _createDepthOfFieldPostProcess;
  129523. private _createMotionBlurPostProcess;
  129524. private _getDepthTexture;
  129525. private _disposePostProcesses;
  129526. /**
  129527. * Dispose of the pipeline and stop all post processes
  129528. */
  129529. dispose(): void;
  129530. /**
  129531. * Serialize the rendering pipeline (Used when exporting)
  129532. * @returns the serialized object
  129533. */
  129534. serialize(): any;
  129535. /**
  129536. * Parse the serialized pipeline
  129537. * @param source Source pipeline.
  129538. * @param scene The scene to load the pipeline to.
  129539. * @param rootUrl The URL of the serialized pipeline.
  129540. * @returns An instantiated pipeline from the serialized object.
  129541. */
  129542. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  129543. /**
  129544. * Luminance steps
  129545. */
  129546. static LuminanceSteps: number;
  129547. }
  129548. }
  129549. declare module BABYLON {
  129550. /** @hidden */
  129551. export var tonemapPixelShader: {
  129552. name: string;
  129553. shader: string;
  129554. };
  129555. }
  129556. declare module BABYLON {
  129557. /** Defines operator used for tonemapping */
  129558. export enum TonemappingOperator {
  129559. /** Hable */
  129560. Hable = 0,
  129561. /** Reinhard */
  129562. Reinhard = 1,
  129563. /** HejiDawson */
  129564. HejiDawson = 2,
  129565. /** Photographic */
  129566. Photographic = 3
  129567. }
  129568. /**
  129569. * Defines a post process to apply tone mapping
  129570. */
  129571. export class TonemapPostProcess extends PostProcess {
  129572. private _operator;
  129573. /** Defines the required exposure adjustement */
  129574. exposureAdjustment: number;
  129575. /**
  129576. * Creates a new TonemapPostProcess
  129577. * @param name defines the name of the postprocess
  129578. * @param _operator defines the operator to use
  129579. * @param exposureAdjustment defines the required exposure adjustement
  129580. * @param camera defines the camera to use (can be null)
  129581. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  129582. * @param engine defines the hosting engine (can be ignore if camera is set)
  129583. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  129584. */
  129585. constructor(name: string, _operator: TonemappingOperator,
  129586. /** Defines the required exposure adjustement */
  129587. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  129588. }
  129589. }
  129590. declare module BABYLON {
  129591. /** @hidden */
  129592. export var depthVertexShader: {
  129593. name: string;
  129594. shader: string;
  129595. };
  129596. }
  129597. declare module BABYLON {
  129598. /** @hidden */
  129599. export var volumetricLightScatteringPixelShader: {
  129600. name: string;
  129601. shader: string;
  129602. };
  129603. }
  129604. declare module BABYLON {
  129605. /** @hidden */
  129606. export var volumetricLightScatteringPassVertexShader: {
  129607. name: string;
  129608. shader: string;
  129609. };
  129610. }
  129611. declare module BABYLON {
  129612. /** @hidden */
  129613. export var volumetricLightScatteringPassPixelShader: {
  129614. name: string;
  129615. shader: string;
  129616. };
  129617. }
  129618. declare module BABYLON {
  129619. /**
  129620. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  129621. */
  129622. export class VolumetricLightScatteringPostProcess extends PostProcess {
  129623. private _volumetricLightScatteringPass;
  129624. private _volumetricLightScatteringRTT;
  129625. private _viewPort;
  129626. private _screenCoordinates;
  129627. private _cachedDefines;
  129628. /**
  129629. * If not undefined, the mesh position is computed from the attached node position
  129630. */
  129631. attachedNode: {
  129632. position: Vector3;
  129633. };
  129634. /**
  129635. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  129636. */
  129637. customMeshPosition: Vector3;
  129638. /**
  129639. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  129640. */
  129641. useCustomMeshPosition: boolean;
  129642. /**
  129643. * If the post-process should inverse the light scattering direction
  129644. */
  129645. invert: boolean;
  129646. /**
  129647. * The internal mesh used by the post-process
  129648. */
  129649. mesh: Mesh;
  129650. /**
  129651. * @hidden
  129652. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  129653. */
  129654. useDiffuseColor: boolean;
  129655. /**
  129656. * Array containing the excluded meshes not rendered in the internal pass
  129657. */
  129658. excludedMeshes: AbstractMesh[];
  129659. /**
  129660. * Controls the overall intensity of the post-process
  129661. */
  129662. exposure: number;
  129663. /**
  129664. * Dissipates each sample's contribution in range [0, 1]
  129665. */
  129666. decay: number;
  129667. /**
  129668. * Controls the overall intensity of each sample
  129669. */
  129670. weight: number;
  129671. /**
  129672. * Controls the density of each sample
  129673. */
  129674. density: number;
  129675. /**
  129676. * @constructor
  129677. * @param name The post-process name
  129678. * @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)
  129679. * @param camera The camera that the post-process will be attached to
  129680. * @param mesh The mesh used to create the light scattering
  129681. * @param samples The post-process quality, default 100
  129682. * @param samplingModeThe post-process filtering mode
  129683. * @param engine The babylon engine
  129684. * @param reusable If the post-process is reusable
  129685. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  129686. */
  129687. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  129688. /**
  129689. * Returns the string "VolumetricLightScatteringPostProcess"
  129690. * @returns "VolumetricLightScatteringPostProcess"
  129691. */
  129692. getClassName(): string;
  129693. private _isReady;
  129694. /**
  129695. * Sets the new light position for light scattering effect
  129696. * @param position The new custom light position
  129697. */
  129698. setCustomMeshPosition(position: Vector3): void;
  129699. /**
  129700. * Returns the light position for light scattering effect
  129701. * @return Vector3 The custom light position
  129702. */
  129703. getCustomMeshPosition(): Vector3;
  129704. /**
  129705. * Disposes the internal assets and detaches the post-process from the camera
  129706. */
  129707. dispose(camera: Camera): void;
  129708. /**
  129709. * Returns the render target texture used by the post-process
  129710. * @return the render target texture used by the post-process
  129711. */
  129712. getPass(): RenderTargetTexture;
  129713. private _meshExcluded;
  129714. private _createPass;
  129715. private _updateMeshScreenCoordinates;
  129716. /**
  129717. * Creates a default mesh for the Volumeric Light Scattering post-process
  129718. * @param name The mesh name
  129719. * @param scene The scene where to create the mesh
  129720. * @return the default mesh
  129721. */
  129722. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  129723. }
  129724. }
  129725. declare module BABYLON {
  129726. interface Scene {
  129727. /** @hidden (Backing field) */
  129728. _boundingBoxRenderer: BoundingBoxRenderer;
  129729. /** @hidden (Backing field) */
  129730. _forceShowBoundingBoxes: boolean;
  129731. /**
  129732. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  129733. */
  129734. forceShowBoundingBoxes: boolean;
  129735. /**
  129736. * Gets the bounding box renderer associated with the scene
  129737. * @returns a BoundingBoxRenderer
  129738. */
  129739. getBoundingBoxRenderer(): BoundingBoxRenderer;
  129740. }
  129741. interface AbstractMesh {
  129742. /** @hidden (Backing field) */
  129743. _showBoundingBox: boolean;
  129744. /**
  129745. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  129746. */
  129747. showBoundingBox: boolean;
  129748. }
  129749. /**
  129750. * Component responsible of rendering the bounding box of the meshes in a scene.
  129751. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  129752. */
  129753. export class BoundingBoxRenderer implements ISceneComponent {
  129754. /**
  129755. * The component name helpfull to identify the component in the list of scene components.
  129756. */
  129757. readonly name: string;
  129758. /**
  129759. * The scene the component belongs to.
  129760. */
  129761. scene: Scene;
  129762. /**
  129763. * Color of the bounding box lines placed in front of an object
  129764. */
  129765. frontColor: Color3;
  129766. /**
  129767. * Color of the bounding box lines placed behind an object
  129768. */
  129769. backColor: Color3;
  129770. /**
  129771. * Defines if the renderer should show the back lines or not
  129772. */
  129773. showBackLines: boolean;
  129774. /**
  129775. * @hidden
  129776. */
  129777. renderList: SmartArray<BoundingBox>;
  129778. private _colorShader;
  129779. private _vertexBuffers;
  129780. private _indexBuffer;
  129781. private _fillIndexBuffer;
  129782. private _fillIndexData;
  129783. /**
  129784. * Instantiates a new bounding box renderer in a scene.
  129785. * @param scene the scene the renderer renders in
  129786. */
  129787. constructor(scene: Scene);
  129788. /**
  129789. * Registers the component in a given scene
  129790. */
  129791. register(): void;
  129792. private _evaluateSubMesh;
  129793. private _activeMesh;
  129794. private _prepareRessources;
  129795. private _createIndexBuffer;
  129796. /**
  129797. * Rebuilds the elements related to this component in case of
  129798. * context lost for instance.
  129799. */
  129800. rebuild(): void;
  129801. /**
  129802. * @hidden
  129803. */
  129804. reset(): void;
  129805. /**
  129806. * Render the bounding boxes of a specific rendering group
  129807. * @param renderingGroupId defines the rendering group to render
  129808. */
  129809. render(renderingGroupId: number): void;
  129810. /**
  129811. * In case of occlusion queries, we can render the occlusion bounding box through this method
  129812. * @param mesh Define the mesh to render the occlusion bounding box for
  129813. */
  129814. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  129815. /**
  129816. * Dispose and release the resources attached to this renderer.
  129817. */
  129818. dispose(): void;
  129819. }
  129820. }
  129821. declare module BABYLON {
  129822. /** @hidden */
  129823. export var depthPixelShader: {
  129824. name: string;
  129825. shader: string;
  129826. };
  129827. }
  129828. declare module BABYLON {
  129829. /**
  129830. * This represents a depth renderer in Babylon.
  129831. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  129832. */
  129833. export class DepthRenderer {
  129834. private _scene;
  129835. private _depthMap;
  129836. private _effect;
  129837. private readonly _storeNonLinearDepth;
  129838. private readonly _clearColor;
  129839. /** Get if the depth renderer is using packed depth or not */
  129840. readonly isPacked: boolean;
  129841. private _cachedDefines;
  129842. private _camera;
  129843. /**
  129844. * Specifiess that the depth renderer will only be used within
  129845. * the camera it is created for.
  129846. * This can help forcing its rendering during the camera processing.
  129847. */
  129848. useOnlyInActiveCamera: boolean;
  129849. /** @hidden */
  129850. static _SceneComponentInitialization: (scene: Scene) => void;
  129851. /**
  129852. * Instantiates a depth renderer
  129853. * @param scene The scene the renderer belongs to
  129854. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  129855. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  129856. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  129857. */
  129858. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  129859. /**
  129860. * Creates the depth rendering effect and checks if the effect is ready.
  129861. * @param subMesh The submesh to be used to render the depth map of
  129862. * @param useInstances If multiple world instances should be used
  129863. * @returns if the depth renderer is ready to render the depth map
  129864. */
  129865. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  129866. /**
  129867. * Gets the texture which the depth map will be written to.
  129868. * @returns The depth map texture
  129869. */
  129870. getDepthMap(): RenderTargetTexture;
  129871. /**
  129872. * Disposes of the depth renderer.
  129873. */
  129874. dispose(): void;
  129875. }
  129876. }
  129877. declare module BABYLON {
  129878. interface Scene {
  129879. /** @hidden (Backing field) */
  129880. _depthRenderer: {
  129881. [id: string]: DepthRenderer;
  129882. };
  129883. /**
  129884. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  129885. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  129886. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  129887. * @returns the created depth renderer
  129888. */
  129889. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  129890. /**
  129891. * Disables a depth renderer for a given camera
  129892. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  129893. */
  129894. disableDepthRenderer(camera?: Nullable<Camera>): void;
  129895. }
  129896. /**
  129897. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  129898. * in several rendering techniques.
  129899. */
  129900. export class DepthRendererSceneComponent implements ISceneComponent {
  129901. /**
  129902. * The component name helpfull to identify the component in the list of scene components.
  129903. */
  129904. readonly name: string;
  129905. /**
  129906. * The scene the component belongs to.
  129907. */
  129908. scene: Scene;
  129909. /**
  129910. * Creates a new instance of the component for the given scene
  129911. * @param scene Defines the scene to register the component in
  129912. */
  129913. constructor(scene: Scene);
  129914. /**
  129915. * Registers the component in a given scene
  129916. */
  129917. register(): void;
  129918. /**
  129919. * Rebuilds the elements related to this component in case of
  129920. * context lost for instance.
  129921. */
  129922. rebuild(): void;
  129923. /**
  129924. * Disposes the component and the associated ressources
  129925. */
  129926. dispose(): void;
  129927. private _gatherRenderTargets;
  129928. private _gatherActiveCameraRenderTargets;
  129929. }
  129930. }
  129931. declare module BABYLON {
  129932. /** @hidden */
  129933. export var outlinePixelShader: {
  129934. name: string;
  129935. shader: string;
  129936. };
  129937. }
  129938. declare module BABYLON {
  129939. /** @hidden */
  129940. export var outlineVertexShader: {
  129941. name: string;
  129942. shader: string;
  129943. };
  129944. }
  129945. declare module BABYLON {
  129946. interface Scene {
  129947. /** @hidden */
  129948. _outlineRenderer: OutlineRenderer;
  129949. /**
  129950. * Gets the outline renderer associated with the scene
  129951. * @returns a OutlineRenderer
  129952. */
  129953. getOutlineRenderer(): OutlineRenderer;
  129954. }
  129955. interface AbstractMesh {
  129956. /** @hidden (Backing field) */
  129957. _renderOutline: boolean;
  129958. /**
  129959. * Gets or sets a boolean indicating if the outline must be rendered as well
  129960. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  129961. */
  129962. renderOutline: boolean;
  129963. /** @hidden (Backing field) */
  129964. _renderOverlay: boolean;
  129965. /**
  129966. * Gets or sets a boolean indicating if the overlay must be rendered as well
  129967. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  129968. */
  129969. renderOverlay: boolean;
  129970. }
  129971. /**
  129972. * This class is responsible to draw bothe outline/overlay of meshes.
  129973. * It should not be used directly but through the available method on mesh.
  129974. */
  129975. export class OutlineRenderer implements ISceneComponent {
  129976. /**
  129977. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  129978. */
  129979. private static _StencilReference;
  129980. /**
  129981. * The name of the component. Each component must have a unique name.
  129982. */
  129983. name: string;
  129984. /**
  129985. * The scene the component belongs to.
  129986. */
  129987. scene: Scene;
  129988. /**
  129989. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  129990. */
  129991. zOffset: number;
  129992. private _engine;
  129993. private _effect;
  129994. private _cachedDefines;
  129995. private _savedDepthWrite;
  129996. /**
  129997. * Instantiates a new outline renderer. (There could be only one per scene).
  129998. * @param scene Defines the scene it belongs to
  129999. */
  130000. constructor(scene: Scene);
  130001. /**
  130002. * Register the component to one instance of a scene.
  130003. */
  130004. register(): void;
  130005. /**
  130006. * Rebuilds the elements related to this component in case of
  130007. * context lost for instance.
  130008. */
  130009. rebuild(): void;
  130010. /**
  130011. * Disposes the component and the associated ressources.
  130012. */
  130013. dispose(): void;
  130014. /**
  130015. * Renders the outline in the canvas.
  130016. * @param subMesh Defines the sumesh to render
  130017. * @param batch Defines the batch of meshes in case of instances
  130018. * @param useOverlay Defines if the rendering is for the overlay or the outline
  130019. */
  130020. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  130021. /**
  130022. * Returns whether or not the outline renderer is ready for a given submesh.
  130023. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  130024. * @param subMesh Defines the submesh to check readyness for
  130025. * @param useInstances Defines wheter wee are trying to render instances or not
  130026. * @returns true if ready otherwise false
  130027. */
  130028. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  130029. private _beforeRenderingMesh;
  130030. private _afterRenderingMesh;
  130031. }
  130032. }
  130033. declare module BABYLON {
  130034. /**
  130035. * Class used to manage multiple sprites of different sizes on the same spritesheet
  130036. * @see http://doc.babylonjs.com/babylon101/sprites
  130037. */
  130038. export class SpritePackedManager extends SpriteManager {
  130039. /** defines the packed manager's name */
  130040. name: string;
  130041. /**
  130042. * Creates a new sprite manager from a packed sprite sheet
  130043. * @param name defines the manager's name
  130044. * @param imgUrl defines the sprite sheet url
  130045. * @param capacity defines the maximum allowed number of sprites
  130046. * @param scene defines the hosting scene
  130047. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  130048. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  130049. * @param samplingMode defines the smapling mode to use with spritesheet
  130050. * @param fromPacked set to true; do not alter
  130051. */
  130052. constructor(
  130053. /** defines the packed manager's name */
  130054. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  130055. }
  130056. }
  130057. declare module BABYLON {
  130058. /**
  130059. * Defines the list of states available for a task inside a AssetsManager
  130060. */
  130061. export enum AssetTaskState {
  130062. /**
  130063. * Initialization
  130064. */
  130065. INIT = 0,
  130066. /**
  130067. * Running
  130068. */
  130069. RUNNING = 1,
  130070. /**
  130071. * Done
  130072. */
  130073. DONE = 2,
  130074. /**
  130075. * Error
  130076. */
  130077. ERROR = 3
  130078. }
  130079. /**
  130080. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  130081. */
  130082. export abstract class AbstractAssetTask {
  130083. /**
  130084. * Task name
  130085. */ name: string;
  130086. /**
  130087. * Callback called when the task is successful
  130088. */
  130089. onSuccess: (task: any) => void;
  130090. /**
  130091. * Callback called when the task is not successful
  130092. */
  130093. onError: (task: any, message?: string, exception?: any) => void;
  130094. /**
  130095. * Creates a new AssetsManager
  130096. * @param name defines the name of the task
  130097. */
  130098. constructor(
  130099. /**
  130100. * Task name
  130101. */ name: string);
  130102. private _isCompleted;
  130103. private _taskState;
  130104. private _errorObject;
  130105. /**
  130106. * Get if the task is completed
  130107. */
  130108. readonly isCompleted: boolean;
  130109. /**
  130110. * Gets the current state of the task
  130111. */
  130112. readonly taskState: AssetTaskState;
  130113. /**
  130114. * Gets the current error object (if task is in error)
  130115. */
  130116. readonly errorObject: {
  130117. message?: string;
  130118. exception?: any;
  130119. };
  130120. /**
  130121. * Internal only
  130122. * @hidden
  130123. */
  130124. _setErrorObject(message?: string, exception?: any): void;
  130125. /**
  130126. * Execute the current task
  130127. * @param scene defines the scene where you want your assets to be loaded
  130128. * @param onSuccess is a callback called when the task is successfully executed
  130129. * @param onError is a callback called if an error occurs
  130130. */
  130131. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130132. /**
  130133. * Execute the current task
  130134. * @param scene defines the scene where you want your assets to be loaded
  130135. * @param onSuccess is a callback called when the task is successfully executed
  130136. * @param onError is a callback called if an error occurs
  130137. */
  130138. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130139. /**
  130140. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  130141. * This can be used with failed tasks that have the reason for failure fixed.
  130142. */
  130143. reset(): void;
  130144. private onErrorCallback;
  130145. private onDoneCallback;
  130146. }
  130147. /**
  130148. * Define the interface used by progress events raised during assets loading
  130149. */
  130150. export interface IAssetsProgressEvent {
  130151. /**
  130152. * Defines the number of remaining tasks to process
  130153. */
  130154. remainingCount: number;
  130155. /**
  130156. * Defines the total number of tasks
  130157. */
  130158. totalCount: number;
  130159. /**
  130160. * Defines the task that was just processed
  130161. */
  130162. task: AbstractAssetTask;
  130163. }
  130164. /**
  130165. * Class used to share progress information about assets loading
  130166. */
  130167. export class AssetsProgressEvent implements IAssetsProgressEvent {
  130168. /**
  130169. * Defines the number of remaining tasks to process
  130170. */
  130171. remainingCount: number;
  130172. /**
  130173. * Defines the total number of tasks
  130174. */
  130175. totalCount: number;
  130176. /**
  130177. * Defines the task that was just processed
  130178. */
  130179. task: AbstractAssetTask;
  130180. /**
  130181. * Creates a AssetsProgressEvent
  130182. * @param remainingCount defines the number of remaining tasks to process
  130183. * @param totalCount defines the total number of tasks
  130184. * @param task defines the task that was just processed
  130185. */
  130186. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  130187. }
  130188. /**
  130189. * Define a task used by AssetsManager to load meshes
  130190. */
  130191. export class MeshAssetTask extends AbstractAssetTask {
  130192. /**
  130193. * Defines the name of the task
  130194. */
  130195. name: string;
  130196. /**
  130197. * Defines the list of mesh's names you want to load
  130198. */
  130199. meshesNames: any;
  130200. /**
  130201. * Defines the root url to use as a base to load your meshes and associated resources
  130202. */
  130203. rootUrl: string;
  130204. /**
  130205. * Defines the filename of the scene to load from
  130206. */
  130207. sceneFilename: string;
  130208. /**
  130209. * Gets the list of loaded meshes
  130210. */
  130211. loadedMeshes: Array<AbstractMesh>;
  130212. /**
  130213. * Gets the list of loaded particle systems
  130214. */
  130215. loadedParticleSystems: Array<IParticleSystem>;
  130216. /**
  130217. * Gets the list of loaded skeletons
  130218. */
  130219. loadedSkeletons: Array<Skeleton>;
  130220. /**
  130221. * Gets the list of loaded animation groups
  130222. */
  130223. loadedAnimationGroups: Array<AnimationGroup>;
  130224. /**
  130225. * Callback called when the task is successful
  130226. */
  130227. onSuccess: (task: MeshAssetTask) => void;
  130228. /**
  130229. * Callback called when the task is successful
  130230. */
  130231. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  130232. /**
  130233. * Creates a new MeshAssetTask
  130234. * @param name defines the name of the task
  130235. * @param meshesNames defines the list of mesh's names you want to load
  130236. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  130237. * @param sceneFilename defines the filename of the scene to load from
  130238. */
  130239. constructor(
  130240. /**
  130241. * Defines the name of the task
  130242. */
  130243. name: string,
  130244. /**
  130245. * Defines the list of mesh's names you want to load
  130246. */
  130247. meshesNames: any,
  130248. /**
  130249. * Defines the root url to use as a base to load your meshes and associated resources
  130250. */
  130251. rootUrl: string,
  130252. /**
  130253. * Defines the filename of the scene to load from
  130254. */
  130255. sceneFilename: string);
  130256. /**
  130257. * Execute the current task
  130258. * @param scene defines the scene where you want your assets to be loaded
  130259. * @param onSuccess is a callback called when the task is successfully executed
  130260. * @param onError is a callback called if an error occurs
  130261. */
  130262. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130263. }
  130264. /**
  130265. * Define a task used by AssetsManager to load text content
  130266. */
  130267. export class TextFileAssetTask extends AbstractAssetTask {
  130268. /**
  130269. * Defines the name of the task
  130270. */
  130271. name: string;
  130272. /**
  130273. * Defines the location of the file to load
  130274. */
  130275. url: string;
  130276. /**
  130277. * Gets the loaded text string
  130278. */
  130279. text: string;
  130280. /**
  130281. * Callback called when the task is successful
  130282. */
  130283. onSuccess: (task: TextFileAssetTask) => void;
  130284. /**
  130285. * Callback called when the task is successful
  130286. */
  130287. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  130288. /**
  130289. * Creates a new TextFileAssetTask object
  130290. * @param name defines the name of the task
  130291. * @param url defines the location of the file to load
  130292. */
  130293. constructor(
  130294. /**
  130295. * Defines the name of the task
  130296. */
  130297. name: string,
  130298. /**
  130299. * Defines the location of the file to load
  130300. */
  130301. url: string);
  130302. /**
  130303. * Execute the current task
  130304. * @param scene defines the scene where you want your assets to be loaded
  130305. * @param onSuccess is a callback called when the task is successfully executed
  130306. * @param onError is a callback called if an error occurs
  130307. */
  130308. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130309. }
  130310. /**
  130311. * Define a task used by AssetsManager to load binary data
  130312. */
  130313. export class BinaryFileAssetTask extends AbstractAssetTask {
  130314. /**
  130315. * Defines the name of the task
  130316. */
  130317. name: string;
  130318. /**
  130319. * Defines the location of the file to load
  130320. */
  130321. url: string;
  130322. /**
  130323. * Gets the lodaded data (as an array buffer)
  130324. */
  130325. data: ArrayBuffer;
  130326. /**
  130327. * Callback called when the task is successful
  130328. */
  130329. onSuccess: (task: BinaryFileAssetTask) => void;
  130330. /**
  130331. * Callback called when the task is successful
  130332. */
  130333. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  130334. /**
  130335. * Creates a new BinaryFileAssetTask object
  130336. * @param name defines the name of the new task
  130337. * @param url defines the location of the file to load
  130338. */
  130339. constructor(
  130340. /**
  130341. * Defines the name of the task
  130342. */
  130343. name: string,
  130344. /**
  130345. * Defines the location of the file to load
  130346. */
  130347. url: string);
  130348. /**
  130349. * Execute the current task
  130350. * @param scene defines the scene where you want your assets to be loaded
  130351. * @param onSuccess is a callback called when the task is successfully executed
  130352. * @param onError is a callback called if an error occurs
  130353. */
  130354. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130355. }
  130356. /**
  130357. * Define a task used by AssetsManager to load images
  130358. */
  130359. export class ImageAssetTask extends AbstractAssetTask {
  130360. /**
  130361. * Defines the name of the task
  130362. */
  130363. name: string;
  130364. /**
  130365. * Defines the location of the image to load
  130366. */
  130367. url: string;
  130368. /**
  130369. * Gets the loaded images
  130370. */
  130371. image: HTMLImageElement;
  130372. /**
  130373. * Callback called when the task is successful
  130374. */
  130375. onSuccess: (task: ImageAssetTask) => void;
  130376. /**
  130377. * Callback called when the task is successful
  130378. */
  130379. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  130380. /**
  130381. * Creates a new ImageAssetTask
  130382. * @param name defines the name of the task
  130383. * @param url defines the location of the image to load
  130384. */
  130385. constructor(
  130386. /**
  130387. * Defines the name of the task
  130388. */
  130389. name: string,
  130390. /**
  130391. * Defines the location of the image to load
  130392. */
  130393. url: string);
  130394. /**
  130395. * Execute the current task
  130396. * @param scene defines the scene where you want your assets to be loaded
  130397. * @param onSuccess is a callback called when the task is successfully executed
  130398. * @param onError is a callback called if an error occurs
  130399. */
  130400. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130401. }
  130402. /**
  130403. * Defines the interface used by texture loading tasks
  130404. */
  130405. export interface ITextureAssetTask<TEX extends BaseTexture> {
  130406. /**
  130407. * Gets the loaded texture
  130408. */
  130409. texture: TEX;
  130410. }
  130411. /**
  130412. * Define a task used by AssetsManager to load 2D textures
  130413. */
  130414. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  130415. /**
  130416. * Defines the name of the task
  130417. */
  130418. name: string;
  130419. /**
  130420. * Defines the location of the file to load
  130421. */
  130422. url: string;
  130423. /**
  130424. * Defines if mipmap should not be generated (default is false)
  130425. */
  130426. noMipmap?: boolean | undefined;
  130427. /**
  130428. * Defines if texture must be inverted on Y axis (default is false)
  130429. */
  130430. invertY?: boolean | undefined;
  130431. /**
  130432. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  130433. */
  130434. samplingMode: number;
  130435. /**
  130436. * Gets the loaded texture
  130437. */
  130438. texture: Texture;
  130439. /**
  130440. * Callback called when the task is successful
  130441. */
  130442. onSuccess: (task: TextureAssetTask) => void;
  130443. /**
  130444. * Callback called when the task is successful
  130445. */
  130446. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  130447. /**
  130448. * Creates a new TextureAssetTask object
  130449. * @param name defines the name of the task
  130450. * @param url defines the location of the file to load
  130451. * @param noMipmap defines if mipmap should not be generated (default is false)
  130452. * @param invertY defines if texture must be inverted on Y axis (default is false)
  130453. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  130454. */
  130455. constructor(
  130456. /**
  130457. * Defines the name of the task
  130458. */
  130459. name: string,
  130460. /**
  130461. * Defines the location of the file to load
  130462. */
  130463. url: string,
  130464. /**
  130465. * Defines if mipmap should not be generated (default is false)
  130466. */
  130467. noMipmap?: boolean | undefined,
  130468. /**
  130469. * Defines if texture must be inverted on Y axis (default is false)
  130470. */
  130471. invertY?: boolean | undefined,
  130472. /**
  130473. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  130474. */
  130475. samplingMode?: number);
  130476. /**
  130477. * Execute the current task
  130478. * @param scene defines the scene where you want your assets to be loaded
  130479. * @param onSuccess is a callback called when the task is successfully executed
  130480. * @param onError is a callback called if an error occurs
  130481. */
  130482. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130483. }
  130484. /**
  130485. * Define a task used by AssetsManager to load cube textures
  130486. */
  130487. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  130488. /**
  130489. * Defines the name of the task
  130490. */
  130491. name: string;
  130492. /**
  130493. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  130494. */
  130495. url: string;
  130496. /**
  130497. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  130498. */
  130499. extensions?: string[] | undefined;
  130500. /**
  130501. * Defines if mipmaps should not be generated (default is false)
  130502. */
  130503. noMipmap?: boolean | undefined;
  130504. /**
  130505. * Defines the explicit list of files (undefined by default)
  130506. */
  130507. files?: string[] | undefined;
  130508. /**
  130509. * Gets the loaded texture
  130510. */
  130511. texture: CubeTexture;
  130512. /**
  130513. * Callback called when the task is successful
  130514. */
  130515. onSuccess: (task: CubeTextureAssetTask) => void;
  130516. /**
  130517. * Callback called when the task is successful
  130518. */
  130519. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  130520. /**
  130521. * Creates a new CubeTextureAssetTask
  130522. * @param name defines the name of the task
  130523. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  130524. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  130525. * @param noMipmap defines if mipmaps should not be generated (default is false)
  130526. * @param files defines the explicit list of files (undefined by default)
  130527. */
  130528. constructor(
  130529. /**
  130530. * Defines the name of the task
  130531. */
  130532. name: string,
  130533. /**
  130534. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  130535. */
  130536. url: string,
  130537. /**
  130538. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  130539. */
  130540. extensions?: string[] | undefined,
  130541. /**
  130542. * Defines if mipmaps should not be generated (default is false)
  130543. */
  130544. noMipmap?: boolean | undefined,
  130545. /**
  130546. * Defines the explicit list of files (undefined by default)
  130547. */
  130548. files?: string[] | undefined);
  130549. /**
  130550. * Execute the current task
  130551. * @param scene defines the scene where you want your assets to be loaded
  130552. * @param onSuccess is a callback called when the task is successfully executed
  130553. * @param onError is a callback called if an error occurs
  130554. */
  130555. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130556. }
  130557. /**
  130558. * Define a task used by AssetsManager to load HDR cube textures
  130559. */
  130560. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  130561. /**
  130562. * Defines the name of the task
  130563. */
  130564. name: string;
  130565. /**
  130566. * Defines the location of the file to load
  130567. */
  130568. url: string;
  130569. /**
  130570. * Defines the desired size (the more it increases the longer the generation will be)
  130571. */
  130572. size: number;
  130573. /**
  130574. * Defines if mipmaps should not be generated (default is false)
  130575. */
  130576. noMipmap: boolean;
  130577. /**
  130578. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  130579. */
  130580. generateHarmonics: boolean;
  130581. /**
  130582. * 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)
  130583. */
  130584. gammaSpace: boolean;
  130585. /**
  130586. * Internal Use Only
  130587. */
  130588. reserved: boolean;
  130589. /**
  130590. * Gets the loaded texture
  130591. */
  130592. texture: HDRCubeTexture;
  130593. /**
  130594. * Callback called when the task is successful
  130595. */
  130596. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  130597. /**
  130598. * Callback called when the task is successful
  130599. */
  130600. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  130601. /**
  130602. * Creates a new HDRCubeTextureAssetTask object
  130603. * @param name defines the name of the task
  130604. * @param url defines the location of the file to load
  130605. * @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.
  130606. * @param noMipmap defines if mipmaps should not be generated (default is false)
  130607. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  130608. * @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)
  130609. * @param reserved Internal use only
  130610. */
  130611. constructor(
  130612. /**
  130613. * Defines the name of the task
  130614. */
  130615. name: string,
  130616. /**
  130617. * Defines the location of the file to load
  130618. */
  130619. url: string,
  130620. /**
  130621. * Defines the desired size (the more it increases the longer the generation will be)
  130622. */
  130623. size: number,
  130624. /**
  130625. * Defines if mipmaps should not be generated (default is false)
  130626. */
  130627. noMipmap?: boolean,
  130628. /**
  130629. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  130630. */
  130631. generateHarmonics?: boolean,
  130632. /**
  130633. * 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)
  130634. */
  130635. gammaSpace?: boolean,
  130636. /**
  130637. * Internal Use Only
  130638. */
  130639. reserved?: boolean);
  130640. /**
  130641. * Execute the current task
  130642. * @param scene defines the scene where you want your assets to be loaded
  130643. * @param onSuccess is a callback called when the task is successfully executed
  130644. * @param onError is a callback called if an error occurs
  130645. */
  130646. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130647. }
  130648. /**
  130649. * Define a task used by AssetsManager to load Equirectangular cube textures
  130650. */
  130651. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  130652. /**
  130653. * Defines the name of the task
  130654. */
  130655. name: string;
  130656. /**
  130657. * Defines the location of the file to load
  130658. */
  130659. url: string;
  130660. /**
  130661. * Defines the desired size (the more it increases the longer the generation will be)
  130662. */
  130663. size: number;
  130664. /**
  130665. * Defines if mipmaps should not be generated (default is false)
  130666. */
  130667. noMipmap: boolean;
  130668. /**
  130669. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  130670. * but the standard material would require them in Gamma space) (default is true)
  130671. */
  130672. gammaSpace: boolean;
  130673. /**
  130674. * Gets the loaded texture
  130675. */
  130676. texture: EquiRectangularCubeTexture;
  130677. /**
  130678. * Callback called when the task is successful
  130679. */
  130680. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  130681. /**
  130682. * Callback called when the task is successful
  130683. */
  130684. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  130685. /**
  130686. * Creates a new EquiRectangularCubeTextureAssetTask object
  130687. * @param name defines the name of the task
  130688. * @param url defines the location of the file to load
  130689. * @param size defines the desired size (the more it increases the longer the generation will be)
  130690. * If the size is omitted this implies you are using a preprocessed cubemap.
  130691. * @param noMipmap defines if mipmaps should not be generated (default is false)
  130692. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  130693. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  130694. * (default is true)
  130695. */
  130696. constructor(
  130697. /**
  130698. * Defines the name of the task
  130699. */
  130700. name: string,
  130701. /**
  130702. * Defines the location of the file to load
  130703. */
  130704. url: string,
  130705. /**
  130706. * Defines the desired size (the more it increases the longer the generation will be)
  130707. */
  130708. size: number,
  130709. /**
  130710. * Defines if mipmaps should not be generated (default is false)
  130711. */
  130712. noMipmap?: boolean,
  130713. /**
  130714. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  130715. * but the standard material would require them in Gamma space) (default is true)
  130716. */
  130717. gammaSpace?: boolean);
  130718. /**
  130719. * Execute the current task
  130720. * @param scene defines the scene where you want your assets to be loaded
  130721. * @param onSuccess is a callback called when the task is successfully executed
  130722. * @param onError is a callback called if an error occurs
  130723. */
  130724. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130725. }
  130726. /**
  130727. * This class can be used to easily import assets into a scene
  130728. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  130729. */
  130730. export class AssetsManager {
  130731. private _scene;
  130732. private _isLoading;
  130733. protected _tasks: AbstractAssetTask[];
  130734. protected _waitingTasksCount: number;
  130735. protected _totalTasksCount: number;
  130736. /**
  130737. * Callback called when all tasks are processed
  130738. */
  130739. onFinish: (tasks: AbstractAssetTask[]) => void;
  130740. /**
  130741. * Callback called when a task is successful
  130742. */
  130743. onTaskSuccess: (task: AbstractAssetTask) => void;
  130744. /**
  130745. * Callback called when a task had an error
  130746. */
  130747. onTaskError: (task: AbstractAssetTask) => void;
  130748. /**
  130749. * Callback called when a task is done (whatever the result is)
  130750. */
  130751. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  130752. /**
  130753. * Observable called when all tasks are processed
  130754. */
  130755. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  130756. /**
  130757. * Observable called when a task had an error
  130758. */
  130759. onTaskErrorObservable: Observable<AbstractAssetTask>;
  130760. /**
  130761. * Observable called when all tasks were executed
  130762. */
  130763. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  130764. /**
  130765. * Observable called when a task is done (whatever the result is)
  130766. */
  130767. onProgressObservable: Observable<IAssetsProgressEvent>;
  130768. /**
  130769. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  130770. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  130771. */
  130772. useDefaultLoadingScreen: boolean;
  130773. /**
  130774. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  130775. * when all assets have been downloaded.
  130776. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  130777. */
  130778. autoHideLoadingUI: boolean;
  130779. /**
  130780. * Creates a new AssetsManager
  130781. * @param scene defines the scene to work on
  130782. */
  130783. constructor(scene: Scene);
  130784. /**
  130785. * Add a MeshAssetTask to the list of active tasks
  130786. * @param taskName defines the name of the new task
  130787. * @param meshesNames defines the name of meshes to load
  130788. * @param rootUrl defines the root url to use to locate files
  130789. * @param sceneFilename defines the filename of the scene file
  130790. * @returns a new MeshAssetTask object
  130791. */
  130792. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  130793. /**
  130794. * Add a TextFileAssetTask to the list of active tasks
  130795. * @param taskName defines the name of the new task
  130796. * @param url defines the url of the file to load
  130797. * @returns a new TextFileAssetTask object
  130798. */
  130799. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  130800. /**
  130801. * Add a BinaryFileAssetTask to the list of active tasks
  130802. * @param taskName defines the name of the new task
  130803. * @param url defines the url of the file to load
  130804. * @returns a new BinaryFileAssetTask object
  130805. */
  130806. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  130807. /**
  130808. * Add a ImageAssetTask to the list of active tasks
  130809. * @param taskName defines the name of the new task
  130810. * @param url defines the url of the file to load
  130811. * @returns a new ImageAssetTask object
  130812. */
  130813. addImageTask(taskName: string, url: string): ImageAssetTask;
  130814. /**
  130815. * Add a TextureAssetTask to the list of active tasks
  130816. * @param taskName defines the name of the new task
  130817. * @param url defines the url of the file to load
  130818. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  130819. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  130820. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  130821. * @returns a new TextureAssetTask object
  130822. */
  130823. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  130824. /**
  130825. * Add a CubeTextureAssetTask to the list of active tasks
  130826. * @param taskName defines the name of the new task
  130827. * @param url defines the url of the file to load
  130828. * @param extensions defines the extension to use to load the cube map (can be null)
  130829. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  130830. * @param files defines the list of files to load (can be null)
  130831. * @returns a new CubeTextureAssetTask object
  130832. */
  130833. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  130834. /**
  130835. *
  130836. * Add a HDRCubeTextureAssetTask to the list of active tasks
  130837. * @param taskName defines the name of the new task
  130838. * @param url defines the url of the file to load
  130839. * @param size defines the size you want for the cubemap (can be null)
  130840. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  130841. * @param generateHarmonics defines if you want to automatically generate (true by default)
  130842. * @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)
  130843. * @param reserved Internal use only
  130844. * @returns a new HDRCubeTextureAssetTask object
  130845. */
  130846. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  130847. /**
  130848. *
  130849. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  130850. * @param taskName defines the name of the new task
  130851. * @param url defines the url of the file to load
  130852. * @param size defines the size you want for the cubemap (can be null)
  130853. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  130854. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  130855. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  130856. * @returns a new EquiRectangularCubeTextureAssetTask object
  130857. */
  130858. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  130859. /**
  130860. * Remove a task from the assets manager.
  130861. * @param task the task to remove
  130862. */
  130863. removeTask(task: AbstractAssetTask): void;
  130864. private _decreaseWaitingTasksCount;
  130865. private _runTask;
  130866. /**
  130867. * Reset the AssetsManager and remove all tasks
  130868. * @return the current instance of the AssetsManager
  130869. */
  130870. reset(): AssetsManager;
  130871. /**
  130872. * Start the loading process
  130873. * @return the current instance of the AssetsManager
  130874. */
  130875. load(): AssetsManager;
  130876. /**
  130877. * Start the loading process as an async operation
  130878. * @return a promise returning the list of failed tasks
  130879. */
  130880. loadAsync(): Promise<void>;
  130881. }
  130882. }
  130883. declare module BABYLON {
  130884. /**
  130885. * Wrapper class for promise with external resolve and reject.
  130886. */
  130887. export class Deferred<T> {
  130888. /**
  130889. * The promise associated with this deferred object.
  130890. */
  130891. readonly promise: Promise<T>;
  130892. private _resolve;
  130893. private _reject;
  130894. /**
  130895. * The resolve method of the promise associated with this deferred object.
  130896. */
  130897. readonly resolve: (value?: T | PromiseLike<T> | undefined) => void;
  130898. /**
  130899. * The reject method of the promise associated with this deferred object.
  130900. */
  130901. readonly reject: (reason?: any) => void;
  130902. /**
  130903. * Constructor for this deferred object.
  130904. */
  130905. constructor();
  130906. }
  130907. }
  130908. declare module BABYLON {
  130909. /**
  130910. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  130911. */
  130912. export class MeshExploder {
  130913. private _centerMesh;
  130914. private _meshes;
  130915. private _meshesOrigins;
  130916. private _toCenterVectors;
  130917. private _scaledDirection;
  130918. private _newPosition;
  130919. private _centerPosition;
  130920. /**
  130921. * Explodes meshes from a center mesh.
  130922. * @param meshes The meshes to explode.
  130923. * @param centerMesh The mesh to be center of explosion.
  130924. */
  130925. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  130926. private _setCenterMesh;
  130927. /**
  130928. * Get class name
  130929. * @returns "MeshExploder"
  130930. */
  130931. getClassName(): string;
  130932. /**
  130933. * "Exploded meshes"
  130934. * @returns Array of meshes with the centerMesh at index 0.
  130935. */
  130936. getMeshes(): Array<Mesh>;
  130937. /**
  130938. * Explodes meshes giving a specific direction
  130939. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  130940. */
  130941. explode(direction?: number): void;
  130942. }
  130943. }
  130944. declare module BABYLON {
  130945. /**
  130946. * Class used to help managing file picking and drag'n'drop
  130947. */
  130948. export class FilesInput {
  130949. /**
  130950. * List of files ready to be loaded
  130951. */
  130952. static readonly FilesToLoad: {
  130953. [key: string]: File;
  130954. };
  130955. /**
  130956. * Callback called when a file is processed
  130957. */
  130958. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  130959. private _engine;
  130960. private _currentScene;
  130961. private _sceneLoadedCallback;
  130962. private _progressCallback;
  130963. private _additionalRenderLoopLogicCallback;
  130964. private _textureLoadingCallback;
  130965. private _startingProcessingFilesCallback;
  130966. private _onReloadCallback;
  130967. private _errorCallback;
  130968. private _elementToMonitor;
  130969. private _sceneFileToLoad;
  130970. private _filesToLoad;
  130971. /**
  130972. * Creates a new FilesInput
  130973. * @param engine defines the rendering engine
  130974. * @param scene defines the hosting scene
  130975. * @param sceneLoadedCallback callback called when scene is loaded
  130976. * @param progressCallback callback called to track progress
  130977. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  130978. * @param textureLoadingCallback callback called when a texture is loading
  130979. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  130980. * @param onReloadCallback callback called when a reload is requested
  130981. * @param errorCallback callback call if an error occurs
  130982. */
  130983. constructor(engine: Engine, scene: Scene, sceneLoadedCallback: (sceneFile: File, scene: Scene) => void, progressCallback: (progress: SceneLoaderProgressEvent) => void, additionalRenderLoopLogicCallback: () => void, textureLoadingCallback: (remaining: number) => void, startingProcessingFilesCallback: (files?: File[]) => void, onReloadCallback: (sceneFile: File) => void, errorCallback: (sceneFile: File, scene: Scene, message: string) => void);
  130984. private _dragEnterHandler;
  130985. private _dragOverHandler;
  130986. private _dropHandler;
  130987. /**
  130988. * Calls this function to listen to drag'n'drop events on a specific DOM element
  130989. * @param elementToMonitor defines the DOM element to track
  130990. */
  130991. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  130992. /**
  130993. * Release all associated resources
  130994. */
  130995. dispose(): void;
  130996. private renderFunction;
  130997. private drag;
  130998. private drop;
  130999. private _traverseFolder;
  131000. private _processFiles;
  131001. /**
  131002. * Load files from a drop event
  131003. * @param event defines the drop event to use as source
  131004. */
  131005. loadFiles(event: any): void;
  131006. private _processReload;
  131007. /**
  131008. * Reload the current scene from the loaded files
  131009. */
  131010. reload(): void;
  131011. }
  131012. }
  131013. declare module BABYLON {
  131014. /**
  131015. * Defines the root class used to create scene optimization to use with SceneOptimizer
  131016. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131017. */
  131018. export class SceneOptimization {
  131019. /**
  131020. * Defines the priority of this optimization (0 by default which means first in the list)
  131021. */
  131022. priority: number;
  131023. /**
  131024. * Gets a string describing the action executed by the current optimization
  131025. * @returns description string
  131026. */
  131027. getDescription(): string;
  131028. /**
  131029. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131030. * @param scene defines the current scene where to apply this optimization
  131031. * @param optimizer defines the current optimizer
  131032. * @returns true if everything that can be done was applied
  131033. */
  131034. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131035. /**
  131036. * Creates the SceneOptimization object
  131037. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  131038. * @param desc defines the description associated with the optimization
  131039. */
  131040. constructor(
  131041. /**
  131042. * Defines the priority of this optimization (0 by default which means first in the list)
  131043. */
  131044. priority?: number);
  131045. }
  131046. /**
  131047. * Defines an optimization used to reduce the size of render target textures
  131048. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131049. */
  131050. export class TextureOptimization extends SceneOptimization {
  131051. /**
  131052. * Defines the priority of this optimization (0 by default which means first in the list)
  131053. */
  131054. priority: number;
  131055. /**
  131056. * 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
  131057. */
  131058. maximumSize: number;
  131059. /**
  131060. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  131061. */
  131062. step: number;
  131063. /**
  131064. * Gets a string describing the action executed by the current optimization
  131065. * @returns description string
  131066. */
  131067. getDescription(): string;
  131068. /**
  131069. * Creates the TextureOptimization object
  131070. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  131071. * @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
  131072. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  131073. */
  131074. constructor(
  131075. /**
  131076. * Defines the priority of this optimization (0 by default which means first in the list)
  131077. */
  131078. priority?: number,
  131079. /**
  131080. * 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
  131081. */
  131082. maximumSize?: number,
  131083. /**
  131084. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  131085. */
  131086. step?: number);
  131087. /**
  131088. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131089. * @param scene defines the current scene where to apply this optimization
  131090. * @param optimizer defines the current optimizer
  131091. * @returns true if everything that can be done was applied
  131092. */
  131093. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131094. }
  131095. /**
  131096. * Defines an optimization used to increase or decrease the rendering resolution
  131097. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131098. */
  131099. export class HardwareScalingOptimization extends SceneOptimization {
  131100. /**
  131101. * Defines the priority of this optimization (0 by default which means first in the list)
  131102. */
  131103. priority: number;
  131104. /**
  131105. * Defines the maximum scale to use (2 by default)
  131106. */
  131107. maximumScale: number;
  131108. /**
  131109. * Defines the step to use between two passes (0.5 by default)
  131110. */
  131111. step: number;
  131112. private _currentScale;
  131113. private _directionOffset;
  131114. /**
  131115. * Gets a string describing the action executed by the current optimization
  131116. * @return description string
  131117. */
  131118. getDescription(): string;
  131119. /**
  131120. * Creates the HardwareScalingOptimization object
  131121. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  131122. * @param maximumScale defines the maximum scale to use (2 by default)
  131123. * @param step defines the step to use between two passes (0.5 by default)
  131124. */
  131125. constructor(
  131126. /**
  131127. * Defines the priority of this optimization (0 by default which means first in the list)
  131128. */
  131129. priority?: number,
  131130. /**
  131131. * Defines the maximum scale to use (2 by default)
  131132. */
  131133. maximumScale?: number,
  131134. /**
  131135. * Defines the step to use between two passes (0.5 by default)
  131136. */
  131137. step?: number);
  131138. /**
  131139. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131140. * @param scene defines the current scene where to apply this optimization
  131141. * @param optimizer defines the current optimizer
  131142. * @returns true if everything that can be done was applied
  131143. */
  131144. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131145. }
  131146. /**
  131147. * Defines an optimization used to remove shadows
  131148. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131149. */
  131150. export class ShadowsOptimization extends SceneOptimization {
  131151. /**
  131152. * Gets a string describing the action executed by the current optimization
  131153. * @return description string
  131154. */
  131155. getDescription(): string;
  131156. /**
  131157. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131158. * @param scene defines the current scene where to apply this optimization
  131159. * @param optimizer defines the current optimizer
  131160. * @returns true if everything that can be done was applied
  131161. */
  131162. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131163. }
  131164. /**
  131165. * Defines an optimization used to turn post-processes off
  131166. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131167. */
  131168. export class PostProcessesOptimization extends SceneOptimization {
  131169. /**
  131170. * Gets a string describing the action executed by the current optimization
  131171. * @return description string
  131172. */
  131173. getDescription(): string;
  131174. /**
  131175. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131176. * @param scene defines the current scene where to apply this optimization
  131177. * @param optimizer defines the current optimizer
  131178. * @returns true if everything that can be done was applied
  131179. */
  131180. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131181. }
  131182. /**
  131183. * Defines an optimization used to turn lens flares off
  131184. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131185. */
  131186. export class LensFlaresOptimization extends SceneOptimization {
  131187. /**
  131188. * Gets a string describing the action executed by the current optimization
  131189. * @return description string
  131190. */
  131191. getDescription(): string;
  131192. /**
  131193. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131194. * @param scene defines the current scene where to apply this optimization
  131195. * @param optimizer defines the current optimizer
  131196. * @returns true if everything that can be done was applied
  131197. */
  131198. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131199. }
  131200. /**
  131201. * Defines an optimization based on user defined callback.
  131202. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131203. */
  131204. export class CustomOptimization extends SceneOptimization {
  131205. /**
  131206. * Callback called to apply the custom optimization.
  131207. */
  131208. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  131209. /**
  131210. * Callback called to get custom description
  131211. */
  131212. onGetDescription: () => string;
  131213. /**
  131214. * Gets a string describing the action executed by the current optimization
  131215. * @returns description string
  131216. */
  131217. getDescription(): string;
  131218. /**
  131219. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131220. * @param scene defines the current scene where to apply this optimization
  131221. * @param optimizer defines the current optimizer
  131222. * @returns true if everything that can be done was applied
  131223. */
  131224. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131225. }
  131226. /**
  131227. * Defines an optimization used to turn particles off
  131228. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131229. */
  131230. export class ParticlesOptimization extends SceneOptimization {
  131231. /**
  131232. * Gets a string describing the action executed by the current optimization
  131233. * @return description string
  131234. */
  131235. getDescription(): string;
  131236. /**
  131237. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131238. * @param scene defines the current scene where to apply this optimization
  131239. * @param optimizer defines the current optimizer
  131240. * @returns true if everything that can be done was applied
  131241. */
  131242. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131243. }
  131244. /**
  131245. * Defines an optimization used to turn render targets off
  131246. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131247. */
  131248. export class RenderTargetsOptimization extends SceneOptimization {
  131249. /**
  131250. * Gets a string describing the action executed by the current optimization
  131251. * @return description string
  131252. */
  131253. getDescription(): string;
  131254. /**
  131255. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131256. * @param scene defines the current scene where to apply this optimization
  131257. * @param optimizer defines the current optimizer
  131258. * @returns true if everything that can be done was applied
  131259. */
  131260. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131261. }
  131262. /**
  131263. * Defines an optimization used to merge meshes with compatible materials
  131264. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131265. */
  131266. export class MergeMeshesOptimization extends SceneOptimization {
  131267. private static _UpdateSelectionTree;
  131268. /**
  131269. * Gets or sets a boolean which defines if optimization octree has to be updated
  131270. */
  131271. /**
  131272. * Gets or sets a boolean which defines if optimization octree has to be updated
  131273. */
  131274. static UpdateSelectionTree: boolean;
  131275. /**
  131276. * Gets a string describing the action executed by the current optimization
  131277. * @return description string
  131278. */
  131279. getDescription(): string;
  131280. private _canBeMerged;
  131281. /**
  131282. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131283. * @param scene defines the current scene where to apply this optimization
  131284. * @param optimizer defines the current optimizer
  131285. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  131286. * @returns true if everything that can be done was applied
  131287. */
  131288. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  131289. }
  131290. /**
  131291. * Defines a list of options used by SceneOptimizer
  131292. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131293. */
  131294. export class SceneOptimizerOptions {
  131295. /**
  131296. * Defines the target frame rate to reach (60 by default)
  131297. */
  131298. targetFrameRate: number;
  131299. /**
  131300. * Defines the interval between two checkes (2000ms by default)
  131301. */
  131302. trackerDuration: number;
  131303. /**
  131304. * Gets the list of optimizations to apply
  131305. */
  131306. optimizations: SceneOptimization[];
  131307. /**
  131308. * Creates a new list of options used by SceneOptimizer
  131309. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  131310. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  131311. */
  131312. constructor(
  131313. /**
  131314. * Defines the target frame rate to reach (60 by default)
  131315. */
  131316. targetFrameRate?: number,
  131317. /**
  131318. * Defines the interval between two checkes (2000ms by default)
  131319. */
  131320. trackerDuration?: number);
  131321. /**
  131322. * Add a new optimization
  131323. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  131324. * @returns the current SceneOptimizerOptions
  131325. */
  131326. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  131327. /**
  131328. * Add a new custom optimization
  131329. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  131330. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  131331. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  131332. * @returns the current SceneOptimizerOptions
  131333. */
  131334. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  131335. /**
  131336. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  131337. * @param targetFrameRate defines the target frame rate (60 by default)
  131338. * @returns a SceneOptimizerOptions object
  131339. */
  131340. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  131341. /**
  131342. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  131343. * @param targetFrameRate defines the target frame rate (60 by default)
  131344. * @returns a SceneOptimizerOptions object
  131345. */
  131346. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  131347. /**
  131348. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  131349. * @param targetFrameRate defines the target frame rate (60 by default)
  131350. * @returns a SceneOptimizerOptions object
  131351. */
  131352. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  131353. }
  131354. /**
  131355. * Class used to run optimizations in order to reach a target frame rate
  131356. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131357. */
  131358. export class SceneOptimizer implements IDisposable {
  131359. private _isRunning;
  131360. private _options;
  131361. private _scene;
  131362. private _currentPriorityLevel;
  131363. private _targetFrameRate;
  131364. private _trackerDuration;
  131365. private _currentFrameRate;
  131366. private _sceneDisposeObserver;
  131367. private _improvementMode;
  131368. /**
  131369. * Defines an observable called when the optimizer reaches the target frame rate
  131370. */
  131371. onSuccessObservable: Observable<SceneOptimizer>;
  131372. /**
  131373. * Defines an observable called when the optimizer enables an optimization
  131374. */
  131375. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  131376. /**
  131377. * Defines an observable called when the optimizer is not able to reach the target frame rate
  131378. */
  131379. onFailureObservable: Observable<SceneOptimizer>;
  131380. /**
  131381. * Gets a boolean indicating if the optimizer is in improvement mode
  131382. */
  131383. readonly isInImprovementMode: boolean;
  131384. /**
  131385. * Gets the current priority level (0 at start)
  131386. */
  131387. readonly currentPriorityLevel: number;
  131388. /**
  131389. * Gets the current frame rate checked by the SceneOptimizer
  131390. */
  131391. readonly currentFrameRate: number;
  131392. /**
  131393. * Gets or sets the current target frame rate (60 by default)
  131394. */
  131395. /**
  131396. * Gets or sets the current target frame rate (60 by default)
  131397. */
  131398. targetFrameRate: number;
  131399. /**
  131400. * Gets or sets the current interval between two checks (every 2000ms by default)
  131401. */
  131402. /**
  131403. * Gets or sets the current interval between two checks (every 2000ms by default)
  131404. */
  131405. trackerDuration: number;
  131406. /**
  131407. * Gets the list of active optimizations
  131408. */
  131409. readonly optimizations: SceneOptimization[];
  131410. /**
  131411. * Creates a new SceneOptimizer
  131412. * @param scene defines the scene to work on
  131413. * @param options defines the options to use with the SceneOptimizer
  131414. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  131415. * @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)
  131416. */
  131417. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  131418. /**
  131419. * Stops the current optimizer
  131420. */
  131421. stop(): void;
  131422. /**
  131423. * Reset the optimizer to initial step (current priority level = 0)
  131424. */
  131425. reset(): void;
  131426. /**
  131427. * Start the optimizer. By default it will try to reach a specific framerate
  131428. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  131429. */
  131430. start(): void;
  131431. private _checkCurrentState;
  131432. /**
  131433. * Release all resources
  131434. */
  131435. dispose(): void;
  131436. /**
  131437. * Helper function to create a SceneOptimizer with one single line of code
  131438. * @param scene defines the scene to work on
  131439. * @param options defines the options to use with the SceneOptimizer
  131440. * @param onSuccess defines a callback to call on success
  131441. * @param onFailure defines a callback to call on failure
  131442. * @returns the new SceneOptimizer object
  131443. */
  131444. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  131445. }
  131446. }
  131447. declare module BABYLON {
  131448. /**
  131449. * Class used to serialize a scene into a string
  131450. */
  131451. export class SceneSerializer {
  131452. /**
  131453. * Clear cache used by a previous serialization
  131454. */
  131455. static ClearCache(): void;
  131456. /**
  131457. * Serialize a scene into a JSON compatible object
  131458. * @param scene defines the scene to serialize
  131459. * @returns a JSON compatible object
  131460. */
  131461. static Serialize(scene: Scene): any;
  131462. /**
  131463. * Serialize a mesh into a JSON compatible object
  131464. * @param toSerialize defines the mesh to serialize
  131465. * @param withParents defines if parents must be serialized as well
  131466. * @param withChildren defines if children must be serialized as well
  131467. * @returns a JSON compatible object
  131468. */
  131469. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  131470. }
  131471. }
  131472. declare module BABYLON {
  131473. /**
  131474. * Class used to host texture specific utilities
  131475. */
  131476. export class TextureTools {
  131477. /**
  131478. * Uses the GPU to create a copy texture rescaled at a given size
  131479. * @param texture Texture to copy from
  131480. * @param width defines the desired width
  131481. * @param height defines the desired height
  131482. * @param useBilinearMode defines if bilinear mode has to be used
  131483. * @return the generated texture
  131484. */
  131485. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  131486. }
  131487. }
  131488. declare module BABYLON {
  131489. /**
  131490. * This represents the different options available for the video capture.
  131491. */
  131492. export interface VideoRecorderOptions {
  131493. /** Defines the mime type of the video. */
  131494. mimeType: string;
  131495. /** Defines the FPS the video should be recorded at. */
  131496. fps: number;
  131497. /** Defines the chunk size for the recording data. */
  131498. recordChunckSize: number;
  131499. /** The audio tracks to attach to the recording. */
  131500. audioTracks?: MediaStreamTrack[];
  131501. }
  131502. /**
  131503. * This can help with recording videos from BabylonJS.
  131504. * This is based on the available WebRTC functionalities of the browser.
  131505. *
  131506. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  131507. */
  131508. export class VideoRecorder {
  131509. private static readonly _defaultOptions;
  131510. /**
  131511. * Returns whether or not the VideoRecorder is available in your browser.
  131512. * @param engine Defines the Babylon Engine.
  131513. * @returns true if supported otherwise false.
  131514. */
  131515. static IsSupported(engine: Engine): boolean;
  131516. private readonly _options;
  131517. private _canvas;
  131518. private _mediaRecorder;
  131519. private _recordedChunks;
  131520. private _fileName;
  131521. private _resolve;
  131522. private _reject;
  131523. /**
  131524. * True when a recording is already in progress.
  131525. */
  131526. readonly isRecording: boolean;
  131527. /**
  131528. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  131529. * @param engine Defines the BabylonJS Engine you wish to record.
  131530. * @param options Defines options that can be used to customize the capture.
  131531. */
  131532. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  131533. /**
  131534. * Stops the current recording before the default capture timeout passed in the startRecording function.
  131535. */
  131536. stopRecording(): void;
  131537. /**
  131538. * Starts recording the canvas for a max duration specified in parameters.
  131539. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  131540. * If null no automatic download will start and you can rely on the promise to get the data back.
  131541. * @param maxDuration Defines the maximum recording time in seconds.
  131542. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  131543. * @return A promise callback at the end of the recording with the video data in Blob.
  131544. */
  131545. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  131546. /**
  131547. * Releases internal resources used during the recording.
  131548. */
  131549. dispose(): void;
  131550. private _handleDataAvailable;
  131551. private _handleError;
  131552. private _handleStop;
  131553. }
  131554. }
  131555. declare module BABYLON {
  131556. /**
  131557. * Class containing a set of static utilities functions for screenshots
  131558. */
  131559. export class ScreenshotTools {
  131560. /**
  131561. * Captures a screenshot of the current rendering
  131562. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  131563. * @param engine defines the rendering engine
  131564. * @param camera defines the source camera
  131565. * @param size This parameter can be set to a single number or to an object with the
  131566. * following (optional) properties: precision, width, height. If a single number is passed,
  131567. * it will be used for both width and height. If an object is passed, the screenshot size
  131568. * will be derived from the parameters. The precision property is a multiplier allowing
  131569. * rendering at a higher or lower resolution
  131570. * @param successCallback defines the callback receives a single parameter which contains the
  131571. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  131572. * src parameter of an <img> to display it
  131573. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  131574. * Check your browser for supported MIME types
  131575. */
  131576. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  131577. /**
  131578. * Captures a screenshot of the current rendering
  131579. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  131580. * @param engine defines the rendering engine
  131581. * @param camera defines the source camera
  131582. * @param size This parameter can be set to a single number or to an object with the
  131583. * following (optional) properties: precision, width, height. If a single number is passed,
  131584. * it will be used for both width and height. If an object is passed, the screenshot size
  131585. * will be derived from the parameters. The precision property is a multiplier allowing
  131586. * rendering at a higher or lower resolution
  131587. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  131588. * Check your browser for supported MIME types
  131589. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  131590. * to the src parameter of an <img> to display it
  131591. */
  131592. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  131593. /**
  131594. * Generates an image screenshot from the specified camera.
  131595. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  131596. * @param engine The engine to use for rendering
  131597. * @param camera The camera to use for rendering
  131598. * @param size This parameter can be set to a single number or to an object with the
  131599. * following (optional) properties: precision, width, height. If a single number is passed,
  131600. * it will be used for both width and height. If an object is passed, the screenshot size
  131601. * will be derived from the parameters. The precision property is a multiplier allowing
  131602. * rendering at a higher or lower resolution
  131603. * @param successCallback The callback receives a single parameter which contains the
  131604. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  131605. * src parameter of an <img> to display it
  131606. * @param mimeType The MIME type of the screenshot image (default: image/png).
  131607. * Check your browser for supported MIME types
  131608. * @param samples Texture samples (default: 1)
  131609. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  131610. * @param fileName A name for for the downloaded file.
  131611. */
  131612. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  131613. /**
  131614. * Generates an image screenshot from the specified camera.
  131615. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  131616. * @param engine The engine to use for rendering
  131617. * @param camera The camera to use for rendering
  131618. * @param size This parameter can be set to a single number or to an object with the
  131619. * following (optional) properties: precision, width, height. If a single number is passed,
  131620. * it will be used for both width and height. If an object is passed, the screenshot size
  131621. * will be derived from the parameters. The precision property is a multiplier allowing
  131622. * rendering at a higher or lower resolution
  131623. * @param mimeType The MIME type of the screenshot image (default: image/png).
  131624. * Check your browser for supported MIME types
  131625. * @param samples Texture samples (default: 1)
  131626. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  131627. * @param fileName A name for for the downloaded file.
  131628. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  131629. * to the src parameter of an <img> to display it
  131630. */
  131631. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  131632. /**
  131633. * Gets height and width for screenshot size
  131634. * @private
  131635. */
  131636. private static _getScreenshotSize;
  131637. }
  131638. }
  131639. declare module BABYLON {
  131640. /**
  131641. * Interface for a data buffer
  131642. */
  131643. export interface IDataBuffer {
  131644. /**
  131645. * Reads bytes from the data buffer.
  131646. * @param byteOffset The byte offset to read
  131647. * @param byteLength The byte length to read
  131648. * @returns A promise that resolves when the bytes are read
  131649. */
  131650. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  131651. /**
  131652. * The byte length of the buffer.
  131653. */
  131654. readonly byteLength: number;
  131655. }
  131656. /**
  131657. * Utility class for reading from a data buffer
  131658. */
  131659. export class DataReader {
  131660. /**
  131661. * The data buffer associated with this data reader.
  131662. */
  131663. readonly buffer: IDataBuffer;
  131664. /**
  131665. * The current byte offset from the beginning of the data buffer.
  131666. */
  131667. byteOffset: number;
  131668. private _dataView;
  131669. private _dataByteOffset;
  131670. /**
  131671. * Constructor
  131672. * @param buffer The buffer to read
  131673. */
  131674. constructor(buffer: IDataBuffer);
  131675. /**
  131676. * Loads the given byte length.
  131677. * @param byteLength The byte length to load
  131678. * @returns A promise that resolves when the load is complete
  131679. */
  131680. loadAsync(byteLength: number): Promise<void>;
  131681. /**
  131682. * Read a unsigned 32-bit integer from the currently loaded data range.
  131683. * @returns The 32-bit integer read
  131684. */
  131685. readUint32(): number;
  131686. /**
  131687. * Read a byte array from the currently loaded data range.
  131688. * @param byteLength The byte length to read
  131689. * @returns The byte array read
  131690. */
  131691. readUint8Array(byteLength: number): Uint8Array;
  131692. /**
  131693. * Read a string from the currently loaded data range.
  131694. * @param byteLength The byte length to read
  131695. * @returns The string read
  131696. */
  131697. readString(byteLength: number): string;
  131698. /**
  131699. * Skips the given byte length the currently loaded data range.
  131700. * @param byteLength The byte length to skip
  131701. */
  131702. skipBytes(byteLength: number): void;
  131703. }
  131704. }
  131705. declare module BABYLON {
  131706. /**
  131707. * A cursor which tracks a point on a path
  131708. */
  131709. export class PathCursor {
  131710. private path;
  131711. /**
  131712. * Stores path cursor callbacks for when an onchange event is triggered
  131713. */
  131714. private _onchange;
  131715. /**
  131716. * The value of the path cursor
  131717. */
  131718. value: number;
  131719. /**
  131720. * The animation array of the path cursor
  131721. */
  131722. animations: Animation[];
  131723. /**
  131724. * Initializes the path cursor
  131725. * @param path The path to track
  131726. */
  131727. constructor(path: Path2);
  131728. /**
  131729. * Gets the cursor point on the path
  131730. * @returns A point on the path cursor at the cursor location
  131731. */
  131732. getPoint(): Vector3;
  131733. /**
  131734. * Moves the cursor ahead by the step amount
  131735. * @param step The amount to move the cursor forward
  131736. * @returns This path cursor
  131737. */
  131738. moveAhead(step?: number): PathCursor;
  131739. /**
  131740. * Moves the cursor behind by the step amount
  131741. * @param step The amount to move the cursor back
  131742. * @returns This path cursor
  131743. */
  131744. moveBack(step?: number): PathCursor;
  131745. /**
  131746. * Moves the cursor by the step amount
  131747. * If the step amount is greater than one, an exception is thrown
  131748. * @param step The amount to move the cursor
  131749. * @returns This path cursor
  131750. */
  131751. move(step: number): PathCursor;
  131752. /**
  131753. * Ensures that the value is limited between zero and one
  131754. * @returns This path cursor
  131755. */
  131756. private ensureLimits;
  131757. /**
  131758. * Runs onchange callbacks on change (used by the animation engine)
  131759. * @returns This path cursor
  131760. */
  131761. private raiseOnChange;
  131762. /**
  131763. * Executes a function on change
  131764. * @param f A path cursor onchange callback
  131765. * @returns This path cursor
  131766. */
  131767. onchange(f: (cursor: PathCursor) => void): PathCursor;
  131768. }
  131769. }
  131770. declare module BABYLON {
  131771. /** @hidden */
  131772. export var blurPixelShader: {
  131773. name: string;
  131774. shader: string;
  131775. };
  131776. }
  131777. declare module BABYLON {
  131778. /** @hidden */
  131779. export var pointCloudVertexDeclaration: {
  131780. name: string;
  131781. shader: string;
  131782. };
  131783. }
  131784. // Mixins
  131785. interface Window {
  131786. mozIndexedDB: IDBFactory;
  131787. webkitIndexedDB: IDBFactory;
  131788. msIndexedDB: IDBFactory;
  131789. webkitURL: typeof URL;
  131790. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  131791. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  131792. WebGLRenderingContext: WebGLRenderingContext;
  131793. MSGesture: MSGesture;
  131794. CANNON: any;
  131795. AudioContext: AudioContext;
  131796. webkitAudioContext: AudioContext;
  131797. PointerEvent: any;
  131798. Math: Math;
  131799. Uint8Array: Uint8ArrayConstructor;
  131800. Float32Array: Float32ArrayConstructor;
  131801. mozURL: typeof URL;
  131802. msURL: typeof URL;
  131803. VRFrameData: any; // WebVR, from specs 1.1
  131804. DracoDecoderModule: any;
  131805. setImmediate(handler: (...args: any[]) => void): number;
  131806. }
  131807. interface HTMLCanvasElement {
  131808. requestPointerLock(): void;
  131809. msRequestPointerLock?(): void;
  131810. mozRequestPointerLock?(): void;
  131811. webkitRequestPointerLock?(): void;
  131812. /** Track wether a record is in progress */
  131813. isRecording: boolean;
  131814. /** Capture Stream method defined by some browsers */
  131815. captureStream(fps?: number): MediaStream;
  131816. }
  131817. interface CanvasRenderingContext2D {
  131818. msImageSmoothingEnabled: boolean;
  131819. }
  131820. interface MouseEvent {
  131821. mozMovementX: number;
  131822. mozMovementY: number;
  131823. webkitMovementX: number;
  131824. webkitMovementY: number;
  131825. msMovementX: number;
  131826. msMovementY: number;
  131827. }
  131828. interface Navigator {
  131829. mozGetVRDevices: (any: any) => any;
  131830. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  131831. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  131832. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  131833. webkitGetGamepads(): Gamepad[];
  131834. msGetGamepads(): Gamepad[];
  131835. webkitGamepads(): Gamepad[];
  131836. }
  131837. interface HTMLVideoElement {
  131838. mozSrcObject: any;
  131839. }
  131840. interface Math {
  131841. fround(x: number): number;
  131842. imul(a: number, b: number): number;
  131843. }
  131844. interface WebGLRenderingContext {
  131845. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  131846. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  131847. vertexAttribDivisor(index: number, divisor: number): void;
  131848. createVertexArray(): any;
  131849. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  131850. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  131851. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  131852. renderbufferStorageMultisample(target: number, samples: number, internalformat: number, width: number, height: number): void;
  131853. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  131854. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  131855. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  131856. // Queries
  131857. createQuery(): WebGLQuery;
  131858. deleteQuery(query: WebGLQuery): void;
  131859. beginQuery(target: number, query: WebGLQuery): void;
  131860. endQuery(target: number): void;
  131861. getQueryParameter(query: WebGLQuery, pname: number): any;
  131862. getQuery(target: number, pname: number): any;
  131863. MAX_SAMPLES: number;
  131864. RGBA8: number;
  131865. READ_FRAMEBUFFER: number;
  131866. DRAW_FRAMEBUFFER: number;
  131867. UNIFORM_BUFFER: number;
  131868. HALF_FLOAT_OES: number;
  131869. RGBA16F: number;
  131870. RGBA32F: number;
  131871. R32F: number;
  131872. RG32F: number;
  131873. RGB32F: number;
  131874. R16F: number;
  131875. RG16F: number;
  131876. RGB16F: number;
  131877. RED: number;
  131878. RG: number;
  131879. R8: number;
  131880. RG8: number;
  131881. UNSIGNED_INT_24_8: number;
  131882. DEPTH24_STENCIL8: number;
  131883. MIN: number;
  131884. MAX: number;
  131885. /* Multiple Render Targets */
  131886. drawBuffers(buffers: number[]): void;
  131887. readBuffer(src: number): void;
  131888. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  131889. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  131890. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  131891. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  131892. // Occlusion Query
  131893. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  131894. ANY_SAMPLES_PASSED: number;
  131895. QUERY_RESULT_AVAILABLE: number;
  131896. QUERY_RESULT: number;
  131897. }
  131898. interface WebGLProgram {
  131899. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  131900. }
  131901. interface EXT_disjoint_timer_query {
  131902. QUERY_COUNTER_BITS_EXT: number;
  131903. TIME_ELAPSED_EXT: number;
  131904. TIMESTAMP_EXT: number;
  131905. GPU_DISJOINT_EXT: number;
  131906. QUERY_RESULT_EXT: number;
  131907. QUERY_RESULT_AVAILABLE_EXT: number;
  131908. queryCounterEXT(query: WebGLQuery, target: number): void;
  131909. createQueryEXT(): WebGLQuery;
  131910. beginQueryEXT(target: number, query: WebGLQuery): void;
  131911. endQueryEXT(target: number): void;
  131912. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  131913. deleteQueryEXT(query: WebGLQuery): void;
  131914. }
  131915. interface WebGLUniformLocation {
  131916. _currentState: any;
  131917. }
  131918. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  131919. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  131920. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  131921. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  131922. interface WebGLRenderingContext {
  131923. readonly RASTERIZER_DISCARD: number;
  131924. readonly DEPTH_COMPONENT24: number;
  131925. readonly TEXTURE_3D: number;
  131926. readonly TEXTURE_2D_ARRAY: number;
  131927. readonly TEXTURE_COMPARE_FUNC: number;
  131928. readonly TEXTURE_COMPARE_MODE: number;
  131929. readonly COMPARE_REF_TO_TEXTURE: number;
  131930. readonly TEXTURE_WRAP_R: number;
  131931. readonly HALF_FLOAT: number;
  131932. readonly RGB8: number;
  131933. readonly RED_INTEGER: number;
  131934. readonly RG_INTEGER: number;
  131935. readonly RGB_INTEGER: number;
  131936. readonly RGBA_INTEGER: number;
  131937. readonly R8_SNORM: number;
  131938. readonly RG8_SNORM: number;
  131939. readonly RGB8_SNORM: number;
  131940. readonly RGBA8_SNORM: number;
  131941. readonly R8I: number;
  131942. readonly RG8I: number;
  131943. readonly RGB8I: number;
  131944. readonly RGBA8I: number;
  131945. readonly R8UI: number;
  131946. readonly RG8UI: number;
  131947. readonly RGB8UI: number;
  131948. readonly RGBA8UI: number;
  131949. readonly R16I: number;
  131950. readonly RG16I: number;
  131951. readonly RGB16I: number;
  131952. readonly RGBA16I: number;
  131953. readonly R16UI: number;
  131954. readonly RG16UI: number;
  131955. readonly RGB16UI: number;
  131956. readonly RGBA16UI: number;
  131957. readonly R32I: number;
  131958. readonly RG32I: number;
  131959. readonly RGB32I: number;
  131960. readonly RGBA32I: number;
  131961. readonly R32UI: number;
  131962. readonly RG32UI: number;
  131963. readonly RGB32UI: number;
  131964. readonly RGBA32UI: number;
  131965. readonly RGB10_A2UI: number;
  131966. readonly R11F_G11F_B10F: number;
  131967. readonly RGB9_E5: number;
  131968. readonly RGB10_A2: number;
  131969. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  131970. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  131971. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  131972. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  131973. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  131974. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  131975. 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;
  131976. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  131977. readonly TRANSFORM_FEEDBACK: number;
  131978. readonly INTERLEAVED_ATTRIBS: number;
  131979. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  131980. createTransformFeedback(): WebGLTransformFeedback;
  131981. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  131982. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  131983. beginTransformFeedback(primitiveMode: number): void;
  131984. endTransformFeedback(): void;
  131985. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  131986. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  131987. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  131988. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  131989. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  131990. }
  131991. interface ImageBitmap {
  131992. readonly width: number;
  131993. readonly height: number;
  131994. close(): void;
  131995. }
  131996. interface WebGLQuery extends WebGLObject {
  131997. }
  131998. declare var WebGLQuery: {
  131999. prototype: WebGLQuery;
  132000. new(): WebGLQuery;
  132001. };
  132002. interface WebGLSampler extends WebGLObject {
  132003. }
  132004. declare var WebGLSampler: {
  132005. prototype: WebGLSampler;
  132006. new(): WebGLSampler;
  132007. };
  132008. interface WebGLSync extends WebGLObject {
  132009. }
  132010. declare var WebGLSync: {
  132011. prototype: WebGLSync;
  132012. new(): WebGLSync;
  132013. };
  132014. interface WebGLTransformFeedback extends WebGLObject {
  132015. }
  132016. declare var WebGLTransformFeedback: {
  132017. prototype: WebGLTransformFeedback;
  132018. new(): WebGLTransformFeedback;
  132019. };
  132020. interface WebGLVertexArrayObject extends WebGLObject {
  132021. }
  132022. declare var WebGLVertexArrayObject: {
  132023. prototype: WebGLVertexArrayObject;
  132024. new(): WebGLVertexArrayObject;
  132025. };
  132026. // Type definitions for WebVR API
  132027. // Project: https://w3c.github.io/webvr/
  132028. // Definitions by: six a <https://github.com/lostfictions>
  132029. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  132030. interface VRDisplay extends EventTarget {
  132031. /**
  132032. * Dictionary of capabilities describing the VRDisplay.
  132033. */
  132034. readonly capabilities: VRDisplayCapabilities;
  132035. /**
  132036. * z-depth defining the far plane of the eye view frustum
  132037. * enables mapping of values in the render target depth
  132038. * attachment to scene coordinates. Initially set to 10000.0.
  132039. */
  132040. depthFar: number;
  132041. /**
  132042. * z-depth defining the near plane of the eye view frustum
  132043. * enables mapping of values in the render target depth
  132044. * attachment to scene coordinates. Initially set to 0.01.
  132045. */
  132046. depthNear: number;
  132047. /**
  132048. * An identifier for this distinct VRDisplay. Used as an
  132049. * association point in the Gamepad API.
  132050. */
  132051. readonly displayId: number;
  132052. /**
  132053. * A display name, a user-readable name identifying it.
  132054. */
  132055. readonly displayName: string;
  132056. readonly isConnected: boolean;
  132057. readonly isPresenting: boolean;
  132058. /**
  132059. * If this VRDisplay supports room-scale experiences, the optional
  132060. * stage attribute contains details on the room-scale parameters.
  132061. */
  132062. readonly stageParameters: VRStageParameters | null;
  132063. /**
  132064. * Passing the value returned by `requestAnimationFrame` to
  132065. * `cancelAnimationFrame` will unregister the callback.
  132066. * @param handle Define the hanle of the request to cancel
  132067. */
  132068. cancelAnimationFrame(handle: number): void;
  132069. /**
  132070. * Stops presenting to the VRDisplay.
  132071. * @returns a promise to know when it stopped
  132072. */
  132073. exitPresent(): Promise<void>;
  132074. /**
  132075. * Return the current VREyeParameters for the given eye.
  132076. * @param whichEye Define the eye we want the parameter for
  132077. * @returns the eye parameters
  132078. */
  132079. getEyeParameters(whichEye: string): VREyeParameters;
  132080. /**
  132081. * Populates the passed VRFrameData with the information required to render
  132082. * the current frame.
  132083. * @param frameData Define the data structure to populate
  132084. * @returns true if ok otherwise false
  132085. */
  132086. getFrameData(frameData: VRFrameData): boolean;
  132087. /**
  132088. * Get the layers currently being presented.
  132089. * @returns the list of VR layers
  132090. */
  132091. getLayers(): VRLayer[];
  132092. /**
  132093. * Return a VRPose containing the future predicted pose of the VRDisplay
  132094. * when the current frame will be presented. The value returned will not
  132095. * change until JavaScript has returned control to the browser.
  132096. *
  132097. * The VRPose will contain the position, orientation, velocity,
  132098. * and acceleration of each of these properties.
  132099. * @returns the pose object
  132100. */
  132101. getPose(): VRPose;
  132102. /**
  132103. * Return the current instantaneous pose of the VRDisplay, with no
  132104. * prediction applied.
  132105. * @returns the current instantaneous pose
  132106. */
  132107. getImmediatePose(): VRPose;
  132108. /**
  132109. * The callback passed to `requestAnimationFrame` will be called
  132110. * any time a new frame should be rendered. When the VRDisplay is
  132111. * presenting the callback will be called at the native refresh
  132112. * rate of the HMD. When not presenting this function acts
  132113. * identically to how window.requestAnimationFrame acts. Content should
  132114. * make no assumptions of frame rate or vsync behavior as the HMD runs
  132115. * asynchronously from other displays and at differing refresh rates.
  132116. * @param callback Define the eaction to run next frame
  132117. * @returns the request handle it
  132118. */
  132119. requestAnimationFrame(callback: FrameRequestCallback): number;
  132120. /**
  132121. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  132122. * Repeat calls while already presenting will update the VRLayers being displayed.
  132123. * @param layers Define the list of layer to present
  132124. * @returns a promise to know when the request has been fulfilled
  132125. */
  132126. requestPresent(layers: VRLayer[]): Promise<void>;
  132127. /**
  132128. * Reset the pose for this display, treating its current position and
  132129. * orientation as the "origin/zero" values. VRPose.position,
  132130. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  132131. * updated when calling resetPose(). This should be called in only
  132132. * sitting-space experiences.
  132133. */
  132134. resetPose(): void;
  132135. /**
  132136. * The VRLayer provided to the VRDisplay will be captured and presented
  132137. * in the HMD. Calling this function has the same effect on the source
  132138. * canvas as any other operation that uses its source image, and canvases
  132139. * created without preserveDrawingBuffer set to true will be cleared.
  132140. * @param pose Define the pose to submit
  132141. */
  132142. submitFrame(pose?: VRPose): void;
  132143. }
  132144. declare var VRDisplay: {
  132145. prototype: VRDisplay;
  132146. new(): VRDisplay;
  132147. };
  132148. interface VRLayer {
  132149. leftBounds?: number[] | Float32Array | null;
  132150. rightBounds?: number[] | Float32Array | null;
  132151. source?: HTMLCanvasElement | null;
  132152. }
  132153. interface VRDisplayCapabilities {
  132154. readonly canPresent: boolean;
  132155. readonly hasExternalDisplay: boolean;
  132156. readonly hasOrientation: boolean;
  132157. readonly hasPosition: boolean;
  132158. readonly maxLayers: number;
  132159. }
  132160. interface VREyeParameters {
  132161. /** @deprecated */
  132162. readonly fieldOfView: VRFieldOfView;
  132163. readonly offset: Float32Array;
  132164. readonly renderHeight: number;
  132165. readonly renderWidth: number;
  132166. }
  132167. interface VRFieldOfView {
  132168. readonly downDegrees: number;
  132169. readonly leftDegrees: number;
  132170. readonly rightDegrees: number;
  132171. readonly upDegrees: number;
  132172. }
  132173. interface VRFrameData {
  132174. readonly leftProjectionMatrix: Float32Array;
  132175. readonly leftViewMatrix: Float32Array;
  132176. readonly pose: VRPose;
  132177. readonly rightProjectionMatrix: Float32Array;
  132178. readonly rightViewMatrix: Float32Array;
  132179. readonly timestamp: number;
  132180. }
  132181. interface VRPose {
  132182. readonly angularAcceleration: Float32Array | null;
  132183. readonly angularVelocity: Float32Array | null;
  132184. readonly linearAcceleration: Float32Array | null;
  132185. readonly linearVelocity: Float32Array | null;
  132186. readonly orientation: Float32Array | null;
  132187. readonly position: Float32Array | null;
  132188. readonly timestamp: number;
  132189. }
  132190. interface VRStageParameters {
  132191. sittingToStandingTransform?: Float32Array;
  132192. sizeX?: number;
  132193. sizeY?: number;
  132194. }
  132195. interface Navigator {
  132196. getVRDisplays(): Promise<VRDisplay[]>;
  132197. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  132198. }
  132199. interface Window {
  132200. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  132201. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  132202. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  132203. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  132204. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  132205. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  132206. }
  132207. interface Gamepad {
  132208. readonly displayId: number;
  132209. }
  132210. type XRSessionMode =
  132211. | "inline"
  132212. | "immersive-vr"
  132213. | "immersive-ar";
  132214. type XRReferenceSpaceType =
  132215. | "viewer"
  132216. | "local"
  132217. | "local-floor"
  132218. | "bounded-floor"
  132219. | "unbounded";
  132220. type XREnvironmentBlendMode =
  132221. | "opaque"
  132222. | "additive"
  132223. | "alpha-blend";
  132224. type XRVisibilityState =
  132225. | "visible"
  132226. | "visible-blurred"
  132227. | "hidden";
  132228. type XRHandedness =
  132229. | "none"
  132230. | "left"
  132231. | "right";
  132232. type XRTargetRayMode =
  132233. | "gaze"
  132234. | "tracked-pointer"
  132235. | "screen";
  132236. type XREye =
  132237. | "none"
  132238. | "left"
  132239. | "right";
  132240. interface XRSpace extends EventTarget {
  132241. }
  132242. interface XRRenderState {
  132243. depthNear?: number;
  132244. depthFar?: number;
  132245. inlineVerticalFieldOfView?: number;
  132246. baseLayer?: XRWebGLLayer;
  132247. }
  132248. interface XRInputSource {
  132249. handedness: XRHandedness;
  132250. targetRayMode: XRTargetRayMode;
  132251. targetRaySpace: XRSpace;
  132252. gripSpace: XRSpace | undefined;
  132253. gamepad: Gamepad | undefined;
  132254. profiles: Array<string>;
  132255. }
  132256. interface XRSession {
  132257. addEventListener: Function;
  132258. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  132259. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  132260. requestAnimationFrame: Function;
  132261. end(): Promise<void>;
  132262. renderState: XRRenderState;
  132263. inputSources: Array<XRInputSource>;
  132264. }
  132265. interface XRReferenceSpace extends XRSpace {
  132266. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  132267. onreset: any;
  132268. }
  132269. interface XRFrame {
  132270. session: XRSession;
  132271. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  132272. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  132273. }
  132274. interface XRViewerPose extends XRPose {
  132275. views: Array<XRView>;
  132276. }
  132277. interface XRPose {
  132278. transform: XRRigidTransform;
  132279. emulatedPosition: boolean;
  132280. }
  132281. declare var XRWebGLLayer: {
  132282. prototype: XRWebGLLayer;
  132283. new(session: XRSession, context: WebGLRenderingContext | undefined): XRWebGLLayer;
  132284. };
  132285. interface XRWebGLLayer {
  132286. framebuffer: WebGLFramebuffer;
  132287. framebufferWidth: number;
  132288. framebufferHeight: number;
  132289. getViewport: Function;
  132290. }
  132291. interface XRRigidTransform {
  132292. position: DOMPointReadOnly;
  132293. orientation: DOMPointReadOnly;
  132294. matrix: Float32Array;
  132295. inverse: XRRigidTransform;
  132296. }
  132297. interface XRView {
  132298. eye: XREye;
  132299. projectionMatrix: Float32Array;
  132300. transform: XRRigidTransform;
  132301. }
  132302. interface XRInputSourceChangeEvent {
  132303. session: XRSession;
  132304. removed: Array<XRInputSource>;
  132305. added: Array<XRInputSource>;
  132306. }